Usage API
POST /api/usage/ingest
- Purpose: Ingest usage events from the edge/proxy layer.
- Auth:
X-Ingest-Keyshared secret. - Request shape: Usage payload (tenant, bytes, request metadata).
- Response shape:
{ ok: true }. - Key errors:
401/403invalid ingest key,400invalid payload. - Example:
POST /api/usage/ingestwith ingest key header.
GET /api/usage/check
- Purpose: Internal usage limit/status check.
- Auth:
X-Ingest-Keyshared secret. - Request shape: Query for tenant/period (as defined in handler).
- Response shape: Limit/check result.
- Key errors:
401/403,400. - Example:
GET /api/usage/check?....
GET /api/stats
- Purpose: Return aggregated public/platform stats overview.
- Auth: Public or internal read (depends on deployment policy).
- Request shape: Optional query filters.
- Response shape: Stats object.
- Key errors:
400. - Example:
GET /api/stats.
GET /api/demos/{provider}
- Purpose: Return demo payload for supported providers.
- Auth: Public read.
- Request shape: Path
{provider}. - Response shape: Demo data for requested provider.
- Key errors:
404provider not found,400invalid provider. - Example:
GET /api/demos/prismic.
✦
Need help understanding this?Ask CMS Assets Copilot about features, setup, or integrations.
Ask Copilot →