Get a cacheable report

get

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

Produce a report in either JSON or CSV format for a specific version of a type of report. While functionally identical to Generate a report, this alternative GET operation specifies all request data as query parameters.

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:

objectIds

string

As an alternative to allObjectIds, specifies the set of unique IDs for the given object type you want to report on, formatted as a comma-delimited list.

allObjectIds

boolean

As an alternative to objectIds, enabling this generates a report that includes all IDs available for the specified object type (each report supports only one specific object type). This parameter is ignored if the request also specifies a set of objectIds.

metrics

string

Specifies a comma-separated list of metrics to include in the report, otherwise all metrics if omitted. The set of available metrics depends on the type of report.

filters

string

Specifies criteria to filter the report's data. The set of available filters depends on the type of report. Separate each filter name and value with an equals (=) character, and separate various name/value pairs with commas (,). To specify more than one filter value, repeat the filter name. See the accompanying example for guidance. URL-encode the entire value in the GET request.

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.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

200Success.

400Invalid report request. Appropriate message is returned.

403Access is forbidden for requested object IDs.