View External demand sample report

GET /reports/external-demand-sample
Copied
Arrow
                https://api.ocamba.com/v2/adex/reports/external-demand-sample

Obtains sample report on External demand

query Parameters
Arrow
Name
Description
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
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
outstring
You can request JSON formatted response. Set the `out` parameter value to json.


Example: out=json
stat_datestring
The request time.
expected format for date is "YYYY-MM-DD", example "2021-12-27"
expected format for date time is "YYYY-MM-DD HH:SS", example "2022-12-23 01:00"


Example: rf:2022-02-10,2022-02-15
exchange_idinteger
Unique external demand identifier generated by Ocamba.


Example: 936
partner_idinteger
Unique partner identifier generated by Ocamba.


Example: 56
country_codestring
Two letter country code.


Example: US
zone_idinteger
Unique zone identifier generated by Ocamba.


Example: 1009638
Response status codes
Arrow
200 - OK
Arrow
Name
Description
country_codestring
Dimension
Two letter country code.


Example: RS
country_namestring
Dimension
The name of country.


Example: Serbia
exchange_idinteger
Dimension
Unique external demand identifier generated by Ocamba.


Example: 1258
exchange_namestring
Dimension
The external demand name.


Example: First test external demand #1
partner_idinteger
Dimension
Unique partner identifier generated by Ocamba.


Example: 16
partner_namestring
Dimension
The partner name.


Example: Zeropark
samplestring
Dimension
Hydra content, request and response samples.


