Skip to main content

Download an usage summary report

GET 
/platform/solutions/api/v1/reports/usage-jobs/{usageJobId}/summaries

This API downloads a usage summary report for a specified task identified by usageJobId.

You can provide a startTime and endTime in yyyy-MM-dd format to define the reporting period. The format parameter specifies the download file format, currently only json is supported.

Upon success, the API returns the report file as a downloadable JSON file named summary-report-{usageJobId}.json.

If the task does not exist or an error occurs during report generation, a 500 status code is returned with an error message.

Parameters

  • usageJobId: The ID of the task for which to download the report (required).
  • startTime: Start date of the report in yyyy-MM-dd format (required).
  • endTime: End date of the report in yyyy-MM-dd format (required).
  • format: File format for download, default is json.

Notes

  • Ensure the usageJobId is correct and the task exists.
  • The report includes data points for the specified period only.
  • Downloading a report does not modify or delete the task.

200 Response

  • Download file

500 Response

{
   message: start time after than end time error.
}

{
   message: wrong download file format type error.
}

Request​

Responses​

OK