v1

latestOpenAPI 3.0.02026-08-064311,0881.3 MB

accountManagement

Get report generation status.

Get the report download URL and status using Job Id.

get/v1/account/usage/report/{jobId}/status

Path parameters

jobIdstring required

Job Id for the report to be exported.

Response

Status response containing status and downloadURL if successful.

codestring required

An error code describing the type of error.

messagestring required

A short English-language description of the error.

detailstring

An optional fuller English-language description of the error.

metaobject

An optional list of metadata about the error.

statusstring

Status export

statusMessagestring

Status message export

reportDownloadURLstring

S3 presigned download URL for the report. It is valid for 10 minutes.

Example response

{
  "code": "auth:password_too_short",
  "message": "Your password was too short.",
  "detail": "Your password was 5 characters long, the minimum length is 12 characters. See http://example.com/password for more information.",
  "meta": {
    "minLength": 12,
    "actualLength": 5
  },
  "status": "Success",
  "statusMessage": "Successful request",
  "reportDownloadURL": "www.example.com"
}