List report types

List all versions of all report types, optionally filtering out older deprecated versions.

Recipes
List report types
Open Recipe
Query Params
boolean
Defaults to true

Specifies if deprecated reports should be shown.

boolean
Defaults to true

Specifies if unavailable reports should be shown.

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.

Response

Response body
array of objects
object
boolean
required

When enabled, indicates the report can be executed by the current user.

integer
required

The number of days for which this report's data is available.

boolean
required

When enabled, indicates that this is an older version of the report.

filters
array of objects

The set of available filters available for this report.

filters
object
string

Provides documentation describing the available filter.

string

The name of the available filter.

boolean

When enabled, you need to specify this filter when executing the report.

string

The type of data this filter expects, either arbitrary int or string, or a fixed enum specified by values.

string int enum

values
array of objects

When the type of filter is enum, this lists available values.

values
object
string

Where necessary, provides documentation describing the enumerated value.

string
required

Specifies each enumerated string value.

string

Documentation that describes this report.

groupBy
array of strings

This indicates names of columns by which reported data is grouped. It's reflected in the generated report's metadata.

groupBy
groupOutlyingValues
object

Specifies this report's support for grouping outlying values under a single category.

intervals
array of strings
required

Specifies the set of available spans of time to aggregate data by. Use one of these values as the interval query parameter when executing the report.

intervals*
integer

The default number of data rows included for this report.

links
array of objects
integer

The maximum number of data rows permitted for this report.

metrics
array of objects

The set of available metrics available for this report.

metrics
object
string

Provides documentation describing the available metric.

string
required

The name of the available metric.

string
required

Specifies the name of the report.

string

The report type. Either HIERARCHICAL with two columns you can group data by, with the first being Time, or FLAT.

FLAT HIERARCHICAL

requiredProducts
array of strings

If specified, this lists any product you need to execute the report.

requiredProducts
requiredRoles
array of strings
required

Information about required role to run this report.

requiredRoles*
string
required

Whether this version of the report is PUBLISHED or DEPRECATED. Selecting DEPRECATED enables the deprecated JSON member.

PUBLISHED DEPRECATED

integer
required

The version of this report.

Language
Authentication
URL