Example: {\"req\":{\"host\":\"www.example.com\",\"method\":\"GET\",\"target\":\"/search?user_id=123456789&domain=https%3A%2F%2Fexample.info%2F&domainId=654321&format=jsonv2&ip=101.0.0.101&lang=en-US%2Cen%3Bq%3D0.9&secure=true&ua=Mozilla%2F5.0+%28Windows+NT+10.0%3B+Win64%3B+x64%29+AppleWebKit%2F537.36+%28KHTML%2C+like+Gecko%29+Chrome%2F101.0.4951.67+Safari%2F537.36\",\"hdrs\":{\"Host\":\"www.example.com\",\"User-Agent\":\"Hydra v1.0\",\"Accept-Encoding\":\"gzip, deflate\"}},\"res\":{\"code\":200,\"hdrs\":{\"Date\":\"Mon, 23 May 2022 08:35:00 GMT\",\"Content-Type\":\"text/json;charset=UTF-8\",\"Transfer-Encoding\":\"chunked\",\"Connection\":\"keep-alive\",\"vary\":\"accept-encoding\",\"Content-Encoding\":\"gzip\"},\"body\":{\"title\":\"Example title\",\"token\":\"_lhJxadKQd7dwvldcnT1_um0mVkEZ6E7EfUr36A=.d9Qk9D1T4s26RrRsyMTOyQ==\",\"link\":\"https://example.com/c/3bc7d951-da73-11ec-81d4-12d1e567c9b5/2/ecaecdb0-d9f3-11e9-8d9d-0a97765f9322/{token}\",\"imp_url\":\"https://example.com/imp/3bc7d951-da73-11ec-81d4-12d1e567c9b5/2/ecaecdb0-d9f3-11e9-8d9d-0a97765f9322/{token}\",\"image_url\":\"https://example.com/imp/3bc7d951-da73-11ec-81d4-12d1e567c9b5/2/ecaecdb0-d9f3-11e9-8d9d-0a97765f9322/{token}\",\"description\":\"Example description.\",\"price\":0,\"cpc\":0.0068,\"ad_id\":\"fd320164-fe6c-43c3-9109f035a04c\"}}}
stat_datedateTime
Dimension
The request time.


Example: 2021-12-27
zone_idinteger
Dimension
Unique zone identifier generated by Ocamba.


Example: 1029607
zone_namestring
Dimension
The zone name.


Example: Push zone

tip
1 Sortable fields are: stat_date, exchange_id, exchange_name, partner_id, partner_name, country_code, country_name, zone_id and zone_name.
2 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.
3 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
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
[
   {
       "zone_id": "1000001",
       "zone_name": "EXAMPLE PUSH ZONE",
       "exchange_id": "101",
       "exchange_name": "Example PUSH Adult CPC",
       "partner_id": "1",
       "partner_name": "Example - Push CPC",
       "country_code": "GB",
       "country_name": "United Kingdom",
       "stat_date": "2022-05-23T00:00:00Z",
       "sample": "{\"req\":{\"host\":\"www.example.com\",\"method\":\"GET\",\"target\":\"/search?user_id=123456789&domain=https%3A%2F%2Fexample.info%2F&domainId=654321&format=jsonv2&ip=101.0.0.101&lang=en-US%2Cen%3Bq%3D0.9&secure=true&ua=Mozilla%2F5.0+%28Windows+NT+10.0%3B+Win64%3B+x64%29+AppleWebKit%2F537.36+%28KHTML%2C+like+Gecko%29+Chrome%2F101.0.4951.67+Safari%2F537.36\",\"hdrs\":{\"Host\":\"www.example.com\",\"User-Agent\":\"Hydra v1.0\",\"Accept-Encoding\":\"gzip, deflate\"}},\"res\":{\"code\":200,\"hdrs\":{\"Date\":\"Mon, 23 May 2022 08:35:00 GMT\",\"Content-Type\":\"text/json;charset=UTF-8\",\"Transfer-Encoding\":\"chunked\",\"Connection\":\"keep-alive\",\"vary\":\"accept-encoding\",\"Content-Encoding\":\"gzip\"},\"body\":{\"title\":\"Example title\",\"token\":\"_lhJxadKQd7dwvldcnT1_um0mVkEZ6E7EfUr36A=.d9Qk9D1T4s26RrRsyMTOyQ==\",\"link\":\"https://example.com/c/3bc7d951-da73-11ec-81d4-12d1e567c9b5/2/ecaecdb0-d9f3-11e9-8d9d-0a97765f9322/{token}\",\"imp_url\":\"https://example.com/imp/3bc7d951-da73-11ec-81d4-12d1e567c9b5/2/ecaecdb0-d9f3-11e9-8d9d-0a97765f9322/{token}\",\"image_url\":\"https://example.com/imp/3bc7d951-da73-11ec-81d4-12d1e567c9b5/2/ecaecdb0-d9f3-11e9-8d9d-0a97765f9322/{token}\",\"description\":\"Example description.\",\"price\":0,\"cpc\":0.0068,\"ad_id\":\"fd320164-fe6c-43c3-9109f035a04c\"}}}"
   },
   {
       "zone_id": "1000002",
       "zone_name": "EXAMPLE PUSH MAINSTREAM ZONE",
       "exchange_id": "102",
       "exchange_name": "Example PUSH Mainstream CPC",
       "partner_id": "2",
       "partner_name": "Example2 - Push CPC",
       "country_code": "GR",
       "country_name": "Greece",
       "stat_date": "2022-05-23T00:00:00Z",
       "sample": "{\"req\":{\"host\":\"xml.example.com\",\"method\":\"GET\",\"target\":\"/search?auth=I1eGbG&count=1&empty=204&feed=114358&format=json&lang=el-GR%2Cel%3Bq%3D0.9&pub_sublt=1605877213&query=mainstream%2Cadult&subid=subid_example&ua=Mozilla%2F5.0+%28Linux%3B+Android+8.1.0%3B+SAMSUNG+SM-J730F%29+AppleWebKit%2F537.36+%28KHTML%2C+like+Gecko%29+SamsungBrowser%2F14.0+Chrome%2F87.0.4280.141+Mobile+Safari%2F537.36&url=https%3A%2F%2Fexample2.net%2Fjs%2Fosw.js&user_ip=102.0.0.102\",\"hdrs\":{\"Host\":\"xml.example.com\",\"User-Agent\":\"Hydra v1.0\",\"Accept-Encoding\":\"gzip, deflate\"}},\"res\":{\"code\":200,\"hdrs\":{\"Cache-Control\":\"no-store\",\"Content-Type\":\"application/json; charset=utf-8\",\"Age\":\"0\",\"Content-Length\":\"390\",\"Connection\":\"keep-alive\",\"Pragma\":\"no-cache\"},\"body\":{\"result\":{\"listing\":[{\"title\":\"Διαβητικούς! Παρακαλώ διαβάστε\",\"url\":\"https://click.example.name/click?i=1whFP0GrStk_0\",\"descr\":\"Ο διαβήτης θεραπεύεται σε 7 ημέρες...\",\"site\":\"u.example.com\",\"bid\":0.004857,\"image\":\"https://click.example.name/thumbnail?i=1whBV0QlZsn_0\",\"icon\":\"https://click.example.name/thumbnail?i=1btRZ0QlSmn_0&imgt=icon\"}]}}}}"
   }
 ]

{
  "stat_date": "2021-12-27",
  "exchange_id": 1258,
  "exchange_name": "First test external demand #1",
  "partner_id": 16,
  "partner_name": "Zeropark",
  "zone_id": 1029607,
  "zone_name": "Push zone",
  "country_code": "RS",
  "country_name": "Serbia",
  "sample": "{\\\"req\\\":{\\\"host\\\":\\\"www.example.com\\\",\\\"method\\\":\\\"GET\\\",\\\"target\\\":\\\"/search?user_id=123456789&domain=https%3A%2F%2Fexample.info%2F&domainId=654321&format=jsonv2&ip=101.0.0.101&lang=en-US%2Cen%3Bq%3D0.9&secure=true&ua=Mozilla%2F5.0+%28Windows+NT+10.0%3B+Win64%3B+x64%29+AppleWebKit%2F537.36+%28KHTML%2C+like+Gecko%29+Chrome%2F101.0.4951.67+Safari%2F537.36\\\",\\\"hdrs\\\":{\\\"Host\\\":\\\"www.example.com\\\",\\\"User-Agent\\\":\\\"Hydra v1.0\\\",\\\"Accept-Encoding\\\":\\\"gzip, deflate\\\"}},\\\"res\\\":{\\\"code\\\":200,\\\"hdrs\\\":{\\\"Date\\\":\\\"Mon, 23 May 2022 08:35:00 GMT\\\",\\\"Content-Type\\\":\\\"text/json;charset=UTF-8\\\",\\\"Transfer-Encoding\\\":\\\"chunked\\\",\\\"Connection\\\":\\\"keep-alive\\\",\\\"vary\\\":\\\"accept-encoding\\\",\\\"Content-Encoding\\\":\\\"gzip\\\"},\\\"body\\\":{\\\"title\\\":\\\"Example title\\\",\\\"token\\\":\\\"_lhJxadKQd7dwvldcnT1_um0mVkEZ6E7EfUr36A=.d9Qk9D1T4s26RrRsyMTOyQ==\\\",\\\"link\\\":\\\"https://example.com/c/3bc7d951-da73-11ec-81d4-12d1e567c9b5/2/ecaecdb0-d9f3-11e9-8d9d-0a97765f9322/{token}\\\",\\\"imp_url\\\":\\\"https://example.com/imp/3bc7d951-da73-11ec-81d4-12d1e567c9b5/2/ecaecdb0-d9f3-11e9-8d9d-0a97765f9322/{token}\\\",\\\"image_url\\\":\\\"https://example.com/imp/3bc7d951-da73-11ec-81d4-12d1e567c9b5/2/ecaecdb0-d9f3-11e9-8d9d-0a97765f9322/{token}\\\",\\\"description\\\":\\\"Example description.\\\",\\\"price\\\":0,\\\"cpc\\\":0.0068,\\\"ad_id\\\":\\\"fd320164-fe6c-43c3-9109f035a04c\\\"}}}"
}