Sign in

v1

latestOpenAPI 3.0.02026-08-064311,0881.3 MB
accountManagement

Export credits usage details as CSV.

Export the credit usage details as csv for the specific period of time given as input in the form of a start and end date with a specific grouping according to day, week, month, Note that this API will work only for credits plan customers.

post/v1/account/usage/report

Request body

startDatestring

Start date, without the time, of the usage data to fetch. If no value is provided startDate is used as the start of the subscription. The start date cannot be before the start of the subscription.

endDatestring

End date, without the time, of usage data to fetch. If no value is provided endDate is used as the end of the subscription. The end date cannot be after the end of the subscription.

groupBystring

Perform a groupBy operation on the usage details. If no value is provided data is grouped by Day - day: Aggregate the data by day - week: Aggregate the data by week. Week starts at Monday and ends at sunday night. - month: Aggregate the data by calendar month.

reportTypestring

Specifies the type of report to be exported. Available types are standard and detailed. An additional childDetailed type is available for Sumo Orgs parents. Detailed report will have raw consumption along with the credits breakdown. If no value is provided Standard reports will be exported.

includeDeploymentChargeboolean

Deployment charges will be applied to the returned usages csv if this is set to true and the organization is a part of Sumo Organizations as a child organization.

Example request

{
  "startDate": "2019-07-20",
  "endDate": "2019-08-20",
  "groupBy": "day",
  "reportType": "standard"
}

Response

Export Response with Job Id.

jobIdstring

Job Id for export

Example response

{
  "jobId": "12345678"
}