The following document provides information for our Publisher Reporting API.
Run SKAdNetwork Reports
Run a new report with the given parameters. The result will be a report id that can be used to query the status of the report and, eventually, get the results. See
Get Results
for more info.start
andend
are expected to be unix timestampstype
is optional, specifyingsummary
returns summary style results and leaving it blank will return row level data.format
is optional and defaults tocsv
, acceptable values arejson
andcsv
.
Endpoint:
POST:
https://adsmeasurement.com/v1/report/skad
Headers:
Authentication Key: api key
Content-Type: application/json
Request Body:
{
"start": 1603200000,
"end": 1603230270,
"type": "summary",
"format": "csv"
}
Response Body:
{
"report_id": "123456789"
}
Get SKAdNetwork Report Results
Query the results of the report. The results may not be available which will be indicated by
status
on the response. Reports expire after some time at which time this endpoint will return requested resource not found
.When the report is complete
links to download the files will be listed in files
. The links will be valid for aproximately a week.
Endpoint:
GET:
https://adsmeasurement.com/v1/report/skad/result?report_id=123456789
Header:
Authentication Key: 123456789
Response Body:
{
"status": "running"
}
Response Body:
{
"status": "failed",
"message": "no results found for 123456789"
}
Response Body:
{
"message": "requested resource not found"
}
Response Body:
{
"status": "complete",
"files": [
"<file1>",
"<file2>",
"...",
"<filen>"
]
}