Skip to main content
Access usage statistics and performance metrics for your tenant’s API usage.

Get Usage Statistics

string
Month in YYYY-MM format (e.g., “2024-01”). Defaults to current month.
boolean
true
string
Month in YYYY-MM format
number
Total API requests in the month
object
Requests broken down by endpoint path
object
Requests broken down by HTTP method (GET, POST, etc.)
number
Monthly API call limit from your plan (-1 for unlimited)
boolean
Whether the plan has unlimited API calls
number
Number of requests exceeding the plan limit
number
Percentage of limit exceeded

Example Request

Example Response

Get Usage History

integer
Number of months to retrieve (1-24, default: 12)
boolean
true
array
Array of usage objects, one per month

Example Request

Example Response

Get Performance Metrics

string
Month in YYYY-MM format (e.g., “2024-01”). Defaults to current month.
boolean
true
string
Month in YYYY-MM format
number
Average API response time in milliseconds
number
95th percentile response time in milliseconds
number
99th percentile response time in milliseconds
number
Percentage of requests that resulted in errors
number
Total requests in the month
number
Number of successful requests (2xx status codes)
number
Number of failed requests (4xx, 5xx status codes)

Example Request

Example Response

Required Permissions

  • read:analytics - Required for all analytics endpoints
Analytics data is aggregated monthly. Historical data is available for up to 24 months.