A visual representation, for example, a bar chart or a pie chart, defined within a report. Although visual rendering is not exposed through the public API, chart definitions are available in the report structure.
The logical operation used in a field criterion to compare field values. Supported operators include:
EQ– equal toNOT_EQ– not equal toSTARTS_WITH– value begins with the specified stringIN– value is one of the specified valuesNOT_IN– value is not any of the specified values
A component of a report filter that scopes report execution to a specific time window. Supports two modes:
- Relative – Specify a named range such as
LAST_7_DAYSorLAST_30_DAYSusing therelativeRangefield. - Absolute – specify an explicit
startDateandendDateinYYYY-MM-DDformat. Both values must be supplied together.
When both a relative range and absolute dates are present in the same request, the relative range takes precedence.
A condition applied to a specific metadata field in the dataset. Each criterion specifies a name (the field identifier), an operator (the comparison to perform), and a values array (the values to compare against). Multiple field criteria can be combined in the fieldFilters array of a report filter.
A type of filter applied to a specific metadata field in the dataset, for example, service category or account ID.
A set of criteria used to limit the data in a report. Filters may include date ranges or field-based conditions.
A saved analytical configuration that defines how consumption data should be filtered, grouped, and aggregated. Reports can be retrieved and downloaded via the API.
The result of executing a report, returned as a downloadable CSV file. The structure depends on the report’s columns and filters.
The full structure of a report, including filters, selected columns, charts, and sharing settings.
A lightweight representation of a report, including its ID, name, and metadata. Used primarily when listing available reports.