Reporting API

Use this endpoint to get a report.

Request

End Point https://msp-platform.newsbreak.com/reporting

Method GET

Header

Field	Required	Data Type	Description
Content-Type	Y	string	Request message type Allowed format:application/json

Request Parameters

Field	Required	Data Type	Description
org_id	Y	integer	Organization id
app_id	Y	integer	App id
token	Y	string	api token
start_date	Y	string	Start date of the report.
end_date	Y	string	End date of the report.
timezone	N	enumerate	Supported timezone: "PST"/"EST"/"UTC"/"Beijing Time", default "UTC"
breakdown	N	list of string	Dimensions. "date"/"os"/seat"/"placement_id", none are selected by default
metrics	N	list of string	Metrics. "imp"/"revenue"/"ecpm"/"payout_revenue", default ["revenue", "imp", "ecpm"] are selected

Example

curl -X GET \
  'https://msp-platform.newsbreak.com/reporting' \
  -G \
  --data-urlencode 'org_id=111' \
  --data-urlencode 'app_id=2' \
  --data-urlencode 'token=123' \
  --data-urlencode 'start_date=2024-11-01' \
  --data-urlencode 'end_date=2024-12-18' \
  --data-urlencode 'timezone=Beijing Time' \
  --data-urlencode 'breakdown=date' \
  --data-urlencode 'breakdown=seat' \
  --data-urlencode 'metrics=revenue' \
  --data-urlencode 'metrics=ecpm' \
  -H 'accept: application/json'

Response

Response Parameters

Field	Data Type	Description
code	int	Status code, see Return Codes
errMsg	string	Error message when return code is not 0
list
date	string	Date
org_id	int	Organization ID
app_id	int	APP ID
os	string	Operating System
seat	string	Bidder
placement_name	string	Placement Name
imp	int	Impression count
revenue	float	Revenue in USD
payout_revenue	float	Publisher net Revenue in USD
ecpm	float	Gross ecpm

Example

[
      {
        "app_id": 2,
        "seat": "bidderA",
        "date": "2024-12-15",
        "ecpm": 110.0000,
        "org_id": 111,
        "revenue": 11
      },
      {
        "app_id": 2,
        "seat": "bidderA",
        "date": "2024-12-16",
        "ecpm": 135.1899,
        "org_id": 111,
        "revenue": 534
      },
      {
        "app_id": 2,
        "seat": "bidderA",
        "date": "2024-12-17",
        "ecpm": 136.0000,
        "org_id": 111,
        "revenue": 272
      },
      {
        "app_id": 2,
        "seat": "bidderB",
        "date": "2024-12-15",
        "ecpm": 115.0000,
        "org_id": 111,
        "revenue": 46
      }
]