View Advertiser report
View Advertiser report
Query parameters
parametersResponse schemas
curl -X GET \
"https://api.ocamba.com/v2/adex/reports/advertiser" \
-H "Authorization: Bearer {TOKEN}"const url = 'https://api.ocamba.com/v2/adex/reports/advertiser';
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/advertiser");
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
[
{
"partner_name": "Partner1 - Push CPC",
"subid": "subid_example_1",
"ppm": 62.502,
"stat_date": "2022-03-11T00:00:00Z"
},
{
"partner_name": "Partner2 - Push CPC",
"subid": "subid_example_2",
"ppm": 50.85625,
"stat_date": "2022-03-11T00:00:00Z"
},
{
"partner_name": "Partner3 - Push CPC",
"subid": "subid_example_3",
"ppm": 43.61045,
"stat_date": "2022-03-11T00:00:00Z"
},
{
"partner_name": "Partner3 - Push CPC",
"subid": "subid_example_4",
"ppm": 39.69,
"stat_date": "2022-03-11T00:00:00Z"
},
{
"partner_name": "Partner4 - Push CPC",
"subid": "subid_example_5",
"ppm": 35.49,
"stat_date": "2022-03-11T00:00:00Z"
}
]
Sortable fields are: stat_date, subid, zone_id, zone_name, country_code, country_name, os_version, os_id, os_name, tag, browser_version, browser_id, browser_name, device_id, device_name, user_lang, hood_tag_id, hood_tag_name, container_id, container_name, asn, isp, conn_type_id, conn_type, city_id, city_name, keyword, ssp_account_id, ssp_account_name, ssp_pm, server_traffic_id, server_traffic_name, region, region_name, exchange_id, exchange_name, partner_id, partner_name, campaign_id, campaign_name, creator_id, creator_name, creative_id, creative_name, creative_lang, dsp_pm, dsp_account_id, dsp_account_name, dsp_iab_category, dsp_iab_id, dsp_parent_iab_id, dsp_iab_name, ab_test_id, ab_test_name, ab_test_variation_id, ab_test_variation_name, page_url, page_domain, impression, total_click, spam_click, click, conversion, income, cost, expected_income, attributed_revenue, expense, served, ctr, ctp, cir, ecpm, ecpa, ppm, ccr, cta_0, cta_1, cta_2, cta_3, campaign_algo_id and campaign_algo_name.
Filterable fields are: stat_date, subid, zone_id, country_code, os_version, os_id, tag, browser_version, browser_id, device_id, user_lang, hood_tag_id, container_id, asn, isp, conn_type_id, city_id, keyword, ssp_account_id, ssp_pm, server_traffic_id, region, exchange_id, partner_id, campaign_id, campaign_name, creator_id, creator_name, creative_id, creative_name, creative_lang, dsp_pm, dsp_account_id, dsp_iab_category, dsp_iab_id, dsp_parent_iab_id, ab_test_id, ab_test_variation_id, page_url, page_domain, impression, total_click, spam_click, click, conversion, income, cost, expected_income, attributed_revenue, expense, served, ctr, ctp, cir, ecpm, ecpa, ppm, ccr, cta_0, cta_1, cta_2, cta_3, 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.
API provided filling empty entry points in between first and last date/hour. You should set with_fill parameter to true, but just in case the date dimension is requested only. It is in relation with resolution. You should pass day or hour, which defines what type of breakdown you request, default setup displays daily breakdown.
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, current-hour, last-hour, last-48-hours, last-2-days, month-to-date, month-to-yesterday, quarter-to-date.
When filtering delivery_date and delivery_time, 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.
- r - range - The value must be in a specified open range, where both endpoints are excluded.
- 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.