Skip to main content
GET
/
v1
/
usage
/
summary
Get usage summary
curl --request GET \
  --url https://api.dynamosql.com/v1/usage/summary \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "data": {
    "tenantId": "tenant-abc123",
    "startDate": "2026-03-01",
    "endDate": "2026-03-31",
    "totals": {
      "requests": 4210,
      "rowsReturned": 1752000,
      "ddbReadUnits": 384900
    },
    "days": [
      {
        "day": "2026-03-01",
        "requests": 142,
        "rowsReturned": 58300,
        "ddbReadUnits": 12450
      },
      {
        "day": "2026-03-02",
        "requests": 198,
        "rowsReturned": 81200,
        "ddbReadUnits": 18700
      }
    ]
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.dynamosql.com/llms.txt

Use this file to discover all available pages before exploring further.

Required scope: usage:read

Authorizations

​
Authorization
string
header
required

Bearer token obtained from POST /v1/auth/token. Pass in the Authorization header as Bearer <token>.

Query Parameters

​
startDate
string
required

Start of the date range, inclusive. Format: YYYY-MM-DD. Must be a valid calendar date and must be on or before endDate.

​
endDate
string
required

End of the date range, inclusive. Format: YYYY-MM-DD. Must be a valid calendar date. Maximum range is 366 days from startDate.

Response

Usage summary for the requested date range.

​
success
boolean
required

true when the request was processed without errors, false otherwise. Always present.

​
data
object

Aggregated usage for the requested date range, broken down by day and summarized in totals.

​
error
object

Present in the response body when success is false.