Agency RollupsPer-location contract coverage

Per-location contract coverage

One row per location: how many event contracts are declared, whether the daily contract-alert webhook is configured, and when the last alert fired. A location with zero contracts has no event-shape monitoring at all; one with contracts but no webhook finds out about breakage only when someone runs a check by hand.

curl -X GET "https://mythic-analytics.gulp.workers.dev/client/v1/agency/contracts/summary?location_ids=loc_abc123%2Cloc_def456" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
{
  "success": true,
  "data": [
    {
      "location_id": "loc_abc123",
      "name": "Acme Dental",
      "contracts_declared": 7,
      "alert_webhook_configured": true,
      "last_alert_at": "2024-12-25T10:00:00Z"
    }
  ]
}
GET
/client/v1/agency/contracts/summary
GET
Base URLstring

Target server for requests. Edit to use your own host.

Bearer Token
Bearer Tokenstring
Required

Agency key (ak_) only — a location secret key (sk_) gets 403 agency_required. Keys are server-side credentials; this surface serves no CORS headers on purpose. Agency-wide scoped keys (mcp_ with no fixed location) are accepted too and need agency:read; a client-bound mcp_ key gets 403 agency_key_required. See Using an mcp_ key over HTTP.

Agency key (ak_) only — a location secret key (sk_) gets 403 agency_required. Keys are server-side credentials; this surface serves no CORS headers on purpose. Agency-wide scoped keys (mcp_ with no fixed location) are accepted too and need agency:read; a client-bound mcp_ key gets 403 agency_key_required. See Using an mcp_ key over HTTP.
query
location_idsstring

Comma-separated location ids to narrow the roster. Every id must belong to this agency — a foreign id is 403 location_not_linked, never a silent empty result. Required in batches of up to 100 when the agency has more than 100 locations.

Request Preview
Response

Response will appear here after sending the request

Authentication

header
Authorizationstring
Required

Bearer token. Agency key (ak_) only — a location secret key (sk_) gets 403 agency_required. Keys are server-side credentials; this surface serves no CORS headers on purpose. Agency-wide scoped keys (mcp_ with no fixed location) are accepted too and need agency:read; a client-bound mcp_ key gets 403 agency_key_required. See Using an mcp_ key over HTTP.

Query Parameters

location_idsstring

Comma-separated location ids to narrow the roster. Every id must belong to this agency — a foreign id is 403 location_not_linked, never a silent empty result. Required in batches of up to 100 when the agency has more than 100 locations.

Example:
loc_abc123,loc_def456

Responses

successboolean
dataarray