Get API Call Statistics

GET 
/organizations/:organizationId/stats/api-calls

Get API call count per organization from CloudWatch Logs. Queries CloudWatch Logs Insights to count API requests for the organization. Results are cached for 1 hour to reduce CloudWatch Logs costs.

Request

Query Parameters

days string

Possible values: ["7", "30", "90"]

Default value: 30

Number of days to query (7, 30, or 90)

forceRefresh string

Possible values: ["true", "false"]

Force refresh cache (bypass 1-hour cache)

Responses

200

application/json

Schema

Schema

totalRequests numberrequired

Total number of API requests in the period

dailyAverage numberrequired

Average requests per day

topEndpoints object[]required
Top 10 most called endpoints
Array [
endpoint stringrequired
count numberrequired
]
cachedAt numberrequired

Unix timestamp when data was fetched

isCached booleanrequired

Whether the response was served from cache

queryDays numberrequired

Number of days queried

Example (from schema)

{
  "totalRequests": 0,
  "dailyAverage": 0,
  "topEndpoints": [
    {
      "endpoint": "string",
      "count": 0
    }
  ],
  "cachedAt": 0,
  "isCached": true,
  "queryDays": 0
}

Example

{}

401

The request has not permission.

application/json

Schema

Schema

error stringrequired

The request has not permission.

message stringrequired

The request has not permission message.

Example (from schema)

{
  "error": "string",
  "message": "string"
}

Example

{
  "error": "Unauthenticated",
  "message": "Authentication is required and has failed or has not yet been provided."
}

403

The request has not permission.

application/json

Schema

Schema

error stringrequired

The request has not permission.

message stringrequired

The request has not permission message.

Example (from schema)

{
  "error": "string",
  "message": "string"
}

Example

{
  "error": "Forbidden",
  "message": "Access to the requested resource is forbidden."
}

Loading...