REST API
Read reports, visitors, leads and funnels, and create short links from your own systems.
3 min readFor Developers
- 1Create a key under Workspace → API keys: choose the permissions and sites it may use and an expiry (30, 90 or 365 days, or none). The key is shown once; it starts with
exk_. - 2Send it in the
Authorizationheader. Your organization id and site ids are in the dashboard URL (/app/{orgSlug}/sites/{siteId}) and in the List sites call. - 3Read the full reference with request and response samples at
/docs/api.
curl https://YOUR-ELEXY-DOMAIN/api/v1/orgs/{orgId}/sites \
-H "Authorization: Bearer exk_…"
curl "https://YOUR-ELEXY-DOMAIN/api/v1/orgs/{orgId}/sites/{siteId}/analytics/overview?from=2026-09-01&to=2026-09-30" \
-H "Authorization: Bearer exk_…"- A key acts with its creator's access, narrowed to the permissions and sites you picked. Anything outside returns 404; a permission the key lacks returns 403.
- Limits: 300 requests per minute per key and 600 per minute per IP address (HTTP 429 with
Retry-After). - Dates are
from/toin the site's timezone (YYYY-MM-DD, up to 400 days); lists page withpageand returntotal. - Errors always look like
{ "error": { "code", "message", "details", "requestId" } }. Quote therequestIdwhen you contact support. - Machine-readable spec: OpenAPI 3.1 at
/api/v1/openapi.json.