Sign in

v1

latestOpenAPI 3.0.02026-07-2496664456.3 KB
Report

Read report status.

Read the most recent report status. It will also show URLs containing report contents.

get/cm/v1/reports/{report_id}/status

Path parameters

report_idstring required

Report ID to read the status.

Response

A successful response.

status'UNKNOWN_REPORT_STATUS' | 'ACCEPTED' | 'READY' | 'FAILED'

Status enumerates the status of report.

  • ACCEPTED: Successfully initiated the report generation request.
  • READY: Successfully generated the report. It's ready to download from the location.
  • FAILED: Failed to generate the report. Reasons of failure can be found at errors.
location_jsonstring

URL of the report contents in JSON form. Will be expired in an hour.

location_csvstring

URL of the report contents in CSV form. Will be expired in an hour.

Example response

{
  "id": "anExistingReportId",
  "status": "READY",
  "location_json": "https://{WORKPLACE_REPORT_STORAGE}/reports/anExistingReportId.json?token={ONE_TIME_TOKEN}",
  "location_csv": "https://{WORKPLACE_REPORT_STORAGE}/reports/anExistingReportId.csv?token={ONE_TIME_TOKEN}"
}