View Click report

GET https://api.ocamba.com/v2/adex/reports/click

Obtain various reports on clicks

Query parameters

parameters

Response schemas

›

200

application/json

curl -X GET \
 "https://api.ocamba.com/v2/adex/reports/click" \
  -H "Authorization: Bearer {TOKEN}"

const url = 'https://api.ocamba.com/v2/adex/reports/click';
const options = {
  method: 'GET',
  headers: {
    Authorization: `Bearer {TOKEN}`
  }
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

$ch = curl_init("https://api.ocamba.com/v2/adex/reports/click");
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "GET");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  "Authorization: Bearer {TOKEN}"
]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);

Responses

200 OK

[
  {
    "browser_id": "12",
    "exchange_id": "1",
    "income": 0.008,
    "click_date": "2022-03-03T00:00:00Z"
  },
  {
    "browser_id": "17",
    "exchange_id": "2",
    "income": 0.0008,
    "click_date": "2022-03-03T00:00:00Z"
  },
  {
    "browser_id": "17",
    "exchange_id": "3",
    "income": 0.05094,
    "click_date": "2022-03-03T00:00:00Z"
  },
  {
    "browser_id": "17",
    "exchange_id": "4",
    "income": 0.0462,
    "click_date": "2022-03-03T00:00:00Z"
  },
  {
    "browser_id": "12",
    "exchange_id": "5",
    "income": 0.002,
    "click_date": "2022-03-03T00:00:00Z"
  }
]

Responses

Tip

Sortable fields are: click_date, zone_name, exchange_name, partner_name, hood_tag_id, hood_tag_name, container_id, container_name, subid, os_name, browser_name, campaign_name, creative_name, country_name, ssp_account_name, dsp_account_id, dsp_account_name, isp, conn_type, user_data_kv, city_name, keyword, ssp_iab_category, ssp_parent_iab_id, ssp_iab_name, dsp_iab_category, dsp_parent_iab_id, dsp_iab_name, page_domain, page_url, income, expense, revenue, automation_id, automation_name, cta_position, campaign_algo_id and campaign_algo_name.

Filterable fields are: click_date, zone_id, exchange_id, partner_id, subid, os_id, browser_id, campaign_id, creative_id, country_code, spam, user_id, dsp_account_id, hood_tag_id, container_id, task_id, server_traffic_id, region, asn, conn_type_id, user_data_kv, city_id, keyword, ssp_iab_category, ssp_iab_id, dsp_iab_category, dsp_iab_id, page_domain, automation_id, page_url, cta_position, campaign_algo_id and campaign_algo_name.

To get data by the time in your local time zone, you should set tz query parameter to the specific time zone. See the list of valid time zones here -> https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List.

For easier search, Reports API gives you the possibility of using one of the following labels: today, yesterday, last-7-days, last-30-days, last-24-hours,this-month,last-month.

Note

When filtering click_date, use one of the following formats:

Single format: YYYY-mm-dd;

Displaying stats for this specific day
Range format: rf:YYYY-mm-dd,YYYY-mm-dd;
Requires usage of the range operators:
- r - range - The value must be in a specified open range, where both endpoints are excluded.
- rf - range full - The value must be in a specified closed range, where both endpoints are included.
- rl - range left - The value must be in a specified half-open range, where only left or start point is included.
- rr - range right - The value must be in a specified half-open range, where only right or end point is included.
  
  Displaying stats in this specific range.
Hour range format: rl: YYYY-mm-dd hh:00:00,YYYY-mm-dd hh:00:00
If you exclude this parameter, the default setup displays “today” stats.

LinkedIn Facebook Instagram