Read company-wide API usage
/company/usagebilling:readRead company-wide API usage. Only explicitly granted sites and permissions are accessible. No credentials or raw worker payloads are returned. Requires explicitly delegated company-wide billing:read; business-unit-restricted integrations are rejected. No date filters or credit mutations are supported.
| Request | GET https://satelliteai.io/api/v1/company/usage |
| Permission | billing:read |
| Response | A list (cursor or offset paginated): data is array of CompanyApiUsage. |
| Operation ID | getCompanyApiUsage |
More context and worked examples are in the developer guide.
Example request
curl --fail-with-body \
'https://satelliteai.io/api/v1/company/usage' \
-H "Authorization: Bearer $SATELLITE_API_KEY"Replace the example IDs with values returned by the discovery endpoints. Example values are placeholders, not real records.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
limit | query | integer | Maximum records per page. Default 50, maximum 100. default 50 · min 1 · max 100 |
offset | query | integer | Zero-based row offset, default 0, maximum 100000. default 0 · min 0 · max 100000 |
Unknown or repeated query parameters return 400.
Data dictionary
Scoped result. Lists return pagination metadata; unavailable records return 404. Daily API request counters across this company’s integrations. latency_ms_total is the sum, not an average. Credit spending is in credit-transactions.
[] marks an array element. nullable means the value can be null; treat it as unknown, not zero. always present means the key is always included in the object.
| Field | Type | Description |
|---|---|---|
data[].id | integer | Id. |
data[].integration_id | integer | Integration id. |
data[].request_count | integer | Request count. |
data[].successes | integer | Successes. |
data[].errors | integer | Errors. |
data[].throttles | integer | Throttles. |
data[].response_bytes | integer | Response bytes. |
data[].latency_ms_total | integer | Latency ms total. |
data[].day | string (date) | |
data[].endpoint_family | string |
Response metadata
| Field | Type | Description |
|---|---|---|
meta.request_id | stringalways present | Request identifier; also returned in X-Request-ID. Include it in support requests. |
meta.api_version | stringalways present | API version that produced the response. one of: v1 |
meta.limit | integer | Applied page size; default 50, maximum 100. |
meta.has_more | boolean | Whether another page exists. |
meta.next_cursor | stringnullable | Opaque cursor for the next page; send as cursor. Null on the last page. |
meta.availability | string | available when stored data exists; not_available when it does not. one of: available, not_available |
meta.billing | object | Present for paid live SERP requests; replayed receipts describe the original debit, not an additional charge. |
meta.billing.operation | stringalways present | one of: client_api_serp_refresh |
meta.billing.credits_charged | integeralways present | min 0 |
meta.billing.transaction_id | integeralways present | |
meta.billing.replayed | booleanalways present | |
meta.offset | integer | Applied offset, maximum 100000. |
meta.next_offset | integernullable | Next offset, null at the end. |
Error responses
Errors return {"error": {"code", "message", "request_id"}}. See error handling for retry guidance.
| HTTP | When |
|---|---|
400 | Invalid parameters |
401 | Invalid credentials |
403 | Missing permission |
404 | Missing or inaccessible resource |