Sign in

v1

latestOpenAPI 3.0.02026-08-064311,0881.3 MB
orgsManagement

Get usages for child orgs.

Get the credits usage details of the child orgs for a parent.

post/v1/organizations/usages

Request body

startDatestring

Start date, without the time, of the usage data to fetch.

endDatestring

End date, without the time, of usage data to fetch.

Example request

{
  "startDate": "2019-07-20",
  "endDate": "2019-10-20"
}

Response

Usage details for the child orgs.

Example response

{
  "data": [
    {
      "status": "Active",
      "orgName": "DSW Corp - Prod/Main",
      "orgId": "us2-00000000FF42A0C3",
      "allocatedCredits": 10000,
      "usages": {
        "totalCreditsUsed": 10000,
        "usagePercentage": 10000,
        "forecastPercentage": 10000,
        "usagePercentChangeWoW": 10000,
        "usagePercentChange": 10000
      }
    }
  ]
}