Report-related JSON object structure

The API represents tenant service usage as JSON objects.

Report object structure

Name	Value type	Description
recipients	array of UUID strings	An array of UUIDs of the user accounts which should receive the report by email. Must be used only when result_action is set to send.
parameters	report parameters object	An object of report parameters which allow to configure the report.
schedule	report schedule object	An object that allows to configure scheduling of the report.
generation_date	string	ISO 8061 date when the report should be generated (only one-time reports).
result_action	string	Action to be done with the report. See report result actions for the list of available report result actions.

Report parameters object structure

Name	Value type	Description
tenant_id	UUID string	The UUID of the tenant that will be the subject of this report
level	string	Level of report detail. See report levels for the list of available report levels.
kind	string	Kind of report. See report kinds for the list of available report kinds.
formats	array of strings	Report formats. See report formats for the list of available report formats.
period	report period parameter object	An object that allows to set desired period of the report.
hide_zero_usage	boolean	Hide metrics with zero usage in report.
show_skus	boolean	Show SKU-related fields in report.

Report period parameter object structure

Name	Value type	Description
start	string	ISO 8061 date when the report starts.
end	string	ISO 8061 date when the report ends.

Report schedule object structure

Name	Value type	Description
enabled	boolean	Flag indicating whether the report is enabled (scheduled reports only).
type	string	Type of report schedule. See report scheduling types for the list of available report types.

Example report schedule object

{
    "recipients": [
        "ca451758-b48a-45d9-9ae6-8f1059f67619",
        "ab00e527-219b-481b-b01b-311b5be0ed3c"
    ],
    "parameters": {
        "kind": "usage_summary",
        "tenant_id": "2a91a14d-ffd3-4ac1-9b4d-3990162c5acc",
        "level": "accounts",
        "period": {
            "start": "2017-05-01",
            "end": "2017-05-07"
        },
        "formats": [
            "csv",
            "json_v1",
            "csv_v2_0",
            "json_v2_0"
        ]
    },
    "schedule": {
        "type": "once"
    },
    "generation_date": "2017-05-08",
    "result_action": "send"
}

Stored report object structure

Name	Value type	Description
id	UUID string	The UUID of the stored report.
created_at	string	ISO 8061 date when the stored report was generated.
size	number	Size of the compressed stored report in bytes.
status	string	Report generation status.
report_format	string	Stored report data format. See report formats for the list of available report formats.

Example stored report object

{
    "id": "af5946c3-7e5b-4480-8835-518efe1c3522",
    "created_at": "2019-08-08T07:36:57+00:00",
    "size": 3605,
    "status": "saved",
    "report_format": "csv"
}