Skip to content
roasOS API
Esc
navigateopen⌘Jpreview

Summarize usage

GET/v1/account/usage/summary
Query parameters
fromstring<date-time>required
tostring<date-time>required
group_bystring
default: "day"
Allowed:dayapi_keymodelcapabilityprojectcost_center
Responses
200Completed consumption grouped by one bounded dimension
dataobjectrequired
Show properties
fromstring<date-time>required
tostring<date-time>required
group_bystringrequired
Allowed:dayapi_keymodelcapabilityprojectcost_center
rowsobject[]required
max items 1000
Show properties
Array of object
dimensionstringrequired
min length 1 · max length 160
consumed_creditsintegerrequired
min 0
job_countintegerrequired
min 0
Request
curl -X GET "https://api.roasos.com/v1/account/usage/summary?from=2024-01-01T00%3A00%3A00Z&to=2024-01-01T00%3A00%3A00Z"
Response
{
  "data": {
    "from": "2024-01-01T00:00:00Z",
    "to": "2024-01-01T00:00:00Z",
    "group_by": "day",
    "rows": [
      {
        "dimension": "string",
        "consumed_credits": 0,
        "job_count": 0
      }
    ]
  }
}