Connectivity API
API connectivity check
Returns the organization ID associated with the API key. Call it with a GET request to /ping, authenticated with a restricted API key.
Returns the organization ID associated with the API key. Use this to verify your API key and connectivity before sending events. Requests count toward your per-API-key rate limit; sustained overruns return 429 with the standard error envelope.
Authentication and scopes
Authenticate with a restricted API key in the Authorization: Bearer <key> header. No additional scope is required.
Response fields
Fields returned in the 200 response body. Nested objects are listed under their parent. A field marked optional may be absent from the body; one marked nullable is always present but its value may be null.
| Field | Type | Description |
|---|---|---|
ok | boolean | Always true when the request succeeds. |
organization_id | string | Organization ID associated with the API key. |
Error codes
Errors return the standard error envelope with a code, message, and a correlationId you can quote to support.
| Status | When it happens |
|---|---|
401 | Missing or invalid API key. Send your key as Authorization: Bearer YOUR_API_KEY. |
429 | Rate limit or plan quota exceeded. Slow down and retry after the current window resets. |
Rate limits and retries
Rate limit or plan quota exceeded. Slow down and retry after the current window resets.