Generate a report

post

https://{hostname}/reporting-api/v1/reports/{name}/versions/{version}/report-data

Produces a report in either JSON or CSV format for a report type's version. In CSV data, values with commas or space characters are quoted. Query parameters specify the range of data and the aggregation interval for each record.

Path Params

version

integer

required

≥ 1

The version of the report type.

name

string

required

Identifies the type of report.

Query Params

start

string

required

Specifies the start of the reported period as an ISO 8601 date with timezone.

end

string

required

Specifies the end of the reported period as an ISO 8601 date with timezone. Any data that matches the end value's timestamp is excluded from the report.

interval

string

enum

required

Enum The duration of each data record, either FIVE_MINUTES, HOUR, DAY, WEEK, or MONTH. Support for specific interval values may vary by report type.

Allowed:

dataWrapNumberOfItems

integer

For reports that allow non-top values to cluster, this specifies the number of top values to report on separately.

dataWrapLabel

string

Label used as title for grouped record.

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

Specifies available metrics for the report type, filters to reduce the data, and a set of objects to report on.

filters

object

Specifies a set of custom filters, with each filter's name keying an array with each filter's set of values. The set of available filters depends on the type of report.

metrics

array of strings

length ≥ 0

The set of desired metrics. The set of available metrics depends on the type of report. If omitted, the report includes all available metrics.

metrics

objectIds

array of strings

required

length ≥ 0

Unique IDs for the given object type you want to report on.

objectIds*

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

URL

Loading…

Response

Choose an example:

application/json

text/csv

application/problem+json

200The response returns the report data.

400Bad request. Invalid report request.

401Unauthorized. Authentication has failed or hasn't been provided.

403Forbidden. Access is forbidden for requested object IDs.

404Not found. The requested object IDs couldn't be found.

405Method not allowed. The HTTP method used isn't supported for this operation.

406Not acceptable. The Accept header requests data in an unsupported format.

415Unsupported media type. The request's Content-Type header specifies data in unsupported format.