Generate a report

post

https://{hostname}/reporting-api/v2/reports/{productFamily}/{reportingArea}/{report}/data

Path Params

productFamily

string

required

reportingArea

string

required

report

string

required

Query Params

start

date-time

end

date-time

timeRange

string

enum

async

boolean

Defaults to false

pageSize

integer

Defaults to 50000

accountSwitchKey

string

Body Params

dimensions

array of strings

length ≥ 0

dimensions

filters

array

length ≥ 0

filters

limit

integer

≥ 0

metrics

array of strings

length ≥ 0

metrics

sortBys

array of objects

length ≥ 0

sortBys

Headers

string

enum

Defaults to application/json

Allowed:

Responses

`Location` header provides a redirect link to get the results, which you can call after the number of seconds in the `Retry-After` header.

Language

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

text/csv

*/*

application/problem+json

200The request is processed. The response body contains the requested data.

303Results are delayed. The Location header provides a redirect link to get the results, which you can call after the number of seconds in the Retry-After header.

400The reporting data request is incorrect.

403You are unauthorized to make calls to the requested report.

404The requested resource doesn't exist.

422The request cannot be processed, since its cost exceeds the maximum request cost limit.

429Hit or cost based limits exceeded.

`Location` header provides a redirect link to get the results, which you can call after the number of seconds in the `Retry-After` header.