# Demand Report API

# Definition

Endpoint: https://buyer.svr-algorix.com/api/report/demand_report_v2

Request Method: GET | POST

Request Authorization: Please contact your account manager

Time zone: UTC

# Request

Name Type Required Description Available Values Default
metrics array<string> No Metrics of report revenue, request, response, impression, fill_rate, render_rate, ecpm revenue
dimensions array<string> No Dimensions of report date, date_hour, platform, ad_format
ad_format array<integer> No Advertiser Format,
1 = Banner
2 = Native
3 = Video
4 = Rewarded Video
i.e.,1,2,3,4
start timestamp Yes Start date,format YYYY-MM-DDThh:mm:ss. -
end timestamp Yes End date,format YYYY-MM-DDThh:mm:ss. -
limit integer No Maximum number of result set, defaults to 10,000 rows, max 50,000. - 10000

# Response

  • All of the requests will be responded with HTTP
  • Content-Type: application/json

# Response Schema

Attribute Type Description
timestamp string UTC time, which is used to indicate the time when the server responds to the current request.
status.code integer Server response status, when it is zero, indicates that the server responded correctly to the request. When it is not zero, you can find specific error messages in status.msg.
status.msg string Server response description.
data array or null Server response content.

# Response Data Schema

Attribute Type Description
ad_format integer Your ad Format
platform integer Platform,
0 = Unknow
1 = iOS
2 = Android
3 = Other(DEPRECATED)
4 = Linux
5 = MacOS
6 = Windows
11 = tvOS
12 = Roku
13 = Amazon
14 = Microsoft
15 = Samsung Smart TV
16 = LG Smart TV
17 = Sony Playstation
18 = Vizio
19 = Philips Smart TV
50 = Tizen
51 = KaiOS
date date Date,format YYYY-MM-DD
date_hour timestamp Date,format YYYY-MM-DDThh:mm:ss
revenue float Estimated revenue
request integer Request count
response integer Response count
impression integer Impress count
fill_rate float Estimated-Response-Per-Request
render_rate float Estimated-Impression-Per-Response
ecpm float Estimated-Cost-Per-Mille

# Status Schema

Error Code Error Message
0 success
-1 system error
-2 invalid params.
-3 token authorized failed.
-4 date range more than one month.

# Example

### GET
curl -X GET -g "https://buyer.svr-algorix.com/api/report/demand_report_v2?x-userid={YOUR_USERID}&x-authorization={YOUR_AUTHORIZATION}&start=2018-06-23T02:00:00&end=2018-06-24T02:00:00&metrics[]=revenue&metrics[]=request&metrics[]=response&metrics[]=impression&metrics[]=fill_rate&metrics[]=render_rate&metrics[]=ecpm&dimensions[]=date_hour&dimensions[]=platform&dimensions[]=ad_format&ad_format[]=1&ad_format[]=2&limit=1000"

### POST
curl -H "x-userid: {YOUR_USERID}"  -H "x-authorization: {YOUR_AUTHORIZATION}" -H "Content-Type: application/json" \
-d '{"start":"2018-06-23T02:00:00","end": "2018-06-24T02:00:00","metrics": ["revenue","request","response","impression","fill_rate","render_rate","ecpm"],"dimensions": ["date_hour","platform", "ad_format"],"ad_format": [1, 2],"limit": 1000}' \
-X POST "https://buyer.svr-algorix.com/api/report/demand_report_v2"
{
  "status": {
    "code": 0,
    "msg": "success"
  },
  "timestamp": "Thu Dec 06 08:00:20 +0000 2019",
  "data": {
    "total": 2,
    "data": [
      {
        "ad_format": 1,
        "platform": 1,
        "date": "2018-06-23",
        "revenue": 16.34,
        "request": 24718416,
        "response": 43604,
        "impression": 26841,
        "fill_rate": 0.18,
        "render_rate": 61.56,
        "ecpm": 0.61
      },
      {
        "ad_format": 1,
        "platform": 1,
        "date": "2018-06-24",
        "revenue": 0.72,
        "request": 1029197,
        "response": 1385,
        "impression": 999,
        "fill_rate": 0.13,
        "render_rate": 72.13,
        "ecpm": 0.72
      }
    ]
  }
}


Copyright © 2020 AlgoriX. All Rights Reserved