List usage summary

GET

/v1/usage-summary

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

Authorization

Send a personal access token with every request.

Authorization: Bearer PAT

Authentication guide

Responses

Success

dataobjectrequired
- periodStartstringrequired
- periodEndstringrequired
- totalsByMeterCodeobjectrequired
- breakdownByProjectarray<UsageSummaryProjectBreakdownDto>
- breakdownByUserarray<UsageSummaryUserBreakdownDto>
- breakdownByTierarray<UsageSummaryTierBreakdownDto>

Response example

{
  "data": {
    "periodStart": "string",
    "periodEnd": "string",
    "totalsByMeterCode": {},
    "breakdownByProject": [
      {
        "projectId": "string",
        "projectName": "string",
        "meterCode": "string",
        "quantity": "string",
        "storageTier": "string"
      }
    ],
    "breakdownByUser": [
      {
        "userId": "string",
        "userDisplayName": "string",
        "meterCode": "string",
        "quantity": "string",
        "storageTier": "string"
      }
    ],
    "breakdownByTier": [
      {
        "storageTier": "string",
        "quantity": "string",
        "billable": false
      }
    ]
  }
}

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

{ "data": { "periodStart": "string", "periodEnd": "string", "totalsByMeterCode": {}, "breakdownByProject": [ { "projectId": "string", "projectName": "string", "meterCode": "string", "quantity": "string", "storageTier": "string" } ], "breakdownByUser": [ { "userId": "string", "userDisplayName": "string", "meterCode": "string", "quantity": "string", "storageTier": "string" } ], "breakdownByTier": [ { "storageTier": "string", "quantity": "string", "billable": false } ] } }