Stream EstateStream Estate
AccountAPI Usage

Get billable API usage analytics

Returns billable API usage aggregates for the authenticated API customer.

GET
/account/api-usage

Query Parameters

startDate?string

Start date (ISO 8601). Defaults to last 30 days when omitted.

Formatdate-time
endDate?string

End date (ISO 8601). Defaults to now when omitted.

Formatdate-time
apiKeyId?string

Filter by API key public UUID owned by authenticated user.

Formatuuid
granularity?string

Time grouping granularity.

Default"day"
Value in"year" | "month" | "day"

Response Body

curl -X GET "https://api-v2.stream.estate/account/api-usage"
{
  "period": {
    "start": "string",
    "end": "string",
    "granularity": "string"
  },
  "totals": {
    "calls": 0,
    "results": 0
  },
  "timeSeries": [
    {
      "period": "string",
      "calls": 0,
      "results": 0
    }
  ],
  "byApiKey": [
    {
      "apiKeyUuid": "string",
      "apiKeyName": "string",
      "status": "string",
      "calls": 0,
      "results": 0
    }
  ],
  "byRoute": [
    {
      "route": "string",
      "routeType": "string",
      "calls": 0,
      "results": 0
    }
  ]
}
{
  "title": "string",
  "detail": "string",
  "status": 404,
  "instance": "string",
  "type": "string"
}
{
  "title": "string",
  "detail": "string",
  "status": 404,
  "instance": "string",
  "type": "string"
}