Get Organization API Metrics
Retrieves API request metrics including total requests, success rate, and time interval-based breakdowns.
Required Scope: read-platform-metrics
Request
- Base URL: https://api.hubble.com
- URL: https://api.hubble.com/v1/org/{org_id}/api_metrics
- Auth: HTTP bearer
Path parameters
The ID for an organization
Your organization ID
Query parameters
The number of days of metrics to include in the request.
The maximum value is further restricted when small time_interval values are used. The maximum number of total metric buckets is 365.
The time interval for the metric buckets. If not provided, a default value is selected based on the days parameter:
| days | time_interval |
|---|---|
| [1 => 1) | hour |
| [2 => 31] | day |
| [32 => 365] | month |
Partial buckets: The most recent bucket of metrics is a "partial" bucket depending on the interval - partial because it doesn't span a full time_interval yet. (e.g. 10:00pm -> 10:36pm for hour, June 3rd 12:00am -> June 3rd 10:36pm for day, June 1st 12:00am -> June 3rd 10:36pm for month). The older buckets are always "complete" buckets. (e.g. 09:00pm -> 10:00pm for hour, June 2nd 12:00am -> June 3rd 12:00am for day, May 1st 12:00am -> June 1st 12:00am for month).
Edge cases: If days is not large enough to include a full month bucket, days is increased in the backend. For example, querying days=90 with a month time_interval on June 13th, 2025 will return "complete" March, April, and May buckets and a "partial" June bucket. Similarly, when querying for days=7 with a day time_interval on June 13th, 2025 at 6:00am will return "complete" June 6th, 7th, 8th, 9th, 10th, 11th, and 12th buckets and a "partial" June 13th bucket.
Response
Successfully retrieved API metrics
Changes
No recorded changes to this operation across all 1 revision of this API.