View User-age report

GET /reports/user-age
Copied
Arrow
                https://api.ocamba.com/v2/adex/reports/user-age

List selected user-age details

query Parameters
Arrow
Name
Description
sortstring
Sorts the response by specified field(s) with the option to specify sorting order (ascending by default, add prefix "-" for descending).

Examples:
GET /VERSION/adex/RESOURCE_NAME?sort=name → sorts per name, ascending
GET /VERSION/adex/RESOURCE_NAME?sort=-id → sorts per id descending
GET /VERSION/adex/RESOURCE_NAME?sort=id,-name → sorts per id ascending, then name descending

See tips for the list of sortable fields.


Example: sort=-field1,field2
pagestring
The page number indicates which set of items will be returned in the response. The format of request is "page=N,M" where 'N' (required) represents page number and 'M' (optional) is number of items per page.

Examples:
N=1, M=20 → returns page 1 with 20 items
N=2, M=20 → returns page 2 with 20 items (items 21-40)
N=3 → returns page 3. The number of objects returned depends on the resource settings.


Example: page=1,10
fieldsstring
The client can request more efficient filtered representation of the resource showing only specific field(s), using the “fields” query parameter. Note that the “fields” parameter has precedence over the “view” parameter.

Example GET /VERSION/adex/RESOURCE_NAME?fields=id,name

See "Tips" for the list of filterable parameters.


Example: fields=field1,field2,field3
stat_datestring
The day of the event.


Example: today
Response status codes
Arrow
200 - OK
Arrow
Name
Description
browser_idinteger
Dimension
The id of the browser.


Example: 10
browser_namestring
Dimension
The name of the browser.


Example: Chrome
browser_versioninteger
Dimension
The major version of the browser.


Example: 87
campaign_idinteger
Dimension
The campaign id generated on ocamba platform.


Example: 1059687
campaign_namestring
Dimension
The campaign name created on ocamba platform.


Example: Test campaign
ccrfloat
Measure
The rate of conversions to clicks.


Example: 0.057
cirfloat
Measure
The rate of clicks to impressions.


Example: 12.98
clickinteger
Measure
The total number of valid clicks across all impressions.


Example: 123456
conversioninteger
Measure
The total number of conversions.


Example: 12
convs_ratefloat
Measure
The rate of conversions to impressions.


Example: 0.0856
country_codestring
Dimension
The code of the geographical country.


Example: RS
country_namestring
Dimension
The name of the geographical country.


Example: Serbia
cpcfloat
Measure
The rate of clicks to revenue.


Example: 187.02
cpmmfloat
Measure
The number of conversions per million impressions.


Example: 221.877
creative_idinteger
Dimension
The creative id generated on ocamba platform.


Example: 1029607
creative_namestring
Dimension
The creative name created on ocamba platform.


Example: Dynamic native test
ctpfloat
Measure
The rate of clicks to impressions with percentage.


Example: 0.56
ctrfloat
Measure
The rate of clicks to impressions.


Example: 0.002
dsp_account_idinteger
Dimension
The adex account id generated on ocamba platform.


Example: 874214212
dsp_account_namestring
Dimension
The adex account name created on ocamba platform.


Example: Default account
ecpafloat
Measure
The effective spend per conversion.


Example: 1.2
ecpcfloat
Measure
The effective spend per click.


Example: 1.25
ecpmfloat
Measure
The effective spend per 1000 impressions.


Example: 187.02
exchange_idinteger
Dimension
The exchange id generated on ocamba platform.


Example: 1258
exchange_namestring
Dimension
The exchange name created on ocamba platform.


Example: First test exchange #1
expected_incomefloat
Measure
The total expected income.


Example: 0.56
expensefloat
Measure
The total expense.


Example: 12.98
impressioninteger
Measure
The total number of impressions served.


Example: 5246872
incomefloat
Measure
The total income.


Example: 125.65
os_idinteger
Dimension
The id of the operating system.


Example: 12
os_namestring
Dimension
The name of the operating system.


Example: Android
os_versioninteger
Dimension
The major version of the operating system.


