About

This is a detailed guide on how to use the AdColony CPA API.

Use this API to:
  • Feed real-time user action data to the AdColony ad servers in order to drive better campaign optimization.
  • Provide critical performance metrics back to you the advertiser.

Reporting User Actions (Installs, etc)

Action

GET https://cpa.adcolony.com/on_user_action

Parameters

api_key - (Required) An API Key to use for reporting your product's user activity. Contact support@adcolony.com to acquire an API Key

product_id - (Required) The id of the product i.e. iTunes App ID (123456789) or Android Bundle ID (com.yourcompany.app).

adc_conversion - (Optional) Used to specify whether an install is attributed to AdColony in cases where AdColony is not responsible for attribution. A value of 1 = attributed to AdColony. A value of 0 = not attributed to AdColony. If the parameter is absent AdColony will claim all installs by default.

raw_mac - (Optional) The device's human readable mac address i.e. '12:34:56:78:90:ab'

sha1_mac - (Optional) The sha1 of the lower case human readable mac address i.e. '12:34:56:78:90:ab'

open_udid - (Optional) The device's OpenUDID identifier

odin1 - (Optional) The device's ODIN-1 identifier

raw_advertising_id - (Optional) The iOS device's raw identifier for advertising (IDFA)

raw_imei - (Optional) The Android device's raw IMEI identifier

sha1_imei - (Optional) The sha1 of the Android device's raw IMEI identifier

raw_android_id - (Optional) The Android device's raw AndroidID identifier

sha1_android_id - (Optional) The sha1 of the Android device's raw AndroidID identifier

google_ad_id - (Optional) The raw version of Google's device identifier for advertising

traffic_flag_status - (Optional) Status of traffic validation (Tune)

traffic_flag_reason_code - (Optional) Reason for traffic validation (Tune)

traffic_validated - (Optional) Result of traffic validation (Kochava)

traffic_rule - (Optional) The rule that triggered traffic validation result (Kochava)

traffic_value - (Optional) The value that broke the traffic validation rule (Kochava)

invalid_traffic - (Optional) ID of the traffic that broke the validation rule (Kochava)

install_rejection_reason - (Optional) Reason for traffic validation (Adjust)

rejected_reason - (Optional) Reason for traffic validation (AppsFlyer)

rejected_reason_value - (Optional) Reason for traffic validation (AppsFlyer)

attribution_type - (Optional) Attribution type (Tune, Adjust)

click_lookback_window - (Optional) The click lookback window in seconds for an install. Example: 604800 (Kochava, Adjust)

view_lookback_window - (Optional) The view lookback window in seconds for an install. Example: 604800 (Kochava, Adjust)

install_begin_time - (Optional) The unix timestamp for an install start time. Example: 1502254761 (Kochava, Adjust)

install_end_time - (Optional) The unix timestamp for an install end time. Example: 1502254761 (Kochava, Adjust)

Return Value

Returns a json result. '{status:true}' on successful call

Example Usage

GET https://cpa.adcolony.com/on_user_action?api_key=12345&product_id=123456789&open_udid=1234567&odin1=12345678

Checking for User Actions (i.e. if an install was ever reported)

Action

GET https://cpa.adcolony.com/has_user_action

Parameters

api_key - (Required) An API Key to use for reporting your product's user activity. Contact support@adcolony.com to acquire an API Key

product_id - (Required) The id of the product i.e. iTunes App ID (123456789) or Android Bundle ID (com.yourcompany.app).

device_id - (Required) A device id (e.g. raw_advertising_id) that was used previously as a parameter to 'on_user_action'

Return Value

Returns a json result. '{status:true,item:{item details}}' on successful lookup. Status will be false if the action was never recorded

Example Usage

GET https://cpa.adcolony.com/has_user_action?api_key=12345&product_id=123456789&device_id=1234567

Checking for recent product user activity

Action

GET https://cpa.adcolony.com/product_status

Parameters

api_key - (Required) An API Key to use for reporting your product's user activity. Contact support@adcolony.com to acquire an API Key

product_id - (Required) The id of the product that you are querying i.e. iTunes App ID (123456789) or Android Bundle ID (com.yourcompany.app).

Return Value

Returns a json result detailing the number of installs per day

Example Usage

GET https://cpa.adcolony.com/product_status?api_key=12345&product_id=123456789

Need help or have any questions?

Please contact us at support@adcolony.com