Retrieve usage report status

GET 
/reporting/usage_reports/:id

Retrieve the status of a usage report. Response includes a link to the report once it is generated.

Request

Path Parameters

id stringrequired

ID of Usage Report to retrieve

Responses

200: usage_report

application/json

• Schema
• Example (from schema)

Schema

id stringrequired
start_time stringrequired

UTC (2024-04-10T00:00:00+00:00)

end_time stringrequired

UTC (2024-04-10T12:09:59+00:00)

connections string[]required

Array of connection IDs

aggregation_type integerrequired

Default value: 0

Aggregate by: All = 0, By Connections = 1

status integerrequired

Default value: 1

Pending = 1, Complete = 2, Failed = 3, Expired = 4

report_url stringrequired

Link to report

result objectrequired

Report results

created_at stringrequired
updated_at stringrequired

{
  "id": "string",
  "start_time": "string",
  "end_time": "string",
  "connections": [
    "string"
  ],
  "aggregation_type": 0,
  "status": 1,
  "report_url": "string",
  "result": {},
  "created_at": "string",
  "updated_at": "string"
}

401: Unauthorized

404: Resource not found

Loading...