API

Generate a report

post
https://{hostname}/reporting-api/v2/reports////data

Produces a report in either JSON or CSV format.

Path Params
string
required

The area of products.

string
required

The grouping of reports related to the same area.

string
required

An individual report name.

Query Params
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.

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.

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.

boolean
Defaults to false

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

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.

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
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated 4 months ago

Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
text/csv
*/*
application/problem+json

Updated 4 months ago