Example: 15
ppmfloat
Measure
The profit per 1000 impressions.


Example: 0.944
revenuefloat
Measure
The total revenue.


Example: 187.02
rpmfloat
Measure
The revenue per 1000 impressions.


Example: 2.65
servedinteger
Measure
The total number of served campaigns in response.


Example: 5687421
spam_clickinteger
Measure
The total number of spam clicks across all impressions.


Example: 56
stat_datedateTime
Dimension
The day of the event.


Example: 2021-12-27
subidstring
Dimension
String used to record and track unique user attributes, traffic sources, banners, and/or link placement.


Example: example_source
total_clickinteger
Measure
The total number of all clicks across all impressions.


Example: 56
user_agestring
Dimension
The range user age.


Example: 8-30
user_age_by_hourstring
Dimension
The range user age by hour.


Example: 17

tip
1 Sortable fields are: campaign_id, campaign_name, creative_id, creative_name, exchange_id, exchange_name, subid, browser_id, browser_name, browser_version, dsp_account_id, dsp_account_name, os_id, os_name, os_version, country_code, country_name, user_age, user_age_by_hour, page_domain, stat_date, impression, total_click, spam_click, click, conversion, income, expected_income, expense, revenue, served, ctr, ctp, cir, cpc, ecpc, rpm, cpmm, convs_rate, ecpm, ecpa, ppm, ccr.
2 Filterable fields are: campaign_id, creative_id, exchange_id, subid, browser_id, browser_version, dsp_account_id, os_id, os_version, country_code, user_age, user_age_by_hour, page_domain, stat_date, impression, total_click, spam_click, click, conversion, income, expected_income, expense, revenue, served, ctr, ctp, cir, cpc, ecpc, rpm, cpmm, convs_rate, ecpm, ecpa, ppm, ccr.
3 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.
4 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.
5 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.
note
1 When filtering stat_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.

Response examples
Copied
Arrow
200 Arrow
  • 200
  • 200
[
  {
    "campaign_name": "Campaign1 - Push CPC",
    "subid": "subid_example_1",
    "ppm": 50.85625,
    "stat_date": "2022-03-11T00:00:00Z"
  },
  {
    "campaign_name": "Campaign2 - Push CPC",
    "subid": "subid_example_2",
    "ppm": 43.61045,
    "stat_date": "2022-03-11T00:00:00Z"
  },
  {
    "campaign_name": "Campaign3 - Push CPC",
    "subid": "subid_example_3",
    "ppm": 39.69,
    "stat_date": "2022-03-11T00:00:00Z"
  },
  {
    "campaign_name": "Campaign4 - Push CPC",
    "subid": "subid_example_4",
    "ppm": 35.49,
    "stat_date": "2022-03-11T00:00:00Z"
  }
]

{
  "stat_date": "2021-12-27",
  "subid": "example_source",
  "campaign_id": 1059687,
  "campaign_name": "Test campaign",
  "creative_id": 1029607,
  "creative_name": "Dynamic native test",
  "dsp_account_id": 874214212,
  "dsp_account_name": "Default account",
  "exchange_id": 1258,
  "exchange_name": "First test exchange #1",
  "country_code": "RS",
  "country_name": "Serbia",
  "browser_id": 10,
  "browser_name": "Chrome",
  "browser_version": 87,
  "os_id": 12,
  "os_name": "Android",
  "os_version": 15,
  "user_age": "8-30",
  "user_age_by_hour": "17",
  "served": 5687421,
  "click": 123456,
  "spam_click": 56,
  "total_click": 56,
  "impression": 5246872,
  "conversion": 12,
  "income": 125.65,
  "expected_income": 0.56,
  "expense": 12.98,
  "revenue": 187.02,
  "ctp": 0.56,
  "cir": 12.98,
  "cpc": 187.02,
  "ecpm": 187.02,
  "ppm": 0.944,
  "ccr": 0.057,
  "ctr": 0.002,
  "ecpc": 1.25,
  "ecpa": 1.2,
  "rpm": 2.65,
  "cpmm": 221.877,
  "convs_rate": 0.0856
}