apps.patrol docs

Ping

GET /v1/ping: check an ingest key and read current usage.

Check that an ingest key works and see which app and organization it belongs to. Call it once when your app starts, or from a health check.

Request

GET https://www.apps-patrol.com/v1/ping
Authorization: Bearer <ingest key>

Response

{
  "ok": true,
  "app": { "name": "Cart Holder", "public_id": "7c46d20f-1f89-46e5-aeb4-922c96c648f8" },
  "organization": { "name": "Acme Apps", "plan": "solo" },
  "usage": { "events_this_month": 1280, "events_limit": 250000 }
}
FieldMeaning
appThe app this key writes to.
organizationThe organization and its plan.
usage.events_this_monthEvents stored this calendar month (UTC) across the organization.
usage.events_limitThe plan's monthly allowance.

Errors

401 unauthorized for a missing, wrong or rotated key; 429 rate_limited when the per-minute limit is used. Ping counts toward the same rate limit as the other /v1 endpoints.

Example

curl -H "Authorization: Bearer $APPS_PATROL_KEY" https://www.apps-patrol.com/v1/ping