Generate a report

post

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

Produces a report in either JSON or CSV format.

Path Params

productFamily

string

required

The area of products.

reportingArea

string

required

The grouping of reports related to the same area.

report

string

required

An individual report name.

Query Params

start

date-time

Start date in ISO 8601 format. Use this parameter together with end, or else replace both with a fixed timeRange. Read more about setting the report time range.

end

date-time

End date in ISO 8601 format. Use this parameter together with start, or else replace both with a fixed timeRange. Read more about setting the report time range.

timeRange

string

enum

Enum Predefined time range, either LAST_15_MINUTES, LAST_30_MINUTES, LAST_1_HOUR, LAST_3_HOURS, LAST_6_HOURS, LAST_12_HOURS, LAST_1_DAY, LAST_2_DAYS, LAST_1_WEEK, LAST_30_DAYS, or LAST_90_DAYS. Use this as an alternative to a more flexible start and end time range. Support for specific time range values may vary by report type. See the report documentation under Available reports.

async

boolean

Defaults to false

Enables the asynchronous flow to get the data. By default, false.

pageSize

integer

Defaults to 50000

The size of a page in an async query. By default, the page size is the report's maximum number of returned data points, configured by the dataPointsLimit setting. If a report doesn't have this setting, the default value is 50000.

accountSwitchKey

string

For customers who manage more than one account, this runs the operation from another account. The Identity and Access Management API provides a list of available account switch keys.

Body Params

dimensions

array of strings

length ≥ 0

Dimensions to include in the report.

dimensions

filters

array

length ≥ 0

Filters to narrow down the report data. You can filter by metrics and dimensions. Support for specific filter types may vary by report type. See the report documentation under Available reports.

filters

limit

integer

≥ 0

Limits the number of records returned in the response.

metrics

array of strings

length ≥ 0

Metrics to include in the report.

metrics

sortBys

array of objects

length ≥ 0

Specifies metrics or dimensions for sorting the report data.

sortBys

Headers

string

enum

Defaults to application/json

Generated from available response content types

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

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.