Usage for the current or previous UTC calendar month

GET

/v1/usage

curl -X GET 'https://api.embodiflow.io/v1/usage' \
  -H 'Authorization: Bearer $EMBODIFLOW_PAT'

Authorization

Send a personal access token with every request.

Authorization: Bearer PAT

Authentication guide

Query parameters

periodstring
Allowed values
current
previous
groupBystring
Allowed values
project
category

Responses

Success

dataobjectrequired
- periodstringrequired
  Allowed values
  current
  previous
- periodKeystringrequired
- periodStartstringrequired
- periodEndstringrequired
- groupBystringrequired
  Allowed values
  project
  category
- groupsarray<UsageAggregationGroupDto>required
- totalsobjectrequired

Response example

{
  "data": {
    "period": "current",
    "periodKey": "string",
    "periodStart": "string",
    "periodEnd": "string",
    "groupBy": "project",
    "groups": [
      {
        "projectId": "string",
        "projectName": "string",
        "category": "storage",
        "quantity": "string",
        "unit": "string",
        "meters": [
          {
            "meterCode": "string",
            "quantity": "string"
          }
        ]
      }
    ],
    "totals": {
      "storageGbMonth": {
        "quantity": "string",
        "metered": false
      },
      "processingMinutes": "string",
      "gpuHours": "string",
      "endpointHours": "string",
      "other": "string"
    }
  }
}

Servershttps://api.embodiflow.io/v1https://api.embodiflow.dev/v1

{ "data": { "period": "current", "periodKey": "string", "periodStart": "string", "periodEnd": "string", "groupBy": "project", "groups": [ { "projectId": "string", "projectName": "string", "category": "storage", "quantity": "string", "unit": "string", "meters": [ { "meterCode": "string", "quantity": "string" } ] } ], "totals": { "storageGbMonth": { "quantity": "string", "metered": false }, "processingMinutes": "string", "gpuHours": "string", "endpointHours": "string", "other": "string" } } }