Retidal
Overview
Retidal Management API 1.0.0
Section titled “Retidal Management API 1.0.0”The console/back-office surface for Retidal (engineering codename Trackly): configure projects, analytics, the event catalog, email (providers, templates, triggers, campaigns), automations, custom domains, users and more. Most routes authenticate with the console session cookie trackly_session and authorize by project role. A growing subset also accepts scoped API keys (X-API-Key); where supported, the required scope is stated on the operation.
Information
- OpenAPI version:
3.1.0
Operations
Section titled “Operations”GET
/api/accountPATCH
/api/account/profilePOST
/api/auth/loginPOST
/api/auth/logoutGET
/api/auth/mePATCH
/api/auth/localePOST
/api/projectsPATCH
/api/tenant/profileAuthentication
Section titled “Authentication”SessionCookie
Section titled “SessionCookie”Console session cookie established by the login flow.
Security scheme type: apiKey
Cookie parameter name: trackly_session
ApiKeyAuth
Section titled “ApiKeyAuth”Project API key. Accepted on two kinds of route only, and the operation always says which: (1) routes gated by a capability scope via requireProjectRoleOrApiScope — currently the metric-definitions endpoints, needing metrics:read / metrics:write; and (2) a small number of read-only project endpoints that accept the project’s own legacy API key with no scope. Every other Management route rejects API keys with 403 and requires the console session cookie.
Security scheme type: apiKey
Header parameter name: X-API-Key
WorkerToken
Section titled “WorkerToken”Internal worker-to-worker token. Not for customer use.
Security scheme type: apiKey
Header parameter name: x-worker-token