# SSP Report API

# Definition

Endpoint: https://ssp.svr-algorix.com/api/report/v2

Request Method: 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~~(deprecated), net_revenue, request, response, impression, fill_rate, render_rate, ~~ecpm~~(deprecated),net_ecpm, gross_revenue, gross_ecpm (`gross_revenue` and `gross_ecpm` are only available to specific types of publishers, please confirm with your account manager before integration.)	net_revenue
dimensions	array<string>	No	Dimensions of report	date,date_hour, app_bundle_id, ad_format, platform, country, placement_id, publisher_id, publisher_tagid (`placement_id`, `publisher_id` and `publisher_tagid` are only available to specific types of publishers, please confirm with your account manager before integration.)
start	timestamp	Yes	Start date,format YYYY-MM-DDThh:mm:ss.	-
end	timestamp	Yes	End date,format YYYY-MM-DDThh:mm:ss.	-
placement_id	array<string>	No	Placement ID	-
app_bundle_id	array<string>	No	Bundle ID	-
ad_format	array<integer>	No	Advertiser Format, 1 = Banner 2 = Native 3 = Video 4 = Rewarded Video	i.e.,1,2,3,4
platform	array<integer>	No	Platform, Refer to list Response Data Schema	e.g.0,1,2,3,4,5...
country	array<string>	No	Country code using ISO-3166-1-alpha-3	e.g.,CHN,USA...
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
app_bundle_id	string	Your bundle id
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
country	string	Country code using ISO-3166-1-alpha-3
placement_id	string	Your ad Placement ID
publisher_id	string	Your ad Publisher ID
date	date	Date,format YYYY-MM-DD
date_hour	timestamp	Date,format YYYY-MM-DDThh:mm:ss
net_revenue	float	Estimated net revenue
gross_revenue	float	Estimated gross 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
net_ecpm	float	Estimated-Net-Cost-Per-Mille
gross_ecpm	float	Estimated-Gross-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.
-5	the old account request start date must be after March 1st, 2020.

# Example

curl -H "x-userid: {YOUR_USERID}"  -H "x-authorization: {YOUR_AUTHORIZATION}" -H "Content-Type: application/json" \
-d '{"start":"2018-06-23T00:00:00","end": "2018-06-25T00:00:00","metrics": ["net_revenue","request","response","impression","fill_rate","render_rate","net_ecpm"],"dimensions": ["date"]}' \
-X POST "https://ssp.svr-algorix.com/api/report/v2"

1
2
3

{
  "status": {
    "code": 0,
    "msg": "success"
  },
  "timestamp": "Thu Dec 26 06:32:50 +0000 2019",
  "data": {
    "total": 2,
    "data": [
      {
        "date": "2018-06-23",
        "net_revenue": 16.34,
        "request": 24718416,
        "response": 43604,
        "impression": 26841,
        "fill_rate": 0.18,
        "render_rate": 61.56,
        "net_ecpm": 0.61
      },
      {
        "date": "2018-06-24",
        "net_revenue": 0.72,
        "request": 1029197,
        "response": 1385,
        "impression": 999,
        "fill_rate": 0.13,
        "render_rate": 72.13,
        "net_ecpm": 0.72
      }
    ]
  }
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32