{"info":{"title":"invisit","version":"0.0.0","description":"Authenticate with a dashboard session or `Authorization: Bearer invisit_sk_…`: an API key of one site, whose scopes (read, write, manage, ingest) bound what it may do. Errors share one envelope, `{ error: { code, message, request_id, details } }`; a validation failure lists `details.issues[{ path, code, message }]`. Lists page with `items`, `next_cursor` and `has_more`, with list-wide context under `meta`. GET responses carry an ETag; send it back in `If-None-Match` for a 304. API-key requests report `RateLimit-*` headers and, when refused, `Retry-After`. Instants are ISO-8601 UTC; ranges are half-open `[from, to)`."},"tags":[{"name":"Sites","description":"The sites you can reach, and their lifecycle."},{"name":"Analytics","description":"Traffic reports. Every report carries `meta`: window, freshness, accuracy."},{"name":"Revenue","description":"Revenue from a connected payment provider."},{"name":"Realtime","description":"Live visitors: a short-lived token, then a server-sent event stream."},{"name":"Heatmaps","description":"Click and scroll maps per page."},{"name":"Annotations","description":"Notes pinned to the timeline."},{"name":"Funnels","description":"Saved funnel definitions; run one under Analytics."},{"name":"Event definitions","description":"Named custom events and their no-code rules."},{"name":"Links","description":"Short links, their rules and social cards."},{"name":"Link domains","description":"Custom domains for short links."},{"name":"Feedback","description":"Messages visitors left through the feedback widget."},{"name":"Alerts","description":"Traffic alerts and where they are sent."},{"name":"Tracker","description":"The snippet and what the tracker collects."},{"name":"Ingest","description":"What the collector refused, and why."},{"name":"Exports","description":"A full export of a site."},{"name":"API keys","description":"Site API keys and their scopes."},{"name":"Public dashboard","description":"A site shared read-only at a public address."},{"name":"Workspaces","description":"Workspaces and the active one."},{"name":"Members","description":"Workspace members and their roles."},{"name":"Invitations","description":"Invitations into a workspace."},{"name":"Account","description":"Your own account."},{"name":"Auth","description":"Sign-in methods and sign-up."},{"name":"Revenue webhooks","description":"Payment providers call these; not for API clients."},{"name":"Billing","description":"The workspace's plan, usage and subscription."},{"name":"Health","description":"Liveness and dependency checks."},{"name":"Admin","description":"The install administrators’ console; not for API clients."}],"security":[{"session":[]},{"bearer":[]}],"components":{"securitySchemes":{"session":{"type":"apiKey","in":"cookie","name":"invisit_session"},"bearer":{"type":"http","scheme":"bearer"}},"schemas":{}},"openapi":"3.1.2","paths":{"/health":{"get":{"tags":["Health"],"operationId":"getHealth","summary":"Service health and the state of each dependency; 503 when one is unavailable","security":[],"responses":{"200":{"description":"Response for status 200","content":{"application/json":{"schema":{"type":"object","required":["status","service","version","commit","environment","time","dependencies"],"properties":{"status":{"enum":["ok","degraded","unavailable"]},"service":{"type":"string","minLength":1},"version":{"type":"string","minLength":1},"commit":{"type":"string","minLength":1},"environment":{"type":"string","minLength":1},"time":{"type":"string","format":"date-time","pattern":"Z$"},"dependencies":{"type":"array","items":{"type":"object","required":["name","status","detail"],"properties":{"name":{"type":"string","minLength":1},"status":{"enum":["ok","degraded","unavailable"]},"detail":{"type":["string","null"]}}}}}}}}},"503":{"description":"Response for status 503","content":{"application/json":{"schema":{"type":"object","required":["status","service","version","commit","environment","time","dependencies"],"properties":{"status":{"enum":["ok","degraded","unavailable"]},"service":{"type":"string","minLength":1},"version":{"type":"string","minLength":1},"commit":{"type":"string","minLength":1},"environment":{"type":"string","minLength":1},"time":{"type":"string","format":"date-time","pattern":"Z$"},"dependencies":{"type":"array","items":{"type":"object","required":["name","status","detail"],"properties":{"name":{"type":"string","minLength":1},"status":{"enum":["ok","degraded","unavailable"]},"detail":{"type":["string","null"]}}}}}}}}}}}},"/v1/realtime/stream":{"get":{"tags":["Realtime"],"operationId":"streamRealtime","summary":"Stream realtime snapshot and control events over Server-Sent Events","description":"Authenticate with a realtime token from a realtime/token endpoint as a Bearer header; tokens in the query string are refused. Send Last-Event-ID to resume.","security":[{"bearer":[]}],"responses":{"200":{"description":"`snapshot` and `control` events, plus keepalive comments","content":{"text/event-stream":{"schema":{"type":"string"}}}},"401":{"description":"The realtime token is missing, invalid, expired or revoked","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"500":{"description":"Internal error","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}}}}},"/v1/auth/providers":{"get":{"tags":["Auth"],"operationId":"listAuthProviders","summary":"List the sign-in methods","security":[],"responses":{"200":{"description":"Response for status 200","content":{"application/json":{"schema":{"type":"object","required":["items","password_reset","turnstile_site_key"],"properties":{"items":{"type":"array","items":{"type":"object","required":["id","kind"],"properties":{"id":{"type":"string"},"kind":{"enum":["password","oauth"]}}}},"password_reset":{"type":"boolean"},"turnstile_site_key":{"type":["string","null"]}}}}}},"400":{"description":"Response for status 400","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"401":{"description":"Response for status 401","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"402":{"description":"Response for status 402","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"403":{"description":"Response for status 403","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"404":{"description":"Response for status 404","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"409":{"description":"Response for status 409","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"429":{"description":"Response for status 429","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"500":{"description":"Response for status 500","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"503":{"description":"Response for status 503","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}}}}},"/v1/auth/sign-up":{"post":{"tags":["Auth"],"operationId":"signUp","summary":"Create an account and mail its confirmation link","description":"Nothing signs in yet: the link signs the account in once followed. Signing up again with an address that was never confirmed replaces that attempt.","security":[],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["email","password"],"properties":{"email":{"type":"string"},"password":{"type":"string","description":"8 to 128 characters"},"name":{"type":"string","description":"Defaults to the email's local part"},"timezone":{"type":"string","description":"An IANA time zone, e.g. Europe/Istanbul"},"turnstile_token":{"type":"string","maxLength":2048,"description":"Cloud sign-up: the Cloudflare Turnstile token, when the deployment asks for one"},"return_to":{"type":"string","maxLength":4096,"description":"Cloud sign-up: the sign-in page with the query it was opened with (an OAuth client authorization in progress), where the confirmation link should land instead of '/auth'"}}}}},"required":true},"responses":{"200":{"description":"Response for status 200","content":{"application/json":{"schema":{"type":"object","required":["status","email"],"properties":{"status":{"type":"string","const":"verification_sent"},"email":{"type":"string"}}}}}},"400":{"description":"Response for status 400","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"401":{"description":"Response for status 401","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"402":{"description":"Response for status 402","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"403":{"description":"Response for status 403","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"404":{"description":"Response for status 404","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"409":{"description":"Response for status 409","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"429":{"description":"Response for status 429","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"500":{"description":"Response for status 500","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"503":{"description":"Response for status 503","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}}}}},"/v1/invitations/{invitation_id}":{"get":{"tags":["Invitations"],"operationId":"previewInvitation","summary":"Show what an invitation link is for","description":"The link itself is the credential; no session is needed.","security":[],"parameters":[{"name":"invitation_id","in":"path","required":true,"schema":{"type":"string","description":"The invitation id"}}],"responses":{"200":{"description":"Response for status 200","content":{"application/json":{"schema":{"type":"object","required":["invitation_id","email","role","status","expires_at","workspace_name","inviter_name","account_exists"],"properties":{"invitation_id":{"type":"string"},"email":{"type":"string"},"role":{"enum":["viewer","member","owner"]},"status":{"enum":["pending","expired","canceled","accepted"]},"expires_at":{"type":"string","format":"date-time","pattern":"Z$"},"workspace_name":{"type":"string"},"inviter_name":{"type":["string","null"]},"account_exists":{"type":"boolean"}}}}}},"400":{"description":"Response for status 400","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"401":{"description":"Response for status 401","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"402":{"description":"Response for status 402","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"403":{"description":"Response for status 403","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"404":{"description":"Response for status 404","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"409":{"description":"Response for status 409","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"429":{"description":"Response for status 429","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"500":{"description":"Response for status 500","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"503":{"description":"Response for status 503","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}}}}},"/v1/invitations/{invitation_id}/sign-up":{"post":{"tags":["Invitations"],"operationId":"signUpWithInvitation","summary":"Create an account for the invited address and mail its confirmation link","description":"The link is mailed; following it lands on the invitation signed in, ready to accept.","security":[],"parameters":[{"name":"invitation_id","in":"path","required":true,"schema":{"type":"string","description":"The invitation id"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["password"],"properties":{"name":{"type":"string","description":"Defaults to the email's local part"},"password":{"type":"string","description":"8 to 128 characters"},"timezone":{"type":"string","description":"An IANA time zone, e.g. Europe/Istanbul"}}}}},"required":true},"responses":{"200":{"description":"Response for status 200","content":{"application/json":{"schema":{"type":"object","required":["status","email"],"properties":{"status":{"type":"string","const":"verification_sent"},"email":{"type":"string"}}}}}},"400":{"description":"Response for status 400","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"401":{"description":"Response for status 401","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"402":{"description":"Response for status 402","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"403":{"description":"Response for status 403","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"404":{"description":"Response for status 404","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"409":{"description":"Response for status 409","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"429":{"description":"Response for status 429","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"500":{"description":"Response for status 500","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"503":{"description":"Response for status 503","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}}}}},"/v1/billing/polar/webhook":{"post":{"tags":["Billing"],"operationId":"receiveBillingWebhook","summary":"Receive a signed subscription event from invisit's payment provider","description":"Called by Polar, not by users. The raw body is verified against its signature.","security":[],"responses":{"200":{"description":"Response for status 200","content":{"application/json":{"schema":{"type":"object","required":["received"],"properties":{"received":{"type":"boolean"}}}}}},"400":{"description":"Response for status 400","content":{"application/json":{"schema":{"type":"object","required":["received"],"properties":{"received":{"type":"boolean"}}}}}},"413":{"description":"Response for status 413","content":{"application/json":{"schema":{"type":"object","required":["received"],"properties":{"received":{"type":"boolean"}}}}}},"500":{"description":"Response for status 500","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"503":{"description":"Response for status 503","content":{"application/json":{"schema":{"type":"object","required":["received"],"properties":{"received":{"type":"boolean"}}}}}}}}},"/v1/revenue/webhooks/{provider}/{webhook_token}":{"post":{"tags":["Revenue webhooks"],"operationId":"receiveRevenueWebhook","summary":"Receive a signed event delivery from a payment provider","description":"Called by the payment provider, not by users. The raw body is verified against the provider signature.","security":[],"parameters":[{"name":"provider","in":"path","required":true,"schema":{"type":"string","description":"The provider id the endpoint was issued for"}},{"name":"webhook_token","in":"path","required":true,"schema":{"type":"string","description":"The opaque token in the connection webhook URL"}}],"responses":{"200":{"description":"Response for status 200","content":{"application/json":{"schema":{"type":"object","required":["received"],"properties":{"received":{"type":"boolean"}}}}}},"400":{"description":"Response for status 400","content":{"application/json":{"schema":{"type":"object","required":["received"],"properties":{"received":{"type":"boolean"}}}}}},"404":{"description":"Response for status 404","content":{"application/json":{"schema":{"type":"object","required":["received"],"properties":{"received":{"type":"boolean"}}}}}},"413":{"description":"Response for status 413","content":{"application/json":{"schema":{"type":"object","required":["received"],"properties":{"received":{"type":"boolean"}}}}}},"500":{"description":"Response for status 500","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"503":{"description":"Response for status 503","content":{"application/json":{"schema":{"type":"object","required":["received"],"properties":{"received":{"type":"boolean"}}}}}}}}},"/v1/public/{share_slug}/unlock":{"post":{"tags":["Public dashboard"],"operationId":"unlockPublicDashboard","summary":"Trade a shared dashboard’s password for a key","security":[],"parameters":[{"name":"share_slug","in":"path","required":true,"schema":{"type":"string","description":"The public dashboard share slug"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["password"],"properties":{"password":{"type":"string","minLength":1,"maxLength":128}}}}},"required":true},"responses":{"200":{"description":"Response for status 200","content":{"application/json":{"schema":{"type":"object","required":["token","expires_at"],"properties":{"token":{"type":"string","description":"Sent back in the x-invisit-share-key header"},"expires_at":{"type":"string","format":"date-time","pattern":"Z$"}}}}}},"400":{"description":"Response for status 400","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"401":{"description":"Response for status 401","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"402":{"description":"Response for status 402","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"403":{"description":"Response for status 403","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"404":{"description":"Response for status 404","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"409":{"description":"Response for status 409","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"429":{"description":"Response for status 429","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"500":{"description":"Response for status 500","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"503":{"description":"Response for status 503","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}}}}},"/v1/public/{share_slug}/site":{"get":{"tags":["Public dashboard"],"operationId":"getPublicSite","summary":"What a shared dashboard shows and how it introduces itself","security":[],"parameters":[{"name":"share_slug","in":"path","required":true,"schema":{"type":"string","description":"The public dashboard share slug"}}],"responses":{"200":{"description":"Response for status 200","content":{"application/json":{"schema":{"type":"object","required":["show_hostname","first_event_at","shares","allow_embed","watermark"],"properties":{"show_hostname":{"enum":["auto","always","never"]},"display_name":{"type":"string"},"favicon_domain":{"type":["string","null"]},"first_event_at":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"shares":{"type":"object","required":["pages","realtime","revenue"],"properties":{"pages":{"type":"boolean"},"realtime":{"type":"boolean"},"revenue":{"type":"boolean"}}},"allow_embed":{"type":"boolean"},"watermark":{"type":"boolean"}}}}}},"304":{"description":"Not modified"},"400":{"description":"Response for status 400","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"401":{"description":"Response for status 401","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"402":{"description":"Response for status 402","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"403":{"description":"Response for status 403","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"404":{"description":"Response for status 404","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"409":{"description":"Response for status 409","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"429":{"description":"Response for status 429","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"500":{"description":"Response for status 500","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"503":{"description":"Response for status 503","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}}}}},"/v1/public/{share_slug}/overview":{"get":{"tags":["Public dashboard"],"operationId":"getPublicOverview","summary":"Headline totals of a shared dashboard","security":[],"parameters":[{"name":"share_slug","in":"path","required":true,"schema":{"type":"string","description":"The public dashboard share slug"}},{"name":"from","in":"query","required":true,"schema":{"type":"string","format":"date-time","pattern":"Z$"}},{"name":"to","in":"query","required":true,"schema":{"type":"string","format":"date-time","pattern":"Z$"}},{"name":"timezone","in":"query","required":false,"schema":{"type":"string","description":"An IANA time zone; defaults to the site owner's"}},{"name":"compare","in":"query","required":false,"schema":{"enum":["true","false"],"description":"Also report the preceding period of equal length"}},{"name":"resolution","in":"query","required":false,"schema":{"enum":["hour","day"]}}],"responses":{"200":{"description":"Response for status 200","content":{"application/json":{"schema":{"type":"object","required":["meta","totals","comparison"],"properties":{"meta":{"type":"object","required":["requested_range","effective_range","timezone","resolution","data_sources","accuracy","comparison_range","truncated","cached","partial","freshness"],"properties":{"requested_range":{"type":"object","required":["from","to"],"properties":{"from":{"type":"string","format":"date-time","pattern":"Z$"},"to":{"type":"string","format":"date-time","pattern":"Z$"}}},"effective_range":{"type":"object","required":["from","to"],"properties":{"from":{"type":"string","format":"date-time","pattern":"Z$"},"to":{"type":"string","format":"date-time","pattern":"Z$"}}},"timezone":{"type":"string","description":"An IANA time zone, e.g. Europe/Istanbul"},"resolution":{"enum":["minute","hour","day","week"]},"data_sources":{"type":"array","items":{"type":"string","const":"live"}},"accuracy":{"enum":["exact","estimated","provider_defined"]},"comparison_range":{"type":["object","null"],"required":["from","to"],"properties":{"from":{"type":"string","format":"date-time","pattern":"Z$"},"to":{"type":"string","format":"date-time","pattern":"Z$"}}},"truncated":{"type":"boolean","description":"The store capped the rows; the report is incomplete"},"cached":{"type":"boolean"},"partial":{"type":"boolean"},"freshness":{"type":"object","required":["state","watermark","as_of"],"properties":{"state":{"enum":["ok","no_data","stale","degraded"]},"watermark":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"as_of":{"type":"string","format":"date-time","pattern":"Z$"}}},"revenue":{"type":"object","required":["provider","connection_status","last_synced_at","last_webhook_at","rollup_through"],"properties":{"provider":{"type":["string","null"]},"connection_status":{"enum":["connected","degraded","disconnected","not_connected"]},"last_synced_at":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"last_webhook_at":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"rollup_through":{"type":["string","null"],"format":"date-time","pattern":"Z$"}}}}},"totals":{"type":"object","required":["events","pageviews","visits"],"properties":{"events":{"type":"number"},"pageviews":{"type":"number"},"visits":{"type":"number"}}},"comparison":{"type":["object","null"],"required":["totals"],"properties":{"totals":{"type":"object","required":["events","pageviews","visits"],"properties":{"events":{"type":"number"},"pageviews":{"type":"number"},"visits":{"type":"number"}}}}}}}}}},"304":{"description":"Not modified"},"400":{"description":"Response for status 400","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"401":{"description":"Response for status 401","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"402":{"description":"Response for status 402","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"403":{"description":"Response for status 403","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"404":{"description":"Response for status 404","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"409":{"description":"Response for status 409","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"429":{"description":"Response for status 429","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"500":{"description":"Response for status 500","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"503":{"description":"Response for status 503","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}}}}},"/v1/public/{share_slug}/timeseries":{"get":{"tags":["Public dashboard"],"operationId":"getPublicTimeseries","summary":"Traffic over time of a shared dashboard","security":[],"parameters":[{"name":"share_slug","in":"path","required":true,"schema":{"type":"string","description":"The public dashboard share slug"}},{"name":"from","in":"query","required":true,"schema":{"type":"string","format":"date-time","pattern":"Z$"}},{"name":"to","in":"query","required":true,"schema":{"type":"string","format":"date-time","pattern":"Z$"}},{"name":"timezone","in":"query","required":false,"schema":{"type":"string","description":"An IANA time zone; defaults to the site owner's"}},{"name":"compare","in":"query","required":false,"schema":{"enum":["true","false"],"description":"Also report the preceding period of equal length"}},{"name":"resolution","in":"query","required":false,"schema":{"enum":["minute","hour","day","week"]}}],"responses":{"200":{"description":"Response for status 200","content":{"application/json":{"schema":{"type":"object","required":["meta","series","comparison"],"properties":{"meta":{"type":"object","required":["requested_range","effective_range","timezone","resolution","data_sources","accuracy","comparison_range","truncated","cached","partial","freshness"],"properties":{"requested_range":{"type":"object","required":["from","to"],"properties":{"from":{"type":"string","format":"date-time","pattern":"Z$"},"to":{"type":"string","format":"date-time","pattern":"Z$"}}},"effective_range":{"type":"object","required":["from","to"],"properties":{"from":{"type":"string","format":"date-time","pattern":"Z$"},"to":{"type":"string","format":"date-time","pattern":"Z$"}}},"timezone":{"type":"string","description":"An IANA time zone, e.g. Europe/Istanbul"},"resolution":{"enum":["minute","hour","day","week"]},"data_sources":{"type":"array","items":{"type":"string","const":"live"}},"accuracy":{"enum":["exact","estimated","provider_defined"]},"comparison_range":{"type":["object","null"],"required":["from","to"],"properties":{"from":{"type":"string","format":"date-time","pattern":"Z$"},"to":{"type":"string","format":"date-time","pattern":"Z$"}}},"truncated":{"type":"boolean","description":"The store capped the rows; the report is incomplete"},"cached":{"type":"boolean"},"partial":{"type":"boolean"},"freshness":{"type":"object","required":["state","watermark","as_of"],"properties":{"state":{"enum":["ok","no_data","stale","degraded"]},"watermark":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"as_of":{"type":"string","format":"date-time","pattern":"Z$"}}},"revenue":{"type":"object","required":["provider","connection_status","last_synced_at","last_webhook_at","rollup_through"],"properties":{"provider":{"type":["string","null"]},"connection_status":{"enum":["connected","degraded","disconnected","not_connected"]},"last_synced_at":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"last_webhook_at":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"rollup_through":{"type":["string","null"],"format":"date-time","pattern":"Z$"}}}}},"series":{"type":"array","items":{"type":"object","required":["bucket","events","pageviews","visits"],"properties":{"bucket":{"type":"string","format":"date-time","pattern":"Z$"},"events":{"type":"number"},"pageviews":{"type":"number"},"visits":{"type":"number"}}}},"comparison":{"type":["object","null"],"required":["series"],"properties":{"series":{"type":"array","items":{"type":"object","required":["bucket","events","pageviews","visits"],"properties":{"bucket":{"type":"string","format":"date-time","pattern":"Z$"},"events":{"type":"number"},"pageviews":{"type":"number"},"visits":{"type":"number"}}}}}}}}}}},"304":{"description":"Not modified"},"400":{"description":"Response for status 400","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"401":{"description":"Response for status 401","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"402":{"description":"Response for status 402","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"403":{"description":"Response for status 403","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"404":{"description":"Response for status 404","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"409":{"description":"Response for status 409","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"429":{"description":"Response for status 429","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"500":{"description":"Response for status 500","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"503":{"description":"Response for status 503","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}}}}},"/v1/public/{share_slug}/referrer-highlights":{"get":{"tags":["Public dashboard"],"operationId":"listPublicReferrerHighlights","summary":"Referrers that dominated a time bucket","security":[],"parameters":[{"name":"share_slug","in":"path","required":true,"schema":{"type":"string","description":"The public dashboard share slug"}},{"name":"from","in":"query","required":true,"schema":{"type":"string","format":"date-time","pattern":"Z$"}},{"name":"to","in":"query","required":true,"schema":{"type":"string","format":"date-time","pattern":"Z$"}},{"name":"timezone","in":"query","required":false,"schema":{"type":"string","description":"An IANA time zone; defaults to the site owner's"}},{"name":"resolution","in":"query","required":false,"schema":{"enum":["minute","hour","day","week"]}}],"responses":{"200":{"description":"Response for status 200","content":{"application/json":{"schema":{"type":"object","required":["meta","suppressed","items"],"properties":{"meta":{"type":"object","required":["requested_range","effective_range","timezone","resolution","data_sources","accuracy","comparison_range","truncated","cached","partial","freshness"],"properties":{"requested_range":{"type":"object","required":["from","to"],"properties":{"from":{"type":"string","format":"date-time","pattern":"Z$"},"to":{"type":"string","format":"date-time","pattern":"Z$"}}},"effective_range":{"type":"object","required":["from","to"],"properties":{"from":{"type":"string","format":"date-time","pattern":"Z$"},"to":{"type":"string","format":"date-time","pattern":"Z$"}}},"timezone":{"type":"string","description":"An IANA time zone, e.g. Europe/Istanbul"},"resolution":{"enum":["minute","hour","day","week"]},"data_sources":{"type":"array","items":{"type":"string","const":"live"}},"accuracy":{"enum":["exact","estimated","provider_defined"]},"comparison_range":{"type":["object","null"],"required":["from","to"],"properties":{"from":{"type":"string","format":"date-time","pattern":"Z$"},"to":{"type":"string","format":"date-time","pattern":"Z$"}}},"truncated":{"type":"boolean","description":"The store capped the rows; the report is incomplete"},"cached":{"type":"boolean"},"partial":{"type":"boolean"},"freshness":{"type":"object","required":["state","watermark","as_of"],"properties":{"state":{"enum":["ok","no_data","stale","degraded"]},"watermark":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"as_of":{"type":"string","format":"date-time","pattern":"Z$"}}},"revenue":{"type":"object","required":["provider","connection_status","last_synced_at","last_webhook_at","rollup_through"],"properties":{"provider":{"type":["string","null"]},"connection_status":{"enum":["connected","degraded","disconnected","not_connected"]},"last_synced_at":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"last_webhook_at":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"rollup_through":{"type":["string","null"],"format":"date-time","pattern":"Z$"}}}}},"suppressed":{"anyOf":[{"enum":["filtered","grain"]},{"type":"null"}]},"items":{"type":"array","items":{"type":"object","required":["bucket_start","referrer_domain","visits","bucket_visits","share_pct"],"properties":{"bucket_start":{"type":"string","format":"date-time","pattern":"Z$"},"referrer_domain":{"type":"string"},"visits":{"type":"number"},"bucket_visits":{"type":"number"},"share_pct":{"type":"number"}}}}}}}}},"304":{"description":"Not modified"},"400":{"description":"Response for status 400","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"401":{"description":"Response for status 401","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"402":{"description":"Response for status 402","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"403":{"description":"Response for status 403","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"404":{"description":"Response for status 404","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"409":{"description":"Response for status 409","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"429":{"description":"Response for status 429","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"500":{"description":"Response for status 500","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"503":{"description":"Response for status 503","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}}}}},"/v1/public/{share_slug}/sessions":{"get":{"tags":["Public dashboard"],"operationId":"getPublicSessions","summary":"Visit engagement metrics of a shared dashboard","security":[],"parameters":[{"name":"share_slug","in":"path","required":true,"schema":{"type":"string","description":"The public dashboard share slug"}},{"name":"from","in":"query","required":true,"schema":{"type":"string","format":"date-time","pattern":"Z$"}},{"name":"to","in":"query","required":true,"schema":{"type":"string","format":"date-time","pattern":"Z$"}},{"name":"timezone","in":"query","required":false,"schema":{"type":"string","description":"An IANA time zone; defaults to the site owner's"}},{"name":"compare","in":"query","required":false,"schema":{"enum":["true","false"],"description":"Also report the preceding period of equal length"}}],"responses":{"200":{"description":"Response for status 200","content":{"application/json":{"schema":{"type":"object","required":["meta","layering","totals","series","comparison"],"properties":{"meta":{"type":"object","required":["requested_range","effective_range","timezone","resolution","data_sources","accuracy","comparison_range","truncated","cached","partial","freshness"],"properties":{"requested_range":{"type":"object","required":["from","to"],"properties":{"from":{"type":"string","format":"date-time","pattern":"Z$"},"to":{"type":"string","format":"date-time","pattern":"Z$"}}},"effective_range":{"type":"object","required":["from","to"],"properties":{"from":{"type":"string","format":"date-time","pattern":"Z$"},"to":{"type":"string","format":"date-time","pattern":"Z$"}}},"timezone":{"type":"string","description":"An IANA time zone, e.g. Europe/Istanbul"},"resolution":{"enum":["minute","hour","day","week"]},"data_sources":{"type":"array","items":{"type":"string","const":"live"}},"accuracy":{"enum":["exact","estimated","provider_defined"]},"comparison_range":{"type":["object","null"],"required":["from","to"],"properties":{"from":{"type":"string","format":"date-time","pattern":"Z$"},"to":{"type":"string","format":"date-time","pattern":"Z$"}}},"truncated":{"type":"boolean","description":"The store capped the rows; the report is incomplete"},"cached":{"type":"boolean"},"partial":{"type":"boolean"},"freshness":{"type":"object","required":["state","watermark","as_of"],"properties":{"state":{"enum":["ok","no_data","stale","degraded"]},"watermark":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"as_of":{"type":"string","format":"date-time","pattern":"Z$"}}},"revenue":{"type":"object","required":["provider","connection_status","last_synced_at","last_webhook_at","rollup_through"],"properties":{"provider":{"type":["string","null"]},"connection_status":{"enum":["connected","degraded","disconnected","not_connected"]},"last_synced_at":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"last_webhook_at":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"rollup_through":{"type":["string","null"],"format":"date-time","pattern":"Z$"}}}}},"layering":{"type":"object","required":["finalized_through","provisional_through"],"properties":{"finalized_through":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"provisional_through":{"type":["string","null"],"format":"date-time","pattern":"Z$"}}},"totals":{"type":"object","required":["visits","engaged_visits","bounced_visits","bounce_rate","pageviews","avg_visit_duration_ms","avg_active_duration_ms"],"properties":{"visits":{"type":"number"},"engaged_visits":{"type":"number"},"bounced_visits":{"type":"number"},"bounce_rate":{"type":"number"},"pageviews":{"type":"number"},"avg_visit_duration_ms":{"type":"number"},"avg_active_duration_ms":{"type":"number"}}},"series":{"type":"array","items":{"type":"object","required":["bucket","visits","engaged_visits","bounced_visits","bounce_rate","pageviews","avg_visit_duration_ms","avg_active_duration_ms"],"properties":{"bucket":{"type":"string","format":"date-time","pattern":"Z$"},"visits":{"type":"number"},"engaged_visits":{"type":"number"},"bounced_visits":{"type":"number"},"bounce_rate":{"type":"number"},"pageviews":{"type":"number"},"avg_visit_duration_ms":{"type":"number"},"avg_active_duration_ms":{"type":"number"}}}},"comparison":{"type":["object","null"],"required":["totals"],"properties":{"totals":{"type":"object","required":["visits","engaged_visits","bounced_visits","bounce_rate","pageviews","avg_visit_duration_ms","avg_active_duration_ms"],"properties":{"visits":{"type":"number"},"engaged_visits":{"type":"number"},"bounced_visits":{"type":"number"},"bounce_rate":{"type":"number"},"pageviews":{"type":"number"},"avg_visit_duration_ms":{"type":"number"},"avg_active_duration_ms":{"type":"number"}}}}}}}}}},"304":{"description":"Not modified"},"400":{"description":"Response for status 400","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"401":{"description":"Response for status 401","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"402":{"description":"Response for status 402","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"403":{"description":"Response for status 403","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"404":{"description":"Response for status 404","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"409":{"description":"Response for status 409","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"429":{"description":"Response for status 429","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"500":{"description":"Response for status 500","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"503":{"description":"Response for status 503","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}}}}},"/v1/public/{share_slug}/pages":{"get":{"tags":["Public dashboard"],"operationId":"getPublicPages","summary":"Top, entry or exit pages of a shared dashboard","security":[],"parameters":[{"name":"share_slug","in":"path","required":true,"schema":{"type":"string","description":"The public dashboard share slug"}},{"name":"from","in":"query","required":true,"schema":{"type":"string","format":"date-time","pattern":"Z$"}},{"name":"to","in":"query","required":true,"schema":{"type":"string","format":"date-time","pattern":"Z$"}},{"name":"timezone","in":"query","required":false,"schema":{"type":"string","description":"An IANA time zone; defaults to the site owner's"}},{"name":"limit","in":"query","required":false,"schema":{"type":"string","pattern":"^[0-9]{1,3}$","description":"Rows, 1 to 500"}},{"name":"sort","in":"query","required":false,"schema":{"enum":["views","entrances","exits"],"default":"views"}}],"responses":{"200":{"description":"Response for status 200","content":{"application/json":{"schema":{"type":"object","required":["meta","hostnames_count","items"],"properties":{"meta":{"type":"object","required":["requested_range","effective_range","timezone","resolution","data_sources","accuracy","comparison_range","truncated","cached","partial","freshness"],"properties":{"requested_range":{"type":"object","required":["from","to"],"properties":{"from":{"type":"string","format":"date-time","pattern":"Z$"},"to":{"type":"string","format":"date-time","pattern":"Z$"}}},"effective_range":{"type":"object","required":["from","to"],"properties":{"from":{"type":"string","format":"date-time","pattern":"Z$"},"to":{"type":"string","format":"date-time","pattern":"Z$"}}},"timezone":{"type":"string","description":"An IANA time zone, e.g. Europe/Istanbul"},"resolution":{"enum":["minute","hour","day","week"]},"data_sources":{"type":"array","items":{"type":"string","const":"live"}},"accuracy":{"enum":["exact","estimated","provider_defined"]},"comparison_range":{"type":["object","null"],"required":["from","to"],"properties":{"from":{"type":"string","format":"date-time","pattern":"Z$"},"to":{"type":"string","format":"date-time","pattern":"Z$"}}},"truncated":{"type":"boolean","description":"The store capped the rows; the report is incomplete"},"cached":{"type":"boolean"},"partial":{"type":"boolean"},"freshness":{"type":"object","required":["state","watermark","as_of"],"properties":{"state":{"enum":["ok","no_data","stale","degraded"]},"watermark":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"as_of":{"type":"string","format":"date-time","pattern":"Z$"}}},"revenue":{"type":"object","required":["provider","connection_status","last_synced_at","last_webhook_at","rollup_through"],"properties":{"provider":{"type":["string","null"]},"connection_status":{"enum":["connected","degraded","disconnected","not_connected"]},"last_synced_at":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"last_webhook_at":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"rollup_through":{"type":["string","null"],"format":"date-time","pattern":"Z$"}}}}},"hostnames_count":{"type":"number"},"items":{"type":"array","items":{"type":"object","required":["hostname","page_path","views","visits","entrances","exits","bounces","bounce_rate"],"properties":{"hostname":{"type":"string"},"page_path":{"type":"string"},"views":{"type":"number"},"visits":{"type":"number"},"entrances":{"type":["number","null"]},"exits":{"type":["number","null"]},"bounces":{"type":["number","null"]},"bounce_rate":{"type":["number","null"]},"scroll_depth":{"type":["object","null"],"required":["samples","average_percent","reached_25","reached_50","reached_75","reached_100"],"properties":{"samples":{"type":"number"},"average_percent":{"type":"number"},"reached_25":{"type":"number"},"reached_50":{"type":"number"},"reached_75":{"type":"number"},"reached_100":{"type":"number"}}}}}}}}}}},"304":{"description":"Not modified"},"400":{"description":"Response for status 400","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"401":{"description":"Response for status 401","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"402":{"description":"Response for status 402","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"403":{"description":"Response for status 403","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"404":{"description":"Response for status 404","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"409":{"description":"Response for status 409","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"429":{"description":"Response for status 429","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"500":{"description":"Response for status 500","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"503":{"description":"Response for status 503","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}}}}},"/v1/public/{share_slug}/sources":{"get":{"tags":["Public dashboard"],"operationId":"getPublicSources","summary":"Top traffic sources of a shared dashboard","security":[],"parameters":[{"name":"share_slug","in":"path","required":true,"schema":{"type":"string","description":"The public dashboard share slug"}},{"name":"from","in":"query","required":true,"schema":{"type":"string","format":"date-time","pattern":"Z$"}},{"name":"to","in":"query","required":true,"schema":{"type":"string","format":"date-time","pattern":"Z$"}},{"name":"timezone","in":"query","required":false,"schema":{"type":"string","description":"An IANA time zone; defaults to the site owner's"}},{"name":"limit","in":"query","required":false,"schema":{"type":"string","pattern":"^[0-9]{1,3}$","description":"Rows, 1 to 500"}}],"responses":{"200":{"description":"Response for status 200","content":{"application/json":{"schema":{"type":"object","required":["meta","items"],"properties":{"meta":{"type":"object","required":["requested_range","effective_range","timezone","resolution","data_sources","accuracy","comparison_range","truncated","cached","partial","freshness"],"properties":{"requested_range":{"type":"object","required":["from","to"],"properties":{"from":{"type":"string","format":"date-time","pattern":"Z$"},"to":{"type":"string","format":"date-time","pattern":"Z$"}}},"effective_range":{"type":"object","required":["from","to"],"properties":{"from":{"type":"string","format":"date-time","pattern":"Z$"},"to":{"type":"string","format":"date-time","pattern":"Z$"}}},"timezone":{"type":"string","description":"An IANA time zone, e.g. Europe/Istanbul"},"resolution":{"enum":["minute","hour","day","week"]},"data_sources":{"type":"array","items":{"type":"string","const":"live"}},"accuracy":{"enum":["exact","estimated","provider_defined"]},"comparison_range":{"type":["object","null"],"required":["from","to"],"properties":{"from":{"type":"string","format":"date-time","pattern":"Z$"},"to":{"type":"string","format":"date-time","pattern":"Z$"}}},"truncated":{"type":"boolean","description":"The store capped the rows; the report is incomplete"},"cached":{"type":"boolean"},"partial":{"type":"boolean"},"freshness":{"type":"object","required":["state","watermark","as_of"],"properties":{"state":{"enum":["ok","no_data","stale","degraded"]},"watermark":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"as_of":{"type":"string","format":"date-time","pattern":"Z$"}}},"revenue":{"type":"object","required":["provider","connection_status","last_synced_at","last_webhook_at","rollup_through"],"properties":{"provider":{"type":["string","null"]},"connection_status":{"enum":["connected","degraded","disconnected","not_connected"]},"last_synced_at":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"last_webhook_at":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"rollup_through":{"type":["string","null"],"format":"date-time","pattern":"Z$"}}}}},"items":{"type":"array","items":{"type":"object","required":["referrer_domain","utm_source","utm_medium","utm_campaign","views","visits"],"properties":{"referrer_domain":{"type":"string"},"utm_source":{"type":"string"},"utm_medium":{"type":"string"},"utm_campaign":{"type":"string"},"views":{"type":"number"},"visits":{"type":"number"}}}}}}}}},"304":{"description":"Not modified"},"400":{"description":"Response for status 400","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"401":{"description":"Response for status 401","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"402":{"description":"Response for status 402","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"403":{"description":"Response for status 403","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"404":{"description":"Response for status 404","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"409":{"description":"Response for status 409","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"429":{"description":"Response for status 429","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"500":{"description":"Response for status 500","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"503":{"description":"Response for status 503","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}}}}},"/v1/public/{share_slug}/devices":{"get":{"tags":["Public dashboard"],"operationId":"getPublicDevices","summary":"Device, browser and OS breakdown of a shared dashboard","security":[],"parameters":[{"name":"share_slug","in":"path","required":true,"schema":{"type":"string","description":"The public dashboard share slug"}},{"name":"from","in":"query","required":true,"schema":{"type":"string","format":"date-time","pattern":"Z$"}},{"name":"to","in":"query","required":true,"schema":{"type":"string","format":"date-time","pattern":"Z$"}},{"name":"timezone","in":"query","required":false,"schema":{"type":"string","description":"An IANA time zone; defaults to the site owner's"}},{"name":"limit","in":"query","required":false,"schema":{"type":"string","pattern":"^[0-9]{1,3}$","description":"Rows, 1 to 500"}}],"responses":{"200":{"description":"Response for status 200","content":{"application/json":{"schema":{"type":"object","required":["meta","items"],"properties":{"meta":{"type":"object","required":["requested_range","effective_range","timezone","resolution","data_sources","accuracy","comparison_range","truncated","cached","partial","freshness"],"properties":{"requested_range":{"type":"object","required":["from","to"],"properties":{"from":{"type":"string","format":"date-time","pattern":"Z$"},"to":{"type":"string","format":"date-time","pattern":"Z$"}}},"effective_range":{"type":"object","required":["from","to"],"properties":{"from":{"type":"string","format":"date-time","pattern":"Z$"},"to":{"type":"string","format":"date-time","pattern":"Z$"}}},"timezone":{"type":"string","description":"An IANA time zone, e.g. Europe/Istanbul"},"resolution":{"enum":["minute","hour","day","week"]},"data_sources":{"type":"array","items":{"type":"string","const":"live"}},"accuracy":{"enum":["exact","estimated","provider_defined"]},"comparison_range":{"type":["object","null"],"required":["from","to"],"properties":{"from":{"type":"string","format":"date-time","pattern":"Z$"},"to":{"type":"string","format":"date-time","pattern":"Z$"}}},"truncated":{"type":"boolean","description":"The store capped the rows; the report is incomplete"},"cached":{"type":"boolean"},"partial":{"type":"boolean"},"freshness":{"type":"object","required":["state","watermark","as_of"],"properties":{"state":{"enum":["ok","no_data","stale","degraded"]},"watermark":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"as_of":{"type":"string","format":"date-time","pattern":"Z$"}}},"revenue":{"type":"object","required":["provider","connection_status","last_synced_at","last_webhook_at","rollup_through"],"properties":{"provider":{"type":["string","null"]},"connection_status":{"enum":["connected","degraded","disconnected","not_connected"]},"last_synced_at":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"last_webhook_at":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"rollup_through":{"type":["string","null"],"format":"date-time","pattern":"Z$"}}}}},"items":{"type":"array","items":{"type":"object","required":["device_type","browser","os","views","visits"],"properties":{"device_type":{"type":"string"},"browser":{"type":"string"},"os":{"type":"string"},"views":{"type":"number"},"visits":{"type":"number"}}}}}}}}},"304":{"description":"Not modified"},"400":{"description":"Response for status 400","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"401":{"description":"Response for status 401","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"402":{"description":"Response for status 402","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"403":{"description":"Response for status 403","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"404":{"description":"Response for status 404","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"409":{"description":"Response for status 409","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"429":{"description":"Response for status 429","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"500":{"description":"Response for status 500","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"503":{"description":"Response for status 503","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}}}}},"/v1/public/{share_slug}/geography":{"get":{"tags":["Public dashboard"],"operationId":"getPublicGeography","summary":"Visits by country, region or city of a shared dashboard","security":[],"parameters":[{"name":"share_slug","in":"path","required":true,"schema":{"type":"string","description":"The public dashboard share slug"}},{"name":"from","in":"query","required":true,"schema":{"type":"string","format":"date-time","pattern":"Z$"}},{"name":"to","in":"query","required":true,"schema":{"type":"string","format":"date-time","pattern":"Z$"}},{"name":"timezone","in":"query","required":false,"schema":{"type":"string","description":"An IANA time zone; defaults to the site owner's"}},{"name":"limit","in":"query","required":false,"schema":{"type":"string","pattern":"^[0-9]{1,3}$","description":"Rows, 1 to 500"}},{"name":"level","in":"query","required":false,"schema":{"enum":["country","region","city"]}}],"responses":{"200":{"description":"Response for status 200","content":{"application/json":{"schema":{"type":"object","required":["meta","items"],"properties":{"meta":{"type":"object","required":["requested_range","effective_range","timezone","resolution","data_sources","accuracy","comparison_range","truncated","cached","partial","freshness"],"properties":{"requested_range":{"type":"object","required":["from","to"],"properties":{"from":{"type":"string","format":"date-time","pattern":"Z$"},"to":{"type":"string","format":"date-time","pattern":"Z$"}}},"effective_range":{"type":"object","required":["from","to"],"properties":{"from":{"type":"string","format":"date-time","pattern":"Z$"},"to":{"type":"string","format":"date-time","pattern":"Z$"}}},"timezone":{"type":"string","description":"An IANA time zone, e.g. Europe/Istanbul"},"resolution":{"enum":["minute","hour","day","week"]},"data_sources":{"type":"array","items":{"type":"string","const":"live"}},"accuracy":{"enum":["exact","estimated","provider_defined"]},"comparison_range":{"type":["object","null"],"required":["from","to"],"properties":{"from":{"type":"string","format":"date-time","pattern":"Z$"},"to":{"type":"string","format":"date-time","pattern":"Z$"}}},"truncated":{"type":"boolean","description":"The store capped the rows; the report is incomplete"},"cached":{"type":"boolean"},"partial":{"type":"boolean"},"freshness":{"type":"object","required":["state","watermark","as_of"],"properties":{"state":{"enum":["ok","no_data","stale","degraded"]},"watermark":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"as_of":{"type":"string","format":"date-time","pattern":"Z$"}}},"revenue":{"type":"object","required":["provider","connection_status","last_synced_at","last_webhook_at","rollup_through"],"properties":{"provider":{"type":["string","null"]},"connection_status":{"enum":["connected","degraded","disconnected","not_connected"]},"last_synced_at":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"last_webhook_at":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"rollup_through":{"type":["string","null"],"format":"date-time","pattern":"Z$"}}}}},"items":{"type":"array","items":{"type":"object","required":["country","region","city","views","visits","city_suppressed"],"properties":{"country":{"type":"string"},"region":{"type":"string"},"city":{"type":["string","null"]},"views":{"type":"number"},"visits":{"type":"number"},"city_suppressed":{"type":"boolean"}}}}}}}}},"304":{"description":"Not modified"},"400":{"description":"Response for status 400","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"401":{"description":"Response for status 401","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"402":{"description":"Response for status 402","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"403":{"description":"Response for status 403","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"404":{"description":"Response for status 404","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"409":{"description":"Response for status 409","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"429":{"description":"Response for status 429","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"500":{"description":"Response for status 500","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"503":{"description":"Response for status 503","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}}}}},"/v1/public/{share_slug}/languages":{"get":{"tags":["Public dashboard"],"operationId":"getPublicLanguages","summary":"Visitor languages of a shared dashboard","security":[],"parameters":[{"name":"share_slug","in":"path","required":true,"schema":{"type":"string","description":"The public dashboard share slug"}},{"name":"from","in":"query","required":true,"schema":{"type":"string","format":"date-time","pattern":"Z$"}},{"name":"to","in":"query","required":true,"schema":{"type":"string","format":"date-time","pattern":"Z$"}},{"name":"timezone","in":"query","required":false,"schema":{"type":"string","description":"An IANA time zone; defaults to the site owner's"}},{"name":"limit","in":"query","required":false,"schema":{"type":"string","pattern":"^[0-9]{1,3}$","description":"Rows, 1 to 500"}}],"responses":{"200":{"description":"Response for status 200","content":{"application/json":{"schema":{"type":"object","required":["meta","items"],"properties":{"meta":{"type":"object","required":["requested_range","effective_range","timezone","resolution","data_sources","accuracy","comparison_range","truncated","cached","partial","freshness"],"properties":{"requested_range":{"type":"object","required":["from","to"],"properties":{"from":{"type":"string","format":"date-time","pattern":"Z$"},"to":{"type":"string","format":"date-time","pattern":"Z$"}}},"effective_range":{"type":"object","required":["from","to"],"properties":{"from":{"type":"string","format":"date-time","pattern":"Z$"},"to":{"type":"string","format":"date-time","pattern":"Z$"}}},"timezone":{"type":"string","description":"An IANA time zone, e.g. Europe/Istanbul"},"resolution":{"enum":["minute","hour","day","week"]},"data_sources":{"type":"array","items":{"type":"string","const":"live"}},"accuracy":{"enum":["exact","estimated","provider_defined"]},"comparison_range":{"type":["object","null"],"required":["from","to"],"properties":{"from":{"type":"string","format":"date-time","pattern":"Z$"},"to":{"type":"string","format":"date-time","pattern":"Z$"}}},"truncated":{"type":"boolean","description":"The store capped the rows; the report is incomplete"},"cached":{"type":"boolean"},"partial":{"type":"boolean"},"freshness":{"type":"object","required":["state","watermark","as_of"],"properties":{"state":{"enum":["ok","no_data","stale","degraded"]},"watermark":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"as_of":{"type":"string","format":"date-time","pattern":"Z$"}}},"revenue":{"type":"object","required":["provider","connection_status","last_synced_at","last_webhook_at","rollup_through"],"properties":{"provider":{"type":["string","null"]},"connection_status":{"enum":["connected","degraded","disconnected","not_connected"]},"last_synced_at":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"last_webhook_at":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"rollup_through":{"type":["string","null"],"format":"date-time","pattern":"Z$"}}}}},"items":{"type":"array","items":{"type":"object","required":["language","views","visits"],"properties":{"language":{"type":"string"},"views":{"type":"number"},"visits":{"type":"number"}}}}}}}}},"304":{"description":"Not modified"},"400":{"description":"Response for status 400","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"401":{"description":"Response for status 401","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"402":{"description":"Response for status 402","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"403":{"description":"Response for status 403","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"404":{"description":"Response for status 404","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"409":{"description":"Response for status 409","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"429":{"description":"Response for status 429","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"500":{"description":"Response for status 500","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"503":{"description":"Response for status 503","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}}}}},"/v1/public/{share_slug}/performance":{"get":{"tags":["Public dashboard"],"operationId":"getPublicWebVitals","summary":"Web vitals per metric and device type","security":[],"parameters":[{"name":"share_slug","in":"path","required":true,"schema":{"type":"string","description":"The public dashboard share slug"}},{"name":"from","in":"query","required":true,"schema":{"type":"string","format":"date-time","pattern":"Z$"}},{"name":"to","in":"query","required":true,"schema":{"type":"string","format":"date-time","pattern":"Z$"}},{"name":"timezone","in":"query","required":false,"schema":{"type":"string","description":"An IANA time zone; defaults to the site owner's"}},{"name":"limit","in":"query","required":false,"schema":{"type":"string","pattern":"^[0-9]{1,3}$","description":"Rows, 1 to 500"}},{"name":"percentile","in":"query","required":false,"schema":{"enum":["p50","p75","p90","p95","p99"],"default":"p75"}}],"responses":{"200":{"description":"Response for status 200","content":{"application/json":{"schema":{"type":"object","required":["meta","percentile","items"],"properties":{"meta":{"type":"object","required":["requested_range","effective_range","timezone","resolution","data_sources","accuracy","comparison_range","truncated","cached","partial","freshness"],"properties":{"requested_range":{"type":"object","required":["from","to"],"properties":{"from":{"type":"string","format":"date-time","pattern":"Z$"},"to":{"type":"string","format":"date-time","pattern":"Z$"}}},"effective_range":{"type":"object","required":["from","to"],"properties":{"from":{"type":"string","format":"date-time","pattern":"Z$"},"to":{"type":"string","format":"date-time","pattern":"Z$"}}},"timezone":{"type":"string","description":"An IANA time zone, e.g. Europe/Istanbul"},"resolution":{"enum":["minute","hour","day","week"]},"data_sources":{"type":"array","items":{"type":"string","const":"live"}},"accuracy":{"enum":["exact","estimated","provider_defined"]},"comparison_range":{"type":["object","null"],"required":["from","to"],"properties":{"from":{"type":"string","format":"date-time","pattern":"Z$"},"to":{"type":"string","format":"date-time","pattern":"Z$"}}},"truncated":{"type":"boolean","description":"The store capped the rows; the report is incomplete"},"cached":{"type":"boolean"},"partial":{"type":"boolean"},"freshness":{"type":"object","required":["state","watermark","as_of"],"properties":{"state":{"enum":["ok","no_data","stale","degraded"]},"watermark":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"as_of":{"type":"string","format":"date-time","pattern":"Z$"}}},"revenue":{"type":"object","required":["provider","connection_status","last_synced_at","last_webhook_at","rollup_through"],"properties":{"provider":{"type":["string","null"]},"connection_status":{"enum":["connected","degraded","disconnected","not_connected"]},"last_synced_at":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"last_webhook_at":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"rollup_through":{"type":["string","null"],"format":"date-time","pattern":"Z$"}}}}},"percentile":{"enum":["p50","p75","p90","p95","p99"]},"items":{"type":"array","items":{"type":"object","required":["metric","device_type","value","rating","samples","mean","p50","p75","p90","p95","p99","good_samples","needs_improvement_samples","poor_samples"],"properties":{"metric":{"type":"string"},"device_type":{"type":"string"},"value":{"type":"number"},"rating":{"anyOf":[{"enum":["good","needs-improvement","poor"]},{"type":"null"}]},"samples":{"type":"number"},"mean":{"type":"number"},"p50":{"type":"number"},"p75":{"type":"number"},"p90":{"type":"number"},"p95":{"type":"number"},"p99":{"type":"number"},"good_samples":{"type":"number"},"needs_improvement_samples":{"type":"number"},"poor_samples":{"type":"number"}}}}}}}}},"304":{"description":"Not modified"},"400":{"description":"Response for status 400","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"401":{"description":"Response for status 401","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"402":{"description":"Response for status 402","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"403":{"description":"Response for status 403","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"404":{"description":"Response for status 404","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"409":{"description":"Response for status 409","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"429":{"description":"Response for status 429","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"500":{"description":"Response for status 500","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"503":{"description":"Response for status 503","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}}}}},"/v1/public/{share_slug}/performance/timeseries":{"get":{"tags":["Public dashboard"],"operationId":"getPublicWebVitalsTimeseries","summary":"Web vitals per metric and time bucket","security":[],"parameters":[{"name":"share_slug","in":"path","required":true,"schema":{"type":"string","description":"The public dashboard share slug"}},{"name":"from","in":"query","required":true,"schema":{"type":"string","format":"date-time","pattern":"Z$"}},{"name":"to","in":"query","required":true,"schema":{"type":"string","format":"date-time","pattern":"Z$"}},{"name":"timezone","in":"query","required":false,"schema":{"type":"string","description":"An IANA time zone; defaults to the site owner's"}},{"name":"percentile","in":"query","required":false,"schema":{"enum":["p50","p75","p90","p95","p99"],"default":"p75"}},{"name":"resolution","in":"query","required":false,"schema":{"enum":["hour","day","week"]}}],"responses":{"200":{"description":"Response for status 200","content":{"application/json":{"schema":{"type":"object","required":["meta","percentile","series"],"properties":{"meta":{"type":"object","required":["requested_range","effective_range","timezone","resolution","data_sources","accuracy","comparison_range","truncated","cached","partial","freshness"],"properties":{"requested_range":{"type":"object","required":["from","to"],"properties":{"from":{"type":"string","format":"date-time","pattern":"Z$"},"to":{"type":"string","format":"date-time","pattern":"Z$"}}},"effective_range":{"type":"object","required":["from","to"],"properties":{"from":{"type":"string","format":"date-time","pattern":"Z$"},"to":{"type":"string","format":"date-time","pattern":"Z$"}}},"timezone":{"type":"string","description":"An IANA time zone, e.g. Europe/Istanbul"},"resolution":{"enum":["minute","hour","day","week"]},"data_sources":{"type":"array","items":{"type":"string","const":"live"}},"accuracy":{"enum":["exact","estimated","provider_defined"]},"comparison_range":{"type":["object","null"],"required":["from","to"],"properties":{"from":{"type":"string","format":"date-time","pattern":"Z$"},"to":{"type":"string","format":"date-time","pattern":"Z$"}}},"truncated":{"type":"boolean","description":"The store capped the rows; the report is incomplete"},"cached":{"type":"boolean"},"partial":{"type":"boolean"},"freshness":{"type":"object","required":["state","watermark","as_of"],"properties":{"state":{"enum":["ok","no_data","stale","degraded"]},"watermark":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"as_of":{"type":"string","format":"date-time","pattern":"Z$"}}},"revenue":{"type":"object","required":["provider","connection_status","last_synced_at","last_webhook_at","rollup_through"],"properties":{"provider":{"type":["string","null"]},"connection_status":{"enum":["connected","degraded","disconnected","not_connected"]},"last_synced_at":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"last_webhook_at":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"rollup_through":{"type":["string","null"],"format":"date-time","pattern":"Z$"}}}}},"percentile":{"enum":["p50","p75","p90","p95","p99"]},"series":{"type":"array","items":{"type":"object","required":["bucket","metric","samples","value","rating","good_samples","needs_improvement_samples","poor_samples"],"properties":{"bucket":{"type":"string","format":"date-time","pattern":"Z$"},"metric":{"enum":["LCP","CLS","INP","FCP","TTFB"]},"samples":{"type":"number"},"value":{"type":"number"},"rating":{"anyOf":[{"enum":["good","needs-improvement","poor"]},{"type":"null"}]},"good_samples":{"type":"number"},"needs_improvement_samples":{"type":"number"},"poor_samples":{"type":"number"}}}}}}}}},"304":{"description":"Not modified"},"400":{"description":"Response for status 400","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"401":{"description":"Response for status 401","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"402":{"description":"Response for status 402","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"403":{"description":"Response for status 403","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"404":{"description":"Response for status 404","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"409":{"description":"Response for status 409","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"429":{"description":"Response for status 429","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"500":{"description":"Response for status 500","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"503":{"description":"Response for status 503","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}}}}},"/v1/public/{share_slug}/performance/pages":{"get":{"tags":["Public dashboard"],"operationId":"listPublicWebVitalsByPage","summary":"Web vitals per page","security":[],"parameters":[{"name":"share_slug","in":"path","required":true,"schema":{"type":"string","description":"The public dashboard share slug"}},{"name":"from","in":"query","required":true,"schema":{"type":"string","format":"date-time","pattern":"Z$"}},{"name":"to","in":"query","required":true,"schema":{"type":"string","format":"date-time","pattern":"Z$"}},{"name":"timezone","in":"query","required":false,"schema":{"type":"string","description":"An IANA time zone; defaults to the site owner's"}},{"name":"limit","in":"query","required":false,"schema":{"type":"string","pattern":"^[0-9]{1,3}$","description":"Rows, 1 to 500"}},{"name":"percentile","in":"query","required":false,"schema":{"enum":["p50","p75","p90","p95","p99"],"default":"p75"}},{"name":"metric","in":"query","required":false,"schema":{"enum":["LCP","CLS","INP","FCP","TTFB"],"description":"All metrics if absent"}}],"responses":{"200":{"description":"Response for status 200","content":{"application/json":{"schema":{"type":"object","required":["meta","percentile","items"],"properties":{"meta":{"type":"object","required":["requested_range","effective_range","timezone","resolution","data_sources","accuracy","comparison_range","truncated","cached","partial","freshness"],"properties":{"requested_range":{"type":"object","required":["from","to"],"properties":{"from":{"type":"string","format":"date-time","pattern":"Z$"},"to":{"type":"string","format":"date-time","pattern":"Z$"}}},"effective_range":{"type":"object","required":["from","to"],"properties":{"from":{"type":"string","format":"date-time","pattern":"Z$"},"to":{"type":"string","format":"date-time","pattern":"Z$"}}},"timezone":{"type":"string","description":"An IANA time zone, e.g. Europe/Istanbul"},"resolution":{"enum":["minute","hour","day","week"]},"data_sources":{"type":"array","items":{"type":"string","const":"live"}},"accuracy":{"enum":["exact","estimated","provider_defined"]},"comparison_range":{"type":["object","null"],"required":["from","to"],"properties":{"from":{"type":"string","format":"date-time","pattern":"Z$"},"to":{"type":"string","format":"date-time","pattern":"Z$"}}},"truncated":{"type":"boolean","description":"The store capped the rows; the report is incomplete"},"cached":{"type":"boolean"},"partial":{"type":"boolean"},"freshness":{"type":"object","required":["state","watermark","as_of"],"properties":{"state":{"enum":["ok","no_data","stale","degraded"]},"watermark":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"as_of":{"type":"string","format":"date-time","pattern":"Z$"}}},"revenue":{"type":"object","required":["provider","connection_status","last_synced_at","last_webhook_at","rollup_through"],"properties":{"provider":{"type":["string","null"]},"connection_status":{"enum":["connected","degraded","disconnected","not_connected"]},"last_synced_at":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"last_webhook_at":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"rollup_through":{"type":["string","null"],"format":"date-time","pattern":"Z$"}}}}},"percentile":{"enum":["p50","p75","p90","p95","p99"]},"items":{"type":"array","items":{"type":"object","required":["metric","hostname","page_path","samples","mean","value","rating","good_samples","needs_improvement_samples","poor_samples"],"properties":{"metric":{"enum":["LCP","CLS","INP","FCP","TTFB"]},"hostname":{"type":"string"},"page_path":{"type":"string"},"samples":{"type":"number"},"mean":{"type":"number"},"value":{"type":"number"},"rating":{"anyOf":[{"enum":["good","needs-improvement","poor"]},{"type":"null"}]},"good_samples":{"type":"number"},"needs_improvement_samples":{"type":"number"},"poor_samples":{"type":"number"}}}}}}}}},"304":{"description":"Not modified"},"400":{"description":"Response for status 400","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"401":{"description":"Response for status 401","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"402":{"description":"Response for status 402","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"403":{"description":"Response for status 403","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"404":{"description":"Response for status 404","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"409":{"description":"Response for status 409","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"429":{"description":"Response for status 429","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"500":{"description":"Response for status 500","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"503":{"description":"Response for status 503","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}}}}},"/v1/public/{share_slug}/performance/countries":{"get":{"tags":["Public dashboard"],"operationId":"listPublicWebVitalsByCountry","summary":"Web vitals per country","security":[],"parameters":[{"name":"share_slug","in":"path","required":true,"schema":{"type":"string","description":"The public dashboard share slug"}},{"name":"from","in":"query","required":true,"schema":{"type":"string","format":"date-time","pattern":"Z$"}},{"name":"to","in":"query","required":true,"schema":{"type":"string","format":"date-time","pattern":"Z$"}},{"name":"timezone","in":"query","required":false,"schema":{"type":"string","description":"An IANA time zone; defaults to the site owner's"}},{"name":"limit","in":"query","required":false,"schema":{"type":"string","pattern":"^[0-9]{1,3}$","description":"Rows, 1 to 500"}},{"name":"percentile","in":"query","required":false,"schema":{"enum":["p50","p75","p90","p95","p99"],"default":"p75"}},{"name":"metric","in":"query","required":false,"schema":{"enum":["LCP","CLS","INP","FCP","TTFB"],"description":"All metrics if absent"}}],"responses":{"200":{"description":"Response for status 200","content":{"application/json":{"schema":{"type":"object","required":["meta","percentile","items"],"properties":{"meta":{"type":"object","required":["requested_range","effective_range","timezone","resolution","data_sources","accuracy","comparison_range","truncated","cached","partial","freshness"],"properties":{"requested_range":{"type":"object","required":["from","to"],"properties":{"from":{"type":"string","format":"date-time","pattern":"Z$"},"to":{"type":"string","format":"date-time","pattern":"Z$"}}},"effective_range":{"type":"object","required":["from","to"],"properties":{"from":{"type":"string","format":"date-time","pattern":"Z$"},"to":{"type":"string","format":"date-time","pattern":"Z$"}}},"timezone":{"type":"string","description":"An IANA time zone, e.g. Europe/Istanbul"},"resolution":{"enum":["minute","hour","day","week"]},"data_sources":{"type":"array","items":{"type":"string","const":"live"}},"accuracy":{"enum":["exact","estimated","provider_defined"]},"comparison_range":{"type":["object","null"],"required":["from","to"],"properties":{"from":{"type":"string","format":"date-time","pattern":"Z$"},"to":{"type":"string","format":"date-time","pattern":"Z$"}}},"truncated":{"type":"boolean","description":"The store capped the rows; the report is incomplete"},"cached":{"type":"boolean"},"partial":{"type":"boolean"},"freshness":{"type":"object","required":["state","watermark","as_of"],"properties":{"state":{"enum":["ok","no_data","stale","degraded"]},"watermark":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"as_of":{"type":"string","format":"date-time","pattern":"Z$"}}},"revenue":{"type":"object","required":["provider","connection_status","last_synced_at","last_webhook_at","rollup_through"],"properties":{"provider":{"type":["string","null"]},"connection_status":{"enum":["connected","degraded","disconnected","not_connected"]},"last_synced_at":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"last_webhook_at":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"rollup_through":{"type":["string","null"],"format":"date-time","pattern":"Z$"}}}}},"percentile":{"enum":["p50","p75","p90","p95","p99"]},"items":{"type":"array","items":{"type":"object","required":["metric","country","samples","mean","value","rating","good_samples","needs_improvement_samples","poor_samples"],"properties":{"metric":{"enum":["LCP","CLS","INP","FCP","TTFB"]},"country":{"type":"string"},"samples":{"type":"number"},"mean":{"type":"number"},"value":{"type":"number"},"rating":{"anyOf":[{"enum":["good","needs-improvement","poor"]},{"type":"null"}]},"good_samples":{"type":"number"},"needs_improvement_samples":{"type":"number"},"poor_samples":{"type":"number"}}}}}}}}},"304":{"description":"Not modified"},"400":{"description":"Response for status 400","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"401":{"description":"Response for status 401","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"402":{"description":"Response for status 402","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"403":{"description":"Response for status 403","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"404":{"description":"Response for status 404","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"409":{"description":"Response for status 409","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"429":{"description":"Response for status 429","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"500":{"description":"Response for status 500","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"503":{"description":"Response for status 503","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}}}}},"/v1/public/{share_slug}/performance/browsers":{"get":{"tags":["Public dashboard"],"operationId":"listPublicWebVitalsByBrowser","summary":"Web vitals per browser","security":[],"parameters":[{"name":"share_slug","in":"path","required":true,"schema":{"type":"string","description":"The public dashboard share slug"}},{"name":"from","in":"query","required":true,"schema":{"type":"string","format":"date-time","pattern":"Z$"}},{"name":"to","in":"query","required":true,"schema":{"type":"string","format":"date-time","pattern":"Z$"}},{"name":"timezone","in":"query","required":false,"schema":{"type":"string","description":"An IANA time zone; defaults to the site owner's"}},{"name":"limit","in":"query","required":false,"schema":{"type":"string","pattern":"^[0-9]{1,3}$","description":"Rows, 1 to 500"}},{"name":"percentile","in":"query","required":false,"schema":{"enum":["p50","p75","p90","p95","p99"],"default":"p75"}},{"name":"metric","in":"query","required":false,"schema":{"enum":["LCP","CLS","INP","FCP","TTFB"],"description":"All metrics if absent"}}],"responses":{"200":{"description":"Response for status 200","content":{"application/json":{"schema":{"type":"object","required":["meta","percentile","items"],"properties":{"meta":{"type":"object","required":["requested_range","effective_range","timezone","resolution","data_sources","accuracy","comparison_range","truncated","cached","partial","freshness"],"properties":{"requested_range":{"type":"object","required":["from","to"],"properties":{"from":{"type":"string","format":"date-time","pattern":"Z$"},"to":{"type":"string","format":"date-time","pattern":"Z$"}}},"effective_range":{"type":"object","required":["from","to"],"properties":{"from":{"type":"string","format":"date-time","pattern":"Z$"},"to":{"type":"string","format":"date-time","pattern":"Z$"}}},"timezone":{"type":"string","description":"An IANA time zone, e.g. Europe/Istanbul"},"resolution":{"enum":["minute","hour","day","week"]},"data_sources":{"type":"array","items":{"type":"string","const":"live"}},"accuracy":{"enum":["exact","estimated","provider_defined"]},"comparison_range":{"type":["object","null"],"required":["from","to"],"properties":{"from":{"type":"string","format":"date-time","pattern":"Z$"},"to":{"type":"string","format":"date-time","pattern":"Z$"}}},"truncated":{"type":"boolean","description":"The store capped the rows; the report is incomplete"},"cached":{"type":"boolean"},"partial":{"type":"boolean"},"freshness":{"type":"object","required":["state","watermark","as_of"],"properties":{"state":{"enum":["ok","no_data","stale","degraded"]},"watermark":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"as_of":{"type":"string","format":"date-time","pattern":"Z$"}}},"revenue":{"type":"object","required":["provider","connection_status","last_synced_at","last_webhook_at","rollup_through"],"properties":{"provider":{"type":["string","null"]},"connection_status":{"enum":["connected","degraded","disconnected","not_connected"]},"last_synced_at":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"last_webhook_at":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"rollup_through":{"type":["string","null"],"format":"date-time","pattern":"Z$"}}}}},"percentile":{"enum":["p50","p75","p90","p95","p99"]},"items":{"type":"array","items":{"type":"object","required":["metric","browser","samples","mean","value","rating","good_samples","needs_improvement_samples","poor_samples"],"properties":{"metric":{"enum":["LCP","CLS","INP","FCP","TTFB"]},"browser":{"type":"string"},"samples":{"type":"number"},"mean":{"type":"number"},"value":{"type":"number"},"rating":{"anyOf":[{"enum":["good","needs-improvement","poor"]},{"type":"null"}]},"good_samples":{"type":"number"},"needs_improvement_samples":{"type":"number"},"poor_samples":{"type":"number"}}}}}}}}},"304":{"description":"Not modified"},"400":{"description":"Response for status 400","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"401":{"description":"Response for status 401","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"402":{"description":"Response for status 402","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"403":{"description":"Response for status 403","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"404":{"description":"Response for status 404","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"409":{"description":"Response for status 409","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"429":{"description":"Response for status 429","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"500":{"description":"Response for status 500","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"503":{"description":"Response for status 503","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}}}}},"/v1/public/{share_slug}/revenue":{"get":{"tags":["Public dashboard"],"operationId":"getPublicRevenue","summary":"Net revenue of a shared dashboard","security":[],"parameters":[{"name":"share_slug","in":"path","required":true,"schema":{"type":"string","description":"The public dashboard share slug"}},{"name":"from","in":"query","required":true,"schema":{"type":"string","format":"date-time","pattern":"Z$"}},{"name":"to","in":"query","required":true,"schema":{"type":"string","format":"date-time","pattern":"Z$"}},{"name":"timezone","in":"query","required":false,"schema":{"type":"string","description":"An IANA time zone; defaults to the site owner's"}}],"responses":{"200":{"description":"Response for status 200","content":{"application/json":{"schema":{"type":"object","required":["meta","totals"],"properties":{"meta":{"type":"object","required":["requested_range","effective_range","timezone","resolution","data_sources","accuracy","comparison_range","truncated","cached","partial","freshness"],"properties":{"requested_range":{"type":"object","required":["from","to"],"properties":{"from":{"type":"string","format":"date-time","pattern":"Z$"},"to":{"type":"string","format":"date-time","pattern":"Z$"}}},"effective_range":{"type":"object","required":["from","to"],"properties":{"from":{"type":"string","format":"date-time","pattern":"Z$"},"to":{"type":"string","format":"date-time","pattern":"Z$"}}},"timezone":{"type":"string","description":"An IANA time zone, e.g. Europe/Istanbul"},"resolution":{"enum":["minute","hour","day","week"]},"data_sources":{"type":"array","items":{"type":"string","const":"live"}},"accuracy":{"enum":["exact","estimated","provider_defined"]},"comparison_range":{"type":["object","null"],"required":["from","to"],"properties":{"from":{"type":"string","format":"date-time","pattern":"Z$"},"to":{"type":"string","format":"date-time","pattern":"Z$"}}},"truncated":{"type":"boolean","description":"The store capped the rows; the report is incomplete"},"cached":{"type":"boolean"},"partial":{"type":"boolean"},"freshness":{"type":"object","required":["state","watermark","as_of"],"properties":{"state":{"enum":["ok","no_data","stale","degraded"]},"watermark":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"as_of":{"type":"string","format":"date-time","pattern":"Z$"}}},"revenue":{"type":"object","required":["provider","connection_status","last_synced_at","last_webhook_at","rollup_through"],"properties":{"provider":{"type":["string","null"]},"connection_status":{"enum":["connected","degraded","disconnected","not_connected"]},"last_synced_at":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"last_webhook_at":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"rollup_through":{"type":["string","null"],"format":"date-time","pattern":"Z$"}}}}},"totals":{"type":"object","required":["currency","net_minor"],"properties":{"currency":{"type":"string"},"net_minor":{"type":"number"}}}}}}}},"304":{"description":"Not modified"},"400":{"description":"Response for status 400","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"401":{"description":"Response for status 401","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"402":{"description":"Response for status 402","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"403":{"description":"Response for status 403","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"404":{"description":"Response for status 404","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"409":{"description":"Response for status 409","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"429":{"description":"Response for status 429","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"500":{"description":"Response for status 500","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"503":{"description":"Response for status 503","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}}}}},"/v1/heatmaps/overlay":{"get":{"tags":["Heatmaps"],"operationId":"getHeatmapOverlay","summary":"Click cells and scroll depth for the overlay on one page","description":"Authenticate with a heatmap overlay token as a Bearer header.","security":[{"bearer":[]}],"parameters":[{"name":"from","in":"query","required":true,"schema":{"type":"string","format":"date-time","pattern":"Z$"}},{"name":"to","in":"query","required":true,"schema":{"type":"string","format":"date-time","pattern":"Z$"}},{"name":"timezone","in":"query","required":false,"schema":{"type":"string","description":"An IANA time zone; defaults to UTC"}},{"name":"device","in":"query","required":false,"schema":{"enum":["desktop","mobile"],"description":"Defaults to desktop"}},{"name":"hostname","in":"query","required":true,"schema":{"type":"string","description":"The page hostname, without a leading www."}},{"name":"path","in":"query","required":true,"schema":{"type":"string","description":"The page path, starting with /"}}],"responses":{"200":{"description":"Response for status 200","content":{"application/json":{"schema":{"type":"object","required":["device","from","to","totals","cells","scroll","truncated"],"properties":{"device":{"enum":["desktop","mobile"]},"from":{"type":"string","format":"date-time","pattern":"Z$"},"to":{"type":"string","format":"date-time","pattern":"Z$"},"totals":{"type":"object","required":["clicks","rage_clicks","dead_clicks"],"properties":{"clicks":{"type":"number"},"rage_clicks":{"type":"number"},"dead_clicks":{"type":"number"}}},"cells":{"type":"array","items":{"type":"object","required":["clicks","rage_clicks","dead_clicks","selector","x","y"],"properties":{"clicks":{"type":"number"},"rage_clicks":{"type":"number"},"dead_clicks":{"type":"number"},"selector":{"type":"string"},"x":{"type":"number"},"y":{"type":"number"}}}},"scroll":{"type":["object","null"],"required":["samples","average_percent","bins"],"properties":{"samples":{"type":"number"},"average_percent":{"type":"number"},"bins":{"type":"array","items":{"type":"number"}}}},"truncated":{"type":"boolean"}}}}}},"400":{"description":"Response for status 400","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"401":{"description":"Response for status 401","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"402":{"description":"Response for status 402","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"403":{"description":"Response for status 403","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"404":{"description":"Response for status 404","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"409":{"description":"Response for status 409","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"429":{"description":"Response for status 429","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"500":{"description":"Response for status 500","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"503":{"description":"Response for status 503","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}}}}},"/v1/public/{share_slug}/realtime/token":{"post":{"tags":["Realtime"],"operationId":"createPublicRealtimeToken","summary":"Mint a short-lived token for a shared dashboard realtime stream","security":[],"parameters":[{"name":"share_slug","in":"path","required":true,"schema":{"type":"string","description":"The public dashboard share slug"}}],"responses":{"200":{"description":"Response for status 200","content":{"application/json":{"schema":{"type":"object","required":["token","expires_at","epoch_check_seconds"],"properties":{"token":{"type":"string","minLength":1},"expires_at":{"type":"string","format":"date-time","pattern":"Z$"},"epoch_check_seconds":{"type":"integer","minimum":1,"maximum":15}},"additionalProperties":false}}}},"400":{"description":"Response for status 400","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"401":{"description":"Response for status 401","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"402":{"description":"Response for status 402","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"403":{"description":"Response for status 403","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"404":{"description":"Response for status 404","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"409":{"description":"Response for status 409","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"429":{"description":"Response for status 429","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"500":{"description":"Response for status 500","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"503":{"description":"Response for status 503","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}}}}},"/v1/sites/{site_id}/analytics/overview":{"get":{"tags":["Analytics"],"operationId":"getAnalyticsOverview","summary":"Totals of events, pageviews and visits for a range","parameters":[{"name":"site_id","in":"path","required":true,"schema":{"type":"string","description":"The site id"}},{"name":"from","in":"query","required":true,"schema":{"type":"string","description":"Range start, an ISO-8601 UTC instant (inclusive)"}},{"name":"to","in":"query","required":true,"schema":{"type":"string","description":"Range end, an ISO-8601 UTC instant (exclusive)"}},{"name":"timezone","in":"query","required":true,"schema":{"type":"string","description":"IANA time zone the report buckets by, e.g. UTC"}},{"name":"filters","in":"query","required":false,"schema":{"type":"string","description":"A JSON array of {dimension, operator, values} filter clauses that keep only matching visits; values of one dimension are OR-ed, dimensions AND-ed. operator is eq or in. dimension is one of referrer_domain, country, city, device_type, hostname, utm_source, utm_medium, utm_campaign, utm_content, utm_term, browser, os, entry_page_path, page_path, event_name. entry_page_path is the landing page; page_path keeps a visit that viewed the path at least once"}},{"name":"compare","in":"query","required":false,"schema":{"enum":["true","false"],"description":"Also report the preceding period of equal length"}},{"name":"resolution","in":"query","required":false,"schema":{"enum":["hour","day"]}}],"responses":{"200":{"description":"Response for status 200","content":{"application/json":{"schema":{"type":"object","required":["meta","totals","comparison"],"properties":{"meta":{"type":"object","required":["requested_range","effective_range","timezone","resolution","data_sources","accuracy","comparison_range","truncated","cached","partial","freshness"],"properties":{"requested_range":{"type":"object","required":["from","to"],"properties":{"from":{"type":"string","format":"date-time","pattern":"Z$"},"to":{"type":"string","format":"date-time","pattern":"Z$"}}},"effective_range":{"type":"object","required":["from","to"],"properties":{"from":{"type":"string","format":"date-time","pattern":"Z$"},"to":{"type":"string","format":"date-time","pattern":"Z$"}}},"timezone":{"type":"string","description":"An IANA time zone, e.g. Europe/Istanbul"},"resolution":{"enum":["minute","hour","day","week"]},"data_sources":{"type":"array","items":{"type":"string","const":"live"}},"accuracy":{"enum":["exact","estimated","provider_defined"]},"comparison_range":{"type":["object","null"],"required":["from","to"],"properties":{"from":{"type":"string","format":"date-time","pattern":"Z$"},"to":{"type":"string","format":"date-time","pattern":"Z$"}}},"truncated":{"type":"boolean","description":"The store capped the rows; the report is incomplete"},"cached":{"type":"boolean"},"partial":{"type":"boolean"},"freshness":{"type":"object","required":["state","watermark","as_of"],"properties":{"state":{"enum":["ok","no_data","stale","degraded"]},"watermark":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"as_of":{"type":"string","format":"date-time","pattern":"Z$"}}},"revenue":{"type":"object","required":["provider","connection_status","last_synced_at","last_webhook_at","rollup_through"],"properties":{"provider":{"type":["string","null"]},"connection_status":{"enum":["connected","degraded","disconnected","not_connected"]},"last_synced_at":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"last_webhook_at":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"rollup_through":{"type":["string","null"],"format":"date-time","pattern":"Z$"}}}}},"totals":{"type":"object","required":["events","pageviews","visits"],"properties":{"events":{"type":"number"},"pageviews":{"type":"number"},"visits":{"type":"number"}}},"comparison":{"type":["object","null"],"required":["totals"],"properties":{"totals":{"type":"object","required":["events","pageviews","visits"],"properties":{"events":{"type":"number"},"pageviews":{"type":"number"},"visits":{"type":"number"}}}}}}}}}},"400":{"description":"Response for status 400","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"401":{"description":"Response for status 401","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"402":{"description":"Response for status 402","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"403":{"description":"Response for status 403","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"404":{"description":"Response for status 404","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"409":{"description":"Response for status 409","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"429":{"description":"Response for status 429","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"500":{"description":"Response for status 500","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"503":{"description":"Response for status 503","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}}}}},"/v1/sites/{site_id}/analytics/timeseries":{"get":{"tags":["Analytics"],"operationId":"getAnalyticsTimeseries","summary":"Events, pageviews and visits per time bucket","parameters":[{"name":"site_id","in":"path","required":true,"schema":{"type":"string","description":"The site id"}},{"name":"from","in":"query","required":true,"schema":{"type":"string","description":"Range start, an ISO-8601 UTC instant (inclusive)"}},{"name":"to","in":"query","required":true,"schema":{"type":"string","description":"Range end, an ISO-8601 UTC instant (exclusive)"}},{"name":"timezone","in":"query","required":true,"schema":{"type":"string","description":"IANA time zone the report buckets by, e.g. UTC"}},{"name":"filters","in":"query","required":false,"schema":{"type":"string","description":"A JSON array of {dimension, operator, values} filter clauses that keep only matching visits; values of one dimension are OR-ed, dimensions AND-ed. operator is eq or in. dimension is one of referrer_domain, country, city, device_type, hostname, utm_source, utm_medium, utm_campaign, utm_content, utm_term, browser, os, entry_page_path, page_path, event_name. entry_page_path is the landing page; page_path keeps a visit that viewed the path at least once"}},{"name":"compare","in":"query","required":false,"schema":{"enum":["true","false"],"description":"Also report the preceding period of equal length"}},{"name":"resolution","in":"query","required":false,"schema":{"enum":["minute","hour","day","week"]}}],"responses":{"200":{"description":"Response for status 200","content":{"application/json":{"schema":{"type":"object","required":["meta","series","comparison"],"properties":{"meta":{"type":"object","required":["requested_range","effective_range","timezone","resolution","data_sources","accuracy","comparison_range","truncated","cached","partial","freshness"],"properties":{"requested_range":{"type":"object","required":["from","to"],"properties":{"from":{"type":"string","format":"date-time","pattern":"Z$"},"to":{"type":"string","format":"date-time","pattern":"Z$"}}},"effective_range":{"type":"object","required":["from","to"],"properties":{"from":{"type":"string","format":"date-time","pattern":"Z$"},"to":{"type":"string","format":"date-time","pattern":"Z$"}}},"timezone":{"type":"string","description":"An IANA time zone, e.g. Europe/Istanbul"},"resolution":{"enum":["minute","hour","day","week"]},"data_sources":{"type":"array","items":{"type":"string","const":"live"}},"accuracy":{"enum":["exact","estimated","provider_defined"]},"comparison_range":{"type":["object","null"],"required":["from","to"],"properties":{"from":{"type":"string","format":"date-time","pattern":"Z$"},"to":{"type":"string","format":"date-time","pattern":"Z$"}}},"truncated":{"type":"boolean","description":"The store capped the rows; the report is incomplete"},"cached":{"type":"boolean"},"partial":{"type":"boolean"},"freshness":{"type":"object","required":["state","watermark","as_of"],"properties":{"state":{"enum":["ok","no_data","stale","degraded"]},"watermark":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"as_of":{"type":"string","format":"date-time","pattern":"Z$"}}},"revenue":{"type":"object","required":["provider","connection_status","last_synced_at","last_webhook_at","rollup_through"],"properties":{"provider":{"type":["string","null"]},"connection_status":{"enum":["connected","degraded","disconnected","not_connected"]},"last_synced_at":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"last_webhook_at":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"rollup_through":{"type":["string","null"],"format":"date-time","pattern":"Z$"}}}}},"series":{"type":"array","items":{"type":"object","required":["bucket","events","pageviews","visits"],"properties":{"bucket":{"type":"string","format":"date-time","pattern":"Z$"},"events":{"type":"number"},"pageviews":{"type":"number"},"visits":{"type":"number"}}}},"comparison":{"type":["object","null"],"required":["series"],"properties":{"series":{"type":"array","items":{"type":"object","required":["bucket","events","pageviews","visits"],"properties":{"bucket":{"type":"string","format":"date-time","pattern":"Z$"},"events":{"type":"number"},"pageviews":{"type":"number"},"visits":{"type":"number"}}}}}}}}}}},"400":{"description":"Response for status 400","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"401":{"description":"Response for status 401","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"402":{"description":"Response for status 402","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"403":{"description":"Response for status 403","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"404":{"description":"Response for status 404","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"409":{"description":"Response for status 409","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"429":{"description":"Response for status 429","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"500":{"description":"Response for status 500","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"503":{"description":"Response for status 503","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}}}}},"/v1/sites/{site_id}/analytics/referrer-highlights":{"get":{"tags":["Analytics"],"operationId":"listReferrerHighlights","summary":"Referrers that dominated a time bucket","parameters":[{"name":"site_id","in":"path","required":true,"schema":{"type":"string","description":"The site id"}},{"name":"from","in":"query","required":true,"schema":{"type":"string","description":"Range start, an ISO-8601 UTC instant (inclusive)"}},{"name":"to","in":"query","required":true,"schema":{"type":"string","description":"Range end, an ISO-8601 UTC instant (exclusive)"}},{"name":"timezone","in":"query","required":true,"schema":{"type":"string","description":"IANA time zone the report buckets by, e.g. UTC"}},{"name":"filters","in":"query","required":false,"schema":{"type":"string","description":"A JSON array of {dimension, operator, values} filter clauses that keep only matching visits; values of one dimension are OR-ed, dimensions AND-ed. operator is eq or in. dimension is one of referrer_domain, country, city, device_type, hostname, utm_source, utm_medium, utm_campaign, utm_content, utm_term, browser, os, entry_page_path, page_path, event_name. entry_page_path is the landing page; page_path keeps a visit that viewed the path at least once"}},{"name":"resolution","in":"query","required":false,"schema":{"enum":["minute","hour","day","week"]}}],"responses":{"200":{"description":"Response for status 200","content":{"application/json":{"schema":{"type":"object","required":["meta","suppressed","items"],"properties":{"meta":{"type":"object","required":["requested_range","effective_range","timezone","resolution","data_sources","accuracy","comparison_range","truncated","cached","partial","freshness"],"properties":{"requested_range":{"type":"object","required":["from","to"],"properties":{"from":{"type":"string","format":"date-time","pattern":"Z$"},"to":{"type":"string","format":"date-time","pattern":"Z$"}}},"effective_range":{"type":"object","required":["from","to"],"properties":{"from":{"type":"string","format":"date-time","pattern":"Z$"},"to":{"type":"string","format":"date-time","pattern":"Z$"}}},"timezone":{"type":"string","description":"An IANA time zone, e.g. Europe/Istanbul"},"resolution":{"enum":["minute","hour","day","week"]},"data_sources":{"type":"array","items":{"type":"string","const":"live"}},"accuracy":{"enum":["exact","estimated","provider_defined"]},"comparison_range":{"type":["object","null"],"required":["from","to"],"properties":{"from":{"type":"string","format":"date-time","pattern":"Z$"},"to":{"type":"string","format":"date-time","pattern":"Z$"}}},"truncated":{"type":"boolean","description":"The store capped the rows; the report is incomplete"},"cached":{"type":"boolean"},"partial":{"type":"boolean"},"freshness":{"type":"object","required":["state","watermark","as_of"],"properties":{"state":{"enum":["ok","no_data","stale","degraded"]},"watermark":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"as_of":{"type":"string","format":"date-time","pattern":"Z$"}}},"revenue":{"type":"object","required":["provider","connection_status","last_synced_at","last_webhook_at","rollup_through"],"properties":{"provider":{"type":["string","null"]},"connection_status":{"enum":["connected","degraded","disconnected","not_connected"]},"last_synced_at":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"last_webhook_at":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"rollup_through":{"type":["string","null"],"format":"date-time","pattern":"Z$"}}}}},"suppressed":{"anyOf":[{"enum":["filtered","grain"]},{"type":"null"}]},"items":{"type":"array","items":{"type":"object","required":["bucket_start","referrer_domain","visits","bucket_visits","share_pct"],"properties":{"bucket_start":{"type":"string","format":"date-time","pattern":"Z$"},"referrer_domain":{"type":"string"},"visits":{"type":"number"},"bucket_visits":{"type":"number"},"share_pct":{"type":"number"}}}}}}}}},"400":{"description":"Response for status 400","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"401":{"description":"Response for status 401","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"402":{"description":"Response for status 402","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"403":{"description":"Response for status 403","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"404":{"description":"Response for status 404","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"409":{"description":"Response for status 409","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"429":{"description":"Response for status 429","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"500":{"description":"Response for status 500","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"503":{"description":"Response for status 503","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}}}}},"/v1/sites/{site_id}/analytics/pages":{"get":{"tags":["Analytics"],"operationId":"listTopPages","summary":"Top pages with entrances, exits, bounces and scroll depth","parameters":[{"name":"site_id","in":"path","required":true,"schema":{"type":"string","description":"The site id"}},{"name":"from","in":"query","required":true,"schema":{"type":"string","description":"Range start, an ISO-8601 UTC instant (inclusive)"}},{"name":"to","in":"query","required":true,"schema":{"type":"string","description":"Range end, an ISO-8601 UTC instant (exclusive)"}},{"name":"timezone","in":"query","required":true,"schema":{"type":"string","description":"IANA time zone the report buckets by, e.g. UTC"}},{"name":"filters","in":"query","required":false,"schema":{"type":"string","description":"A JSON array of {dimension, operator, values} filter clauses that keep only matching visits; values of one dimension are OR-ed, dimensions AND-ed. operator is eq or in. dimension is one of referrer_domain, country, city, device_type, hostname, utm_source, utm_medium, utm_campaign, utm_content, utm_term, browser, os, entry_page_path, page_path, event_name. entry_page_path is the landing page; page_path keeps a visit that viewed the path at least once"}},{"name":"limit","in":"query","required":false,"schema":{"type":"string","pattern":"^[0-9]{1,3}$","description":"Maximum rows, 1 to 500 (default 100)"}},{"name":"sort","in":"query","required":false,"schema":{"enum":["views","entrances","exits"],"default":"views"}}],"responses":{"200":{"description":"Response for status 200","content":{"application/json":{"schema":{"type":"object","required":["meta","hostnames_count","items"],"properties":{"meta":{"type":"object","required":["requested_range","effective_range","timezone","resolution","data_sources","accuracy","comparison_range","truncated","cached","partial","freshness"],"properties":{"requested_range":{"type":"object","required":["from","to"],"properties":{"from":{"type":"string","format":"date-time","pattern":"Z$"},"to":{"type":"string","format":"date-time","pattern":"Z$"}}},"effective_range":{"type":"object","required":["from","to"],"properties":{"from":{"type":"string","format":"date-time","pattern":"Z$"},"to":{"type":"string","format":"date-time","pattern":"Z$"}}},"timezone":{"type":"string","description":"An IANA time zone, e.g. Europe/Istanbul"},"resolution":{"enum":["minute","hour","day","week"]},"data_sources":{"type":"array","items":{"type":"string","const":"live"}},"accuracy":{"enum":["exact","estimated","provider_defined"]},"comparison_range":{"type":["object","null"],"required":["from","to"],"properties":{"from":{"type":"string","format":"date-time","pattern":"Z$"},"to":{"type":"string","format":"date-time","pattern":"Z$"}}},"truncated":{"type":"boolean","description":"The store capped the rows; the report is incomplete"},"cached":{"type":"boolean"},"partial":{"type":"boolean"},"freshness":{"type":"object","required":["state","watermark","as_of"],"properties":{"state":{"enum":["ok","no_data","stale","degraded"]},"watermark":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"as_of":{"type":"string","format":"date-time","pattern":"Z$"}}},"revenue":{"type":"object","required":["provider","connection_status","last_synced_at","last_webhook_at","rollup_through"],"properties":{"provider":{"type":["string","null"]},"connection_status":{"enum":["connected","degraded","disconnected","not_connected"]},"last_synced_at":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"last_webhook_at":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"rollup_through":{"type":["string","null"],"format":"date-time","pattern":"Z$"}}}}},"hostnames_count":{"type":"number"},"items":{"type":"array","items":{"type":"object","required":["hostname","page_path","views","visits","entrances","exits","bounces","bounce_rate"],"properties":{"hostname":{"type":"string"},"page_path":{"type":"string"},"views":{"type":"number"},"visits":{"type":"number"},"entrances":{"type":["number","null"]},"exits":{"type":["number","null"]},"bounces":{"type":["number","null"]},"bounce_rate":{"type":["number","null"]},"scroll_depth":{"type":["object","null"],"required":["samples","average_percent","reached_25","reached_50","reached_75","reached_100"],"properties":{"samples":{"type":"number"},"average_percent":{"type":"number"},"reached_25":{"type":"number"},"reached_50":{"type":"number"},"reached_75":{"type":"number"},"reached_100":{"type":"number"}}}}}}}}}}},"400":{"description":"Response for status 400","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"401":{"description":"Response for status 401","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"402":{"description":"Response for status 402","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"403":{"description":"Response for status 403","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"404":{"description":"Response for status 404","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"409":{"description":"Response for status 409","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"429":{"description":"Response for status 429","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"500":{"description":"Response for status 500","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"503":{"description":"Response for status 503","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}}}}},"/v1/sites/{site_id}/analytics/crawlers":{"get":{"tags":["Analytics"],"operationId":"getCrawlerTraffic","summary":"Crawler and bot hits by family, category and status","parameters":[{"name":"site_id","in":"path","required":true,"schema":{"type":"string","description":"The site id"}},{"name":"from","in":"query","required":true,"schema":{"type":"string","description":"Range start, an ISO-8601 UTC instant (inclusive)"}},{"name":"to","in":"query","required":true,"schema":{"type":"string","description":"Range end, an ISO-8601 UTC instant (exclusive)"}},{"name":"timezone","in":"query","required":true,"schema":{"type":"string","description":"IANA time zone the report buckets by, e.g. UTC"}}],"responses":{"200":{"description":"Response for status 200","content":{"application/json":{"schema":{"type":"object","required":["meta","totals","families","statuses","error_paths","timeseries"],"properties":{"meta":{"type":"object","required":["requested_range","effective_range","timezone","source_rollup","timeseries_grain","taxonomy_version","truncated"],"properties":{"requested_range":{"type":"object","required":["from","to"],"properties":{"from":{"type":"string","format":"date-time","pattern":"Z$"},"to":{"type":"string","format":"date-time","pattern":"Z$"}}},"effective_range":{"type":"object","required":["from","to"],"properties":{"from":{"type":"string","format":"date-time","pattern":"Z$"},"to":{"type":"string","format":"date-time","pattern":"Z$"}}},"timezone":{"type":"string"},"source_rollup":{"enum":["15m","1d"]},"timeseries_grain":{"enum":["hour","day"]},"taxonomy_version":{"type":"number"},"truncated":{"type":"boolean"}}},"totals":{"type":"object","required":["hits","categories"],"properties":{"hits":{"type":"number"},"categories":{"type":"array","items":{"type":"object","required":["category","hits","share"],"properties":{"category":{"enum":["ai_training","ai_search","ai_assistant","search_engine","seo_tool","social_preview","archiver","other"]},"hits":{"type":"number"},"share":{"type":"number"}}}}}},"families":{"type":"array","items":{"type":"object","required":["family","name","operator","category","hits","paths","top_paths"],"properties":{"family":{"type":"string"},"name":{"type":"string"},"operator":{"type":"string"},"category":{"enum":["ai_training","ai_search","ai_assistant","search_engine","seo_tool","social_preview","archiver","other"]},"hits":{"type":"number"},"paths":{"type":"number"},"top_paths":{"type":"array","items":{"type":"object","required":["hostname","path","hits"],"properties":{"hostname":{"type":"string"},"path":{"type":"string"},"hits":{"type":"number"}}}}}}},"statuses":{"type":"array","items":{"type":"object","required":["category","status","hits"],"properties":{"category":{"enum":["ai_training","ai_search","ai_assistant","search_engine","seo_tool","social_preview","archiver","other"]},"status":{"type":"number"},"hits":{"type":"number"}}}},"error_paths":{"type":"array","items":{"type":"object","required":["category","hostname","path","status","hits"],"properties":{"category":{"enum":["ai_training","ai_search","ai_assistant","search_engine","seo_tool","social_preview","archiver","other"]},"hostname":{"type":"string"},"path":{"type":"string"},"status":{"type":"number"},"hits":{"type":"number"}}}},"timeseries":{"type":"array","items":{"type":"object","required":["bucket","hits","categories"],"properties":{"bucket":{"type":"string","format":"date-time","pattern":"Z$"},"hits":{"type":"number"},"categories":{"type":"object","required":["ai_training","ai_search","ai_assistant","search_engine","seo_tool","social_preview","archiver","other"],"properties":{"ai_training":{"type":"number"},"ai_search":{"type":"number"},"ai_assistant":{"type":"number"},"search_engine":{"type":"number"},"seo_tool":{"type":"number"},"social_preview":{"type":"number"},"archiver":{"type":"number"},"other":{"type":"number"}}}}}}}}}}},"400":{"description":"Response for status 400","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"401":{"description":"Response for status 401","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"402":{"description":"Response for status 402","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"403":{"description":"Response for status 403","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"404":{"description":"Response for status 404","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"409":{"description":"Response for status 409","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"429":{"description":"Response for status 429","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"500":{"description":"Response for status 500","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"503":{"description":"Response for status 503","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}}}}},"/v1/sites/{site_id}/analytics/links":{"get":{"tags":["Analytics"],"operationId":"getLinkClicks","summary":"Short link clicks and visitors over a range","parameters":[{"name":"site_id","in":"path","required":true,"schema":{"type":"string","description":"The site id"}},{"name":"from","in":"query","required":true,"schema":{"type":"string","description":"Range start, an ISO-8601 UTC instant (inclusive)"}},{"name":"to","in":"query","required":true,"schema":{"type":"string","description":"Range end, an ISO-8601 UTC instant (exclusive)"}},{"name":"timezone","in":"query","required":true,"schema":{"type":"string","description":"IANA time zone the report buckets by, e.g. UTC"}},{"name":"link_id","in":"query","required":false,"schema":{"type":"string","description":"Only this link (UUID); all links if absent"}},{"name":"compare","in":"query","required":false,"schema":{"enum":["true","false"],"description":"Also report the preceding period of equal length"}}],"responses":{"200":{"description":"Response for status 200","content":{"application/json":{"schema":{"type":"object","required":["meta","totals","series","links"],"properties":{"meta":{"type":"object","required":["requested_range","effective_range","timezone","resolution","data_sources","accuracy","comparison_range","truncated","cached","partial","freshness"],"properties":{"requested_range":{"type":"object","required":["from","to"],"properties":{"from":{"type":"string","format":"date-time","pattern":"Z$"},"to":{"type":"string","format":"date-time","pattern":"Z$"}}},"effective_range":{"type":"object","required":["from","to"],"properties":{"from":{"type":"string","format":"date-time","pattern":"Z$"},"to":{"type":"string","format":"date-time","pattern":"Z$"}}},"timezone":{"type":"string","description":"An IANA time zone, e.g. Europe/Istanbul"},"resolution":{"enum":["minute","hour","day","week"]},"data_sources":{"type":"array","items":{"type":"string","const":"live"}},"accuracy":{"enum":["exact","estimated","provider_defined"]},"comparison_range":{"type":["object","null"],"required":["from","to"],"properties":{"from":{"type":"string","format":"date-time","pattern":"Z$"},"to":{"type":"string","format":"date-time","pattern":"Z$"}}},"truncated":{"type":"boolean","description":"The store capped the rows; the report is incomplete"},"cached":{"type":"boolean"},"partial":{"type":"boolean"},"freshness":{"type":"object","required":["state","watermark","as_of"],"properties":{"state":{"enum":["ok","no_data","stale","degraded"]},"watermark":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"as_of":{"type":"string","format":"date-time","pattern":"Z$"}}},"revenue":{"type":"object","required":["provider","connection_status","last_synced_at","last_webhook_at","rollup_through"],"properties":{"provider":{"type":["string","null"]},"connection_status":{"enum":["connected","degraded","disconnected","not_connected"]},"last_synced_at":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"last_webhook_at":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"rollup_through":{"type":["string","null"],"format":"date-time","pattern":"Z$"}}}}},"totals":{"type":"object","required":["clicks","visitors"],"properties":{"clicks":{"type":"number"},"visitors":{"type":"number"}}},"comparison":{"type":"object","required":["range","totals"],"properties":{"range":{"type":"object","required":["from","to"],"properties":{"from":{"type":"string","format":"date-time","pattern":"Z$"},"to":{"type":"string","format":"date-time","pattern":"Z$"}}},"totals":{"type":"object","required":["clicks","visitors"],"properties":{"clicks":{"type":"number"},"visitors":{"type":"number"}}}}},"series":{"type":"array","items":{"type":"object","required":["bucket","clicks","visitors"],"properties":{"bucket":{"type":"string","format":"date-time","pattern":"Z$"},"clicks":{"type":"number"},"visitors":{"type":"number"}}}},"links":{"type":"array","items":{"type":"object","required":["link_id","clicks","visitors"],"properties":{"link_id":{"type":"string"},"clicks":{"type":"number"},"visitors":{"type":"number"}}}}}}}}},"400":{"description":"Response for status 400","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"401":{"description":"Response for status 401","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"402":{"description":"Response for status 402","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"403":{"description":"Response for status 403","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"404":{"description":"Response for status 404","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"409":{"description":"Response for status 409","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"429":{"description":"Response for status 429","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"500":{"description":"Response for status 500","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"503":{"description":"Response for status 503","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}}}}},"/v1/sites/{site_id}/analytics/links/breakdown":{"get":{"tags":["Analytics"],"operationId":"getLinkClickBreakdown","summary":"Short link clicks broken down by one dimension","parameters":[{"name":"site_id","in":"path","required":true,"schema":{"type":"string","description":"The site id"}},{"name":"from","in":"query","required":true,"schema":{"type":"string","description":"Range start, an ISO-8601 UTC instant (inclusive)"}},{"name":"to","in":"query","required":true,"schema":{"type":"string","description":"Range end, an ISO-8601 UTC instant (exclusive)"}},{"name":"timezone","in":"query","required":true,"schema":{"type":"string","description":"IANA time zone the report buckets by, e.g. UTC"}},{"name":"link_id","in":"query","required":false,"schema":{"type":"string","description":"Only this link (UUID); all links if absent"}},{"name":"limit","in":"query","required":false,"schema":{"type":"string","pattern":"^[0-9]{1,3}$","description":"Maximum rows, 1 to 500 (default 100)"}},{"name":"dimension","in":"query","required":true,"schema":{"enum":["referrer","country","region","city","device","browser","os"]}}],"responses":{"200":{"description":"Response for status 200","content":{"application/json":{"schema":{"type":"object","required":["meta","dimension","rows"],"properties":{"meta":{"type":"object","required":["requested_range","effective_range","timezone","resolution","data_sources","accuracy","comparison_range","truncated","cached","partial","freshness"],"properties":{"requested_range":{"type":"object","required":["from","to"],"properties":{"from":{"type":"string","format":"date-time","pattern":"Z$"},"to":{"type":"string","format":"date-time","pattern":"Z$"}}},"effective_range":{"type":"object","required":["from","to"],"properties":{"from":{"type":"string","format":"date-time","pattern":"Z$"},"to":{"type":"string","format":"date-time","pattern":"Z$"}}},"timezone":{"type":"string","description":"An IANA time zone, e.g. Europe/Istanbul"},"resolution":{"enum":["minute","hour","day","week"]},"data_sources":{"type":"array","items":{"type":"string","const":"live"}},"accuracy":{"enum":["exact","estimated","provider_defined"]},"comparison_range":{"type":["object","null"],"required":["from","to"],"properties":{"from":{"type":"string","format":"date-time","pattern":"Z$"},"to":{"type":"string","format":"date-time","pattern":"Z$"}}},"truncated":{"type":"boolean","description":"The store capped the rows; the report is incomplete"},"cached":{"type":"boolean"},"partial":{"type":"boolean"},"freshness":{"type":"object","required":["state","watermark","as_of"],"properties":{"state":{"enum":["ok","no_data","stale","degraded"]},"watermark":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"as_of":{"type":"string","format":"date-time","pattern":"Z$"}}},"revenue":{"type":"object","required":["provider","connection_status","last_synced_at","last_webhook_at","rollup_through"],"properties":{"provider":{"type":["string","null"]},"connection_status":{"enum":["connected","degraded","disconnected","not_connected"]},"last_synced_at":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"last_webhook_at":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"rollup_through":{"type":["string","null"],"format":"date-time","pattern":"Z$"}}}}},"dimension":{"enum":["referrer","country","region","city","device","browser","os"]},"rows":{"type":"array","items":{"type":"object","required":["value","country","clicks","share"],"properties":{"value":{"type":"string"},"country":{"type":"string"},"clicks":{"type":"number"},"share":{"type":"number"}}}}}}}}},"400":{"description":"Response for status 400","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"401":{"description":"Response for status 401","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"402":{"description":"Response for status 402","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"403":{"description":"Response for status 403","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"404":{"description":"Response for status 404","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"409":{"description":"Response for status 409","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"429":{"description":"Response for status 429","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"500":{"description":"Response for status 500","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"503":{"description":"Response for status 503","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}}}}},"/v1/sites/{site_id}/analytics/crawlers/paths":{"get":{"tags":["Analytics"],"operationId":"listCrawlerPaths","summary":"The paths one crawler family hit","parameters":[{"name":"site_id","in":"path","required":true,"schema":{"type":"string","description":"The site id"}},{"name":"from","in":"query","required":true,"schema":{"type":"string","description":"Range start, an ISO-8601 UTC instant (inclusive)"}},{"name":"to","in":"query","required":true,"schema":{"type":"string","description":"Range end, an ISO-8601 UTC instant (exclusive)"}},{"name":"timezone","in":"query","required":true,"schema":{"type":"string","description":"IANA time zone the report buckets by, e.g. UTC"}},{"name":"family","in":"query","required":true,"schema":{"type":"string","pattern":"^[a-z0-9][a-z0-9-]{0,63}$","description":"Crawler family id"}}],"responses":{"200":{"description":"Response for status 200","content":{"application/json":{"schema":{"type":"object","required":["meta","family","paths"],"properties":{"meta":{"type":"object","required":["requested_range","effective_range","timezone","source_rollup","truncated"],"properties":{"requested_range":{"type":"object","required":["from","to"],"properties":{"from":{"type":"string","format":"date-time","pattern":"Z$"},"to":{"type":"string","format":"date-time","pattern":"Z$"}}},"effective_range":{"type":"object","required":["from","to"],"properties":{"from":{"type":"string","format":"date-time","pattern":"Z$"},"to":{"type":"string","format":"date-time","pattern":"Z$"}}},"timezone":{"type":"string"},"source_rollup":{"enum":["15m","1d"]},"truncated":{"type":"boolean"}}},"family":{"type":"string"},"paths":{"type":"array","items":{"type":"object","required":["hostname","path","hits"],"properties":{"hostname":{"type":"string"},"path":{"type":"string"},"hits":{"type":"number"}}}}}}}}},"400":{"description":"Response for status 400","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"401":{"description":"Response for status 401","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"402":{"description":"Response for status 402","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"403":{"description":"Response for status 403","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"404":{"description":"Response for status 404","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"409":{"description":"Response for status 409","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"429":{"description":"Response for status 429","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"500":{"description":"Response for status 500","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"503":{"description":"Response for status 503","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}}}}},"/v1/sites/{site_id}/analytics/sources":{"get":{"tags":["Analytics"],"operationId":"listTrafficSources","summary":"Top referrers and UTM sources","parameters":[{"name":"site_id","in":"path","required":true,"schema":{"type":"string","description":"The site id"}},{"name":"from","in":"query","required":true,"schema":{"type":"string","description":"Range start, an ISO-8601 UTC instant (inclusive)"}},{"name":"to","in":"query","required":true,"schema":{"type":"string","description":"Range end, an ISO-8601 UTC instant (exclusive)"}},{"name":"timezone","in":"query","required":true,"schema":{"type":"string","description":"IANA time zone the report buckets by, e.g. UTC"}},{"name":"filters","in":"query","required":false,"schema":{"type":"string","description":"A JSON array of {dimension, operator, values} filter clauses that keep only matching visits; values of one dimension are OR-ed, dimensions AND-ed. operator is eq or in. dimension is one of referrer_domain, country, city, device_type, hostname, utm_source, utm_medium, utm_campaign, utm_content, utm_term, browser, os, entry_page_path, page_path, event_name. entry_page_path is the landing page; page_path keeps a visit that viewed the path at least once"}},{"name":"limit","in":"query","required":false,"schema":{"type":"string","pattern":"^[0-9]{1,3}$","description":"Maximum rows, 1 to 500 (default 100)"}}],"responses":{"200":{"description":"Response for status 200","content":{"application/json":{"schema":{"type":"object","required":["meta","items"],"properties":{"meta":{"type":"object","required":["requested_range","effective_range","timezone","resolution","data_sources","accuracy","comparison_range","truncated","cached","partial","freshness"],"properties":{"requested_range":{"type":"object","required":["from","to"],"properties":{"from":{"type":"string","format":"date-time","pattern":"Z$"},"to":{"type":"string","format":"date-time","pattern":"Z$"}}},"effective_range":{"type":"object","required":["from","to"],"properties":{"from":{"type":"string","format":"date-time","pattern":"Z$"},"to":{"type":"string","format":"date-time","pattern":"Z$"}}},"timezone":{"type":"string","description":"An IANA time zone, e.g. Europe/Istanbul"},"resolution":{"enum":["minute","hour","day","week"]},"data_sources":{"type":"array","items":{"type":"string","const":"live"}},"accuracy":{"enum":["exact","estimated","provider_defined"]},"comparison_range":{"type":["object","null"],"required":["from","to"],"properties":{"from":{"type":"string","format":"date-time","pattern":"Z$"},"to":{"type":"string","format":"date-time","pattern":"Z$"}}},"truncated":{"type":"boolean","description":"The store capped the rows; the report is incomplete"},"cached":{"type":"boolean"},"partial":{"type":"boolean"},"freshness":{"type":"object","required":["state","watermark","as_of"],"properties":{"state":{"enum":["ok","no_data","stale","degraded"]},"watermark":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"as_of":{"type":"string","format":"date-time","pattern":"Z$"}}},"revenue":{"type":"object","required":["provider","connection_status","last_synced_at","last_webhook_at","rollup_through"],"properties":{"provider":{"type":["string","null"]},"connection_status":{"enum":["connected","degraded","disconnected","not_connected"]},"last_synced_at":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"last_webhook_at":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"rollup_through":{"type":["string","null"],"format":"date-time","pattern":"Z$"}}}}},"items":{"type":"array","items":{"type":"object","required":["referrer_domain","utm_source","utm_medium","utm_campaign","views","visits"],"properties":{"referrer_domain":{"type":"string"},"utm_source":{"type":"string"},"utm_medium":{"type":"string"},"utm_campaign":{"type":"string"},"views":{"type":"number"},"visits":{"type":"number"}}}}}}}}},"400":{"description":"Response for status 400","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"401":{"description":"Response for status 401","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"402":{"description":"Response for status 402","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"403":{"description":"Response for status 403","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"404":{"description":"Response for status 404","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"409":{"description":"Response for status 409","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"429":{"description":"Response for status 429","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"500":{"description":"Response for status 500","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"503":{"description":"Response for status 503","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}}}}},"/v1/sites/{site_id}/analytics/geography":{"get":{"tags":["Analytics"],"operationId":"listVisitorLocations","summary":"Top countries, regions or cities","parameters":[{"name":"site_id","in":"path","required":true,"schema":{"type":"string","description":"The site id"}},{"name":"from","in":"query","required":true,"schema":{"type":"string","description":"Range start, an ISO-8601 UTC instant (inclusive)"}},{"name":"to","in":"query","required":true,"schema":{"type":"string","description":"Range end, an ISO-8601 UTC instant (exclusive)"}},{"name":"timezone","in":"query","required":true,"schema":{"type":"string","description":"IANA time zone the report buckets by, e.g. UTC"}},{"name":"filters","in":"query","required":false,"schema":{"type":"string","description":"A JSON array of {dimension, operator, values} filter clauses that keep only matching visits; values of one dimension are OR-ed, dimensions AND-ed. operator is eq or in. dimension is one of referrer_domain, country, city, device_type, hostname, utm_source, utm_medium, utm_campaign, utm_content, utm_term, browser, os, entry_page_path, page_path, event_name. entry_page_path is the landing page; page_path keeps a visit that viewed the path at least once"}},{"name":"limit","in":"query","required":false,"schema":{"type":"string","pattern":"^[0-9]{1,3}$","description":"Maximum rows, 1 to 500 (default 100)"}},{"name":"level","in":"query","required":false,"schema":{"enum":["country","region","city"],"default":"city"}}],"responses":{"200":{"description":"Response for status 200","content":{"application/json":{"schema":{"type":"object","required":["meta","items"],"properties":{"meta":{"type":"object","required":["requested_range","effective_range","timezone","resolution","data_sources","accuracy","comparison_range","truncated","cached","partial","freshness"],"properties":{"requested_range":{"type":"object","required":["from","to"],"properties":{"from":{"type":"string","format":"date-time","pattern":"Z$"},"to":{"type":"string","format":"date-time","pattern":"Z$"}}},"effective_range":{"type":"object","required":["from","to"],"properties":{"from":{"type":"string","format":"date-time","pattern":"Z$"},"to":{"type":"string","format":"date-time","pattern":"Z$"}}},"timezone":{"type":"string","description":"An IANA time zone, e.g. Europe/Istanbul"},"resolution":{"enum":["minute","hour","day","week"]},"data_sources":{"type":"array","items":{"type":"string","const":"live"}},"accuracy":{"enum":["exact","estimated","provider_defined"]},"comparison_range":{"type":["object","null"],"required":["from","to"],"properties":{"from":{"type":"string","format":"date-time","pattern":"Z$"},"to":{"type":"string","format":"date-time","pattern":"Z$"}}},"truncated":{"type":"boolean","description":"The store capped the rows; the report is incomplete"},"cached":{"type":"boolean"},"partial":{"type":"boolean"},"freshness":{"type":"object","required":["state","watermark","as_of"],"properties":{"state":{"enum":["ok","no_data","stale","degraded"]},"watermark":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"as_of":{"type":"string","format":"date-time","pattern":"Z$"}}},"revenue":{"type":"object","required":["provider","connection_status","last_synced_at","last_webhook_at","rollup_through"],"properties":{"provider":{"type":["string","null"]},"connection_status":{"enum":["connected","degraded","disconnected","not_connected"]},"last_synced_at":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"last_webhook_at":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"rollup_through":{"type":["string","null"],"format":"date-time","pattern":"Z$"}}}}},"items":{"type":"array","items":{"type":"object","required":["country","region","city","views","visits"],"properties":{"country":{"type":"string"},"region":{"type":"string"},"city":{"type":"string"},"views":{"type":"number"},"visits":{"type":"number"}}}}}}}}},"400":{"description":"Response for status 400","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"401":{"description":"Response for status 401","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"402":{"description":"Response for status 402","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"403":{"description":"Response for status 403","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"404":{"description":"Response for status 404","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"409":{"description":"Response for status 409","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"429":{"description":"Response for status 429","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"500":{"description":"Response for status 500","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"503":{"description":"Response for status 503","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}}}}},"/v1/sites/{site_id}/analytics/devices":{"get":{"tags":["Analytics"],"operationId":"listVisitorDevices","summary":"Top device types, browsers and operating systems","parameters":[{"name":"site_id","in":"path","required":true,"schema":{"type":"string","description":"The site id"}},{"name":"from","in":"query","required":true,"schema":{"type":"string","description":"Range start, an ISO-8601 UTC instant (inclusive)"}},{"name":"to","in":"query","required":true,"schema":{"type":"string","description":"Range end, an ISO-8601 UTC instant (exclusive)"}},{"name":"timezone","in":"query","required":true,"schema":{"type":"string","description":"IANA time zone the report buckets by, e.g. UTC"}},{"name":"filters","in":"query","required":false,"schema":{"type":"string","description":"A JSON array of {dimension, operator, values} filter clauses that keep only matching visits; values of one dimension are OR-ed, dimensions AND-ed. operator is eq or in. dimension is one of referrer_domain, country, city, device_type, hostname, utm_source, utm_medium, utm_campaign, utm_content, utm_term, browser, os, entry_page_path, page_path, event_name. entry_page_path is the landing page; page_path keeps a visit that viewed the path at least once"}},{"name":"limit","in":"query","required":false,"schema":{"type":"string","pattern":"^[0-9]{1,3}$","description":"Maximum rows, 1 to 500 (default 100)"}}],"responses":{"200":{"description":"Response for status 200","content":{"application/json":{"schema":{"type":"object","required":["meta","items"],"properties":{"meta":{"type":"object","required":["requested_range","effective_range","timezone","resolution","data_sources","accuracy","comparison_range","truncated","cached","partial","freshness"],"properties":{"requested_range":{"type":"object","required":["from","to"],"properties":{"from":{"type":"string","format":"date-time","pattern":"Z$"},"to":{"type":"string","format":"date-time","pattern":"Z$"}}},"effective_range":{"type":"object","required":["from","to"],"properties":{"from":{"type":"string","format":"date-time","pattern":"Z$"},"to":{"type":"string","format":"date-time","pattern":"Z$"}}},"timezone":{"type":"string","description":"An IANA time zone, e.g. Europe/Istanbul"},"resolution":{"enum":["minute","hour","day","week"]},"data_sources":{"type":"array","items":{"type":"string","const":"live"}},"accuracy":{"enum":["exact","estimated","provider_defined"]},"comparison_range":{"type":["object","null"],"required":["from","to"],"properties":{"from":{"type":"string","format":"date-time","pattern":"Z$"},"to":{"type":"string","format":"date-time","pattern":"Z$"}}},"truncated":{"type":"boolean","description":"The store capped the rows; the report is incomplete"},"cached":{"type":"boolean"},"partial":{"type":"boolean"},"freshness":{"type":"object","required":["state","watermark","as_of"],"properties":{"state":{"enum":["ok","no_data","stale","degraded"]},"watermark":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"as_of":{"type":"string","format":"date-time","pattern":"Z$"}}},"revenue":{"type":"object","required":["provider","connection_status","last_synced_at","last_webhook_at","rollup_through"],"properties":{"provider":{"type":["string","null"]},"connection_status":{"enum":["connected","degraded","disconnected","not_connected"]},"last_synced_at":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"last_webhook_at":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"rollup_through":{"type":["string","null"],"format":"date-time","pattern":"Z$"}}}}},"items":{"type":"array","items":{"type":"object","required":["device_type","browser","os","views","visits"],"properties":{"device_type":{"type":"string"},"browser":{"type":"string"},"os":{"type":"string"},"views":{"type":"number"},"visits":{"type":"number"}}}}}}}}},"400":{"description":"Response for status 400","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"401":{"description":"Response for status 401","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"402":{"description":"Response for status 402","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"403":{"description":"Response for status 403","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"404":{"description":"Response for status 404","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"409":{"description":"Response for status 409","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"429":{"description":"Response for status 429","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"500":{"description":"Response for status 500","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"503":{"description":"Response for status 503","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}}}}},"/v1/sites/{site_id}/analytics/languages":{"get":{"tags":["Analytics"],"operationId":"listVisitorLanguages","summary":"Top browser languages","parameters":[{"name":"site_id","in":"path","required":true,"schema":{"type":"string","description":"The site id"}},{"name":"from","in":"query","required":true,"schema":{"type":"string","description":"Range start, an ISO-8601 UTC instant (inclusive)"}},{"name":"to","in":"query","required":true,"schema":{"type":"string","description":"Range end, an ISO-8601 UTC instant (exclusive)"}},{"name":"timezone","in":"query","required":true,"schema":{"type":"string","description":"IANA time zone the report buckets by, e.g. UTC"}},{"name":"filters","in":"query","required":false,"schema":{"type":"string","description":"A JSON array of {dimension, operator, values} filter clauses that keep only matching visits; values of one dimension are OR-ed, dimensions AND-ed. operator is eq or in. dimension is one of referrer_domain, country, city, device_type, hostname, utm_source, utm_medium, utm_campaign, utm_content, utm_term, browser, os, entry_page_path, page_path, event_name. entry_page_path is the landing page; page_path keeps a visit that viewed the path at least once"}},{"name":"limit","in":"query","required":false,"schema":{"type":"string","pattern":"^[0-9]{1,3}$","description":"Maximum rows, 1 to 500 (default 100)"}}],"responses":{"200":{"description":"Response for status 200","content":{"application/json":{"schema":{"type":"object","required":["meta","items"],"properties":{"meta":{"type":"object","required":["requested_range","effective_range","timezone","resolution","data_sources","accuracy","comparison_range","truncated","cached","partial","freshness"],"properties":{"requested_range":{"type":"object","required":["from","to"],"properties":{"from":{"type":"string","format":"date-time","pattern":"Z$"},"to":{"type":"string","format":"date-time","pattern":"Z$"}}},"effective_range":{"type":"object","required":["from","to"],"properties":{"from":{"type":"string","format":"date-time","pattern":"Z$"},"to":{"type":"string","format":"date-time","pattern":"Z$"}}},"timezone":{"type":"string","description":"An IANA time zone, e.g. Europe/Istanbul"},"resolution":{"enum":["minute","hour","day","week"]},"data_sources":{"type":"array","items":{"type":"string","const":"live"}},"accuracy":{"enum":["exact","estimated","provider_defined"]},"comparison_range":{"type":["object","null"],"required":["from","to"],"properties":{"from":{"type":"string","format":"date-time","pattern":"Z$"},"to":{"type":"string","format":"date-time","pattern":"Z$"}}},"truncated":{"type":"boolean","description":"The store capped the rows; the report is incomplete"},"cached":{"type":"boolean"},"partial":{"type":"boolean"},"freshness":{"type":"object","required":["state","watermark","as_of"],"properties":{"state":{"enum":["ok","no_data","stale","degraded"]},"watermark":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"as_of":{"type":"string","format":"date-time","pattern":"Z$"}}},"revenue":{"type":"object","required":["provider","connection_status","last_synced_at","last_webhook_at","rollup_through"],"properties":{"provider":{"type":["string","null"]},"connection_status":{"enum":["connected","degraded","disconnected","not_connected"]},"last_synced_at":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"last_webhook_at":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"rollup_through":{"type":["string","null"],"format":"date-time","pattern":"Z$"}}}}},"items":{"type":"array","items":{"type":"object","required":["language","views","visits"],"properties":{"language":{"type":"string"},"views":{"type":"number"},"visits":{"type":"number"}}}}}}}}},"400":{"description":"Response for status 400","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"401":{"description":"Response for status 401","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"402":{"description":"Response for status 402","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"403":{"description":"Response for status 403","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"404":{"description":"Response for status 404","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"409":{"description":"Response for status 409","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"429":{"description":"Response for status 429","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"500":{"description":"Response for status 500","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"503":{"description":"Response for status 503","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}}}}},"/v1/sites/{site_id}/analytics/outbound":{"get":{"tags":["Analytics"],"operationId":"listOutboundClicks","summary":"Outbound link clicks by domain or by link","parameters":[{"name":"site_id","in":"path","required":true,"schema":{"type":"string","description":"The site id"}},{"name":"from","in":"query","required":true,"schema":{"type":"string","description":"Range start, an ISO-8601 UTC instant (inclusive)"}},{"name":"to","in":"query","required":true,"schema":{"type":"string","description":"Range end, an ISO-8601 UTC instant (exclusive)"}},{"name":"timezone","in":"query","required":true,"schema":{"type":"string","description":"IANA time zone the report buckets by, e.g. UTC"}},{"name":"filters","in":"query","required":false,"schema":{"type":"string","description":"A JSON array of {dimension, operator, values} filter clauses that keep only matching visits; values of one dimension are OR-ed, dimensions AND-ed. operator is eq or in. dimension is one of referrer_domain, country, city, device_type, hostname, utm_source, utm_medium, utm_campaign, utm_content, utm_term, browser, os, entry_page_path, page_path, event_name. entry_page_path is the landing page; page_path keeps a visit that viewed the path at least once"}},{"name":"limit","in":"query","required":false,"schema":{"type":"string","pattern":"^[0-9]{1,3}$","description":"Maximum rows, 1 to 500 (default 100)"}},{"name":"level","in":"query","required":false,"schema":{"enum":["domain","link"],"default":"domain"}},{"name":"domain","in":"query","required":false,"schema":{"type":"string","description":"Only links to this hostname; meaningful with level=link"}}],"responses":{"200":{"description":"Response for status 200","content":{"application/json":{"schema":{"type":"object","required":["meta","level","items"],"properties":{"meta":{"type":"object","required":["requested_range","effective_range","timezone","resolution","data_sources","accuracy","comparison_range","truncated","cached","partial","freshness"],"properties":{"requested_range":{"type":"object","required":["from","to"],"properties":{"from":{"type":"string","format":"date-time","pattern":"Z$"},"to":{"type":"string","format":"date-time","pattern":"Z$"}}},"effective_range":{"type":"object","required":["from","to"],"properties":{"from":{"type":"string","format":"date-time","pattern":"Z$"},"to":{"type":"string","format":"date-time","pattern":"Z$"}}},"timezone":{"type":"string","description":"An IANA time zone, e.g. Europe/Istanbul"},"resolution":{"enum":["minute","hour","day","week"]},"data_sources":{"type":"array","items":{"type":"string","const":"live"}},"accuracy":{"enum":["exact","estimated","provider_defined"]},"comparison_range":{"type":["object","null"],"required":["from","to"],"properties":{"from":{"type":"string","format":"date-time","pattern":"Z$"},"to":{"type":"string","format":"date-time","pattern":"Z$"}}},"truncated":{"type":"boolean","description":"The store capped the rows; the report is incomplete"},"cached":{"type":"boolean"},"partial":{"type":"boolean"},"freshness":{"type":"object","required":["state","watermark","as_of"],"properties":{"state":{"enum":["ok","no_data","stale","degraded"]},"watermark":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"as_of":{"type":"string","format":"date-time","pattern":"Z$"}}},"revenue":{"type":"object","required":["provider","connection_status","last_synced_at","last_webhook_at","rollup_through"],"properties":{"provider":{"type":["string","null"]},"connection_status":{"enum":["connected","degraded","disconnected","not_connected"]},"last_synced_at":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"last_webhook_at":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"rollup_through":{"type":["string","null"],"format":"date-time","pattern":"Z$"}}}}},"level":{"enum":["domain","link"]},"items":{"type":"array","items":{"type":"object","required":["domain","url","clicks","visits"],"properties":{"domain":{"type":"string"},"url":{"type":["string","null"]},"clicks":{"type":"number"},"visits":{"type":"number"}}}}}}}}},"400":{"description":"Response for status 400","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"401":{"description":"Response for status 401","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"402":{"description":"Response for status 402","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"403":{"description":"Response for status 403","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"404":{"description":"Response for status 404","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"409":{"description":"Response for status 409","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"429":{"description":"Response for status 429","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"500":{"description":"Response for status 500","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"503":{"description":"Response for status 503","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}}}}},"/v1/sites/{site_id}/analytics/custom-events":{"get":{"tags":["Analytics"],"operationId":"listCustomEvents","summary":"Custom events with counts and display labels","parameters":[{"name":"site_id","in":"path","required":true,"schema":{"type":"string","description":"The site id"}},{"name":"from","in":"query","required":true,"schema":{"type":"string","description":"Range start, an ISO-8601 UTC instant (inclusive)"}},{"name":"to","in":"query","required":true,"schema":{"type":"string","description":"Range end, an ISO-8601 UTC instant (exclusive)"}},{"name":"timezone","in":"query","required":true,"schema":{"type":"string","description":"IANA time zone the report buckets by, e.g. UTC"}},{"name":"filters","in":"query","required":false,"schema":{"type":"string","description":"A JSON array of {dimension, operator, values} filter clauses that keep only matching visits; values of one dimension are OR-ed, dimensions AND-ed. operator is eq or in. dimension is one of referrer_domain, country, city, device_type, hostname, utm_source, utm_medium, utm_campaign, utm_content, utm_term, browser, os, entry_page_path, page_path, event_name. entry_page_path is the landing page; page_path keeps a visit that viewed the path at least once"}},{"name":"limit","in":"query","required":false,"schema":{"type":"string","pattern":"^[0-9]{1,3}$","description":"Maximum rows, 1 to 500 (default 100)"}},{"name":"event_property","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"},"description":"Repeatable <key>=<value> event property filter, at most 5"}}],"responses":{"200":{"description":"Response for status 200","content":{"application/json":{"schema":{"type":"object","required":["meta","items"],"properties":{"meta":{"type":"object","required":["requested_range","effective_range","timezone","resolution","data_sources","accuracy","comparison_range","truncated","cached","partial","freshness"],"properties":{"requested_range":{"type":"object","required":["from","to"],"properties":{"from":{"type":"string","format":"date-time","pattern":"Z$"},"to":{"type":"string","format":"date-time","pattern":"Z$"}}},"effective_range":{"type":"object","required":["from","to"],"properties":{"from":{"type":"string","format":"date-time","pattern":"Z$"},"to":{"type":"string","format":"date-time","pattern":"Z$"}}},"timezone":{"type":"string","description":"An IANA time zone, e.g. Europe/Istanbul"},"resolution":{"enum":["minute","hour","day","week"]},"data_sources":{"type":"array","items":{"type":"string","const":"live"}},"accuracy":{"enum":["exact","estimated","provider_defined"]},"comparison_range":{"type":["object","null"],"required":["from","to"],"properties":{"from":{"type":"string","format":"date-time","pattern":"Z$"},"to":{"type":"string","format":"date-time","pattern":"Z$"}}},"truncated":{"type":"boolean","description":"The store capped the rows; the report is incomplete"},"cached":{"type":"boolean"},"partial":{"type":"boolean"},"freshness":{"type":"object","required":["state","watermark","as_of"],"properties":{"state":{"enum":["ok","no_data","stale","degraded"]},"watermark":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"as_of":{"type":"string","format":"date-time","pattern":"Z$"}}},"revenue":{"type":"object","required":["provider","connection_status","last_synced_at","last_webhook_at","rollup_through"],"properties":{"provider":{"type":["string","null"]},"connection_status":{"enum":["connected","degraded","disconnected","not_connected"]},"last_synced_at":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"last_webhook_at":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"rollup_through":{"type":["string","null"],"format":"date-time","pattern":"Z$"}}}}},"items":{"type":"array","items":{"type":"object","required":["event_name","event_type","events","visits","display_name","display_template"],"properties":{"event_name":{"type":"string"},"event_type":{"type":"string"},"events":{"type":"number"},"visits":{"type":"number"},"display_name":{"type":["string","null"]},"display_template":{"type":["string","null"]},"last_seen_at":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"sample_page_path":{"type":["string","null"]},"sample_page_hostname":{"type":["string","null"]},"sample_properties":{"type":["object","null"],"patternProperties":{"^.*$":{}}}}}}}}}}},"400":{"description":"Response for status 400","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"401":{"description":"Response for status 401","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"402":{"description":"Response for status 402","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"403":{"description":"Response for status 403","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"404":{"description":"Response for status 404","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"409":{"description":"Response for status 409","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"429":{"description":"Response for status 429","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"500":{"description":"Response for status 500","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"503":{"description":"Response for status 503","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}}}}},"/v1/sites/{site_id}/analytics/custom-events/properties":{"get":{"tags":["Analytics"],"operationId":"getCustomEventProperties","summary":"Property key statistics for one custom event","parameters":[{"name":"site_id","in":"path","required":true,"schema":{"type":"string","description":"The site id"}},{"name":"from","in":"query","required":true,"schema":{"type":"string","description":"Range start, an ISO-8601 UTC instant (inclusive)"}},{"name":"to","in":"query","required":true,"schema":{"type":"string","description":"Range end, an ISO-8601 UTC instant (exclusive)"}},{"name":"timezone","in":"query","required":true,"schema":{"type":"string","description":"IANA time zone the report buckets by, e.g. UTC"}},{"name":"filters","in":"query","required":false,"schema":{"type":"string","description":"A JSON array of {dimension, operator, values} filter clauses that keep only matching visits; values of one dimension are OR-ed, dimensions AND-ed. operator is eq or in. dimension is one of referrer_domain, country, city, device_type, hostname, utm_source, utm_medium, utm_campaign, utm_content, utm_term, browser, os, entry_page_path, page_path, event_name. entry_page_path is the landing page; page_path keeps a visit that viewed the path at least once"}},{"name":"event_name","in":"query","required":true,"schema":{"type":"string","description":"The custom event to break down"}},{"name":"event_property","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"},"description":"Repeatable <key>=<value> event property filter, at most 5"}}],"responses":{"200":{"description":"Response for status 200","content":{"application/json":{"schema":{"type":"object","required":["meta","event_name","events","keys_truncated","items"],"properties":{"meta":{"type":"object","required":["requested_range","effective_range","timezone","resolution","data_sources","accuracy","comparison_range","truncated","cached","partial","freshness"],"properties":{"requested_range":{"type":"object","required":["from","to"],"properties":{"from":{"type":"string","format":"date-time","pattern":"Z$"},"to":{"type":"string","format":"date-time","pattern":"Z$"}}},"effective_range":{"type":"object","required":["from","to"],"properties":{"from":{"type":"string","format":"date-time","pattern":"Z$"},"to":{"type":"string","format":"date-time","pattern":"Z$"}}},"timezone":{"type":"string","description":"An IANA time zone, e.g. Europe/Istanbul"},"resolution":{"enum":["minute","hour","day","week"]},"data_sources":{"type":"array","items":{"type":"string","const":"live"}},"accuracy":{"enum":["exact","estimated","provider_defined"]},"comparison_range":{"type":["object","null"],"required":["from","to"],"properties":{"from":{"type":"string","format":"date-time","pattern":"Z$"},"to":{"type":"string","format":"date-time","pattern":"Z$"}}},"truncated":{"type":"boolean","description":"The store capped the rows; the report is incomplete"},"cached":{"type":"boolean"},"partial":{"type":"boolean"},"freshness":{"type":"object","required":["state","watermark","as_of"],"properties":{"state":{"enum":["ok","no_data","stale","degraded"]},"watermark":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"as_of":{"type":"string","format":"date-time","pattern":"Z$"}}},"revenue":{"type":"object","required":["provider","connection_status","last_synced_at","last_webhook_at","rollup_through"],"properties":{"provider":{"type":["string","null"]},"connection_status":{"enum":["connected","degraded","disconnected","not_connected"]},"last_synced_at":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"last_webhook_at":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"rollup_through":{"type":["string","null"],"format":"date-time","pattern":"Z$"}}}}},"event_name":{"type":"string"},"events":{"type":"number"},"keys_truncated":{"type":"boolean"},"items":{"type":"array","items":{"type":"object","required":["key","events","type","type_counts","number","boolean","string"],"properties":{"key":{"type":"string"},"events":{"type":"number"},"type":{"enum":["string","number","boolean","null","mixed"]},"type_counts":{"type":"object","required":["string","number","boolean","null"],"properties":{"string":{"type":"number"},"number":{"type":"number"},"boolean":{"type":"number"},"null":{"type":"number"}}},"number":{"type":["object","null"],"required":["min","max","mean","p50","p75","p90","p95","p99"],"properties":{"min":{"type":"number"},"max":{"type":"number"},"mean":{"type":"number"},"p50":{"type":"number"},"p75":{"type":"number"},"p90":{"type":"number"},"p95":{"type":"number"},"p99":{"type":"number"}}},"boolean":{"type":["object","null"],"required":["true_events","false_events"],"properties":{"true_events":{"type":"number"},"false_events":{"type":"number"}}},"string":{"type":["object","null"],"required":["distinct_values","top_values","other_events","approximate"],"properties":{"distinct_values":{"type":"number"},"top_values":{"type":"array","items":{"type":"object","required":["value","events"],"properties":{"value":{"type":"string"},"events":{"type":"number"}}}},"other_events":{"type":"number"},"approximate":{"type":"boolean"}}}}}}}}}}},"400":{"description":"Response for status 400","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"401":{"description":"Response for status 401","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"402":{"description":"Response for status 402","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"403":{"description":"Response for status 403","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"404":{"description":"Response for status 404","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"409":{"description":"Response for status 409","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"429":{"description":"Response for status 429","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"500":{"description":"Response for status 500","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"503":{"description":"Response for status 503","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}}}}},"/v1/sites/{site_id}/analytics/custom-events/timeseries":{"get":{"tags":["Analytics"],"operationId":"getCustomEventsTimeseries","summary":"Custom events and conversions per time bucket","parameters":[{"name":"site_id","in":"path","required":true,"schema":{"type":"string","description":"The site id"}},{"name":"from","in":"query","required":true,"schema":{"type":"string","description":"Range start, an ISO-8601 UTC instant (inclusive)"}},{"name":"to","in":"query","required":true,"schema":{"type":"string","description":"Range end, an ISO-8601 UTC instant (exclusive)"}},{"name":"timezone","in":"query","required":true,"schema":{"type":"string","description":"IANA time zone the report buckets by, e.g. UTC"}},{"name":"filters","in":"query","required":false,"schema":{"type":"string","description":"A JSON array of {dimension, operator, values} filter clauses that keep only matching visits; values of one dimension are OR-ed, dimensions AND-ed. operator is eq or in. dimension is one of referrer_domain, country, city, device_type, hostname, utm_source, utm_medium, utm_campaign, utm_content, utm_term, browser, os, entry_page_path, page_path, event_name. entry_page_path is the landing page; page_path keeps a visit that viewed the path at least once"}},{"name":"resolution","in":"query","required":false,"schema":{"enum":["hour","day","week"]}}],"responses":{"200":{"description":"Response for status 200","content":{"application/json":{"schema":{"type":"object","required":["meta","series"],"properties":{"meta":{"type":"object","required":["requested_range","effective_range","timezone","resolution","data_sources","accuracy","comparison_range","truncated","cached","partial","freshness"],"properties":{"requested_range":{"type":"object","required":["from","to"],"properties":{"from":{"type":"string","format":"date-time","pattern":"Z$"},"to":{"type":"string","format":"date-time","pattern":"Z$"}}},"effective_range":{"type":"object","required":["from","to"],"properties":{"from":{"type":"string","format":"date-time","pattern":"Z$"},"to":{"type":"string","format":"date-time","pattern":"Z$"}}},"timezone":{"type":"string","description":"An IANA time zone, e.g. Europe/Istanbul"},"resolution":{"enum":["minute","hour","day","week"]},"data_sources":{"type":"array","items":{"type":"string","const":"live"}},"accuracy":{"enum":["exact","estimated","provider_defined"]},"comparison_range":{"type":["object","null"],"required":["from","to"],"properties":{"from":{"type":"string","format":"date-time","pattern":"Z$"},"to":{"type":"string","format":"date-time","pattern":"Z$"}}},"truncated":{"type":"boolean","description":"The store capped the rows; the report is incomplete"},"cached":{"type":"boolean"},"partial":{"type":"boolean"},"freshness":{"type":"object","required":["state","watermark","as_of"],"properties":{"state":{"enum":["ok","no_data","stale","degraded"]},"watermark":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"as_of":{"type":"string","format":"date-time","pattern":"Z$"}}},"revenue":{"type":"object","required":["provider","connection_status","last_synced_at","last_webhook_at","rollup_through"],"properties":{"provider":{"type":["string","null"]},"connection_status":{"enum":["connected","degraded","disconnected","not_connected"]},"last_synced_at":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"last_webhook_at":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"rollup_through":{"type":["string","null"],"format":"date-time","pattern":"Z$"}}}}},"series":{"type":"array","items":{"type":"object","required":["bucket","events","conversions"],"properties":{"bucket":{"type":"string","format":"date-time","pattern":"Z$"},"events":{"type":"number"},"conversions":{"type":"number"}}}}}}}}},"400":{"description":"Response for status 400","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"401":{"description":"Response for status 401","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"402":{"description":"Response for status 402","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"403":{"description":"Response for status 403","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"404":{"description":"Response for status 404","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"409":{"description":"Response for status 409","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"429":{"description":"Response for status 429","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"500":{"description":"Response for status 500","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"503":{"description":"Response for status 503","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}}}}},"/v1/sites/{site_id}/analytics/performance":{"get":{"tags":["Analytics"],"operationId":"getWebVitals","summary":"Web vitals per metric and device type at a percentile","parameters":[{"name":"site_id","in":"path","required":true,"schema":{"type":"string","description":"The site id"}},{"name":"from","in":"query","required":true,"schema":{"type":"string","description":"Range start, an ISO-8601 UTC instant (inclusive)"}},{"name":"to","in":"query","required":true,"schema":{"type":"string","description":"Range end, an ISO-8601 UTC instant (exclusive)"}},{"name":"timezone","in":"query","required":true,"schema":{"type":"string","description":"IANA time zone the report buckets by, e.g. UTC"}},{"name":"filters","in":"query","required":false,"schema":{"type":"string","description":"A JSON array of {dimension, operator, values} filter clauses that keep only matching visits; values of one dimension are OR-ed, dimensions AND-ed. operator is eq or in. dimension is one of referrer_domain, country, city, device_type, hostname, utm_source, utm_medium, utm_campaign, utm_content, utm_term, browser, os, entry_page_path, page_path, event_name. entry_page_path is the landing page; page_path keeps a visit that viewed the path at least once"}},{"name":"limit","in":"query","required":false,"schema":{"type":"string","pattern":"^[0-9]{1,3}$","description":"Maximum rows, 1 to 500 (default 100)"}},{"name":"percentile","in":"query","required":false,"schema":{"enum":["p50","p75","p90","p95","p99"],"default":"p75"}}],"responses":{"200":{"description":"Response for status 200","content":{"application/json":{"schema":{"type":"object","required":["meta","percentile","items"],"properties":{"meta":{"type":"object","required":["requested_range","effective_range","timezone","resolution","data_sources","accuracy","comparison_range","truncated","cached","partial","freshness"],"properties":{"requested_range":{"type":"object","required":["from","to"],"properties":{"from":{"type":"string","format":"date-time","pattern":"Z$"},"to":{"type":"string","format":"date-time","pattern":"Z$"}}},"effective_range":{"type":"object","required":["from","to"],"properties":{"from":{"type":"string","format":"date-time","pattern":"Z$"},"to":{"type":"string","format":"date-time","pattern":"Z$"}}},"timezone":{"type":"string","description":"An IANA time zone, e.g. Europe/Istanbul"},"resolution":{"enum":["minute","hour","day","week"]},"data_sources":{"type":"array","items":{"type":"string","const":"live"}},"accuracy":{"enum":["exact","estimated","provider_defined"]},"comparison_range":{"type":["object","null"],"required":["from","to"],"properties":{"from":{"type":"string","format":"date-time","pattern":"Z$"},"to":{"type":"string","format":"date-time","pattern":"Z$"}}},"truncated":{"type":"boolean","description":"The store capped the rows; the report is incomplete"},"cached":{"type":"boolean"},"partial":{"type":"boolean"},"freshness":{"type":"object","required":["state","watermark","as_of"],"properties":{"state":{"enum":["ok","no_data","stale","degraded"]},"watermark":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"as_of":{"type":"string","format":"date-time","pattern":"Z$"}}},"revenue":{"type":"object","required":["provider","connection_status","last_synced_at","last_webhook_at","rollup_through"],"properties":{"provider":{"type":["string","null"]},"connection_status":{"enum":["connected","degraded","disconnected","not_connected"]},"last_synced_at":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"last_webhook_at":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"rollup_through":{"type":["string","null"],"format":"date-time","pattern":"Z$"}}}}},"percentile":{"enum":["p50","p75","p90","p95","p99"]},"items":{"type":"array","items":{"type":"object","required":["metric","device_type","value","rating","samples","mean","p50","p75","p90","p95","p99","good_samples","needs_improvement_samples","poor_samples"],"properties":{"metric":{"type":"string"},"device_type":{"type":"string"},"value":{"type":"number"},"rating":{"anyOf":[{"enum":["good","needs-improvement","poor"]},{"type":"null"}]},"samples":{"type":"number"},"mean":{"type":"number"},"p50":{"type":"number"},"p75":{"type":"number"},"p90":{"type":"number"},"p95":{"type":"number"},"p99":{"type":"number"},"good_samples":{"type":"number"},"needs_improvement_samples":{"type":"number"},"poor_samples":{"type":"number"}}}}}}}}},"400":{"description":"Response for status 400","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"401":{"description":"Response for status 401","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"402":{"description":"Response for status 402","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"403":{"description":"Response for status 403","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"404":{"description":"Response for status 404","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"409":{"description":"Response for status 409","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"429":{"description":"Response for status 429","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"500":{"description":"Response for status 500","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"503":{"description":"Response for status 503","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}}}}},"/v1/sites/{site_id}/analytics/performance/timeseries":{"get":{"tags":["Analytics"],"operationId":"getWebVitalsTimeseries","summary":"Web vitals per metric and time bucket","parameters":[{"name":"site_id","in":"path","required":true,"schema":{"type":"string","description":"The site id"}},{"name":"from","in":"query","required":true,"schema":{"type":"string","description":"Range start, an ISO-8601 UTC instant (inclusive)"}},{"name":"to","in":"query","required":true,"schema":{"type":"string","description":"Range end, an ISO-8601 UTC instant (exclusive)"}},{"name":"timezone","in":"query","required":true,"schema":{"type":"string","description":"IANA time zone the report buckets by, e.g. UTC"}},{"name":"filters","in":"query","required":false,"schema":{"type":"string","description":"A JSON array of {dimension, operator, values} filter clauses that keep only matching visits; values of one dimension are OR-ed, dimensions AND-ed. operator is eq or in. dimension is one of referrer_domain, country, city, device_type, hostname, utm_source, utm_medium, utm_campaign, utm_content, utm_term, browser, os, entry_page_path, page_path, event_name. entry_page_path is the landing page; page_path keeps a visit that viewed the path at least once"}},{"name":"percentile","in":"query","required":false,"schema":{"enum":["p50","p75","p90","p95","p99"],"default":"p75"}},{"name":"resolution","in":"query","required":false,"schema":{"enum":["hour","day","week"]}}],"responses":{"200":{"description":"Response for status 200","content":{"application/json":{"schema":{"type":"object","required":["meta","percentile","series"],"properties":{"meta":{"type":"object","required":["requested_range","effective_range","timezone","resolution","data_sources","accuracy","comparison_range","truncated","cached","partial","freshness"],"properties":{"requested_range":{"type":"object","required":["from","to"],"properties":{"from":{"type":"string","format":"date-time","pattern":"Z$"},"to":{"type":"string","format":"date-time","pattern":"Z$"}}},"effective_range":{"type":"object","required":["from","to"],"properties":{"from":{"type":"string","format":"date-time","pattern":"Z$"},"to":{"type":"string","format":"date-time","pattern":"Z$"}}},"timezone":{"type":"string","description":"An IANA time zone, e.g. Europe/Istanbul"},"resolution":{"enum":["minute","hour","day","week"]},"data_sources":{"type":"array","items":{"type":"string","const":"live"}},"accuracy":{"enum":["exact","estimated","provider_defined"]},"comparison_range":{"type":["object","null"],"required":["from","to"],"properties":{"from":{"type":"string","format":"date-time","pattern":"Z$"},"to":{"type":"string","format":"date-time","pattern":"Z$"}}},"truncated":{"type":"boolean","description":"The store capped the rows; the report is incomplete"},"cached":{"type":"boolean"},"partial":{"type":"boolean"},"freshness":{"type":"object","required":["state","watermark","as_of"],"properties":{"state":{"enum":["ok","no_data","stale","degraded"]},"watermark":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"as_of":{"type":"string","format":"date-time","pattern":"Z$"}}},"revenue":{"type":"object","required":["provider","connection_status","last_synced_at","last_webhook_at","rollup_through"],"properties":{"provider":{"type":["string","null"]},"connection_status":{"enum":["connected","degraded","disconnected","not_connected"]},"last_synced_at":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"last_webhook_at":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"rollup_through":{"type":["string","null"],"format":"date-time","pattern":"Z$"}}}}},"percentile":{"enum":["p50","p75","p90","p95","p99"]},"series":{"type":"array","items":{"type":"object","required":["bucket","metric","samples","value","rating","good_samples","needs_improvement_samples","poor_samples"],"properties":{"bucket":{"type":"string","format":"date-time","pattern":"Z$"},"metric":{"enum":["LCP","CLS","INP","FCP","TTFB"]},"samples":{"type":"number"},"value":{"type":"number"},"rating":{"anyOf":[{"enum":["good","needs-improvement","poor"]},{"type":"null"}]},"good_samples":{"type":"number"},"needs_improvement_samples":{"type":"number"},"poor_samples":{"type":"number"}}}}}}}}},"400":{"description":"Response for status 400","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"401":{"description":"Response for status 401","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"402":{"description":"Response for status 402","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"403":{"description":"Response for status 403","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"404":{"description":"Response for status 404","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"409":{"description":"Response for status 409","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"429":{"description":"Response for status 429","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"500":{"description":"Response for status 500","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"503":{"description":"Response for status 503","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}}}}},"/v1/sites/{site_id}/analytics/performance/pages":{"get":{"tags":["Analytics"],"operationId":"listWebVitalsByPage","summary":"Web vitals per page","parameters":[{"name":"site_id","in":"path","required":true,"schema":{"type":"string","description":"The site id"}},{"name":"from","in":"query","required":true,"schema":{"type":"string","description":"Range start, an ISO-8601 UTC instant (inclusive)"}},{"name":"to","in":"query","required":true,"schema":{"type":"string","description":"Range end, an ISO-8601 UTC instant (exclusive)"}},{"name":"timezone","in":"query","required":true,"schema":{"type":"string","description":"IANA time zone the report buckets by, e.g. UTC"}},{"name":"filters","in":"query","required":false,"schema":{"type":"string","description":"A JSON array of {dimension, operator, values} filter clauses that keep only matching visits; values of one dimension are OR-ed, dimensions AND-ed. operator is eq or in. dimension is one of referrer_domain, country, city, device_type, hostname, utm_source, utm_medium, utm_campaign, utm_content, utm_term, browser, os, entry_page_path, page_path, event_name. entry_page_path is the landing page; page_path keeps a visit that viewed the path at least once"}},{"name":"limit","in":"query","required":false,"schema":{"type":"string","pattern":"^[0-9]{1,3}$","description":"Maximum rows, 1 to 500 (default 100)"}},{"name":"percentile","in":"query","required":false,"schema":{"enum":["p50","p75","p90","p95","p99"],"default":"p75"}},{"name":"metric","in":"query","required":false,"schema":{"enum":["LCP","CLS","INP","FCP","TTFB"],"description":"All metrics if absent"}}],"responses":{"200":{"description":"Response for status 200","content":{"application/json":{"schema":{"type":"object","required":["meta","percentile","items"],"properties":{"meta":{"type":"object","required":["requested_range","effective_range","timezone","resolution","data_sources","accuracy","comparison_range","truncated","cached","partial","freshness"],"properties":{"requested_range":{"type":"object","required":["from","to"],"properties":{"from":{"type":"string","format":"date-time","pattern":"Z$"},"to":{"type":"string","format":"date-time","pattern":"Z$"}}},"effective_range":{"type":"object","required":["from","to"],"properties":{"from":{"type":"string","format":"date-time","pattern":"Z$"},"to":{"type":"string","format":"date-time","pattern":"Z$"}}},"timezone":{"type":"string","description":"An IANA time zone, e.g. Europe/Istanbul"},"resolution":{"enum":["minute","hour","day","week"]},"data_sources":{"type":"array","items":{"type":"string","const":"live"}},"accuracy":{"enum":["exact","estimated","provider_defined"]},"comparison_range":{"type":["object","null"],"required":["from","to"],"properties":{"from":{"type":"string","format":"date-time","pattern":"Z$"},"to":{"type":"string","format":"date-time","pattern":"Z$"}}},"truncated":{"type":"boolean","description":"The store capped the rows; the report is incomplete"},"cached":{"type":"boolean"},"partial":{"type":"boolean"},"freshness":{"type":"object","required":["state","watermark","as_of"],"properties":{"state":{"enum":["ok","no_data","stale","degraded"]},"watermark":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"as_of":{"type":"string","format":"date-time","pattern":"Z$"}}},"revenue":{"type":"object","required":["provider","connection_status","last_synced_at","last_webhook_at","rollup_through"],"properties":{"provider":{"type":["string","null"]},"connection_status":{"enum":["connected","degraded","disconnected","not_connected"]},"last_synced_at":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"last_webhook_at":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"rollup_through":{"type":["string","null"],"format":"date-time","pattern":"Z$"}}}}},"percentile":{"enum":["p50","p75","p90","p95","p99"]},"items":{"type":"array","items":{"type":"object","required":["metric","hostname","page_path","samples","mean","value","rating","good_samples","needs_improvement_samples","poor_samples"],"properties":{"metric":{"enum":["LCP","CLS","INP","FCP","TTFB"]},"hostname":{"type":"string"},"page_path":{"type":"string"},"samples":{"type":"number"},"mean":{"type":"number"},"value":{"type":"number"},"rating":{"anyOf":[{"enum":["good","needs-improvement","poor"]},{"type":"null"}]},"good_samples":{"type":"number"},"needs_improvement_samples":{"type":"number"},"poor_samples":{"type":"number"}}}}}}}}},"400":{"description":"Response for status 400","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"401":{"description":"Response for status 401","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"402":{"description":"Response for status 402","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"403":{"description":"Response for status 403","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"404":{"description":"Response for status 404","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"409":{"description":"Response for status 409","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"429":{"description":"Response for status 429","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"500":{"description":"Response for status 500","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"503":{"description":"Response for status 503","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}}}}},"/v1/sites/{site_id}/analytics/performance/countries":{"get":{"tags":["Analytics"],"operationId":"listWebVitalsByCountry","summary":"Web vitals per country","parameters":[{"name":"site_id","in":"path","required":true,"schema":{"type":"string","description":"The site id"}},{"name":"from","in":"query","required":true,"schema":{"type":"string","description":"Range start, an ISO-8601 UTC instant (inclusive)"}},{"name":"to","in":"query","required":true,"schema":{"type":"string","description":"Range end, an ISO-8601 UTC instant (exclusive)"}},{"name":"timezone","in":"query","required":true,"schema":{"type":"string","description":"IANA time zone the report buckets by, e.g. UTC"}},{"name":"filters","in":"query","required":false,"schema":{"type":"string","description":"A JSON array of {dimension, operator, values} filter clauses that keep only matching visits; values of one dimension are OR-ed, dimensions AND-ed. operator is eq or in. dimension is one of referrer_domain, country, city, device_type, hostname, utm_source, utm_medium, utm_campaign, utm_content, utm_term, browser, os, entry_page_path, page_path, event_name. entry_page_path is the landing page; page_path keeps a visit that viewed the path at least once"}},{"name":"limit","in":"query","required":false,"schema":{"type":"string","pattern":"^[0-9]{1,3}$","description":"Maximum rows, 1 to 500 (default 100)"}},{"name":"percentile","in":"query","required":false,"schema":{"enum":["p50","p75","p90","p95","p99"],"default":"p75"}},{"name":"metric","in":"query","required":false,"schema":{"enum":["LCP","CLS","INP","FCP","TTFB"],"description":"All metrics if absent"}}],"responses":{"200":{"description":"Response for status 200","content":{"application/json":{"schema":{"type":"object","required":["meta","percentile","items"],"properties":{"meta":{"type":"object","required":["requested_range","effective_range","timezone","resolution","data_sources","accuracy","comparison_range","truncated","cached","partial","freshness"],"properties":{"requested_range":{"type":"object","required":["from","to"],"properties":{"from":{"type":"string","format":"date-time","pattern":"Z$"},"to":{"type":"string","format":"date-time","pattern":"Z$"}}},"effective_range":{"type":"object","required":["from","to"],"properties":{"from":{"type":"string","format":"date-time","pattern":"Z$"},"to":{"type":"string","format":"date-time","pattern":"Z$"}}},"timezone":{"type":"string","description":"An IANA time zone, e.g. Europe/Istanbul"},"resolution":{"enum":["minute","hour","day","week"]},"data_sources":{"type":"array","items":{"type":"string","const":"live"}},"accuracy":{"enum":["exact","estimated","provider_defined"]},"comparison_range":{"type":["object","null"],"required":["from","to"],"properties":{"from":{"type":"string","format":"date-time","pattern":"Z$"},"to":{"type":"string","format":"date-time","pattern":"Z$"}}},"truncated":{"type":"boolean","description":"The store capped the rows; the report is incomplete"},"cached":{"type":"boolean"},"partial":{"type":"boolean"},"freshness":{"type":"object","required":["state","watermark","as_of"],"properties":{"state":{"enum":["ok","no_data","stale","degraded"]},"watermark":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"as_of":{"type":"string","format":"date-time","pattern":"Z$"}}},"revenue":{"type":"object","required":["provider","connection_status","last_synced_at","last_webhook_at","rollup_through"],"properties":{"provider":{"type":["string","null"]},"connection_status":{"enum":["connected","degraded","disconnected","not_connected"]},"last_synced_at":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"last_webhook_at":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"rollup_through":{"type":["string","null"],"format":"date-time","pattern":"Z$"}}}}},"percentile":{"enum":["p50","p75","p90","p95","p99"]},"items":{"type":"array","items":{"type":"object","required":["metric","country","samples","mean","value","rating","good_samples","needs_improvement_samples","poor_samples"],"properties":{"metric":{"enum":["LCP","CLS","INP","FCP","TTFB"]},"country":{"type":"string"},"samples":{"type":"number"},"mean":{"type":"number"},"value":{"type":"number"},"rating":{"anyOf":[{"enum":["good","needs-improvement","poor"]},{"type":"null"}]},"good_samples":{"type":"number"},"needs_improvement_samples":{"type":"number"},"poor_samples":{"type":"number"}}}}}}}}},"400":{"description":"Response for status 400","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"401":{"description":"Response for status 401","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"402":{"description":"Response for status 402","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"403":{"description":"Response for status 403","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"404":{"description":"Response for status 404","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"409":{"description":"Response for status 409","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"429":{"description":"Response for status 429","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"500":{"description":"Response for status 500","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"503":{"description":"Response for status 503","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}}}}},"/v1/sites/{site_id}/analytics/performance/browsers":{"get":{"tags":["Analytics"],"operationId":"listWebVitalsByBrowser","summary":"Web vitals per browser","parameters":[{"name":"site_id","in":"path","required":true,"schema":{"type":"string","description":"The site id"}},{"name":"from","in":"query","required":true,"schema":{"type":"string","description":"Range start, an ISO-8601 UTC instant (inclusive)"}},{"name":"to","in":"query","required":true,"schema":{"type":"string","description":"Range end, an ISO-8601 UTC instant (exclusive)"}},{"name":"timezone","in":"query","required":true,"schema":{"type":"string","description":"IANA time zone the report buckets by, e.g. UTC"}},{"name":"filters","in":"query","required":false,"schema":{"type":"string","description":"A JSON array of {dimension, operator, values} filter clauses that keep only matching visits; values of one dimension are OR-ed, dimensions AND-ed. operator is eq or in. dimension is one of referrer_domain, country, city, device_type, hostname, utm_source, utm_medium, utm_campaign, utm_content, utm_term, browser, os, entry_page_path, page_path, event_name. entry_page_path is the landing page; page_path keeps a visit that viewed the path at least once"}},{"name":"limit","in":"query","required":false,"schema":{"type":"string","pattern":"^[0-9]{1,3}$","description":"Maximum rows, 1 to 500 (default 100)"}},{"name":"percentile","in":"query","required":false,"schema":{"enum":["p50","p75","p90","p95","p99"],"default":"p75"}},{"name":"metric","in":"query","required":false,"schema":{"enum":["LCP","CLS","INP","FCP","TTFB"],"description":"All metrics if absent"}}],"responses":{"200":{"description":"Response for status 200","content":{"application/json":{"schema":{"type":"object","required":["meta","percentile","items"],"properties":{"meta":{"type":"object","required":["requested_range","effective_range","timezone","resolution","data_sources","accuracy","comparison_range","truncated","cached","partial","freshness"],"properties":{"requested_range":{"type":"object","required":["from","to"],"properties":{"from":{"type":"string","format":"date-time","pattern":"Z$"},"to":{"type":"string","format":"date-time","pattern":"Z$"}}},"effective_range":{"type":"object","required":["from","to"],"properties":{"from":{"type":"string","format":"date-time","pattern":"Z$"},"to":{"type":"string","format":"date-time","pattern":"Z$"}}},"timezone":{"type":"string","description":"An IANA time zone, e.g. Europe/Istanbul"},"resolution":{"enum":["minute","hour","day","week"]},"data_sources":{"type":"array","items":{"type":"string","const":"live"}},"accuracy":{"enum":["exact","estimated","provider_defined"]},"comparison_range":{"type":["object","null"],"required":["from","to"],"properties":{"from":{"type":"string","format":"date-time","pattern":"Z$"},"to":{"type":"string","format":"date-time","pattern":"Z$"}}},"truncated":{"type":"boolean","description":"The store capped the rows; the report is incomplete"},"cached":{"type":"boolean"},"partial":{"type":"boolean"},"freshness":{"type":"object","required":["state","watermark","as_of"],"properties":{"state":{"enum":["ok","no_data","stale","degraded"]},"watermark":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"as_of":{"type":"string","format":"date-time","pattern":"Z$"}}},"revenue":{"type":"object","required":["provider","connection_status","last_synced_at","last_webhook_at","rollup_through"],"properties":{"provider":{"type":["string","null"]},"connection_status":{"enum":["connected","degraded","disconnected","not_connected"]},"last_synced_at":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"last_webhook_at":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"rollup_through":{"type":["string","null"],"format":"date-time","pattern":"Z$"}}}}},"percentile":{"enum":["p50","p75","p90","p95","p99"]},"items":{"type":"array","items":{"type":"object","required":["metric","browser","samples","mean","value","rating","good_samples","needs_improvement_samples","poor_samples"],"properties":{"metric":{"enum":["LCP","CLS","INP","FCP","TTFB"]},"browser":{"type":"string"},"samples":{"type":"number"},"mean":{"type":"number"},"value":{"type":"number"},"rating":{"anyOf":[{"enum":["good","needs-improvement","poor"]},{"type":"null"}]},"good_samples":{"type":"number"},"needs_improvement_samples":{"type":"number"},"poor_samples":{"type":"number"}}}}}}}}},"400":{"description":"Response for status 400","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"401":{"description":"Response for status 401","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"402":{"description":"Response for status 402","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"403":{"description":"Response for status 403","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"404":{"description":"Response for status 404","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"409":{"description":"Response for status 409","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"429":{"description":"Response for status 429","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"500":{"description":"Response for status 500","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"503":{"description":"Response for status 503","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}}}}},"/v1/sites/{site_id}/analytics/sessions":{"get":{"tags":["Analytics"],"operationId":"getSessionMetrics","summary":"Visit, bounce and duration metrics with a per-bucket series","parameters":[{"name":"site_id","in":"path","required":true,"schema":{"type":"string","description":"The site id"}},{"name":"from","in":"query","required":true,"schema":{"type":"string","description":"Range start, an ISO-8601 UTC instant (inclusive)"}},{"name":"to","in":"query","required":true,"schema":{"type":"string","description":"Range end, an ISO-8601 UTC instant (exclusive)"}},{"name":"timezone","in":"query","required":true,"schema":{"type":"string","description":"IANA time zone the report buckets by, e.g. UTC"}},{"name":"compare","in":"query","required":false,"schema":{"enum":["true","false"],"description":"Also report the preceding period of equal length"}}],"responses":{"200":{"description":"Response for status 200","content":{"application/json":{"schema":{"type":"object","required":["meta","layering","totals","series","comparison"],"properties":{"meta":{"type":"object","required":["requested_range","effective_range","timezone","resolution","data_sources","accuracy","comparison_range","truncated","cached","partial","freshness"],"properties":{"requested_range":{"type":"object","required":["from","to"],"properties":{"from":{"type":"string","format":"date-time","pattern":"Z$"},"to":{"type":"string","format":"date-time","pattern":"Z$"}}},"effective_range":{"type":"object","required":["from","to"],"properties":{"from":{"type":"string","format":"date-time","pattern":"Z$"},"to":{"type":"string","format":"date-time","pattern":"Z$"}}},"timezone":{"type":"string","description":"An IANA time zone, e.g. Europe/Istanbul"},"resolution":{"enum":["minute","hour","day","week"]},"data_sources":{"type":"array","items":{"type":"string","const":"live"}},"accuracy":{"enum":["exact","estimated","provider_defined"]},"comparison_range":{"type":["object","null"],"required":["from","to"],"properties":{"from":{"type":"string","format":"date-time","pattern":"Z$"},"to":{"type":"string","format":"date-time","pattern":"Z$"}}},"truncated":{"type":"boolean","description":"The store capped the rows; the report is incomplete"},"cached":{"type":"boolean"},"partial":{"type":"boolean"},"freshness":{"type":"object","required":["state","watermark","as_of"],"properties":{"state":{"enum":["ok","no_data","stale","degraded"]},"watermark":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"as_of":{"type":"string","format":"date-time","pattern":"Z$"}}},"revenue":{"type":"object","required":["provider","connection_status","last_synced_at","last_webhook_at","rollup_through"],"properties":{"provider":{"type":["string","null"]},"connection_status":{"enum":["connected","degraded","disconnected","not_connected"]},"last_synced_at":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"last_webhook_at":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"rollup_through":{"type":["string","null"],"format":"date-time","pattern":"Z$"}}}}},"layering":{"type":"object","required":["finalized_through","provisional_through"],"properties":{"finalized_through":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"provisional_through":{"type":["string","null"],"format":"date-time","pattern":"Z$"}}},"totals":{"type":"object","required":["visits","engaged_visits","bounced_visits","bounce_rate","pageviews","avg_visit_duration_ms","avg_active_duration_ms"],"properties":{"visits":{"type":"number"},"engaged_visits":{"type":"number"},"bounced_visits":{"type":"number"},"bounce_rate":{"type":"number"},"pageviews":{"type":"number"},"avg_visit_duration_ms":{"type":"number"},"avg_active_duration_ms":{"type":"number"}}},"series":{"type":"array","items":{"type":"object","required":["bucket","visits","engaged_visits","bounced_visits","bounce_rate","pageviews","avg_visit_duration_ms","avg_active_duration_ms"],"properties":{"bucket":{"type":"string","format":"date-time","pattern":"Z$"},"visits":{"type":"number"},"engaged_visits":{"type":"number"},"bounced_visits":{"type":"number"},"bounce_rate":{"type":"number"},"pageviews":{"type":"number"},"avg_visit_duration_ms":{"type":"number"},"avg_active_duration_ms":{"type":"number"}}}},"comparison":{"type":["object","null"],"required":["totals"],"properties":{"totals":{"type":"object","required":["visits","engaged_visits","bounced_visits","bounce_rate","pageviews","avg_visit_duration_ms","avg_active_duration_ms"],"properties":{"visits":{"type":"number"},"engaged_visits":{"type":"number"},"bounced_visits":{"type":"number"},"bounce_rate":{"type":"number"},"pageviews":{"type":"number"},"avg_visit_duration_ms":{"type":"number"},"avg_active_duration_ms":{"type":"number"}}}}}}}}}},"400":{"description":"Response for status 400","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"401":{"description":"Response for status 401","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"402":{"description":"Response for status 402","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"403":{"description":"Response for status 403","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"404":{"description":"Response for status 404","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"409":{"description":"Response for status 409","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"429":{"description":"Response for status 429","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"500":{"description":"Response for status 500","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"503":{"description":"Response for status 503","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}}}}},"/v1/sites/{site_id}/analytics/visits":{"get":{"tags":["Analytics"],"operationId":"listRecentVisits","summary":"Visits seen in the last hours","parameters":[{"name":"site_id","in":"path","required":true,"schema":{"type":"string","description":"The site id"}},{"name":"timezone","in":"query","required":true,"schema":{"type":"string","description":"IANA time zone, e.g. UTC"}},{"name":"hours","in":"query","required":false,"schema":{"type":"string","pattern":"^[0-9]{1,2}$","description":"Hours back from now, 1 to 24 (default 2)"}},{"name":"limit","in":"query","required":false,"schema":{"type":"string","pattern":"^[0-9]{1,3}$","description":"Maximum visits, 1 to 200 (default 100)"}}],"responses":{"200":{"description":"Response for status 200","content":{"application/json":{"schema":{"type":"object","required":["meta","items"],"properties":{"meta":{"type":"object","required":["requested_range","timezone","freshness","cached","truncated","provisional"],"properties":{"requested_range":{"type":"object","required":["from","to"],"properties":{"from":{"type":"string","format":"date-time","pattern":"Z$"},"to":{"type":"string","format":"date-time","pattern":"Z$"}}},"timezone":{"type":"string","description":"An IANA time zone, e.g. Europe/Istanbul"},"freshness":{"type":"object","required":["state","watermark","as_of"],"properties":{"state":{"enum":["ok","no_data","stale","degraded"]},"watermark":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"as_of":{"type":"string","format":"date-time","pattern":"Z$"}}},"cached":{"type":"boolean"},"truncated":{"type":"boolean"},"provisional":{"type":"boolean","const":true}}},"items":{"type":"array","items":{"type":"object","required":["visit_id","country","device_type","browser","os","first_seen","last_seen","pageviews"],"properties":{"visit_id":{"type":"string"},"country":{"type":"string"},"device_type":{"type":"string"},"browser":{"type":"string"},"os":{"type":"string"},"first_seen":{"type":"string","format":"date-time","pattern":"Z$"},"last_seen":{"type":"string","format":"date-time","pattern":"Z$"},"pageviews":{"type":"number"}}}}}}}}},"400":{"description":"Response for status 400","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"401":{"description":"Response for status 401","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"402":{"description":"Response for status 402","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"403":{"description":"Response for status 403","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"404":{"description":"Response for status 404","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"409":{"description":"Response for status 409","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"429":{"description":"Response for status 429","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"500":{"description":"Response for status 500","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"503":{"description":"Response for status 503","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}}}}},"/v1/sites/{site_id}/analytics/replay":{"get":{"tags":["Analytics"],"operationId":"getVisitReplay","summary":"Recent visits replayed as fixed-step frames","parameters":[{"name":"site_id","in":"path","required":true,"schema":{"type":"string","description":"The site id"}},{"name":"timezone","in":"query","required":true,"schema":{"type":"string","description":"IANA time zone, e.g. UTC"}},{"name":"hours","in":"query","required":false,"schema":{"type":"string","pattern":"^[0-9]{1,2}$","description":"Hours back from now, 1 to 24 (default 2)"}}],"responses":{"200":{"description":"Response for status 200","content":{"application/json":{"schema":{"type":"object","required":["meta","step_seconds","frames"],"properties":{"meta":{"type":"object","required":["requested_range","timezone","freshness","cached","truncated","provisional"],"properties":{"requested_range":{"type":"object","required":["from","to"],"properties":{"from":{"type":"string","format":"date-time","pattern":"Z$"},"to":{"type":"string","format":"date-time","pattern":"Z$"}}},"timezone":{"type":"string","description":"An IANA time zone, e.g. Europe/Istanbul"},"freshness":{"type":"object","required":["state","watermark","as_of"],"properties":{"state":{"enum":["ok","no_data","stale","degraded"]},"watermark":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"as_of":{"type":"string","format":"date-time","pattern":"Z$"}}},"cached":{"type":"boolean"},"truncated":{"type":"boolean"},"provisional":{"type":"boolean","const":true}}},"step_seconds":{"type":"number"},"frames":{"type":"array","items":{"type":"object","required":["start","visits","items","breakdowns"],"properties":{"start":{"type":"string","format":"date-time","pattern":"Z$"},"visits":{"type":"number"},"items":{"type":"array","items":{"type":"object","required":["visit_id","country","device_type","browser","os","first_seen","last_seen","pageviews"],"properties":{"visit_id":{"type":"string"},"country":{"type":"string"},"device_type":{"type":"string"},"browser":{"type":"string"},"os":{"type":"string"},"first_seen":{"type":"string","format":"date-time","pattern":"Z$"},"last_seen":{"type":"string","format":"date-time","pattern":"Z$"},"pageviews":{"type":"number"}}}},"breakdowns":{"type":"object","required":["pages","sources","countries","devices","browsers","operating_systems"],"properties":{"pages":{"type":"array","items":{"type":"object","required":["hostname","path","visits"],"properties":{"hostname":{"type":"string"},"path":{"type":"string"},"visits":{"type":"number"}}}},"sources":{"type":"array","items":{"type":"object","required":["referrer","visits"],"properties":{"referrer":{"type":"string"},"visits":{"type":"number"}}}},"countries":{"type":"array","items":{"type":"object","required":["country","visits"],"properties":{"country":{"type":"string"},"visits":{"type":"number"}}}},"devices":{"type":"array","items":{"type":"object","required":["device_type","visits"],"properties":{"device_type":{"type":"string"},"visits":{"type":"number"}}}},"browsers":{"type":"array","items":{"type":"object","required":["browser","visits"],"properties":{"browser":{"type":"string"},"visits":{"type":"number"}}}},"operating_systems":{"type":"array","items":{"type":"object","required":["os","visits"],"properties":{"os":{"type":"string"},"visits":{"type":"number"}}}}}}}}}}}}}},"400":{"description":"Response for status 400","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"401":{"description":"Response for status 401","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"402":{"description":"Response for status 402","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"403":{"description":"Response for status 403","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"404":{"description":"Response for status 404","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"409":{"description":"Response for status 409","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"429":{"description":"Response for status 429","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"500":{"description":"Response for status 500","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"503":{"description":"Response for status 503","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}}}}},"/v1/sites/{site_id}/analytics/visits/{visit_id}":{"get":{"tags":["Analytics"],"operationId":"getVisitTrail","summary":"The pageviews and events of one visit, at any age","parameters":[{"name":"site_id","in":"path","required":true,"schema":{"type":"string","description":"The site id"}},{"name":"visit_id","in":"path","required":true,"schema":{"type":"string","description":"The visit id"}},{"name":"timezone","in":"query","required":true,"schema":{"type":"string","description":"IANA time zone, e.g. UTC"}},{"name":"hours","in":"query","required":false,"schema":{"type":"string","pattern":"^[0-9]{1,2}$","description":"Ignored; the visit id sets the window"}}],"responses":{"200":{"description":"Response for status 200","content":{"application/json":{"schema":{"type":"object","required":["meta","visit_id","entries"],"properties":{"meta":{"type":"object","required":["requested_range","timezone","freshness","cached","truncated","provisional"],"properties":{"requested_range":{"type":"object","required":["from","to"],"properties":{"from":{"type":"string","format":"date-time","pattern":"Z$"},"to":{"type":"string","format":"date-time","pattern":"Z$"}}},"timezone":{"type":"string","description":"An IANA time zone, e.g. Europe/Istanbul"},"freshness":{"type":"object","required":["state","watermark","as_of"],"properties":{"state":{"enum":["ok","no_data","stale","degraded"]},"watermark":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"as_of":{"type":"string","format":"date-time","pattern":"Z$"}}},"cached":{"type":"boolean"},"truncated":{"type":"boolean"},"provisional":{"type":"boolean","const":true}}},"visit_id":{"type":"string"},"entries":{"type":"array","items":{"type":"object","required":["event_id","occurred_at","type","name","hostname","page_path","page_title","referrer_domain"],"properties":{"event_id":{"type":"string"},"occurred_at":{"type":"string","format":"date-time","pattern":"Z$"},"type":{"enum":["pageview","event"]},"name":{"type":["string","null"]},"hostname":{"type":"string"},"page_path":{"type":"string"},"page_title":{"type":"string"},"referrer_domain":{"type":"string"}}}}}}}}},"400":{"description":"Response for status 400","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"401":{"description":"Response for status 401","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"402":{"description":"Response for status 402","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"403":{"description":"Response for status 403","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"404":{"description":"Response for status 404","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"409":{"description":"Response for status 409","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"429":{"description":"Response for status 429","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"500":{"description":"Response for status 500","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"503":{"description":"Response for status 503","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}}}}},"/v1/sites/{site_id}/analytics/visit-log":{"get":{"tags":["Analytics"],"operationId":"listVisitLog","summary":"Visits that started in a range, newest first, with a cursor for the next page","parameters":[{"name":"site_id","in":"path","required":true,"schema":{"type":"string","description":"The site id"}},{"name":"from","in":"query","required":true,"schema":{"type":"string","description":"Range start, an ISO-8601 UTC instant (inclusive)"}},{"name":"to","in":"query","required":true,"schema":{"type":"string","description":"Range end, an ISO-8601 UTC instant (exclusive)"}},{"name":"timezone","in":"query","required":true,"schema":{"type":"string","description":"IANA time zone the report buckets by, e.g. UTC"}},{"name":"cursor","in":"query","required":false,"schema":{"type":"string","maxLength":128,"description":"next_cursor from the previous page"}},{"name":"limit","in":"query","required":false,"schema":{"type":"string","pattern":"^[0-9]{1,3}$","description":"Visits per page, 1 to 200 (default 50)"}}],"responses":{"200":{"description":"Response for status 200","content":{"application/json":{"schema":{"type":"object","required":["meta","items","next_cursor","has_more"],"properties":{"meta":{"type":"object","required":["requested_range","effective_range","timezone","resolution","data_sources","accuracy","comparison_range","truncated","cached","partial","freshness"],"properties":{"requested_range":{"type":"object","required":["from","to"],"properties":{"from":{"type":"string","format":"date-time","pattern":"Z$"},"to":{"type":"string","format":"date-time","pattern":"Z$"}}},"effective_range":{"type":"object","required":["from","to"],"properties":{"from":{"type":"string","format":"date-time","pattern":"Z$"},"to":{"type":"string","format":"date-time","pattern":"Z$"}}},"timezone":{"type":"string","description":"An IANA time zone, e.g. Europe/Istanbul"},"resolution":{"enum":["minute","hour","day","week"]},"data_sources":{"type":"array","items":{"type":"string","const":"live"}},"accuracy":{"enum":["exact","estimated","provider_defined"]},"comparison_range":{"type":["object","null"],"required":["from","to"],"properties":{"from":{"type":"string","format":"date-time","pattern":"Z$"},"to":{"type":"string","format":"date-time","pattern":"Z$"}}},"truncated":{"type":"boolean","description":"The store capped the rows; the report is incomplete"},"cached":{"type":"boolean"},"partial":{"type":"boolean"},"freshness":{"type":"object","required":["state","watermark","as_of"],"properties":{"state":{"enum":["ok","no_data","stale","degraded"]},"watermark":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"as_of":{"type":"string","format":"date-time","pattern":"Z$"}}},"revenue":{"type":"object","required":["provider","connection_status","last_synced_at","last_webhook_at","rollup_through"],"properties":{"provider":{"type":["string","null"]},"connection_status":{"enum":["connected","degraded","disconnected","not_connected"]},"last_synced_at":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"last_webhook_at":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"rollup_through":{"type":["string","null"],"format":"date-time","pattern":"Z$"}}}}},"items":{"type":"array","items":{"type":"object","required":["visit_id","started_at","ended_at","duration_ms","active_ms","pageviews","engaged","entry_hostname","entry_page_path","exit_hostname","exit_page_path","referrer_domain","utm_source","utm_medium","utm_campaign","utm_content","utm_term","country","city","device_type","browser","os","identified","finalized"],"properties":{"visit_id":{"type":"string"},"started_at":{"type":"string","format":"date-time","pattern":"Z$"},"ended_at":{"type":"string","format":"date-time","pattern":"Z$"},"duration_ms":{"type":"number"},"active_ms":{"type":"number"},"pageviews":{"type":"number"},"engaged":{"type":"boolean"},"entry_hostname":{"type":"string"},"entry_page_path":{"type":"string"},"exit_hostname":{"type":"string"},"exit_page_path":{"type":"string"},"referrer_domain":{"type":"string"},"utm_source":{"type":"string"},"utm_medium":{"type":"string"},"utm_campaign":{"type":"string"},"utm_content":{"type":"string"},"utm_term":{"type":"string"},"country":{"type":"string"},"city":{"type":"string"},"device_type":{"type":"string"},"browser":{"type":"string"},"os":{"type":"string"},"identified":{"type":"boolean","description":"identify() linked the visit to a signed-in user"},"finalized":{"type":"boolean"}}}},"next_cursor":{"type":["string","null"]},"has_more":{"type":"boolean"}}}}}},"400":{"description":"Response for status 400","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"401":{"description":"Response for status 401","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"402":{"description":"Response for status 402","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"403":{"description":"Response for status 403","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"404":{"description":"Response for status 404","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"409":{"description":"Response for status 409","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"429":{"description":"Response for status 429","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"500":{"description":"Response for status 500","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"503":{"description":"Response for status 503","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}}}}},"/v1/sites/{site_id}/analytics/funnel":{"get":{"tags":["Analytics"],"operationId":"getFunnelReport","summary":"Conversion through an ordered list of steps","parameters":[{"name":"site_id","in":"path","required":true,"schema":{"type":"string","description":"The site id"}},{"name":"from","in":"query","required":true,"schema":{"type":"string","description":"Range start, an ISO-8601 UTC instant (inclusive)"}},{"name":"to","in":"query","required":true,"schema":{"type":"string","description":"Range end, an ISO-8601 UTC instant (exclusive)"}},{"name":"timezone","in":"query","required":true,"schema":{"type":"string","description":"IANA time zone the report buckets by, e.g. UTC"}},{"name":"filters","in":"query","required":false,"schema":{"type":"string","description":"A JSON array of {dimension, operator, values} filter clauses that keep only matching visits; values of one dimension are OR-ed, dimensions AND-ed. operator is eq or in. dimension is one of referrer_domain, country, city, device_type, hostname, utm_source, utm_medium, utm_campaign, utm_content, utm_term, browser, os, entry_page_path, page_path, event_name. entry_page_path is the landing page; page_path keeps a visit that viewed the path at least once"}},{"name":"steps","in":"query","required":true,"schema":{"type":"array","items":{"type":"string"},"description":"Repeatable step key, in order; 2 to 8 steps"}},{"name":"breakdown","in":"query","required":false,"schema":{"enum":["source","country","device"]}},{"name":"breakdown_limit","in":"query","required":false,"schema":{"type":"string","pattern":"^[0-9]{1,3}$","description":"Segments to keep, 1 to 100"}}],"responses":{"200":{"description":"Response for status 200","content":{"application/json":{"schema":{"type":"object","required":["meta","summary","steps","breakdown"],"properties":{"meta":{"type":"object","required":["requested_range","timezone","freshness","cached"],"properties":{"requested_range":{"type":"object","required":["from","to"],"properties":{"from":{"type":"string","format":"date-time","pattern":"Z$"},"to":{"type":"string","format":"date-time","pattern":"Z$"}}},"timezone":{"type":"string","description":"An IANA time zone, e.g. Europe/Istanbul"},"freshness":{"type":"object","required":["state","watermark","as_of"],"properties":{"state":{"enum":["ok","no_data","stale","degraded"]},"watermark":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"as_of":{"type":"string","format":"date-time","pattern":"Z$"}}},"cached":{"type":"boolean"}}},"summary":{"type":"object","required":["entrants","completions","overall_conversion_rate","biggest_dropoff_step","avg_time_to_convert_ms","median_time_to_convert_ms"],"properties":{"entrants":{"type":"number"},"completions":{"type":"number"},"overall_conversion_rate":{"type":"number"},"biggest_dropoff_step":{"type":["number","null"]},"avg_time_to_convert_ms":{"type":["number","null"]},"median_time_to_convert_ms":{"type":["number","null"]}}},"steps":{"type":"array","items":{"type":"object","required":["step","key","count","conversion_rate","dropoff","dropoff_rate","avg_time_from_previous_ms","median_time_from_previous_ms"],"properties":{"step":{"type":"number"},"key":{"type":"string"},"count":{"type":"number"},"conversion_rate":{"type":"number"},"dropoff":{"type":"number"},"dropoff_rate":{"type":"number"},"avg_time_from_previous_ms":{"type":["number","null"]},"median_time_from_previous_ms":{"type":["number","null"]}}}},"breakdown":{"type":["object","null"],"required":["dimension","segments"],"properties":{"dimension":{"enum":["source","country","device"]},"segments":{"type":"array","items":{"type":"object","required":["value","is_other","summary","steps"],"properties":{"value":{"type":"string"},"is_other":{"type":"boolean"},"summary":{"type":"object","required":["entrants","completions","overall_conversion_rate","biggest_dropoff_step","avg_time_to_convert_ms","median_time_to_convert_ms"],"properties":{"entrants":{"type":"number"},"completions":{"type":"number"},"overall_conversion_rate":{"type":"number"},"biggest_dropoff_step":{"type":["number","null"]},"avg_time_to_convert_ms":{"type":["number","null"]},"median_time_to_convert_ms":{"type":["number","null"]}}},"steps":{"type":"array","items":{"type":"object","required":["step","key","count","conversion_rate","dropoff","dropoff_rate","avg_time_from_previous_ms","median_time_from_previous_ms"],"properties":{"step":{"type":"number"},"key":{"type":"string"},"count":{"type":"number"},"conversion_rate":{"type":"number"},"dropoff":{"type":"number"},"dropoff_rate":{"type":"number"},"avg_time_from_previous_ms":{"type":["number","null"]},"median_time_from_previous_ms":{"type":["number","null"]}}}}}}}}}}}}}},"400":{"description":"Response for status 400","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"401":{"description":"Response for status 401","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"402":{"description":"Response for status 402","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"403":{"description":"Response for status 403","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"404":{"description":"Response for status 404","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"409":{"description":"Response for status 409","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"429":{"description":"Response for status 429","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"500":{"description":"Response for status 500","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"503":{"description":"Response for status 503","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}}}}},"/v1/sites/{site_id}/revenue/summary":{"get":{"tags":["Revenue"],"operationId":"getRevenueSummary","summary":"Total revenue over a range, optionally against the previous period","parameters":[{"name":"site_id","in":"path","required":true,"schema":{"type":"string","description":"The site id"}},{"name":"from","in":"query","required":true,"schema":{"type":"string","format":"date-time","pattern":"Z$"}},{"name":"to","in":"query","required":true,"schema":{"type":"string","format":"date-time","pattern":"Z$"}},{"name":"timezone","in":"query","required":true,"schema":{"type":"string","description":"An IANA time zone, e.g. Europe/Istanbul"}},{"name":"compare","in":"query","required":false,"schema":{"enum":["true","false"],"description":"Also total the previous period"}},{"name":"resolution","in":"query","required":false,"schema":{"enum":["hour","day"]}}],"responses":{"200":{"description":"Response for status 200","content":{"application/json":{"schema":{"type":"object","required":["meta","totals","comparison","unconverted"],"properties":{"meta":{"type":"object","required":["requested_range","effective_range","timezone","resolution","data_sources","accuracy","comparison_range","truncated","cached","partial","freshness"],"properties":{"requested_range":{"type":"object","required":["from","to"],"properties":{"from":{"type":"string","format":"date-time","pattern":"Z$"},"to":{"type":"string","format":"date-time","pattern":"Z$"}}},"effective_range":{"type":"object","required":["from","to"],"properties":{"from":{"type":"string","format":"date-time","pattern":"Z$"},"to":{"type":"string","format":"date-time","pattern":"Z$"}}},"timezone":{"type":"string","description":"An IANA time zone, e.g. Europe/Istanbul"},"resolution":{"enum":["minute","hour","day","week"]},"data_sources":{"type":"array","items":{"type":"string","const":"live"}},"accuracy":{"enum":["exact","estimated","provider_defined"]},"comparison_range":{"type":["object","null"],"required":["from","to"],"properties":{"from":{"type":"string","format":"date-time","pattern":"Z$"},"to":{"type":"string","format":"date-time","pattern":"Z$"}}},"truncated":{"type":"boolean","description":"The store capped the rows; the report is incomplete"},"cached":{"type":"boolean"},"partial":{"type":"boolean"},"freshness":{"type":"object","required":["state","watermark","as_of"],"properties":{"state":{"enum":["ok","no_data","stale","degraded"]},"watermark":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"as_of":{"type":"string","format":"date-time","pattern":"Z$"}}},"revenue":{"type":"object","required":["provider","connection_status","last_synced_at","last_webhook_at","rollup_through"],"properties":{"provider":{"type":["string","null"]},"connection_status":{"enum":["connected","degraded","disconnected","not_connected"]},"last_synced_at":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"last_webhook_at":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"rollup_through":{"type":["string","null"],"format":"date-time","pattern":"Z$"}}}}},"totals":{"type":"object","required":["currency","charge_gross_minor","refund_minor","dispute_withdrawn_minor","dispute_reinstated_minor","fee_minor","net_minor","charge_count","refund_count","dispute_count","unconverted_count"],"properties":{"currency":{"type":"string"},"charge_gross_minor":{"type":"number"},"refund_minor":{"type":"number"},"dispute_withdrawn_minor":{"type":"number"},"dispute_reinstated_minor":{"type":"number"},"fee_minor":{"type":"number"},"net_minor":{"type":"number"},"charge_count":{"type":"number"},"refund_count":{"type":"number"},"dispute_count":{"type":"number"},"unconverted_count":{"type":"number"}}},"comparison":{"type":["object","null"],"required":["totals"],"properties":{"totals":{"type":"object","required":["currency","charge_gross_minor","refund_minor","dispute_withdrawn_minor","dispute_reinstated_minor","fee_minor","net_minor","charge_count","refund_count","dispute_count","unconverted_count"],"properties":{"currency":{"type":"string"},"charge_gross_minor":{"type":"number"},"refund_minor":{"type":"number"},"dispute_withdrawn_minor":{"type":"number"},"dispute_reinstated_minor":{"type":"number"},"fee_minor":{"type":"number"},"net_minor":{"type":"number"},"charge_count":{"type":"number"},"refund_count":{"type":"number"},"dispute_count":{"type":"number"},"unconverted_count":{"type":"number"}}}}},"unconverted":{"type":"array","items":{"type":"object","required":["currency","charge_gross_minor","refund_minor","dispute_minor","transactions"],"properties":{"currency":{"type":"string"},"charge_gross_minor":{"type":"number"},"refund_minor":{"type":"number"},"dispute_minor":{"type":"number"},"transactions":{"type":"number"}}}}}}}}},"400":{"description":"Response for status 400","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"401":{"description":"Response for status 401","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"402":{"description":"Response for status 402","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"403":{"description":"Response for status 403","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"404":{"description":"Response for status 404","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"409":{"description":"Response for status 409","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"429":{"description":"Response for status 429","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"500":{"description":"Response for status 500","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"503":{"description":"Response for status 503","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}}}}},"/v1/sites/{site_id}/revenue/timeseries":{"get":{"tags":["Revenue"],"operationId":"getRevenueTimeseries","summary":"Revenue per hour or day over a range","parameters":[{"name":"site_id","in":"path","required":true,"schema":{"type":"string","description":"The site id"}},{"name":"from","in":"query","required":true,"schema":{"type":"string","format":"date-time","pattern":"Z$"}},{"name":"to","in":"query","required":true,"schema":{"type":"string","format":"date-time","pattern":"Z$"}},{"name":"timezone","in":"query","required":true,"schema":{"type":"string","description":"An IANA time zone, e.g. Europe/Istanbul"}},{"name":"resolution","in":"query","required":false,"schema":{"enum":["hour","day"]}}],"responses":{"200":{"description":"Response for status 200","content":{"application/json":{"schema":{"type":"object","required":["meta","series"],"properties":{"meta":{"type":"object","required":["requested_range","effective_range","timezone","resolution","data_sources","accuracy","comparison_range","truncated","cached","partial","freshness"],"properties":{"requested_range":{"type":"object","required":["from","to"],"properties":{"from":{"type":"string","format":"date-time","pattern":"Z$"},"to":{"type":"string","format":"date-time","pattern":"Z$"}}},"effective_range":{"type":"object","required":["from","to"],"properties":{"from":{"type":"string","format":"date-time","pattern":"Z$"},"to":{"type":"string","format":"date-time","pattern":"Z$"}}},"timezone":{"type":"string","description":"An IANA time zone, e.g. Europe/Istanbul"},"resolution":{"enum":["minute","hour","day","week"]},"data_sources":{"type":"array","items":{"type":"string","const":"live"}},"accuracy":{"enum":["exact","estimated","provider_defined"]},"comparison_range":{"type":["object","null"],"required":["from","to"],"properties":{"from":{"type":"string","format":"date-time","pattern":"Z$"},"to":{"type":"string","format":"date-time","pattern":"Z$"}}},"truncated":{"type":"boolean","description":"The store capped the rows; the report is incomplete"},"cached":{"type":"boolean"},"partial":{"type":"boolean"},"freshness":{"type":"object","required":["state","watermark","as_of"],"properties":{"state":{"enum":["ok","no_data","stale","degraded"]},"watermark":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"as_of":{"type":"string","format":"date-time","pattern":"Z$"}}},"revenue":{"type":"object","required":["provider","connection_status","last_synced_at","last_webhook_at","rollup_through"],"properties":{"provider":{"type":["string","null"]},"connection_status":{"enum":["connected","degraded","disconnected","not_connected"]},"last_synced_at":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"last_webhook_at":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"rollup_through":{"type":["string","null"],"format":"date-time","pattern":"Z$"}}}}},"series":{"type":"array","items":{"type":"object","required":["bucket","currency","charge_gross_minor","refund_minor","dispute_withdrawn_minor","dispute_reinstated_minor","fee_minor","net_minor","charge_count","refund_count","dispute_count","unconverted_count"],"properties":{"bucket":{"type":"string","format":"date-time","pattern":"Z$"},"currency":{"type":"string"},"charge_gross_minor":{"type":"number"},"refund_minor":{"type":"number"},"dispute_withdrawn_minor":{"type":"number"},"dispute_reinstated_minor":{"type":"number"},"fee_minor":{"type":"number"},"net_minor":{"type":"number"},"charge_count":{"type":"number"},"refund_count":{"type":"number"},"dispute_count":{"type":"number"},"unconverted_count":{"type":"number"}}}}}}}}},"400":{"description":"Response for status 400","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"401":{"description":"Response for status 401","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"402":{"description":"Response for status 402","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"403":{"description":"Response for status 403","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"404":{"description":"Response for status 404","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"409":{"description":"Response for status 409","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"429":{"description":"Response for status 429","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"500":{"description":"Response for status 500","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"503":{"description":"Response for status 503","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}}}}},"/v1/sites/{site_id}/revenue/transactions":{"get":{"tags":["Revenue"],"operationId":"listRevenueTransactions","summary":"List charges, refunds and disputes over a range, newest first","parameters":[{"name":"site_id","in":"path","required":true,"schema":{"type":"string","description":"The site id"}},{"name":"from","in":"query","required":true,"schema":{"type":"string","format":"date-time","pattern":"Z$"}},{"name":"to","in":"query","required":true,"schema":{"type":"string","format":"date-time","pattern":"Z$"}},{"name":"timezone","in":"query","required":true,"schema":{"type":"string","description":"An IANA time zone, e.g. Europe/Istanbul"}},{"name":"cursor","in":"query","required":false,"schema":{"type":"string","maxLength":512}},{"name":"limit","in":"query","required":false,"schema":{"type":"string","pattern":"^[0-9]{1,3}$","description":"Page size, 1 to 200"}}],"responses":{"200":{"description":"Response for status 200","content":{"application/json":{"schema":{"type":"object","required":["meta","items","next_cursor","has_more"],"properties":{"meta":{"type":"object","required":["requested_range","effective_range","timezone","resolution","data_sources","accuracy","comparison_range","truncated","cached","partial","freshness"],"properties":{"requested_range":{"type":"object","required":["from","to"],"properties":{"from":{"type":"string","format":"date-time","pattern":"Z$"},"to":{"type":"string","format":"date-time","pattern":"Z$"}}},"effective_range":{"type":"object","required":["from","to"],"properties":{"from":{"type":"string","format":"date-time","pattern":"Z$"},"to":{"type":"string","format":"date-time","pattern":"Z$"}}},"timezone":{"type":"string","description":"An IANA time zone, e.g. Europe/Istanbul"},"resolution":{"enum":["minute","hour","day","week"]},"data_sources":{"type":"array","items":{"type":"string","const":"live"}},"accuracy":{"enum":["exact","estimated","provider_defined"]},"comparison_range":{"type":["object","null"],"required":["from","to"],"properties":{"from":{"type":"string","format":"date-time","pattern":"Z$"},"to":{"type":"string","format":"date-time","pattern":"Z$"}}},"truncated":{"type":"boolean","description":"The store capped the rows; the report is incomplete"},"cached":{"type":"boolean"},"partial":{"type":"boolean"},"freshness":{"type":"object","required":["state","watermark","as_of"],"properties":{"state":{"enum":["ok","no_data","stale","degraded"]},"watermark":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"as_of":{"type":"string","format":"date-time","pattern":"Z$"}}},"revenue":{"type":"object","required":["provider","connection_status","last_synced_at","last_webhook_at","rollup_through"],"properties":{"provider":{"type":["string","null"]},"connection_status":{"enum":["connected","degraded","disconnected","not_connected"]},"last_synced_at":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"last_webhook_at":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"rollup_through":{"type":["string","null"],"format":"date-time","pattern":"Z$"}}}}},"items":{"type":"array","items":{"type":"object","required":["object_id","provider","object_kind","occurred_at","status","livemode","gross","refund","fee","net","reporting","conversion","parent_object_id","product_name"],"properties":{"object_id":{"type":"string"},"provider":{"type":"string"},"object_kind":{"enum":["charge","refund","dispute"]},"occurred_at":{"type":"string","format":"date-time","pattern":"Z$"},"status":{"type":"string"},"livemode":{"type":"boolean"},"gross":{"type":"object","required":["amount_minor","currency"],"properties":{"amount_minor":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"currency":{"type":"string","minLength":3,"maxLength":3,"pattern":"^[A-Z]{3}$"}}},"refund":{"type":"object","required":["amount_minor","currency"],"properties":{"amount_minor":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"currency":{"type":"string","minLength":3,"maxLength":3,"pattern":"^[A-Z]{3}$"}}},"fee":{"type":"object","required":["amount_minor","currency"],"properties":{"amount_minor":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"currency":{"type":"string","minLength":3,"maxLength":3,"pattern":"^[A-Z]{3}$"}}},"net":{"type":"object","required":["amount_minor","currency"],"properties":{"amount_minor":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"currency":{"type":"string","minLength":3,"maxLength":3,"pattern":"^[A-Z]{3}$"}}},"reporting":{"type":["object","null"],"required":["amount_minor","currency"],"properties":{"amount_minor":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"currency":{"type":"string","minLength":3,"maxLength":3,"pattern":"^[A-Z]{3}$"}}},"conversion":{"type":["object","null"],"required":["source","rate","rate_at"],"properties":{"source":{"type":"string","minLength":1},"rate":{"type":"number","exclusiveMinimum":0},"rate_at":{"type":"string","format":"date-time","pattern":"Z$"}}},"parent_object_id":{"type":["string","null"]},"product_name":{"type":["string","null"]}}}},"next_cursor":{"type":["string","null"]},"has_more":{"type":"boolean"}}}}}},"400":{"description":"Response for status 400","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"401":{"description":"Response for status 401","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"402":{"description":"Response for status 402","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"403":{"description":"Response for status 403","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"404":{"description":"Response for status 404","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"409":{"description":"Response for status 409","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"429":{"description":"Response for status 429","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"500":{"description":"Response for status 500","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"503":{"description":"Response for status 503","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}}}}},"/v1/sites/{site_id}/analytics/heatmaps":{"get":{"tags":["Heatmaps"],"operationId":"listHeatmapPages","summary":"List the pages with click and scroll data, busiest first","parameters":[{"name":"site_id","in":"path","required":true,"schema":{"type":"string","description":"The site id"}},{"name":"from","in":"query","required":true,"schema":{"type":"string","format":"date-time","pattern":"Z$"}},{"name":"to","in":"query","required":true,"schema":{"type":"string","format":"date-time","pattern":"Z$"}},{"name":"timezone","in":"query","required":false,"schema":{"type":"string","description":"An IANA time zone; defaults to UTC"}},{"name":"device","in":"query","required":false,"schema":{"enum":["desktop","mobile"],"description":"Defaults to desktop"}}],"responses":{"200":{"description":"Response for status 200","content":{"application/json":{"schema":{"type":"object","required":["meta","device","items"],"properties":{"meta":{"type":"object","required":["requested_range","effective_range","timezone","resolution","data_sources","accuracy","comparison_range","truncated","cached","partial","freshness"],"properties":{"requested_range":{"type":"object","required":["from","to"],"properties":{"from":{"type":"string","format":"date-time","pattern":"Z$"},"to":{"type":"string","format":"date-time","pattern":"Z$"}}},"effective_range":{"type":"object","required":["from","to"],"properties":{"from":{"type":"string","format":"date-time","pattern":"Z$"},"to":{"type":"string","format":"date-time","pattern":"Z$"}}},"timezone":{"type":"string","description":"An IANA time zone, e.g. Europe/Istanbul"},"resolution":{"enum":["minute","hour","day","week"]},"data_sources":{"type":"array","items":{"type":"string","const":"live"}},"accuracy":{"enum":["exact","estimated","provider_defined"]},"comparison_range":{"type":["object","null"],"required":["from","to"],"properties":{"from":{"type":"string","format":"date-time","pattern":"Z$"},"to":{"type":"string","format":"date-time","pattern":"Z$"}}},"truncated":{"type":"boolean","description":"The store capped the rows; the report is incomplete"},"cached":{"type":"boolean"},"partial":{"type":"boolean"},"freshness":{"type":"object","required":["state","watermark","as_of"],"properties":{"state":{"enum":["ok","no_data","stale","degraded"]},"watermark":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"as_of":{"type":"string","format":"date-time","pattern":"Z$"}}},"revenue":{"type":"object","required":["provider","connection_status","last_synced_at","last_webhook_at","rollup_through"],"properties":{"provider":{"type":["string","null"]},"connection_status":{"enum":["connected","degraded","disconnected","not_connected"]},"last_synced_at":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"last_webhook_at":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"rollup_through":{"type":["string","null"],"format":"date-time","pattern":"Z$"}}}}},"device":{"enum":["desktop","mobile"]},"items":{"type":"array","items":{"type":"object","required":["clicks","rage_clicks","dead_clicks","hostname","page_path","scroll"],"properties":{"clicks":{"type":"number"},"rage_clicks":{"type":"number"},"dead_clicks":{"type":"number"},"hostname":{"type":"string"},"page_path":{"type":"string"},"scroll":{"type":["object","null"],"required":["samples","average_percent","bins"],"properties":{"samples":{"type":"number"},"average_percent":{"type":"number"},"bins":{"type":"array","items":{"type":"number"}}}}}}}}}}}},"400":{"description":"Response for status 400","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"401":{"description":"Response for status 401","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"402":{"description":"Response for status 402","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"403":{"description":"Response for status 403","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"404":{"description":"Response for status 404","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"409":{"description":"Response for status 409","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"429":{"description":"Response for status 429","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"500":{"description":"Response for status 500","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"503":{"description":"Response for status 503","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}}}}},"/v1/sites/{site_id}/analytics/heatmaps/page":{"get":{"tags":["Heatmaps"],"operationId":"getHeatmapPage","summary":"Click and scroll aggregates for one page","parameters":[{"name":"site_id","in":"path","required":true,"schema":{"type":"string","description":"The site id"}},{"name":"from","in":"query","required":true,"schema":{"type":"string","format":"date-time","pattern":"Z$"}},{"name":"to","in":"query","required":true,"schema":{"type":"string","format":"date-time","pattern":"Z$"}},{"name":"timezone","in":"query","required":false,"schema":{"type":"string","description":"An IANA time zone; defaults to UTC"}},{"name":"device","in":"query","required":false,"schema":{"enum":["desktop","mobile"],"description":"Defaults to desktop"}},{"name":"hostname","in":"query","required":true,"schema":{"type":"string","description":"The page hostname, without a leading www."}},{"name":"path","in":"query","required":true,"schema":{"type":"string","description":"The page path, starting with /"}}],"responses":{"200":{"description":"Response for status 200","content":{"application/json":{"schema":{"type":"object","required":["meta","device","hostname","page_path","totals","devices","elements","scroll"],"properties":{"meta":{"type":"object","required":["requested_range","effective_range","timezone","resolution","data_sources","accuracy","comparison_range","truncated","cached","partial","freshness"],"properties":{"requested_range":{"type":"object","required":["from","to"],"properties":{"from":{"type":"string","format":"date-time","pattern":"Z$"},"to":{"type":"string","format":"date-time","pattern":"Z$"}}},"effective_range":{"type":"object","required":["from","to"],"properties":{"from":{"type":"string","format":"date-time","pattern":"Z$"},"to":{"type":"string","format":"date-time","pattern":"Z$"}}},"timezone":{"type":"string","description":"An IANA time zone, e.g. Europe/Istanbul"},"resolution":{"enum":["minute","hour","day","week"]},"data_sources":{"type":"array","items":{"type":"string","const":"live"}},"accuracy":{"enum":["exact","estimated","provider_defined"]},"comparison_range":{"type":["object","null"],"required":["from","to"],"properties":{"from":{"type":"string","format":"date-time","pattern":"Z$"},"to":{"type":"string","format":"date-time","pattern":"Z$"}}},"truncated":{"type":"boolean","description":"The store capped the rows; the report is incomplete"},"cached":{"type":"boolean"},"partial":{"type":"boolean"},"freshness":{"type":"object","required":["state","watermark","as_of"],"properties":{"state":{"enum":["ok","no_data","stale","degraded"]},"watermark":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"as_of":{"type":"string","format":"date-time","pattern":"Z$"}}},"revenue":{"type":"object","required":["provider","connection_status","last_synced_at","last_webhook_at","rollup_through"],"properties":{"provider":{"type":["string","null"]},"connection_status":{"enum":["connected","degraded","disconnected","not_connected"]},"last_synced_at":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"last_webhook_at":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"rollup_through":{"type":["string","null"],"format":"date-time","pattern":"Z$"}}}}},"device":{"enum":["desktop","mobile"]},"hostname":{"type":"string"},"page_path":{"type":"string"},"totals":{"type":"object","required":["clicks","rage_clicks","dead_clicks"],"properties":{"clicks":{"type":"number"},"rage_clicks":{"type":"number"},"dead_clicks":{"type":"number"}}},"devices":{"type":"object","required":["desktop","mobile"],"properties":{"desktop":{"type":"number"},"mobile":{"type":"number"}}},"elements":{"type":"array","items":{"type":"object","required":["clicks","rage_clicks","dead_clicks","selector"],"properties":{"clicks":{"type":"number"},"rage_clicks":{"type":"number"},"dead_clicks":{"type":"number"},"selector":{"type":"string"}}}},"scroll":{"type":["object","null"],"required":["samples","average_percent","bins"],"properties":{"samples":{"type":"number"},"average_percent":{"type":"number"},"bins":{"type":"array","items":{"type":"number"}}}}}}}}},"400":{"description":"Response for status 400","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"401":{"description":"Response for status 401","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"402":{"description":"Response for status 402","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"403":{"description":"Response for status 403","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"404":{"description":"Response for status 404","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"409":{"description":"Response for status 409","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"429":{"description":"Response for status 429","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"500":{"description":"Response for status 500","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"503":{"description":"Response for status 503","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}}}}},"/v1/sites/{site_id}/heatmaps/overlay-token":{"post":{"tags":["Heatmaps"],"operationId":"createHeatmapOverlayToken","summary":"Mint a token for the heatmap overlay on the site's own pages","parameters":[{"name":"site_id","in":"path","required":true,"schema":{"type":"string","description":"The site id"}}],"responses":{"200":{"description":"Response for status 200","content":{"application/json":{"schema":{"type":"object","required":["token","expires_at"],"properties":{"token":{"type":"string"},"expires_at":{"type":"string","format":"date-time","pattern":"Z$"}}}}}},"400":{"description":"Response for status 400","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"401":{"description":"Response for status 401","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"402":{"description":"Response for status 402","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"403":{"description":"Response for status 403","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"404":{"description":"Response for status 404","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"409":{"description":"Response for status 409","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"429":{"description":"Response for status 429","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"500":{"description":"Response for status 500","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"503":{"description":"Response for status 503","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}}}}},"/v1/sites/{site_id}/ingest/rejections":{"get":{"tags":["Ingest"],"operationId":"getIngestRejections","summary":"Count the events the collector refused, by reason, origin and bot","description":"Hourly buckets kept for 336 hours; the range is widened to whole hours and clamped to that window.","parameters":[{"name":"site_id","in":"path","required":true,"schema":{"type":"string","description":"The site id"}},{"name":"from","in":"query","required":true,"schema":{"type":"string","format":"date-time","pattern":"Z$"}},{"name":"to","in":"query","required":true,"schema":{"type":"string","format":"date-time","pattern":"Z$"}}],"responses":{"200":{"description":"Response for status 200","content":{"application/json":{"schema":{"type":"object","required":["from","to","clamped","retention_hours","total","last_seen_at","reasons","origins","bots","samples","local_testing","local_share","allowed_domains","reason_codes","bot_ruleset_version","referrer_spam_list_version"],"properties":{"from":{"type":"string","format":"date-time","pattern":"Z$"},"to":{"type":"string","format":"date-time","pattern":"Z$"},"clamped":{"type":"boolean"},"retention_hours":{"type":"number"},"total":{"type":"number"},"last_seen_at":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"reasons":{"type":"array","items":{"type":"object","required":["reason","count","last_seen_at"],"properties":{"reason":{"enum":["origin_not_allowed","origin_missing","origin_local","rate_limited","bot_known","bot_headless","bot_missing_user_agent","bot_automation_hint","fetch_metadata_mismatch","prefetch_request","gpc_opt_out","malformed_payload","event_too_old","event_invalid_timestamp","referrer_spam"]},"count":{"type":"number"},"last_seen_at":{"type":["string","null"],"format":"date-time","pattern":"Z$"}}}},"origins":{"type":"array","items":{"type":"object","required":["host","count","last_seen_at","local","suggested_domain","allowed_now"],"properties":{"host":{"type":["string","null"]},"count":{"type":"number"},"last_seen_at":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"local":{"type":"boolean"},"suggested_domain":{"type":["string","null"]},"allowed_now":{"type":"boolean"}}}},"bots":{"type":"array","items":{"type":"object","required":["signature","count"],"properties":{"signature":{"type":"string"},"count":{"type":"number"}}}},"samples":{"type":"array","items":{"type":"object","required":["reason","at","page","origin_host","client","bot"],"properties":{"reason":{"enum":["origin_not_allowed","origin_missing","origin_local","rate_limited","bot_known","bot_headless","bot_missing_user_agent","bot_automation_hint","fetch_metadata_mismatch","prefetch_request","gpc_opt_out","malformed_payload","event_too_old","event_invalid_timestamp","referrer_spam"]},"at":{"type":"string","format":"date-time","pattern":"Z$"},"page":{"type":["string","null"],"description":"Path only; the query is dropped"},"origin_host":{"type":["string","null"]},"client":{"type":["string","null"],"description":"A bot's user agent as sent, or a person's browser, OS and device class"},"bot":{"type":"boolean"}}},"description":"The latest refused requests, at most a few per reason, newest first"},"local_testing":{"type":"boolean"},"local_share":{"type":"number"},"allowed_domains":{"type":"array","items":{"type":"string"}},"reason_codes":{"type":"array","items":{"enum":["origin_not_allowed","origin_missing","origin_local","rate_limited","bot_known","bot_headless","bot_missing_user_agent","bot_automation_hint","fetch_metadata_mismatch","prefetch_request","gpc_opt_out","malformed_payload","event_too_old","event_invalid_timestamp","referrer_spam"]}},"bot_ruleset_version":{"type":"number"},"referrer_spam_list_version":{"type":"number"}}}}}},"400":{"description":"Response for status 400","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"401":{"description":"Response for status 401","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"402":{"description":"Response for status 402","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"403":{"description":"Response for status 403","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"404":{"description":"Response for status 404","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"409":{"description":"Response for status 409","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"429":{"description":"Response for status 429","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"500":{"description":"Response for status 500","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"503":{"description":"Response for status 503","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}}}}},"/v1/sites/{site_id}/alerts":{"get":{"tags":["Alerts"],"operationId":"getSiteAlerts","summary":"Get the alert settings, channels and recent incidents of a site","parameters":[{"name":"site_id","in":"path","required":true,"schema":{"type":"string","description":"The site id"}}],"responses":{"200":{"description":"Response for status 200","content":{"application/json":{"schema":{"type":"object","required":["settings","channels","incidents"],"properties":{"settings":{"type":"object","required":["silence","drop","spike","muted_until"],"properties":{"silence":{"type":"boolean"},"drop":{"type":"boolean"},"spike":{"type":"boolean"},"muted_until":{"type":["string","null"],"format":"date-time","pattern":"Z$"}}},"channels":{"type":"array","items":{"type":"object","required":["id","type","label","hint","created_at","last_delivered_at","last_failed_at","last_error"],"properties":{"id":{"type":"string"},"type":{"enum":["slack","discord","ntfy","webhook"]},"label":{"type":"string"},"hint":{"type":"string"},"created_at":{"type":"string","format":"date-time","pattern":"Z$"},"last_delivered_at":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"last_failed_at":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"last_error":{"type":["string","null"]}}}},"incidents":{"type":"array","items":{"type":"object","required":["id","trigger","state","title","text","opened_at","resolved_at"],"properties":{"id":{"type":"string"},"trigger":{"enum":["silence","drop","spike"]},"state":{"enum":["open","resolved"]},"title":{"type":"string"},"text":{"type":"string"},"opened_at":{"type":"string","format":"date-time","pattern":"Z$"},"resolved_at":{"type":["string","null"],"format":"date-time","pattern":"Z$"}}}}}}}}},"400":{"description":"Response for status 400","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"401":{"description":"Response for status 401","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"402":{"description":"Response for status 402","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"403":{"description":"Response for status 403","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"404":{"description":"Response for status 404","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"409":{"description":"Response for status 409","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"429":{"description":"Response for status 429","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"500":{"description":"Response for status 500","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"503":{"description":"Response for status 503","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}}}},"patch":{"tags":["Alerts"],"operationId":"updateAlertSettings","summary":"Turn alert triggers on or off, or mute alerts for a while","parameters":[{"name":"site_id","in":"path","required":true,"schema":{"type":"string","description":"The site id"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"silence":{"type":"boolean"},"drop":{"type":"boolean"},"spike":{"type":"boolean"},"muted_until":{"type":["string","null"],"description":"When to unmute: an instant within the next 30 days"}}}}},"required":true},"responses":{"200":{"description":"Response for status 200","content":{"application/json":{"schema":{"type":"object","required":["silence","drop","spike","muted_until"],"properties":{"silence":{"type":"boolean"},"drop":{"type":"boolean"},"spike":{"type":"boolean"},"muted_until":{"type":["string","null"],"format":"date-time","pattern":"Z$"}}}}}},"400":{"description":"Response for status 400","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"401":{"description":"Response for status 401","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"402":{"description":"Response for status 402","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"403":{"description":"Response for status 403","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"404":{"description":"Response for status 404","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"409":{"description":"Response for status 409","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"429":{"description":"Response for status 429","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"500":{"description":"Response for status 500","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"503":{"description":"Response for status 503","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}}}}},"/v1/sites/{site_id}/alerts/channels":{"post":{"tags":["Alerts"],"operationId":"createAlertChannel","summary":"Add an alert channel after a test message gets through","parameters":[{"name":"site_id","in":"path","required":true,"schema":{"type":"string","description":"The site id"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["type","url"],"properties":{"type":{"enum":["slack","discord","ntfy","webhook"]},"url":{"type":"string","description":"The webhook or ntfy topic URL"},"label":{"type":["string","null"]},"token":{"type":["string","null"],"description":"ntfy access token"}}}}},"required":true},"responses":{"201":{"description":"Response for status 201","content":{"application/json":{"schema":{"type":"object","required":["channel","signing_secret"],"properties":{"channel":{"type":"object","required":["id","type","label","hint","created_at","last_delivered_at","last_failed_at","last_error"],"properties":{"id":{"type":"string"},"type":{"enum":["slack","discord","ntfy","webhook"]},"label":{"type":"string"},"hint":{"type":"string"},"created_at":{"type":"string","format":"date-time","pattern":"Z$"},"last_delivered_at":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"last_failed_at":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"last_error":{"type":["string","null"]}}},"signing_secret":{"type":["string","null"]}}}}}},"400":{"description":"Response for status 400","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"401":{"description":"Response for status 401","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"402":{"description":"Response for status 402","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"403":{"description":"Response for status 403","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"404":{"description":"Response for status 404","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"409":{"description":"Response for status 409","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"429":{"description":"Response for status 429","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"500":{"description":"Response for status 500","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"503":{"description":"Response for status 503","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}}}}},"/v1/sites/{site_id}/alerts/channels/{channel_id}/test":{"post":{"tags":["Alerts"],"operationId":"testAlertChannel","summary":"Send a test message through an alert channel","parameters":[{"name":"site_id","in":"path","required":true,"schema":{"type":"string","description":"The site id"}},{"name":"channel_id","in":"path","required":true,"schema":{"type":"string","description":"The alert channel id"}}],"responses":{"200":{"description":"Response for status 200","content":{"application/json":{"schema":{"type":"object","required":["id","type","label","hint","created_at","last_delivered_at","last_failed_at","last_error"],"properties":{"id":{"type":"string"},"type":{"enum":["slack","discord","ntfy","webhook"]},"label":{"type":"string"},"hint":{"type":"string"},"created_at":{"type":"string","format":"date-time","pattern":"Z$"},"last_delivered_at":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"last_failed_at":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"last_error":{"type":["string","null"]}}}}}},"400":{"description":"Response for status 400","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"401":{"description":"Response for status 401","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"402":{"description":"Response for status 402","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"403":{"description":"Response for status 403","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"404":{"description":"Response for status 404","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"409":{"description":"Response for status 409","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"429":{"description":"Response for status 429","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"500":{"description":"Response for status 500","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"503":{"description":"Response for status 503","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}}}}},"/v1/sites/{site_id}/alerts/channels/{channel_id}":{"delete":{"tags":["Alerts"],"operationId":"deleteAlertChannel","summary":"Remove an alert channel","parameters":[{"name":"site_id","in":"path","required":true,"schema":{"type":"string","description":"The site id"}},{"name":"channel_id","in":"path","required":true,"schema":{"type":"string","description":"The alert channel id"}}],"responses":{"204":{"description":"No content"},"400":{"description":"Response for status 400","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"401":{"description":"Response for status 401","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"402":{"description":"Response for status 402","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"403":{"description":"Response for status 403","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"404":{"description":"Response for status 404","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"409":{"description":"Response for status 409","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"429":{"description":"Response for status 429","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"500":{"description":"Response for status 500","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"503":{"description":"Response for status 503","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}}}}},"/v1/sites/{site_id}/exports":{"get":{"tags":["Exports"],"operationId":"listSiteExports","summary":"List the site's exports, newest first, the expired ones included","parameters":[{"name":"site_id","in":"path","required":true,"schema":{"type":"string","description":"The site id"}}],"responses":{"200":{"description":"Response for status 200","content":{"application/json":{"schema":{"type":"object","required":["items"],"properties":{"items":{"type":"array","items":{"type":"object","required":["id","status","requested_by","event_count","size_bytes","error","created_at","started_at","completed_at","expires_at"],"properties":{"id":{"type":"string"},"status":{"enum":["queued","running","ready","failed","expired"]},"requested_by":{"type":["object","null"],"required":["id","name"],"properties":{"id":{"type":"string"},"name":{"type":"string"}}},"event_count":{"type":["integer","null"]},"size_bytes":{"type":["integer","null"]},"error":{"type":["string","null"]},"created_at":{"type":"string","format":"date-time","pattern":"Z$"},"started_at":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"completed_at":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"expires_at":{"type":["string","null"],"format":"date-time","pattern":"Z$"}}}}}}}}},"400":{"description":"Response for status 400","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"401":{"description":"Response for status 401","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"402":{"description":"Response for status 402","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"403":{"description":"Response for status 403","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"404":{"description":"Response for status 404","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"409":{"description":"Response for status 409","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"429":{"description":"Response for status 429","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"500":{"description":"Response for status 500","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"503":{"description":"Response for status 503","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}}}},"post":{"tags":["Exports"],"operationId":"createSiteExport","summary":"Start an export of the site's raw events and funnels","description":"Builds one gzipped NDJSON file in the background: an `export` header, then every `funnel`, then every event. Answers 202 with the new export, or 200 with the one already in progress. Once it is `ready`, download it within 24 hours.","parameters":[{"name":"site_id","in":"path","required":true,"schema":{"type":"string","description":"The site id"}}],"responses":{"200":{"description":"Response for status 200","content":{"application/json":{"schema":{"type":"object","required":["id","status","requested_by","event_count","size_bytes","error","created_at","started_at","completed_at","expires_at"],"properties":{"id":{"type":"string"},"status":{"enum":["queued","running","ready","failed","expired"]},"requested_by":{"type":["object","null"],"required":["id","name"],"properties":{"id":{"type":"string"},"name":{"type":"string"}}},"event_count":{"type":["integer","null"]},"size_bytes":{"type":["integer","null"]},"error":{"type":["string","null"]},"created_at":{"type":"string","format":"date-time","pattern":"Z$"},"started_at":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"completed_at":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"expires_at":{"type":["string","null"],"format":"date-time","pattern":"Z$"}}}}}},"202":{"description":"Response for status 202","content":{"application/json":{"schema":{"type":"object","required":["id","status","requested_by","event_count","size_bytes","error","created_at","started_at","completed_at","expires_at"],"properties":{"id":{"type":"string"},"status":{"enum":["queued","running","ready","failed","expired"]},"requested_by":{"type":["object","null"],"required":["id","name"],"properties":{"id":{"type":"string"},"name":{"type":"string"}}},"event_count":{"type":["integer","null"]},"size_bytes":{"type":["integer","null"]},"error":{"type":["string","null"]},"created_at":{"type":"string","format":"date-time","pattern":"Z$"},"started_at":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"completed_at":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"expires_at":{"type":["string","null"],"format":"date-time","pattern":"Z$"}}}}}},"400":{"description":"Response for status 400","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"401":{"description":"Response for status 401","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"402":{"description":"Response for status 402","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"403":{"description":"Response for status 403","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"404":{"description":"Response for status 404","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"409":{"description":"Response for status 409","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"429":{"description":"Response for status 429","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"500":{"description":"Response for status 500","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"503":{"description":"Response for status 503","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}}}}},"/v1/sites/{site_id}/exports/{export_id}/download":{"get":{"tags":["Exports"],"operationId":"downloadSiteExport","summary":"Download a ready export","description":"Redirects to a link to the file that works for five minutes.","responses":{"302":{"description":"Redirect to the gzipped NDJSON file"},"401":{"description":"Not signed in","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"403":{"description":"No access to this site","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"404":{"description":"No such export","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"409":{"description":"The export is not ready yet","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"410":{"description":"The export has expired","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"500":{"description":"Internal error","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}}},"parameters":[{"name":"site_id","in":"path","required":true,"schema":{"type":"string","description":"The site id"}},{"name":"export_id","in":"path","required":true,"schema":{"type":"string","description":"The export id"}}]}},"/v1/sites/{site_id}/realtime/token":{"post":{"tags":["Realtime"],"operationId":"createRealtimeToken","summary":"Mint a short-lived token for the site realtime stream","parameters":[{"name":"site_id","in":"path","required":true,"schema":{"type":"string","description":"The site id"}}],"responses":{"200":{"description":"Response for status 200","content":{"application/json":{"schema":{"type":"object","required":["token","expires_at","epoch_check_seconds"],"properties":{"token":{"type":"string","minLength":1},"expires_at":{"type":"string","format":"date-time","pattern":"Z$"},"epoch_check_seconds":{"type":"integer","minimum":1,"maximum":15}},"additionalProperties":false}}}},"400":{"description":"Response for status 400","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"401":{"description":"Response for status 401","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"402":{"description":"Response for status 402","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"403":{"description":"Response for status 403","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"404":{"description":"Response for status 404","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"409":{"description":"Response for status 409","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"429":{"description":"Response for status 429","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"500":{"description":"Response for status 500","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"503":{"description":"Response for status 503","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}}}}},"/v1/workspaces":{"get":{"tags":["Workspaces"],"operationId":"listWorkspaces","summary":"List the caller's workspaces and which one is active","responses":{"200":{"description":"Response for status 200","content":{"application/json":{"schema":{"type":"object","required":["items","meta"],"properties":{"items":{"type":"array","items":{"type":"object","required":["workspace_id","slug","name","role","created_at"],"properties":{"workspace_id":{"type":"string"},"slug":{"type":"string"},"name":{"type":"string"},"role":{"enum":["viewer","member","owner"]},"created_at":{"type":"string","format":"date-time","pattern":"Z$"}}}},"meta":{"type":"object","required":["active_workspace_id"],"properties":{"active_workspace_id":{"type":["string","null"]}}}}}}}},"400":{"description":"Response for status 400","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"401":{"description":"Response for status 401","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"402":{"description":"Response for status 402","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"403":{"description":"Response for status 403","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"404":{"description":"Response for status 404","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"409":{"description":"Response for status 409","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"429":{"description":"Response for status 429","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"500":{"description":"Response for status 500","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"503":{"description":"Response for status 503","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}}}},"post":{"tags":["Workspaces"],"operationId":"createWorkspace","summary":"Create a workspace and make it the active one","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["name"],"properties":{"name":{"type":"string"}}}}},"required":true},"responses":{"201":{"description":"Response for status 201","content":{"application/json":{"schema":{"type":"object","required":["workspace_id","slug","name","role","created_at"],"properties":{"workspace_id":{"type":"string"},"slug":{"type":"string"},"name":{"type":"string"},"role":{"enum":["viewer","member","owner"]},"created_at":{"type":"string","format":"date-time","pattern":"Z$"}}}}}},"400":{"description":"Response for status 400","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"401":{"description":"Response for status 401","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"402":{"description":"Response for status 402","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"403":{"description":"Response for status 403","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"404":{"description":"Response for status 404","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"409":{"description":"Response for status 409","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"429":{"description":"Response for status 429","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"500":{"description":"Response for status 500","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"503":{"description":"Response for status 503","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}}}}},"/v1/workspaces/{workspace}":{"get":{"tags":["Workspaces"],"operationId":"getWorkspace","summary":"Get a workspace by id or slug","parameters":[{"name":"workspace","in":"path","required":true,"schema":{"type":"string","description":"The workspace id or slug"}}],"responses":{"200":{"description":"Response for status 200","content":{"application/json":{"schema":{"type":"object","required":["workspace_id","slug","name","role","created_at"],"properties":{"workspace_id":{"type":"string"},"slug":{"type":"string"},"name":{"type":"string"},"role":{"enum":["viewer","member","owner"]},"created_at":{"type":"string","format":"date-time","pattern":"Z$"}}}}}},"400":{"description":"Response for status 400","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"401":{"description":"Response for status 401","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"402":{"description":"Response for status 402","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"403":{"description":"Response for status 403","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"404":{"description":"Response for status 404","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"409":{"description":"Response for status 409","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"429":{"description":"Response for status 429","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"500":{"description":"Response for status 500","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"503":{"description":"Response for status 503","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}}}},"patch":{"tags":["Workspaces"],"operationId":"renameWorkspace","summary":"Rename a workspace","parameters":[{"name":"workspace","in":"path","required":true,"schema":{"type":"string","description":"The workspace id or slug"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["name"],"properties":{"name":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Response for status 200","content":{"application/json":{"schema":{"type":"object","required":["workspace_id","slug","name","role","created_at"],"properties":{"workspace_id":{"type":"string"},"slug":{"type":"string"},"name":{"type":"string"},"role":{"enum":["viewer","member","owner"]},"created_at":{"type":"string","format":"date-time","pattern":"Z$"}}}}}},"400":{"description":"Response for status 400","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"401":{"description":"Response for status 401","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"402":{"description":"Response for status 402","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"403":{"description":"Response for status 403","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"404":{"description":"Response for status 404","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"409":{"description":"Response for status 409","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"429":{"description":"Response for status 429","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"500":{"description":"Response for status 500","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"503":{"description":"Response for status 503","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}}}},"delete":{"tags":["Workspaces"],"operationId":"deleteWorkspace","summary":"Start deleting a workspace and all of its sites","description":"Needs the workspace's exact name as confirmation.","parameters":[{"name":"workspace","in":"path","required":true,"schema":{"type":"string","description":"The workspace id or slug"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["confirm"],"properties":{"confirm":{"type":"string","description":"The workspace's exact name"}}}}},"required":true},"responses":{"202":{"description":"Response for status 202","content":{"application/json":{"schema":{"type":"object","required":["workspace_id","deleting_sites"],"properties":{"workspace_id":{"type":"string"},"deleting_sites":{"type":"number"}}}}}},"400":{"description":"Response for status 400","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"401":{"description":"Response for status 401","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"402":{"description":"Response for status 402","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"403":{"description":"Response for status 403","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"404":{"description":"Response for status 404","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"409":{"description":"Response for status 409","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"429":{"description":"Response for status 429","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"500":{"description":"Response for status 500","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"503":{"description":"Response for status 503","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}}}}},"/v1/workspaces/{workspace}/activate":{"post":{"tags":["Workspaces"],"operationId":"activateWorkspace","summary":"Make a workspace the session's active one","parameters":[{"name":"workspace","in":"path","required":true,"schema":{"type":"string","description":"The workspace id or slug"}}],"responses":{"200":{"description":"Response for status 200","content":{"application/json":{"schema":{"type":"object","required":["workspace_id","slug","name","role","created_at"],"properties":{"workspace_id":{"type":"string"},"slug":{"type":"string"},"name":{"type":"string"},"role":{"enum":["viewer","member","owner"]},"created_at":{"type":"string","format":"date-time","pattern":"Z$"}}}}}},"400":{"description":"Response for status 400","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"401":{"description":"Response for status 401","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"402":{"description":"Response for status 402","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"403":{"description":"Response for status 403","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"404":{"description":"Response for status 404","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"409":{"description":"Response for status 409","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"429":{"description":"Response for status 429","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"500":{"description":"Response for status 500","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"503":{"description":"Response for status 503","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}}}}},"/v1/workspaces/{workspace}/members":{"get":{"tags":["Members"],"operationId":"listWorkspaceMembers","summary":"List a workspace's members","parameters":[{"name":"workspace","in":"path","required":true,"schema":{"type":"string","description":"The workspace id or slug"}}],"responses":{"200":{"description":"Response for status 200","content":{"application/json":{"schema":{"type":"object","required":["items"],"properties":{"items":{"type":"array","items":{"type":"object","required":["member_id","user_id","name","email","image","role","joined_at"],"properties":{"member_id":{"type":"string"},"user_id":{"type":"string"},"name":{"type":"string"},"email":{"type":"string"},"image":{"type":["string","null"]},"role":{"enum":["viewer","member","owner"]},"joined_at":{"type":"string","format":"date-time","pattern":"Z$"}}}}}}}}},"400":{"description":"Response for status 400","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"401":{"description":"Response for status 401","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"402":{"description":"Response for status 402","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"403":{"description":"Response for status 403","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"404":{"description":"Response for status 404","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"409":{"description":"Response for status 409","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"429":{"description":"Response for status 429","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"500":{"description":"Response for status 500","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"503":{"description":"Response for status 503","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}}}}},"/v1/workspaces/{workspace}/members/{member_id}":{"patch":{"tags":["Members"],"operationId":"updateWorkspaceMemberRole","summary":"Change a member's role","parameters":[{"name":"workspace","in":"path","required":true,"schema":{"type":"string","description":"The workspace id or slug"}},{"name":"member_id","in":"path","required":true,"schema":{"type":"string","description":"The member id"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["role"],"properties":{"role":{"enum":["viewer","member","owner"]}}}}},"required":true},"responses":{"200":{"description":"Response for status 200","content":{"application/json":{"schema":{"type":"object","required":["member_id","user_id","name","email","image","role","joined_at"],"properties":{"member_id":{"type":"string"},"user_id":{"type":"string"},"name":{"type":"string"},"email":{"type":"string"},"image":{"type":["string","null"]},"role":{"enum":["viewer","member","owner"]},"joined_at":{"type":"string","format":"date-time","pattern":"Z$"}}}}}},"400":{"description":"Response for status 400","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"401":{"description":"Response for status 401","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"402":{"description":"Response for status 402","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"403":{"description":"Response for status 403","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"404":{"description":"Response for status 404","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"409":{"description":"Response for status 409","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"429":{"description":"Response for status 429","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"500":{"description":"Response for status 500","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"503":{"description":"Response for status 503","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}}}},"delete":{"tags":["Members"],"operationId":"removeWorkspaceMember","summary":"Remove a member, or leave the workspace when the member is the caller","parameters":[{"name":"workspace","in":"path","required":true,"schema":{"type":"string","description":"The workspace id or slug"}},{"name":"member_id","in":"path","required":true,"schema":{"type":"string","description":"The member id"}}],"responses":{"200":{"description":"Response for status 200","content":{"application/json":{"schema":{"type":"object","required":["member_id","left"],"properties":{"member_id":{"type":"string"},"left":{"type":"boolean"}}}}}},"400":{"description":"Response for status 400","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"401":{"description":"Response for status 401","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"402":{"description":"Response for status 402","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"403":{"description":"Response for status 403","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"404":{"description":"Response for status 404","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"409":{"description":"Response for status 409","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"429":{"description":"Response for status 429","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"500":{"description":"Response for status 500","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"503":{"description":"Response for status 503","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}}}}},"/v1/workspaces/{workspace}/invitations":{"get":{"tags":["Invitations"],"operationId":"listWorkspaceInvitations","summary":"List a workspace's pending invitations","parameters":[{"name":"workspace","in":"path","required":true,"schema":{"type":"string","description":"The workspace id or slug"}}],"responses":{"200":{"description":"Response for status 200","content":{"application/json":{"schema":{"type":"object","required":["items"],"properties":{"items":{"type":"array","items":{"type":"object","required":["invitation_id","email","role","expires_at","created_at","inviter_name"],"properties":{"invitation_id":{"type":"string"},"email":{"type":"string"},"role":{"enum":["viewer","member","owner"]},"expires_at":{"type":"string","format":"date-time","pattern":"Z$"},"created_at":{"type":"string","format":"date-time","pattern":"Z$"},"inviter_name":{"type":["string","null"]}}}}}}}}},"400":{"description":"Response for status 400","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"401":{"description":"Response for status 401","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"402":{"description":"Response for status 402","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"403":{"description":"Response for status 403","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"404":{"description":"Response for status 404","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"409":{"description":"Response for status 409","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"429":{"description":"Response for status 429","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"500":{"description":"Response for status 500","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"503":{"description":"Response for status 503","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}}}},"post":{"tags":["Invitations"],"operationId":"createWorkspaceInvitations","summary":"Invite people to a workspace by email","parameters":[{"name":"workspace","in":"path","required":true,"schema":{"type":"string","description":"The workspace id or slug"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["emails","role"],"properties":{"emails":{"type":"array","items":{"type":"string"}},"role":{"enum":["viewer","member","owner"]}}}}},"required":true},"responses":{"200":{"description":"Response for status 200","content":{"application/json":{"schema":{"type":"object","required":["items"],"properties":{"items":{"type":"array","items":{"anyOf":[{"type":"object","required":["email","status","invitation","mail"],"properties":{"email":{"type":"string"},"status":{"type":"string","const":"invited"},"invitation":{"type":"object","required":["invitation_id","email","role","expires_at","created_at","inviter_name"],"properties":{"invitation_id":{"type":"string"},"email":{"type":"string"},"role":{"enum":["viewer","member","owner"]},"expires_at":{"type":"string","format":"date-time","pattern":"Z$"},"created_at":{"type":"string","format":"date-time","pattern":"Z$"},"inviter_name":{"type":["string","null"]}}},"mail":{"enum":["sent","needs_live_site","limited","undeliverable","failed","off"]}}},{"type":"object","required":["email","status"],"properties":{"email":{"type":"string"},"status":{"type":"string","const":"already_member"}}}]}}}}}}},"400":{"description":"Response for status 400","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"401":{"description":"Response for status 401","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"402":{"description":"Response for status 402","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"403":{"description":"Response for status 403","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"404":{"description":"Response for status 404","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"409":{"description":"Response for status 409","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"429":{"description":"Response for status 429","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"500":{"description":"Response for status 500","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"503":{"description":"Response for status 503","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}}}}},"/v1/workspaces/{workspace}/invitations/{invitation_id}":{"delete":{"tags":["Invitations"],"operationId":"revokeWorkspaceInvitation","summary":"Revoke a pending invitation","parameters":[{"name":"workspace","in":"path","required":true,"schema":{"type":"string","description":"The workspace id or slug"}},{"name":"invitation_id","in":"path","required":true,"schema":{"type":"string","description":"The invitation id"}}],"responses":{"200":{"description":"Response for status 200","content":{"application/json":{"schema":{"type":"object","required":["invitation_id","status"],"properties":{"invitation_id":{"type":"string"},"status":{"type":"string","const":"canceled"}}}}}},"400":{"description":"Response for status 400","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"401":{"description":"Response for status 401","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"402":{"description":"Response for status 402","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"403":{"description":"Response for status 403","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"404":{"description":"Response for status 404","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"409":{"description":"Response for status 409","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"429":{"description":"Response for status 429","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"500":{"description":"Response for status 500","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"503":{"description":"Response for status 503","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}}}}},"/v1/invitations":{"get":{"tags":["Invitations"],"operationId":"listMyInvitations","summary":"List the open invitations sent to the caller's email address","responses":{"200":{"description":"Response for status 200","content":{"application/json":{"schema":{"type":"object","required":["items"],"properties":{"items":{"type":"array","items":{"type":"object","required":["invitation_id","workspace_name","role","inviter_name","expires_at"],"properties":{"invitation_id":{"type":"string"},"workspace_name":{"type":"string"},"role":{"enum":["viewer","member","owner"]},"inviter_name":{"type":["string","null"]},"expires_at":{"type":"string","format":"date-time","pattern":"Z$"}}}}}}}}},"400":{"description":"Response for status 400","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"401":{"description":"Response for status 401","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"402":{"description":"Response for status 402","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"403":{"description":"Response for status 403","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"404":{"description":"Response for status 404","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"409":{"description":"Response for status 409","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"429":{"description":"Response for status 429","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"500":{"description":"Response for status 500","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"503":{"description":"Response for status 503","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}}}}},"/v1/invitations/{invitation_id}/accept":{"post":{"tags":["Invitations"],"operationId":"acceptInvitation","summary":"Accept an invitation sent to the caller","parameters":[{"name":"invitation_id","in":"path","required":true,"schema":{"type":"string","description":"The invitation id"}}],"responses":{"200":{"description":"Response for status 200","content":{"application/json":{"schema":{"type":"object","required":["workspace","first_site_slug"],"properties":{"workspace":{"type":"object","required":["workspace_id","slug","name","role","created_at"],"properties":{"workspace_id":{"type":"string"},"slug":{"type":"string"},"name":{"type":"string"},"role":{"enum":["viewer","member","owner"]},"created_at":{"type":"string","format":"date-time","pattern":"Z$"}}},"first_site_slug":{"type":["string","null"]}}}}}},"400":{"description":"Response for status 400","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"401":{"description":"Response for status 401","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"402":{"description":"Response for status 402","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"403":{"description":"Response for status 403","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"404":{"description":"Response for status 404","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"409":{"description":"Response for status 409","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"429":{"description":"Response for status 429","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"500":{"description":"Response for status 500","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"503":{"description":"Response for status 503","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}}}}},"/v1/workspaces/{workspace}/transfer":{"get":{"tags":["Workspaces"],"operationId":"getWorkspaceTransfer","summary":"The open ownership offer, if any","parameters":[{"name":"workspace","in":"path","required":true,"schema":{"type":"string","description":"The workspace id or slug"}}],"responses":{"200":{"description":"Response for status 200","content":{"application/json":{"schema":{"type":"object","required":["offer"],"properties":{"offer":{"type":["object","null"],"required":["transfer_id","workspace","from","to","created_at","expires_at"],"properties":{"transfer_id":{"type":"string"},"workspace":{"type":"object","required":["workspace_id","slug","name"],"properties":{"workspace_id":{"type":"string"},"slug":{"type":"string"},"name":{"type":"string"}}},"from":{"type":"object","required":["name","email"],"properties":{"name":{"type":["string","null"]},"email":{"type":"string"}}},"to":{"type":"object","required":["name","email"],"properties":{"name":{"type":["string","null"]},"email":{"type":"string"}}},"created_at":{"type":"string","format":"date-time","pattern":"Z$"},"expires_at":{"type":"string","format":"date-time","pattern":"Z$"}}}}}}}},"400":{"description":"Response for status 400","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"401":{"description":"Response for status 401","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"402":{"description":"Response for status 402","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"403":{"description":"Response for status 403","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"404":{"description":"Response for status 404","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"409":{"description":"Response for status 409","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"429":{"description":"Response for status 429","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"500":{"description":"Response for status 500","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"503":{"description":"Response for status 503","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}}}},"post":{"tags":["Workspaces"],"operationId":"offerWorkspaceTransfer","summary":"Offer the workspace to a member; nothing changes until they accept","parameters":[{"name":"workspace","in":"path","required":true,"schema":{"type":"string","description":"The workspace id or slug"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["member_id"],"properties":{"member_id":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Response for status 200","content":{"application/json":{"schema":{"type":"object","required":["offer"],"properties":{"offer":{"type":["object","null"],"required":["transfer_id","workspace","from","to","created_at","expires_at"],"properties":{"transfer_id":{"type":"string"},"workspace":{"type":"object","required":["workspace_id","slug","name"],"properties":{"workspace_id":{"type":"string"},"slug":{"type":"string"},"name":{"type":"string"}}},"from":{"type":"object","required":["name","email"],"properties":{"name":{"type":["string","null"]},"email":{"type":"string"}}},"to":{"type":"object","required":["name","email"],"properties":{"name":{"type":["string","null"]},"email":{"type":"string"}}},"created_at":{"type":"string","format":"date-time","pattern":"Z$"},"expires_at":{"type":"string","format":"date-time","pattern":"Z$"}}}}}}}},"400":{"description":"Response for status 400","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"401":{"description":"Response for status 401","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"402":{"description":"Response for status 402","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"403":{"description":"Response for status 403","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"404":{"description":"Response for status 404","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"409":{"description":"Response for status 409","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"429":{"description":"Response for status 429","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"500":{"description":"Response for status 500","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"503":{"description":"Response for status 503","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}}}},"delete":{"tags":["Workspaces"],"operationId":"withdrawWorkspaceTransfer","summary":"Withdraw the open ownership offer","parameters":[{"name":"workspace","in":"path","required":true,"schema":{"type":"string","description":"The workspace id or slug"}}],"responses":{"200":{"description":"Response for status 200","content":{"application/json":{"schema":{"type":"object","required":["offer"],"properties":{"offer":{"type":["object","null"],"required":["transfer_id","workspace","from","to","created_at","expires_at"],"properties":{"transfer_id":{"type":"string"},"workspace":{"type":"object","required":["workspace_id","slug","name"],"properties":{"workspace_id":{"type":"string"},"slug":{"type":"string"},"name":{"type":"string"}}},"from":{"type":"object","required":["name","email"],"properties":{"name":{"type":["string","null"]},"email":{"type":"string"}}},"to":{"type":"object","required":["name","email"],"properties":{"name":{"type":["string","null"]},"email":{"type":"string"}}},"created_at":{"type":"string","format":"date-time","pattern":"Z$"},"expires_at":{"type":"string","format":"date-time","pattern":"Z$"}}}}}}}},"400":{"description":"Response for status 400","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"401":{"description":"Response for status 401","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"402":{"description":"Response for status 402","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"403":{"description":"Response for status 403","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"404":{"description":"Response for status 404","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"409":{"description":"Response for status 409","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"429":{"description":"Response for status 429","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"500":{"description":"Response for status 500","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"503":{"description":"Response for status 503","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}}}}},"/v1/me/transfers":{"get":{"tags":["Workspaces"],"operationId":"listIncomingTransfers","summary":"Workspaces offered to the caller, with what accepting would mean","responses":{"200":{"description":"Response for status 200","content":{"application/json":{"schema":{"type":"object","required":["items"],"properties":{"items":{"type":"array","items":{"type":"object","required":["transfer_id","workspace","from","to","created_at","expires_at","impact"],"properties":{"transfer_id":{"type":"string"},"workspace":{"type":"object","required":["workspace_id","slug","name"],"properties":{"workspace_id":{"type":"string"},"slug":{"type":"string"},"name":{"type":"string"}}},"from":{"type":"object","required":["name","email"],"properties":{"name":{"type":["string","null"]},"email":{"type":"string"}}},"to":{"type":"object","required":["name","email"],"properties":{"name":{"type":["string","null"]},"email":{"type":"string"}}},"created_at":{"type":"string","format":"date-time","pattern":"Z$"},"expires_at":{"type":"string","format":"date-time","pattern":"Z$"},"impact":{"type":"object","required":["workspace_plan","workspace_events","workspace_previous_events","workspace_sites","workspace_links","paid_until","events_after","previous_events_after","sites_after","links_after","quota","sites_limit","links_limit"],"properties":{"workspace_plan":{"enum":["free","trial","pro","comped"]},"workspace_events":{"type":"integer"},"workspace_previous_events":{"type":"integer"},"workspace_sites":{"type":"integer"},"workspace_links":{"type":"integer"},"paid_until":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"events_after":{"type":"integer"},"previous_events_after":{"type":"integer"},"sites_after":{"type":"integer"},"links_after":{"type":"integer"},"quota":{"type":"integer"},"sites_limit":{"type":"integer"},"links_limit":{"type":"integer"}}}}}}}}}}},"400":{"description":"Response for status 400","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"401":{"description":"Response for status 401","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"402":{"description":"Response for status 402","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"403":{"description":"Response for status 403","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"404":{"description":"Response for status 404","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"409":{"description":"Response for status 409","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"429":{"description":"Response for status 429","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"500":{"description":"Response for status 500","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"503":{"description":"Response for status 503","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}}}}},"/v1/transfers/{transfer_id}/{decision}":{"post":{"tags":["Workspaces"],"operationId":"resolveWorkspaceTransfer","summary":"Accept or decline an ownership offer","parameters":[{"name":"transfer_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"decision","in":"path","required":true,"schema":{"type":"string","enum":["accept","decline"]}}],"responses":{"200":{"description":"Response for status 200","content":{"application/json":{"schema":{"type":"object","required":["status","workspace_slug"],"properties":{"status":{"enum":["accepted","declined"]},"workspace_slug":{"type":"string"}}}}}},"400":{"description":"Response for status 400","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"401":{"description":"Response for status 401","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"402":{"description":"Response for status 402","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"403":{"description":"Response for status 403","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"404":{"description":"Response for status 404","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"409":{"description":"Response for status 409","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"429":{"description":"Response for status 429","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"500":{"description":"Response for status 500","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"503":{"description":"Response for status 503","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}}}}},"/v1/me/plan":{"get":{"tags":["Billing"],"operationId":"getAccountPlan","summary":"The caller's free plan and paid workspaces","responses":{"200":{"description":"Response for status 200","content":{"application/json":{"schema":{"type":"object","required":["free","paid"],"properties":{"free":{"type":"object","required":["month","events","quota","sites","sites_limit","active_links","links_limit","crawler_hits","crawler_quota","dropped_events","state","previous_month_over","crawler_paused","workspaces"],"properties":{"month":{"type":"string"},"events":{"type":"integer"},"quota":{"type":"integer"},"sites":{"type":"integer"},"sites_limit":{"type":"integer"},"active_links":{"type":"integer"},"links_limit":{"type":"integer"},"crawler_hits":{"type":"integer"},"crawler_quota":{"type":"integer"},"dropped_events":{"type":"integer"},"state":{"enum":["ok","warning","over","paused"]},"previous_month_over":{"type":"boolean"},"crawler_paused":{"type":"boolean"},"workspaces":{"type":"array","items":{"type":"object","required":["workspace_id","slug","name","events","sites","active_links"],"properties":{"workspace_id":{"type":"string"},"slug":{"type":"string"},"name":{"type":"string"},"events":{"type":"integer"},"sites":{"type":"integer"},"active_links":{"type":"integer"}}}}}},"paid":{"type":"array","items":{"type":"object","required":["workspace_id","slug","name","plan","plan_name","tier","interval","events","quota","renews_at","ends_at"],"properties":{"workspace_id":{"type":"string"},"slug":{"type":"string"},"name":{"type":"string"},"plan":{"enum":["trial","pro","comped"]},"plan_name":{"type":"string"},"tier":{"anyOf":[{"enum":["pro_100k","pro_250k","pro_1m","pro_3m","pro_10m"]},{"type":"null"}]},"interval":{"anyOf":[{"enum":["month","year"]},{"type":"null"}]},"events":{"type":"integer"},"quota":{"type":"integer"},"renews_at":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"ends_at":{"type":["string","null"],"format":"date-time","pattern":"Z$"}}}}}}}}},"400":{"description":"Response for status 400","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"401":{"description":"Response for status 401","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"402":{"description":"Response for status 402","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"403":{"description":"Response for status 403","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"404":{"description":"Response for status 404","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"409":{"description":"Response for status 409","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"429":{"description":"Response for status 429","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"500":{"description":"Response for status 500","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"503":{"description":"Response for status 503","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}}}}},"/v1/workspaces/{workspace}/billing/invoices":{"get":{"tags":["Billing"],"operationId":"listBillingInvoices","summary":"The workspace's charges, newest first","parameters":[{"name":"workspace","in":"path","required":true,"schema":{"type":"string","description":"The workspace id or slug"}}],"responses":{"200":{"description":"Response for status 200","content":{"application/json":{"schema":{"type":"object","required":["items"],"properties":{"items":{"type":"array","items":{"type":"object","required":["order_id","created_at","description","status","reason","total_cents","refunded_cents","currency","invoice_number"],"properties":{"order_id":{"type":"string"},"created_at":{"type":"string","format":"date-time","pattern":"Z$"},"description":{"type":"string"},"status":{"type":"string"},"reason":{"type":"string","description":"Why it was charged: a new subscription, a renewal, a plan change"},"total_cents":{"type":"integer"},"refunded_cents":{"type":"integer"},"currency":{"type":"string"},"invoice_number":{"type":["string","null"]}}}}}}}}},"400":{"description":"Response for status 400","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"401":{"description":"Response for status 401","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"402":{"description":"Response for status 402","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"403":{"description":"Response for status 403","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"404":{"description":"Response for status 404","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"409":{"description":"Response for status 409","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"429":{"description":"Response for status 429","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"500":{"description":"Response for status 500","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"503":{"description":"Response for status 503","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}}}}},"/v1/workspaces/{workspace}/billing/invoices/{order_id}/url":{"post":{"tags":["Billing"],"operationId":"billingInvoiceUrl","summary":"A link to one charge's invoice PDF; null while Polar is still rendering it","parameters":[{"name":"workspace","in":"path","required":true,"schema":{"type":"string"}},{"name":"order_id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Response for status 200","content":{"application/json":{"schema":{"type":"object","required":["url"],"properties":{"url":{"type":["string","null"]}}}}}},"400":{"description":"Response for status 400","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"401":{"description":"Response for status 401","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"402":{"description":"Response for status 402","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"403":{"description":"Response for status 403","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"404":{"description":"Response for status 404","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"409":{"description":"Response for status 409","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"429":{"description":"Response for status 429","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"500":{"description":"Response for status 500","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"503":{"description":"Response for status 503","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}}}}},"/v1/workspaces/{workspace}/billing":{"get":{"tags":["Billing"],"operationId":"getWorkspaceBilling","summary":"The workspace's plan and this month's usage","parameters":[{"name":"workspace","in":"path","required":true,"schema":{"type":"string","description":"The workspace id or slug"}}],"responses":{"200":{"description":"Response for status 200","content":{"application/json":{"schema":{"type":"object","required":["plan","tier","interval","limits","counts","usage","subscription","trial","allowance","can_manage","checkout_available","tiers"],"properties":{"plan":{"enum":["free","trial","pro","comped"]},"tier":{"anyOf":[{"enum":["pro_100k","pro_250k","pro_1m","pro_3m","pro_10m"]},{"type":"null"}]},"interval":{"anyOf":[{"enum":["month","year"]},{"type":"null"}]},"limits":{"type":"object","required":["events","sites","active_links","custom_link_domains","revenue_detail","watermark"],"properties":{"events":{"type":"integer"},"sites":{"type":["integer","null"]},"active_links":{"type":["integer","null"]},"custom_link_domains":{"type":"boolean"},"revenue_detail":{"type":"boolean"},"watermark":{"type":"boolean"}}},"counts":{"type":"object","required":["sites","active_links"],"properties":{"sites":{"type":"integer"},"active_links":{"type":"integer"}}},"usage":{"type":"object","required":["month","events","quota","dropped_events","crawler_hits","crawler_quota","state","crawler_paused","previous_month_over"],"properties":{"month":{"type":"string","description":"Calendar month in UTC, YYYY-MM"},"events":{"type":"integer"},"quota":{"type":"integer"},"dropped_events":{"type":"integer"},"crawler_hits":{"type":"integer"},"crawler_quota":{"type":"integer"},"state":{"enum":["ok","warning","over","paused"]},"crawler_paused":{"type":"boolean"},"previous_month_over":{"type":"boolean"}}},"subscription":{"type":["object","null"],"required":["status","current_period_end","cancel_at_period_end","pending_tier","pending_interval","discount"],"properties":{"status":{"type":"string"},"current_period_end":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"cancel_at_period_end":{"type":"boolean"},"pending_tier":{"anyOf":[{"enum":["pro_100k","pro_250k","pro_1m","pro_3m","pro_10m"]},{"type":"null"}]},"pending_interval":{"anyOf":[{"enum":["month","year"]},{"type":"null"}]},"discount":{"type":["object","null"],"required":["name","percent_off","duration","ends_at"],"properties":{"name":{"type":"string"},"percent_off":{"type":["number","null"],"minimum":0,"maximum":100},"duration":{"enum":["once","forever","repeating"]},"ends_at":{"type":["string","null"],"format":"date-time","pattern":"Z$"}}}}},"trial":{"type":"object","required":["days","events","ends_at","available","unavailable_reason"],"properties":{"days":{"type":"integer"},"events":{"type":"integer"},"ends_at":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"available":{"type":"boolean"},"unavailable_reason":{"anyOf":[{"enum":["already_paid","workspace_used","account_used"]},{"type":"null"}]}}},"allowance":{"type":["object","null"],"required":["owned_by_viewer","owner_name","state","previous_month_over","totals"],"properties":{"owned_by_viewer":{"type":"boolean"},"owner_name":{"type":["string","null"]},"state":{"enum":["ok","warning","over","paused"]},"previous_month_over":{"type":"boolean"},"totals":{"type":["object","null"],"required":["month","events","quota","sites","sites_limit","active_links","links_limit","crawler_hits","crawler_quota","dropped_events","state","previous_month_over","crawler_paused","workspaces"],"properties":{"month":{"type":"string"},"events":{"type":"integer"},"quota":{"type":"integer"},"sites":{"type":"integer"},"sites_limit":{"type":"integer"},"active_links":{"type":"integer"},"links_limit":{"type":"integer"},"crawler_hits":{"type":"integer"},"crawler_quota":{"type":"integer"},"dropped_events":{"type":"integer"},"state":{"enum":["ok","warning","over","paused"]},"previous_month_over":{"type":"boolean"},"crawler_paused":{"type":"boolean"},"workspaces":{"type":"array","items":{"type":"object","required":["workspace_id","slug","name","events","sites","active_links"],"properties":{"workspace_id":{"type":"string"},"slug":{"type":"string"},"name":{"type":"string"},"events":{"type":"integer"},"sites":{"type":"integer"},"active_links":{"type":"integer"}}}}}}}},"can_manage":{"type":"boolean"},"checkout_available":{"type":"boolean"},"tiers":{"type":"array","items":{"type":"object","required":["tier","name","events","monthly_cents","yearly_cents"],"properties":{"tier":{"enum":["pro_100k","pro_250k","pro_1m","pro_3m","pro_10m"]},"name":{"type":"string"},"events":{"type":"integer"},"monthly_cents":{"type":"integer"},"yearly_cents":{"type":"integer"}}}}}}}}},"400":{"description":"Response for status 400","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"401":{"description":"Response for status 401","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"402":{"description":"Response for status 402","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"403":{"description":"Response for status 403","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"404":{"description":"Response for status 404","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"409":{"description":"Response for status 409","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"429":{"description":"Response for status 429","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"500":{"description":"Response for status 500","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"503":{"description":"Response for status 503","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}}}}},"/v1/workspaces/{workspace}/billing/plan":{"post":{"tags":["Billing"],"operationId":"changeWorkspacePlan","summary":"Subscribe to a Pro tier, or move an existing subscription to another","parameters":[{"name":"workspace","in":"path","required":true,"schema":{"type":"string","description":"The workspace id or slug"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["tier","interval"],"properties":{"tier":{"enum":["pro_100k","pro_250k","pro_1m","pro_3m","pro_10m"]},"interval":{"enum":["month","year"]}}}}},"required":true},"responses":{"200":{"description":"Response for status 200","content":{"application/json":{"schema":{"anyOf":[{"type":"object","required":["kind","url"],"properties":{"kind":{"type":"string","const":"checkout"},"url":{"type":"string"}}},{"type":"object","required":["kind","timing","billing"],"properties":{"kind":{"type":"string","const":"changed"},"timing":{"enum":["now","period_end"]},"billing":{"type":"object","required":["plan","tier","interval","limits","counts","usage","subscription","trial","allowance","can_manage","checkout_available","tiers"],"properties":{"plan":{"enum":["free","trial","pro","comped"]},"tier":{"anyOf":[{"enum":["pro_100k","pro_250k","pro_1m","pro_3m","pro_10m"]},{"type":"null"}]},"interval":{"anyOf":[{"enum":["month","year"]},{"type":"null"}]},"limits":{"type":"object","required":["events","sites","active_links","custom_link_domains","revenue_detail","watermark"],"properties":{"events":{"type":"integer"},"sites":{"type":["integer","null"]},"active_links":{"type":["integer","null"]},"custom_link_domains":{"type":"boolean"},"revenue_detail":{"type":"boolean"},"watermark":{"type":"boolean"}}},"counts":{"type":"object","required":["sites","active_links"],"properties":{"sites":{"type":"integer"},"active_links":{"type":"integer"}}},"usage":{"type":"object","required":["month","events","quota","dropped_events","crawler_hits","crawler_quota","state","crawler_paused","previous_month_over"],"properties":{"month":{"type":"string","description":"Calendar month in UTC, YYYY-MM"},"events":{"type":"integer"},"quota":{"type":"integer"},"dropped_events":{"type":"integer"},"crawler_hits":{"type":"integer"},"crawler_quota":{"type":"integer"},"state":{"enum":["ok","warning","over","paused"]},"crawler_paused":{"type":"boolean"},"previous_month_over":{"type":"boolean"}}},"subscription":{"type":["object","null"],"required":["status","current_period_end","cancel_at_period_end","pending_tier","pending_interval","discount"],"properties":{"status":{"type":"string"},"current_period_end":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"cancel_at_period_end":{"type":"boolean"},"pending_tier":{"anyOf":[{"enum":["pro_100k","pro_250k","pro_1m","pro_3m","pro_10m"]},{"type":"null"}]},"pending_interval":{"anyOf":[{"enum":["month","year"]},{"type":"null"}]},"discount":{"type":["object","null"],"required":["name","percent_off","duration","ends_at"],"properties":{"name":{"type":"string"},"percent_off":{"type":["number","null"],"minimum":0,"maximum":100},"duration":{"enum":["once","forever","repeating"]},"ends_at":{"type":["string","null"],"format":"date-time","pattern":"Z$"}}}}},"trial":{"type":"object","required":["days","events","ends_at","available","unavailable_reason"],"properties":{"days":{"type":"integer"},"events":{"type":"integer"},"ends_at":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"available":{"type":"boolean"},"unavailable_reason":{"anyOf":[{"enum":["already_paid","workspace_used","account_used"]},{"type":"null"}]}}},"allowance":{"type":["object","null"],"required":["owned_by_viewer","owner_name","state","previous_month_over","totals"],"properties":{"owned_by_viewer":{"type":"boolean"},"owner_name":{"type":["string","null"]},"state":{"enum":["ok","warning","over","paused"]},"previous_month_over":{"type":"boolean"},"totals":{"type":["object","null"],"required":["month","events","quota","sites","sites_limit","active_links","links_limit","crawler_hits","crawler_quota","dropped_events","state","previous_month_over","crawler_paused","workspaces"],"properties":{"month":{"type":"string"},"events":{"type":"integer"},"quota":{"type":"integer"},"sites":{"type":"integer"},"sites_limit":{"type":"integer"},"active_links":{"type":"integer"},"links_limit":{"type":"integer"},"crawler_hits":{"type":"integer"},"crawler_quota":{"type":"integer"},"dropped_events":{"type":"integer"},"state":{"enum":["ok","warning","over","paused"]},"previous_month_over":{"type":"boolean"},"crawler_paused":{"type":"boolean"},"workspaces":{"type":"array","items":{"type":"object","required":["workspace_id","slug","name","events","sites","active_links"],"properties":{"workspace_id":{"type":"string"},"slug":{"type":"string"},"name":{"type":"string"},"events":{"type":"integer"},"sites":{"type":"integer"},"active_links":{"type":"integer"}}}}}}}},"can_manage":{"type":"boolean"},"checkout_available":{"type":"boolean"},"tiers":{"type":"array","items":{"type":"object","required":["tier","name","events","monthly_cents","yearly_cents"],"properties":{"tier":{"enum":["pro_100k","pro_250k","pro_1m","pro_3m","pro_10m"]},"name":{"type":"string"},"events":{"type":"integer"},"monthly_cents":{"type":"integer"},"yearly_cents":{"type":"integer"}}}}}}}}]}}}},"400":{"description":"Response for status 400","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"401":{"description":"Response for status 401","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"402":{"description":"Response for status 402","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"403":{"description":"Response for status 403","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"404":{"description":"Response for status 404","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"409":{"description":"Response for status 409","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"429":{"description":"Response for status 429","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"500":{"description":"Response for status 500","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"503":{"description":"Response for status 503","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}}}}},"/v1/workspaces/{workspace}/billing/cancel":{"post":{"tags":["Billing"],"operationId":"cancelWorkspacePlan","summary":"Cancel Pro at the end of the paid period","parameters":[{"name":"workspace","in":"path","required":true,"schema":{"type":"string","description":"The workspace id or slug"}}],"responses":{"200":{"description":"Response for status 200","content":{"application/json":{"schema":{"type":"object","required":["plan","tier","interval","limits","counts","usage","subscription","trial","allowance","can_manage","checkout_available","tiers"],"properties":{"plan":{"enum":["free","trial","pro","comped"]},"tier":{"anyOf":[{"enum":["pro_100k","pro_250k","pro_1m","pro_3m","pro_10m"]},{"type":"null"}]},"interval":{"anyOf":[{"enum":["month","year"]},{"type":"null"}]},"limits":{"type":"object","required":["events","sites","active_links","custom_link_domains","revenue_detail","watermark"],"properties":{"events":{"type":"integer"},"sites":{"type":["integer","null"]},"active_links":{"type":["integer","null"]},"custom_link_domains":{"type":"boolean"},"revenue_detail":{"type":"boolean"},"watermark":{"type":"boolean"}}},"counts":{"type":"object","required":["sites","active_links"],"properties":{"sites":{"type":"integer"},"active_links":{"type":"integer"}}},"usage":{"type":"object","required":["month","events","quota","dropped_events","crawler_hits","crawler_quota","state","crawler_paused","previous_month_over"],"properties":{"month":{"type":"string","description":"Calendar month in UTC, YYYY-MM"},"events":{"type":"integer"},"quota":{"type":"integer"},"dropped_events":{"type":"integer"},"crawler_hits":{"type":"integer"},"crawler_quota":{"type":"integer"},"state":{"enum":["ok","warning","over","paused"]},"crawler_paused":{"type":"boolean"},"previous_month_over":{"type":"boolean"}}},"subscription":{"type":["object","null"],"required":["status","current_period_end","cancel_at_period_end","pending_tier","pending_interval","discount"],"properties":{"status":{"type":"string"},"current_period_end":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"cancel_at_period_end":{"type":"boolean"},"pending_tier":{"anyOf":[{"enum":["pro_100k","pro_250k","pro_1m","pro_3m","pro_10m"]},{"type":"null"}]},"pending_interval":{"anyOf":[{"enum":["month","year"]},{"type":"null"}]},"discount":{"type":["object","null"],"required":["name","percent_off","duration","ends_at"],"properties":{"name":{"type":"string"},"percent_off":{"type":["number","null"],"minimum":0,"maximum":100},"duration":{"enum":["once","forever","repeating"]},"ends_at":{"type":["string","null"],"format":"date-time","pattern":"Z$"}}}}},"trial":{"type":"object","required":["days","events","ends_at","available","unavailable_reason"],"properties":{"days":{"type":"integer"},"events":{"type":"integer"},"ends_at":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"available":{"type":"boolean"},"unavailable_reason":{"anyOf":[{"enum":["already_paid","workspace_used","account_used"]},{"type":"null"}]}}},"allowance":{"type":["object","null"],"required":["owned_by_viewer","owner_name","state","previous_month_over","totals"],"properties":{"owned_by_viewer":{"type":"boolean"},"owner_name":{"type":["string","null"]},"state":{"enum":["ok","warning","over","paused"]},"previous_month_over":{"type":"boolean"},"totals":{"type":["object","null"],"required":["month","events","quota","sites","sites_limit","active_links","links_limit","crawler_hits","crawler_quota","dropped_events","state","previous_month_over","crawler_paused","workspaces"],"properties":{"month":{"type":"string"},"events":{"type":"integer"},"quota":{"type":"integer"},"sites":{"type":"integer"},"sites_limit":{"type":"integer"},"active_links":{"type":"integer"},"links_limit":{"type":"integer"},"crawler_hits":{"type":"integer"},"crawler_quota":{"type":"integer"},"dropped_events":{"type":"integer"},"state":{"enum":["ok","warning","over","paused"]},"previous_month_over":{"type":"boolean"},"crawler_paused":{"type":"boolean"},"workspaces":{"type":"array","items":{"type":"object","required":["workspace_id","slug","name","events","sites","active_links"],"properties":{"workspace_id":{"type":"string"},"slug":{"type":"string"},"name":{"type":"string"},"events":{"type":"integer"},"sites":{"type":"integer"},"active_links":{"type":"integer"}}}}}}}},"can_manage":{"type":"boolean"},"checkout_available":{"type":"boolean"},"tiers":{"type":"array","items":{"type":"object","required":["tier","name","events","monthly_cents","yearly_cents"],"properties":{"tier":{"enum":["pro_100k","pro_250k","pro_1m","pro_3m","pro_10m"]},"name":{"type":"string"},"events":{"type":"integer"},"monthly_cents":{"type":"integer"},"yearly_cents":{"type":"integer"}}}}}}}}},"400":{"description":"Response for status 400","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"401":{"description":"Response for status 401","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"402":{"description":"Response for status 402","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"403":{"description":"Response for status 403","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"404":{"description":"Response for status 404","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"409":{"description":"Response for status 409","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"429":{"description":"Response for status 429","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"500":{"description":"Response for status 500","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"503":{"description":"Response for status 503","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}}}}},"/v1/workspaces/{workspace}/billing/resume":{"post":{"tags":["Billing"],"operationId":"resumeWorkspacePlan","summary":"Keep Pro after a cancellation","parameters":[{"name":"workspace","in":"path","required":true,"schema":{"type":"string","description":"The workspace id or slug"}}],"responses":{"200":{"description":"Response for status 200","content":{"application/json":{"schema":{"type":"object","required":["plan","tier","interval","limits","counts","usage","subscription","trial","allowance","can_manage","checkout_available","tiers"],"properties":{"plan":{"enum":["free","trial","pro","comped"]},"tier":{"anyOf":[{"enum":["pro_100k","pro_250k","pro_1m","pro_3m","pro_10m"]},{"type":"null"}]},"interval":{"anyOf":[{"enum":["month","year"]},{"type":"null"}]},"limits":{"type":"object","required":["events","sites","active_links","custom_link_domains","revenue_detail","watermark"],"properties":{"events":{"type":"integer"},"sites":{"type":["integer","null"]},"active_links":{"type":["integer","null"]},"custom_link_domains":{"type":"boolean"},"revenue_detail":{"type":"boolean"},"watermark":{"type":"boolean"}}},"counts":{"type":"object","required":["sites","active_links"],"properties":{"sites":{"type":"integer"},"active_links":{"type":"integer"}}},"usage":{"type":"object","required":["month","events","quota","dropped_events","crawler_hits","crawler_quota","state","crawler_paused","previous_month_over"],"properties":{"month":{"type":"string","description":"Calendar month in UTC, YYYY-MM"},"events":{"type":"integer"},"quota":{"type":"integer"},"dropped_events":{"type":"integer"},"crawler_hits":{"type":"integer"},"crawler_quota":{"type":"integer"},"state":{"enum":["ok","warning","over","paused"]},"crawler_paused":{"type":"boolean"},"previous_month_over":{"type":"boolean"}}},"subscription":{"type":["object","null"],"required":["status","current_period_end","cancel_at_period_end","pending_tier","pending_interval","discount"],"properties":{"status":{"type":"string"},"current_period_end":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"cancel_at_period_end":{"type":"boolean"},"pending_tier":{"anyOf":[{"enum":["pro_100k","pro_250k","pro_1m","pro_3m","pro_10m"]},{"type":"null"}]},"pending_interval":{"anyOf":[{"enum":["month","year"]},{"type":"null"}]},"discount":{"type":["object","null"],"required":["name","percent_off","duration","ends_at"],"properties":{"name":{"type":"string"},"percent_off":{"type":["number","null"],"minimum":0,"maximum":100},"duration":{"enum":["once","forever","repeating"]},"ends_at":{"type":["string","null"],"format":"date-time","pattern":"Z$"}}}}},"trial":{"type":"object","required":["days","events","ends_at","available","unavailable_reason"],"properties":{"days":{"type":"integer"},"events":{"type":"integer"},"ends_at":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"available":{"type":"boolean"},"unavailable_reason":{"anyOf":[{"enum":["already_paid","workspace_used","account_used"]},{"type":"null"}]}}},"allowance":{"type":["object","null"],"required":["owned_by_viewer","owner_name","state","previous_month_over","totals"],"properties":{"owned_by_viewer":{"type":"boolean"},"owner_name":{"type":["string","null"]},"state":{"enum":["ok","warning","over","paused"]},"previous_month_over":{"type":"boolean"},"totals":{"type":["object","null"],"required":["month","events","quota","sites","sites_limit","active_links","links_limit","crawler_hits","crawler_quota","dropped_events","state","previous_month_over","crawler_paused","workspaces"],"properties":{"month":{"type":"string"},"events":{"type":"integer"},"quota":{"type":"integer"},"sites":{"type":"integer"},"sites_limit":{"type":"integer"},"active_links":{"type":"integer"},"links_limit":{"type":"integer"},"crawler_hits":{"type":"integer"},"crawler_quota":{"type":"integer"},"dropped_events":{"type":"integer"},"state":{"enum":["ok","warning","over","paused"]},"previous_month_over":{"type":"boolean"},"crawler_paused":{"type":"boolean"},"workspaces":{"type":"array","items":{"type":"object","required":["workspace_id","slug","name","events","sites","active_links"],"properties":{"workspace_id":{"type":"string"},"slug":{"type":"string"},"name":{"type":"string"},"events":{"type":"integer"},"sites":{"type":"integer"},"active_links":{"type":"integer"}}}}}}}},"can_manage":{"type":"boolean"},"checkout_available":{"type":"boolean"},"tiers":{"type":"array","items":{"type":"object","required":["tier","name","events","monthly_cents","yearly_cents"],"properties":{"tier":{"enum":["pro_100k","pro_250k","pro_1m","pro_3m","pro_10m"]},"name":{"type":"string"},"events":{"type":"integer"},"monthly_cents":{"type":"integer"},"yearly_cents":{"type":"integer"}}}}}}}}},"400":{"description":"Response for status 400","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"401":{"description":"Response for status 401","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"402":{"description":"Response for status 402","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"403":{"description":"Response for status 403","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"404":{"description":"Response for status 404","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"409":{"description":"Response for status 409","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"429":{"description":"Response for status 429","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"500":{"description":"Response for status 500","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"503":{"description":"Response for status 503","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}}}}},"/v1/workspaces/{workspace}/billing/trial":{"post":{"tags":["Billing"],"operationId":"startWorkspaceTrial","summary":"Start the 14-day free trial","parameters":[{"name":"workspace","in":"path","required":true,"schema":{"type":"string","description":"The workspace id or slug"}}],"responses":{"200":{"description":"Response for status 200","content":{"application/json":{"schema":{"type":"object","required":["plan","tier","interval","limits","counts","usage","subscription","trial","allowance","can_manage","checkout_available","tiers"],"properties":{"plan":{"enum":["free","trial","pro","comped"]},"tier":{"anyOf":[{"enum":["pro_100k","pro_250k","pro_1m","pro_3m","pro_10m"]},{"type":"null"}]},"interval":{"anyOf":[{"enum":["month","year"]},{"type":"null"}]},"limits":{"type":"object","required":["events","sites","active_links","custom_link_domains","revenue_detail","watermark"],"properties":{"events":{"type":"integer"},"sites":{"type":["integer","null"]},"active_links":{"type":["integer","null"]},"custom_link_domains":{"type":"boolean"},"revenue_detail":{"type":"boolean"},"watermark":{"type":"boolean"}}},"counts":{"type":"object","required":["sites","active_links"],"properties":{"sites":{"type":"integer"},"active_links":{"type":"integer"}}},"usage":{"type":"object","required":["month","events","quota","dropped_events","crawler_hits","crawler_quota","state","crawler_paused","previous_month_over"],"properties":{"month":{"type":"string","description":"Calendar month in UTC, YYYY-MM"},"events":{"type":"integer"},"quota":{"type":"integer"},"dropped_events":{"type":"integer"},"crawler_hits":{"type":"integer"},"crawler_quota":{"type":"integer"},"state":{"enum":["ok","warning","over","paused"]},"crawler_paused":{"type":"boolean"},"previous_month_over":{"type":"boolean"}}},"subscription":{"type":["object","null"],"required":["status","current_period_end","cancel_at_period_end","pending_tier","pending_interval","discount"],"properties":{"status":{"type":"string"},"current_period_end":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"cancel_at_period_end":{"type":"boolean"},"pending_tier":{"anyOf":[{"enum":["pro_100k","pro_250k","pro_1m","pro_3m","pro_10m"]},{"type":"null"}]},"pending_interval":{"anyOf":[{"enum":["month","year"]},{"type":"null"}]},"discount":{"type":["object","null"],"required":["name","percent_off","duration","ends_at"],"properties":{"name":{"type":"string"},"percent_off":{"type":["number","null"],"minimum":0,"maximum":100},"duration":{"enum":["once","forever","repeating"]},"ends_at":{"type":["string","null"],"format":"date-time","pattern":"Z$"}}}}},"trial":{"type":"object","required":["days","events","ends_at","available","unavailable_reason"],"properties":{"days":{"type":"integer"},"events":{"type":"integer"},"ends_at":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"available":{"type":"boolean"},"unavailable_reason":{"anyOf":[{"enum":["already_paid","workspace_used","account_used"]},{"type":"null"}]}}},"allowance":{"type":["object","null"],"required":["owned_by_viewer","owner_name","state","previous_month_over","totals"],"properties":{"owned_by_viewer":{"type":"boolean"},"owner_name":{"type":["string","null"]},"state":{"enum":["ok","warning","over","paused"]},"previous_month_over":{"type":"boolean"},"totals":{"type":["object","null"],"required":["month","events","quota","sites","sites_limit","active_links","links_limit","crawler_hits","crawler_quota","dropped_events","state","previous_month_over","crawler_paused","workspaces"],"properties":{"month":{"type":"string"},"events":{"type":"integer"},"quota":{"type":"integer"},"sites":{"type":"integer"},"sites_limit":{"type":"integer"},"active_links":{"type":"integer"},"links_limit":{"type":"integer"},"crawler_hits":{"type":"integer"},"crawler_quota":{"type":"integer"},"dropped_events":{"type":"integer"},"state":{"enum":["ok","warning","over","paused"]},"previous_month_over":{"type":"boolean"},"crawler_paused":{"type":"boolean"},"workspaces":{"type":"array","items":{"type":"object","required":["workspace_id","slug","name","events","sites","active_links"],"properties":{"workspace_id":{"type":"string"},"slug":{"type":"string"},"name":{"type":"string"},"events":{"type":"integer"},"sites":{"type":"integer"},"active_links":{"type":"integer"}}}}}}}},"can_manage":{"type":"boolean"},"checkout_available":{"type":"boolean"},"tiers":{"type":"array","items":{"type":"object","required":["tier","name","events","monthly_cents","yearly_cents"],"properties":{"tier":{"enum":["pro_100k","pro_250k","pro_1m","pro_3m","pro_10m"]},"name":{"type":"string"},"events":{"type":"integer"},"monthly_cents":{"type":"integer"},"yearly_cents":{"type":"integer"}}}}}}}}},"400":{"description":"Response for status 400","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"401":{"description":"Response for status 401","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"402":{"description":"Response for status 402","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"403":{"description":"Response for status 403","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"404":{"description":"Response for status 404","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"409":{"description":"Response for status 409","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"429":{"description":"Response for status 429","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"500":{"description":"Response for status 500","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"503":{"description":"Response for status 503","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}}}},"delete":{"tags":["Billing"],"operationId":"endWorkspaceTrial","summary":"End the free trial early","parameters":[{"name":"workspace","in":"path","required":true,"schema":{"type":"string","description":"The workspace id or slug"}}],"responses":{"200":{"description":"Response for status 200","content":{"application/json":{"schema":{"type":"object","required":["plan","tier","interval","limits","counts","usage","subscription","trial","allowance","can_manage","checkout_available","tiers"],"properties":{"plan":{"enum":["free","trial","pro","comped"]},"tier":{"anyOf":[{"enum":["pro_100k","pro_250k","pro_1m","pro_3m","pro_10m"]},{"type":"null"}]},"interval":{"anyOf":[{"enum":["month","year"]},{"type":"null"}]},"limits":{"type":"object","required":["events","sites","active_links","custom_link_domains","revenue_detail","watermark"],"properties":{"events":{"type":"integer"},"sites":{"type":["integer","null"]},"active_links":{"type":["integer","null"]},"custom_link_domains":{"type":"boolean"},"revenue_detail":{"type":"boolean"},"watermark":{"type":"boolean"}}},"counts":{"type":"object","required":["sites","active_links"],"properties":{"sites":{"type":"integer"},"active_links":{"type":"integer"}}},"usage":{"type":"object","required":["month","events","quota","dropped_events","crawler_hits","crawler_quota","state","crawler_paused","previous_month_over"],"properties":{"month":{"type":"string","description":"Calendar month in UTC, YYYY-MM"},"events":{"type":"integer"},"quota":{"type":"integer"},"dropped_events":{"type":"integer"},"crawler_hits":{"type":"integer"},"crawler_quota":{"type":"integer"},"state":{"enum":["ok","warning","over","paused"]},"crawler_paused":{"type":"boolean"},"previous_month_over":{"type":"boolean"}}},"subscription":{"type":["object","null"],"required":["status","current_period_end","cancel_at_period_end","pending_tier","pending_interval","discount"],"properties":{"status":{"type":"string"},"current_period_end":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"cancel_at_period_end":{"type":"boolean"},"pending_tier":{"anyOf":[{"enum":["pro_100k","pro_250k","pro_1m","pro_3m","pro_10m"]},{"type":"null"}]},"pending_interval":{"anyOf":[{"enum":["month","year"]},{"type":"null"}]},"discount":{"type":["object","null"],"required":["name","percent_off","duration","ends_at"],"properties":{"name":{"type":"string"},"percent_off":{"type":["number","null"],"minimum":0,"maximum":100},"duration":{"enum":["once","forever","repeating"]},"ends_at":{"type":["string","null"],"format":"date-time","pattern":"Z$"}}}}},"trial":{"type":"object","required":["days","events","ends_at","available","unavailable_reason"],"properties":{"days":{"type":"integer"},"events":{"type":"integer"},"ends_at":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"available":{"type":"boolean"},"unavailable_reason":{"anyOf":[{"enum":["already_paid","workspace_used","account_used"]},{"type":"null"}]}}},"allowance":{"type":["object","null"],"required":["owned_by_viewer","owner_name","state","previous_month_over","totals"],"properties":{"owned_by_viewer":{"type":"boolean"},"owner_name":{"type":["string","null"]},"state":{"enum":["ok","warning","over","paused"]},"previous_month_over":{"type":"boolean"},"totals":{"type":["object","null"],"required":["month","events","quota","sites","sites_limit","active_links","links_limit","crawler_hits","crawler_quota","dropped_events","state","previous_month_over","crawler_paused","workspaces"],"properties":{"month":{"type":"string"},"events":{"type":"integer"},"quota":{"type":"integer"},"sites":{"type":"integer"},"sites_limit":{"type":"integer"},"active_links":{"type":"integer"},"links_limit":{"type":"integer"},"crawler_hits":{"type":"integer"},"crawler_quota":{"type":"integer"},"dropped_events":{"type":"integer"},"state":{"enum":["ok","warning","over","paused"]},"previous_month_over":{"type":"boolean"},"crawler_paused":{"type":"boolean"},"workspaces":{"type":"array","items":{"type":"object","required":["workspace_id","slug","name","events","sites","active_links"],"properties":{"workspace_id":{"type":"string"},"slug":{"type":"string"},"name":{"type":"string"},"events":{"type":"integer"},"sites":{"type":"integer"},"active_links":{"type":"integer"}}}}}}}},"can_manage":{"type":"boolean"},"checkout_available":{"type":"boolean"},"tiers":{"type":"array","items":{"type":"object","required":["tier","name","events","monthly_cents","yearly_cents"],"properties":{"tier":{"enum":["pro_100k","pro_250k","pro_1m","pro_3m","pro_10m"]},"name":{"type":"string"},"events":{"type":"integer"},"monthly_cents":{"type":"integer"},"yearly_cents":{"type":"integer"}}}}}}}}},"400":{"description":"Response for status 400","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"401":{"description":"Response for status 401","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"402":{"description":"Response for status 402","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"403":{"description":"Response for status 403","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"404":{"description":"Response for status 404","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"409":{"description":"Response for status 409","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"429":{"description":"Response for status 429","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"500":{"description":"Response for status 500","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"503":{"description":"Response for status 503","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}}}}},"/v1/workspaces/{workspace}/billing/portal":{"post":{"tags":["Billing"],"operationId":"openBillingPortal","summary":"Open Polar's portal for invoices and the payment method","parameters":[{"name":"workspace","in":"path","required":true,"schema":{"type":"string","description":"The workspace id or slug"}}],"responses":{"200":{"description":"Response for status 200","content":{"application/json":{"schema":{"type":"object","required":["url"],"properties":{"url":{"type":"string"}}}}}},"400":{"description":"Response for status 400","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"401":{"description":"Response for status 401","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"402":{"description":"Response for status 402","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"403":{"description":"Response for status 403","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"404":{"description":"Response for status 404","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"409":{"description":"Response for status 409","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"429":{"description":"Response for status 429","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"500":{"description":"Response for status 500","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"503":{"description":"Response for status 503","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}}}}},"/v1/workspaces/{workspace}/billing/sync":{"post":{"tags":["Billing"],"operationId":"syncWorkspaceBilling","summary":"Read the subscription straight from the provider, after checkout","parameters":[{"name":"workspace","in":"path","required":true,"schema":{"type":"string","description":"The workspace id or slug"}}],"responses":{"200":{"description":"Response for status 200","content":{"application/json":{"schema":{"type":"object","required":["plan","tier","interval","limits","counts","usage","subscription","trial","allowance","can_manage","checkout_available","tiers"],"properties":{"plan":{"enum":["free","trial","pro","comped"]},"tier":{"anyOf":[{"enum":["pro_100k","pro_250k","pro_1m","pro_3m","pro_10m"]},{"type":"null"}]},"interval":{"anyOf":[{"enum":["month","year"]},{"type":"null"}]},"limits":{"type":"object","required":["events","sites","active_links","custom_link_domains","revenue_detail","watermark"],"properties":{"events":{"type":"integer"},"sites":{"type":["integer","null"]},"active_links":{"type":["integer","null"]},"custom_link_domains":{"type":"boolean"},"revenue_detail":{"type":"boolean"},"watermark":{"type":"boolean"}}},"counts":{"type":"object","required":["sites","active_links"],"properties":{"sites":{"type":"integer"},"active_links":{"type":"integer"}}},"usage":{"type":"object","required":["month","events","quota","dropped_events","crawler_hits","crawler_quota","state","crawler_paused","previous_month_over"],"properties":{"month":{"type":"string","description":"Calendar month in UTC, YYYY-MM"},"events":{"type":"integer"},"quota":{"type":"integer"},"dropped_events":{"type":"integer"},"crawler_hits":{"type":"integer"},"crawler_quota":{"type":"integer"},"state":{"enum":["ok","warning","over","paused"]},"crawler_paused":{"type":"boolean"},"previous_month_over":{"type":"boolean"}}},"subscription":{"type":["object","null"],"required":["status","current_period_end","cancel_at_period_end","pending_tier","pending_interval","discount"],"properties":{"status":{"type":"string"},"current_period_end":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"cancel_at_period_end":{"type":"boolean"},"pending_tier":{"anyOf":[{"enum":["pro_100k","pro_250k","pro_1m","pro_3m","pro_10m"]},{"type":"null"}]},"pending_interval":{"anyOf":[{"enum":["month","year"]},{"type":"null"}]},"discount":{"type":["object","null"],"required":["name","percent_off","duration","ends_at"],"properties":{"name":{"type":"string"},"percent_off":{"type":["number","null"],"minimum":0,"maximum":100},"duration":{"enum":["once","forever","repeating"]},"ends_at":{"type":["string","null"],"format":"date-time","pattern":"Z$"}}}}},"trial":{"type":"object","required":["days","events","ends_at","available","unavailable_reason"],"properties":{"days":{"type":"integer"},"events":{"type":"integer"},"ends_at":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"available":{"type":"boolean"},"unavailable_reason":{"anyOf":[{"enum":["already_paid","workspace_used","account_used"]},{"type":"null"}]}}},"allowance":{"type":["object","null"],"required":["owned_by_viewer","owner_name","state","previous_month_over","totals"],"properties":{"owned_by_viewer":{"type":"boolean"},"owner_name":{"type":["string","null"]},"state":{"enum":["ok","warning","over","paused"]},"previous_month_over":{"type":"boolean"},"totals":{"type":["object","null"],"required":["month","events","quota","sites","sites_limit","active_links","links_limit","crawler_hits","crawler_quota","dropped_events","state","previous_month_over","crawler_paused","workspaces"],"properties":{"month":{"type":"string"},"events":{"type":"integer"},"quota":{"type":"integer"},"sites":{"type":"integer"},"sites_limit":{"type":"integer"},"active_links":{"type":"integer"},"links_limit":{"type":"integer"},"crawler_hits":{"type":"integer"},"crawler_quota":{"type":"integer"},"dropped_events":{"type":"integer"},"state":{"enum":["ok","warning","over","paused"]},"previous_month_over":{"type":"boolean"},"crawler_paused":{"type":"boolean"},"workspaces":{"type":"array","items":{"type":"object","required":["workspace_id","slug","name","events","sites","active_links"],"properties":{"workspace_id":{"type":"string"},"slug":{"type":"string"},"name":{"type":"string"},"events":{"type":"integer"},"sites":{"type":"integer"},"active_links":{"type":"integer"}}}}}}}},"can_manage":{"type":"boolean"},"checkout_available":{"type":"boolean"},"tiers":{"type":"array","items":{"type":"object","required":["tier","name","events","monthly_cents","yearly_cents"],"properties":{"tier":{"enum":["pro_100k","pro_250k","pro_1m","pro_3m","pro_10m"]},"name":{"type":"string"},"events":{"type":"integer"},"monthly_cents":{"type":"integer"},"yearly_cents":{"type":"integer"}}}}}}}}},"400":{"description":"Response for status 400","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"401":{"description":"Response for status 401","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"402":{"description":"Response for status 402","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"403":{"description":"Response for status 403","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"404":{"description":"Response for status 404","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"409":{"description":"Response for status 409","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"429":{"description":"Response for status 429","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"500":{"description":"Response for status 500","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"503":{"description":"Response for status 503","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}}}}},"/v1/sites":{"get":{"tags":["Sites"],"operationId":"listSites","summary":"List the caller's sites with their all-time totals","responses":{"200":{"description":"Response for status 200","content":{"application/json":{"schema":{"type":"object","required":["items"],"properties":{"items":{"type":"array","items":{"type":"object","required":["show_hostname","site_id","slug","name","status","domains","created_at","first_event_at","reporting_currency","workspace","role","last_30_days","sparkline"],"properties":{"show_hostname":{"enum":["auto","always","never"]},"site_id":{"type":"string"},"slug":{"type":"string"},"name":{"type":"string"},"status":{"enum":["active","deleting","deleted"]},"domains":{"type":"array","items":{"type":"string"}},"created_at":{"type":"string","format":"date-time","pattern":"Z$"},"first_event_at":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"reporting_currency":{"type":"string"},"workspace":{"type":"object","required":["workspace_id","slug","name"],"properties":{"workspace_id":{"type":"string"},"slug":{"type":"string"},"name":{"type":"string"}}},"role":{"anyOf":[{"enum":["viewer","member","owner"]},{"type":"null"}]},"tag_sightings":{"type":["array","null"],"items":{"type":"object","required":["origin","seen_at","allowed"],"properties":{"origin":{"type":"string"},"seen_at":{"type":"string","format":"date-time","pattern":"Z$"},"allowed":{"type":"boolean"}}}},"last_30_days":{"type":["object","null"],"required":["visits","pageviews","revenue"],"properties":{"visits":{"type":"number"},"pageviews":{"type":"number"},"revenue":{"type":["object","null"],"required":["net_minor","currency"],"properties":{"net_minor":{"type":"number"},"currency":{"type":"string"}}}}},"sparkline":{"type":["array","null"],"items":{"type":"number"}}}}}}}}}},"400":{"description":"Response for status 400","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"401":{"description":"Response for status 401","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"402":{"description":"Response for status 402","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"403":{"description":"Response for status 403","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"404":{"description":"Response for status 404","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"409":{"description":"Response for status 409","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"429":{"description":"Response for status 429","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"500":{"description":"Response for status 500","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"503":{"description":"Response for status 503","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}}}},"post":{"tags":["Sites"],"operationId":"createSite","summary":"Create a site in a workspace","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["name","workspace_id"],"properties":{"name":{"type":"string"},"workspace_id":{"type":"string"}}}}},"required":true},"responses":{"201":{"description":"Response for status 201","content":{"application/json":{"schema":{"type":"object","required":["site_id","slug","name","status","workspace","created_at"],"properties":{"site_id":{"type":"string"},"slug":{"type":"string"},"name":{"type":"string"},"status":{"enum":["active","deleting","deleted"]},"workspace":{"type":"object","required":["workspace_id","slug","name"],"properties":{"workspace_id":{"type":"string"},"slug":{"type":"string"},"name":{"type":"string"}}},"created_at":{"type":"string","format":"date-time","pattern":"Z$"}}}}}},"400":{"description":"Response for status 400","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"401":{"description":"Response for status 401","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"402":{"description":"Response for status 402","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"403":{"description":"Response for status 403","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"404":{"description":"Response for status 404","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"409":{"description":"Response for status 409","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"429":{"description":"Response for status 429","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"500":{"description":"Response for status 500","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"503":{"description":"Response for status 503","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}}}}},"/v1/sites/resolve":{"get":{"tags":["Sites"],"operationId":"resolveSite","summary":"Resolve a workspace and site slug pair to a site id","parameters":[{"name":"workspace","in":"query","required":true,"schema":{"type":"string","description":"The workspace slug"}},{"name":"slug","in":"query","required":true,"schema":{"type":"string","description":"The site slug"}}],"responses":{"200":{"description":"Response for status 200","content":{"application/json":{"schema":{"type":"object","required":["site_id","slug","workspace_slug"],"properties":{"site_id":{"type":"string"},"slug":{"type":"string"},"workspace_slug":{"type":"string"}}}}}},"400":{"description":"Response for status 400","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"401":{"description":"Response for status 401","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"402":{"description":"Response for status 402","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"403":{"description":"Response for status 403","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"404":{"description":"Response for status 404","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"409":{"description":"Response for status 409","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"429":{"description":"Response for status 429","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"500":{"description":"Response for status 500","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"503":{"description":"Response for status 503","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}}}}},"/v1/sites/{site_id}":{"get":{"tags":["Sites"],"operationId":"getSite","summary":"Get a site","parameters":[{"name":"site_id","in":"path","required":true,"schema":{"type":"string","description":"The site id"}}],"responses":{"200":{"description":"Response for status 200","content":{"application/json":{"schema":{"type":"object","required":["show_hostname","site_id","slug","name","status","domains","created_at","first_event_at","reporting_currency","workspace","role"],"properties":{"show_hostname":{"enum":["auto","always","never"]},"site_id":{"type":"string"},"slug":{"type":"string"},"name":{"type":"string"},"status":{"enum":["active","deleting","deleted"]},"domains":{"type":"array","items":{"type":"string"}},"created_at":{"type":"string","format":"date-time","pattern":"Z$"},"first_event_at":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"reporting_currency":{"type":"string"},"workspace":{"type":"object","required":["workspace_id","slug","name"],"properties":{"workspace_id":{"type":"string"},"slug":{"type":"string"},"name":{"type":"string"}}},"role":{"anyOf":[{"enum":["viewer","member","owner"]},{"type":"null"}]},"tag_sightings":{"type":["array","null"],"items":{"type":"object","required":["origin","seen_at","allowed"],"properties":{"origin":{"type":"string"},"seen_at":{"type":"string","format":"date-time","pattern":"Z$"},"allowed":{"type":"boolean"}}}}}}}}},"400":{"description":"Response for status 400","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"401":{"description":"Response for status 401","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"402":{"description":"Response for status 402","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"403":{"description":"Response for status 403","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"404":{"description":"Response for status 404","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"409":{"description":"Response for status 409","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"429":{"description":"Response for status 429","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"500":{"description":"Response for status 500","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"503":{"description":"Response for status 503","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}}}},"delete":{"tags":["Sites"],"operationId":"deleteSite","summary":"Start deleting a site and all of its data","description":"Needs the site's exact name as confirmation.","parameters":[{"name":"site_id","in":"path","required":true,"schema":{"type":"string","description":"The site id"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["confirm"],"properties":{"confirm":{"type":"string","description":"The site's exact name"}}}}},"required":true},"responses":{"202":{"description":"Response for status 202","content":{"application/json":{"schema":{"type":"object","required":["deletion_request_id","status"],"properties":{"deletion_request_id":{"type":"string"},"status":{"type":"string","const":"deleting"}}}}}},"400":{"description":"Response for status 400","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"401":{"description":"Response for status 401","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"402":{"description":"Response for status 402","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"403":{"description":"Response for status 403","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"404":{"description":"Response for status 404","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"409":{"description":"Response for status 409","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"429":{"description":"Response for status 429","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"500":{"description":"Response for status 500","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"503":{"description":"Response for status 503","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}}}},"patch":{"tags":["Sites"],"operationId":"updateSite","summary":"Update a site's name, domains, reporting currency or hostname display","parameters":[{"name":"site_id","in":"path","required":true,"schema":{"type":"string","description":"The site id"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"domains":{"type":"array","items":{"type":"string"}},"reporting_currency":{"type":"string"},"show_hostname":{"enum":["auto","always","never"]}}}}},"required":true},"responses":{"200":{"description":"Response for status 200","content":{"application/json":{"schema":{"type":"object","required":["show_hostname","site_id","slug","name","status","domains","created_at","first_event_at","reporting_currency","workspace","role"],"properties":{"show_hostname":{"enum":["auto","always","never"]},"site_id":{"type":"string"},"slug":{"type":"string"},"name":{"type":"string"},"status":{"enum":["active","deleting","deleted"]},"domains":{"type":"array","items":{"type":"string"}},"created_at":{"type":"string","format":"date-time","pattern":"Z$"},"first_event_at":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"reporting_currency":{"type":"string"},"workspace":{"type":"object","required":["workspace_id","slug","name"],"properties":{"workspace_id":{"type":"string"},"slug":{"type":"string"},"name":{"type":"string"}}},"role":{"anyOf":[{"enum":["viewer","member","owner"]},{"type":"null"}]},"tag_sightings":{"type":["array","null"],"items":{"type":"object","required":["origin","seen_at","allowed"],"properties":{"origin":{"type":"string"},"seen_at":{"type":"string","format":"date-time","pattern":"Z$"},"allowed":{"type":"boolean"}}}}}}}}},"400":{"description":"Response for status 400","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"401":{"description":"Response for status 401","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"402":{"description":"Response for status 402","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"403":{"description":"Response for status 403","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"404":{"description":"Response for status 404","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"409":{"description":"Response for status 409","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"429":{"description":"Response for status 429","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"500":{"description":"Response for status 500","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"503":{"description":"Response for status 503","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}}}}},"/v1/sites/{site_id}/keys":{"get":{"tags":["API keys"],"operationId":"listApiKeys","summary":"List the site's API keys","parameters":[{"name":"site_id","in":"path","required":true,"schema":{"type":"string","description":"The site id"}}],"responses":{"200":{"description":"Response for status 200","content":{"application/json":{"schema":{"type":"object","required":["items"],"properties":{"items":{"type":"array","items":{"type":"object","required":["id","name","scopes","key_prefix","created_at","last_used_at","expires_at"],"properties":{"id":{"type":"string"},"name":{"type":"string"},"scopes":{"type":"array","items":{"enum":["ingest","read","write","manage"]}},"key_prefix":{"type":"string"},"created_at":{"type":"string","format":"date-time","pattern":"Z$"},"last_used_at":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"expires_at":{"type":["string","null"],"format":"date-time","pattern":"Z$"}}}}}}}}},"400":{"description":"Response for status 400","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"401":{"description":"Response for status 401","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"402":{"description":"Response for status 402","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"403":{"description":"Response for status 403","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"404":{"description":"Response for status 404","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"409":{"description":"Response for status 409","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"429":{"description":"Response for status 429","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"500":{"description":"Response for status 500","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"503":{"description":"Response for status 503","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}}}},"post":{"tags":["API keys"],"operationId":"createApiKey","summary":"Create an API key; its raw token is shown only in this response","parameters":[{"name":"site_id","in":"path","required":true,"schema":{"type":"string","description":"The site id"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["name","scopes"],"properties":{"name":{"type":"string","description":"1 to 80 characters after trimming"},"scopes":{"type":"array","items":{"enum":["ingest","read","write","manage"]},"minItems":1},"expires_at":{"type":["string","null"],"format":"date-time","pattern":"Z$"}}}}},"required":true},"responses":{"201":{"description":"Response for status 201","content":{"application/json":{"schema":{"type":"object","required":["id","name","scopes","key_prefix","raw_token"],"properties":{"id":{"type":"string"},"name":{"type":"string"},"scopes":{"type":"array","items":{"enum":["ingest","read","write","manage"]}},"key_prefix":{"type":"string"},"raw_token":{"type":"string"}}}}}},"400":{"description":"Response for status 400","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"401":{"description":"Response for status 401","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"402":{"description":"Response for status 402","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"403":{"description":"Response for status 403","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"404":{"description":"Response for status 404","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"409":{"description":"Response for status 409","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"429":{"description":"Response for status 429","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"500":{"description":"Response for status 500","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"503":{"description":"Response for status 503","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}}}}},"/v1/sites/{site_id}/keys/{key_id}/rotate":{"post":{"tags":["API keys"],"operationId":"rotateApiKey","summary":"Replace an API key with a new secret under the same name, scopes and expiry; the old one stops working at once","parameters":[{"name":"site_id","in":"path","required":true,"schema":{"type":"string","description":"The site id"}},{"name":"key_id","in":"path","required":true,"schema":{"type":"string","description":"The API key id"}}],"responses":{"201":{"description":"Response for status 201","content":{"application/json":{"schema":{"type":"object","required":["id","name","scopes","key_prefix","raw_token"],"properties":{"id":{"type":"string"},"name":{"type":"string"},"scopes":{"type":"array","items":{"enum":["ingest","read","write","manage"]}},"key_prefix":{"type":"string"},"raw_token":{"type":"string"}}}}}},"400":{"description":"Response for status 400","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"401":{"description":"Response for status 401","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"402":{"description":"Response for status 402","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"403":{"description":"Response for status 403","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"404":{"description":"Response for status 404","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"409":{"description":"Response for status 409","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"429":{"description":"Response for status 429","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"500":{"description":"Response for status 500","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"503":{"description":"Response for status 503","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}}}}},"/v1/sites/{site_id}/keys/{key_id}":{"delete":{"tags":["API keys"],"operationId":"revokeApiKey","summary":"Revoke an API key","parameters":[{"name":"site_id","in":"path","required":true,"schema":{"type":"string","description":"The site id"}},{"name":"key_id","in":"path","required":true,"schema":{"type":"string","description":"The API key id"}}],"responses":{"204":{"description":"No content"},"400":{"description":"Response for status 400","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"401":{"description":"Response for status 401","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"402":{"description":"Response for status 402","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"403":{"description":"Response for status 403","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"404":{"description":"Response for status 404","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"409":{"description":"Response for status 409","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"429":{"description":"Response for status 429","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"500":{"description":"Response for status 500","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"503":{"description":"Response for status 503","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}}}}},"/v1/sites/{site_id}/tracker/settings":{"get":{"tags":["Tracker"],"operationId":"getTrackerSettings","summary":"Get the settings the site's tracker runs with","parameters":[{"name":"site_id","in":"path","required":true,"schema":{"type":"string","description":"The site id"}}],"responses":{"200":{"description":"Response for status 200","content":{"application/json":{"schema":{"type":"object","required":["config_version","redact_query_keys","heartbeat_interval_seconds","features","feedback"],"properties":{"config_version":{"type":"integer"},"redact_query_keys":{"type":"array","items":{"type":"string"}},"heartbeat_interval_seconds":{"type":"integer"},"features":{"type":"object","required":["web_vitals","engagement","heartbeat","heatmaps"],"properties":{"web_vitals":{"type":"boolean"},"engagement":{"type":"boolean"},"heartbeat":{"type":"boolean"},"heatmaps":{"type":"boolean"}}},"feedback":{"type":"object","required":["enabled","button","position","label","prompt","color"],"properties":{"enabled":{"type":"boolean"},"button":{"type":"boolean"},"position":{"enum":["left","right"]},"label":{"type":"string"},"prompt":{"type":"string"},"color":{"type":["string","null"]}}}}}}}},"400":{"description":"Response for status 400","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"401":{"description":"Response for status 401","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"402":{"description":"Response for status 402","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"403":{"description":"Response for status 403","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"404":{"description":"Response for status 404","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"409":{"description":"Response for status 409","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"429":{"description":"Response for status 429","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"500":{"description":"Response for status 500","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"503":{"description":"Response for status 503","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}}}},"patch":{"tags":["Tracker"],"operationId":"updateTrackerSettings","summary":"Update the settings the site's tracker runs with","parameters":[{"name":"site_id","in":"path","required":true,"schema":{"type":"string","description":"The site id"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"redact_query_keys":{"type":"array","items":{"type":"string"}},"heartbeat_interval_seconds":{"type":"number"},"features":{"type":"object","properties":{"web_vitals":{"type":"boolean"},"engagement":{"type":"boolean"},"heartbeat":{"type":"boolean"},"heatmaps":{"type":"boolean"}}},"feedback":{"type":"object","properties":{"enabled":{"type":"boolean"},"button":{"type":"boolean"},"position":{"enum":["left","right"]},"label":{"type":"string"},"prompt":{"type":"string"},"color":{"type":["string","null"]}}}}}}},"required":true},"responses":{"200":{"description":"Response for status 200","content":{"application/json":{"schema":{"type":"object","required":["config_version","redact_query_keys","heartbeat_interval_seconds","features","feedback"],"properties":{"config_version":{"type":"integer"},"redact_query_keys":{"type":"array","items":{"type":"string"}},"heartbeat_interval_seconds":{"type":"integer"},"features":{"type":"object","required":["web_vitals","engagement","heartbeat","heatmaps"],"properties":{"web_vitals":{"type":"boolean"},"engagement":{"type":"boolean"},"heartbeat":{"type":"boolean"},"heatmaps":{"type":"boolean"}}},"feedback":{"type":"object","required":["enabled","button","position","label","prompt","color"],"properties":{"enabled":{"type":"boolean"},"button":{"type":"boolean"},"position":{"enum":["left","right"]},"label":{"type":"string"},"prompt":{"type":"string"},"color":{"type":["string","null"]}}}}}}}},"400":{"description":"Response for status 400","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"401":{"description":"Response for status 401","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"402":{"description":"Response for status 402","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"403":{"description":"Response for status 403","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"404":{"description":"Response for status 404","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"409":{"description":"Response for status 409","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"429":{"description":"Response for status 429","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"500":{"description":"Response for status 500","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"503":{"description":"Response for status 503","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}}}}},"/v1/sites/{site_id}/public-dashboard":{"get":{"tags":["Public dashboard"],"operationId":"getPublicDashboardSettings","summary":"Get the site's public dashboard settings","parameters":[{"name":"site_id","in":"path","required":true,"schema":{"type":"string","description":"The site id"}}],"responses":{"200":{"description":"Response for status 200","content":{"application/json":{"schema":{"type":"object","required":["enabled","share_slug","share_pages","share_realtime","share_identity","share_revenue","allow_embed","has_password"],"properties":{"enabled":{"type":"boolean"},"share_slug":{"type":["string","null"]},"share_pages":{"type":"boolean"},"share_realtime":{"type":"boolean"},"share_identity":{"type":"boolean"},"share_revenue":{"type":"boolean"},"allow_embed":{"type":"boolean"},"has_password":{"type":"boolean"}}}}}},"400":{"description":"Response for status 400","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"401":{"description":"Response for status 401","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"402":{"description":"Response for status 402","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"403":{"description":"Response for status 403","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"404":{"description":"Response for status 404","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"409":{"description":"Response for status 409","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"429":{"description":"Response for status 429","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"500":{"description":"Response for status 500","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"503":{"description":"Response for status 503","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}}}},"put":{"tags":["Public dashboard"],"operationId":"updatePublicDashboardSettings","summary":"Replace the site's public dashboard settings","description":"A share flag left out is turned off. A password left out is kept; null removes it.","parameters":[{"name":"site_id","in":"path","required":true,"schema":{"type":"string","description":"The site id"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["enabled"],"properties":{"enabled":{"type":"boolean"},"share_pages":{"type":"boolean"},"share_realtime":{"type":"boolean"},"share_identity":{"type":"boolean"},"share_revenue":{"type":"boolean"},"allow_embed":{"type":"boolean"},"password":{"type":["string","null"],"minLength":1,"maxLength":128,"description":"Left out keeps the current password; null removes it"},"rotate_slug":{"type":"boolean","description":"Issue a new share link, retiring the old one"}}}}},"required":true},"responses":{"200":{"description":"Response for status 200","content":{"application/json":{"schema":{"type":"object","required":["enabled","share_slug","share_pages","share_realtime","share_identity","share_revenue","allow_embed","has_password"],"properties":{"enabled":{"type":"boolean"},"share_slug":{"type":["string","null"]},"share_pages":{"type":"boolean"},"share_realtime":{"type":"boolean"},"share_identity":{"type":"boolean"},"share_revenue":{"type":"boolean"},"allow_embed":{"type":"boolean"},"has_password":{"type":"boolean"}}}}}},"400":{"description":"Response for status 400","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"401":{"description":"Response for status 401","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"402":{"description":"Response for status 402","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"403":{"description":"Response for status 403","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"404":{"description":"Response for status 404","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"409":{"description":"Response for status 409","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"429":{"description":"Response for status 429","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"500":{"description":"Response for status 500","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"503":{"description":"Response for status 503","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}}}}},"/v1/me/preferences":{"get":{"tags":["Account"],"operationId":"getPreferences","summary":"Get the caller's preferences","responses":{"200":{"description":"Response for status 200","content":{"application/json":{"schema":{"type":"object","required":["timezone"],"properties":{"timezone":{"type":"string","description":"An IANA time zone, e.g. Europe/Istanbul"}}}}}},"400":{"description":"Response for status 400","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"401":{"description":"Response for status 401","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"402":{"description":"Response for status 402","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"403":{"description":"Response for status 403","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"404":{"description":"Response for status 404","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"409":{"description":"Response for status 409","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"429":{"description":"Response for status 429","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"500":{"description":"Response for status 500","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"503":{"description":"Response for status 503","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}}}},"patch":{"tags":["Account"],"operationId":"updatePreferences","summary":"Update the caller's preferences","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["timezone"],"properties":{"timezone":{"type":"string","description":"An IANA time zone, e.g. Europe/Istanbul"}}}}},"required":true},"responses":{"200":{"description":"Response for status 200","content":{"application/json":{"schema":{"type":"object","required":["timezone"],"properties":{"timezone":{"type":"string","description":"An IANA time zone, e.g. Europe/Istanbul"}}}}}},"400":{"description":"Response for status 400","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"401":{"description":"Response for status 401","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"402":{"description":"Response for status 402","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"403":{"description":"Response for status 403","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"404":{"description":"Response for status 404","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"409":{"description":"Response for status 409","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"429":{"description":"Response for status 429","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"500":{"description":"Response for status 500","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"503":{"description":"Response for status 503","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}}}}},"/v1/me/avatar":{"put":{"tags":["Account"],"operationId":"uploadAvatar","summary":"Replace the caller's profile picture","description":"Stored as a WebP of at most 512 pixels a side, without its metadata. Animated GIFs keep their first frame.","requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"type":"object","required":["file"],"properties":{"file":{"type":"string","format":"binary","description":"A JPEG, PNG, WebP or GIF image of at most 5 MB"}}}}}},"responses":{"200":{"description":"Response for status 200","content":{"application/json":{"schema":{"type":"object","required":["image"],"properties":{"image":{"type":["string","null"]}}}}}},"400":{"description":"Response for status 400","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"401":{"description":"Response for status 401","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"402":{"description":"Response for status 402","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"403":{"description":"Response for status 403","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"404":{"description":"Response for status 404","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"409":{"description":"Response for status 409","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"429":{"description":"Response for status 429","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"500":{"description":"Response for status 500","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"503":{"description":"Response for status 503","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}}}},"delete":{"tags":["Account"],"operationId":"removeAvatar","summary":"Remove the caller's profile picture","description":"The account then shows a picture generated from it.","responses":{"200":{"description":"Response for status 200","content":{"application/json":{"schema":{"type":"object","required":["image"],"properties":{"image":{"type":["string","null"]}}}}}},"400":{"description":"Response for status 400","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"401":{"description":"Response for status 401","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"402":{"description":"Response for status 402","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"403":{"description":"Response for status 403","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"404":{"description":"Response for status 404","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"409":{"description":"Response for status 409","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"429":{"description":"Response for status 429","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"500":{"description":"Response for status 500","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"503":{"description":"Response for status 503","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}}}}},"/v1/me/deletion":{"get":{"tags":["Account"],"operationId":"previewAccountDeletion","summary":"Show what deleting the account would remove","responses":{"200":{"description":"Response for status 200","content":{"application/json":{"schema":{"type":"object","required":["workspaces","leaving","blocking_workspaces"],"properties":{"workspaces":{"type":"array","items":{"type":"object","required":["workspace_id","name","sites"],"properties":{"workspace_id":{"type":"string"},"name":{"type":"string"},"sites":{"type":"array","items":{"type":"object","required":["site_id","name"],"properties":{"site_id":{"type":"string"},"name":{"type":"string"}}}}}}},"leaving":{"type":"array","items":{"type":"object","required":["workspace_id","name"],"properties":{"workspace_id":{"type":"string"},"name":{"type":"string"}}}},"blocking_workspaces":{"type":"array","items":{"type":"object","required":["workspace_id","slug","name"],"properties":{"workspace_id":{"type":"string"},"slug":{"type":"string"},"name":{"type":"string"}}}}}}}}},"400":{"description":"Response for status 400","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"401":{"description":"Response for status 401","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"402":{"description":"Response for status 402","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"403":{"description":"Response for status 403","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"404":{"description":"Response for status 404","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"409":{"description":"Response for status 409","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"429":{"description":"Response for status 429","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"500":{"description":"Response for status 500","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"503":{"description":"Response for status 503","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}}}}},"/v1/me":{"delete":{"tags":["Account"],"operationId":"deleteAccount","summary":"Delete the caller's account","description":"Needs the exact email address as confirmation. Sign-in, sessions and connected apps end at once and the sites in workspaces only this account belongs to start deleting; the rest follows. Refused with ACCOUNT_DELETION_BLOCKED while the account is the only owner of a workspace others belong to.","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["confirm"],"properties":{"confirm":{"type":"string","description":"The account's exact email address"}}}}},"required":true},"responses":{"202":{"description":"Response for status 202","content":{"application/json":{"schema":{"type":"object","required":["deletion_request_id","emailed"],"properties":{"deletion_request_id":{"type":"string"},"emailed":{"type":"boolean"}}}}}},"400":{"description":"Response for status 400","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"401":{"description":"Response for status 401","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"402":{"description":"Response for status 402","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"403":{"description":"Response for status 403","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"404":{"description":"Response for status 404","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"409":{"description":"Response for status 409","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"429":{"description":"Response for status 429","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"500":{"description":"Response for status 500","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"503":{"description":"Response for status 503","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}}}}},"/v1/me/connections":{"get":{"tags":["Account"],"operationId":"listConnectedApps","summary":"List the apps connected to your account","responses":{"200":{"description":"Response for status 200","content":{"application/json":{"schema":{"type":"object","required":["items"],"properties":{"items":{"type":"array","items":{"type":"object","required":["client_id","name","uri","icon","scopes","connected_at","updated_at"],"properties":{"client_id":{"type":"string"},"name":{"type":["string","null"]},"uri":{"type":["string","null"]},"icon":{"type":["string","null"]},"scopes":{"type":"array","items":{"type":"string"}},"connected_at":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"updated_at":{"type":["string","null"],"format":"date-time","pattern":"Z$"}}}}}}}}},"400":{"description":"Response for status 400","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"401":{"description":"Response for status 401","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"402":{"description":"Response for status 402","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"403":{"description":"Response for status 403","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"404":{"description":"Response for status 404","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"409":{"description":"Response for status 409","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"429":{"description":"Response for status 429","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"500":{"description":"Response for status 500","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"503":{"description":"Response for status 503","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}}}}},"/v1/me/connections/{client_id}":{"delete":{"tags":["Account"],"operationId":"disconnectApp","summary":"Disconnect an app and revoke every token it holds","parameters":[{"name":"client_id","in":"path","required":true,"schema":{"type":"string","description":"The connected app’s client id"}}],"responses":{"204":{"description":"No content"},"400":{"description":"Response for status 400","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"401":{"description":"Response for status 401","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"402":{"description":"Response for status 402","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"403":{"description":"Response for status 403","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"404":{"description":"Response for status 404","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"409":{"description":"Response for status 409","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"429":{"description":"Response for status 429","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"500":{"description":"Response for status 500","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"503":{"description":"Response for status 503","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}}}}},"/v1/me/mcp-tokens":{"get":{"tags":["Account"],"operationId":"listMcpTokens","summary":"List your personal MCP tokens","responses":{"200":{"description":"Response for status 200","content":{"application/json":{"schema":{"type":"object","required":["items"],"properties":{"items":{"type":"array","items":{"type":"object","required":["id","name","scopes","key_prefix","created_at","last_used_at","expires_at"],"properties":{"id":{"type":"string"},"name":{"type":"string"},"scopes":{"type":"array","items":{"enum":["read","write","manage"]}},"key_prefix":{"type":"string"},"created_at":{"type":"string","format":"date-time","pattern":"Z$"},"last_used_at":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"expires_at":{"type":["string","null"],"format":"date-time","pattern":"Z$"}}}}}}}}},"400":{"description":"Response for status 400","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"401":{"description":"Response for status 401","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"402":{"description":"Response for status 402","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"403":{"description":"Response for status 403","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"404":{"description":"Response for status 404","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"409":{"description":"Response for status 409","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"429":{"description":"Response for status 429","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"500":{"description":"Response for status 500","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"503":{"description":"Response for status 503","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}}}},"post":{"tags":["Account"],"operationId":"createMcpToken","summary":"Create a personal MCP token for a client without OAuth; its raw token is shown only in this response","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["name","scopes"],"properties":{"name":{"type":"string","description":"1 to 80 characters after trimming"},"scopes":{"type":"array","items":{"enum":["read","write","manage"]},"minItems":1},"expires_at":{"type":["string","null"],"format":"date-time","pattern":"Z$"}}}}},"required":true},"responses":{"201":{"description":"Response for status 201","content":{"application/json":{"schema":{"type":"object","required":["id","name","scopes","key_prefix","created_at","last_used_at","expires_at","raw_token"],"properties":{"id":{"type":"string"},"name":{"type":"string"},"scopes":{"type":"array","items":{"enum":["read","write","manage"]}},"key_prefix":{"type":"string"},"created_at":{"type":"string","format":"date-time","pattern":"Z$"},"last_used_at":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"expires_at":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"raw_token":{"type":"string"}}}}}},"400":{"description":"Response for status 400","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"401":{"description":"Response for status 401","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"402":{"description":"Response for status 402","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"403":{"description":"Response for status 403","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"404":{"description":"Response for status 404","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"409":{"description":"Response for status 409","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"429":{"description":"Response for status 429","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"500":{"description":"Response for status 500","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"503":{"description":"Response for status 503","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}}}}},"/v1/me/mcp-tokens/{token_id}":{"delete":{"tags":["Account"],"operationId":"revokeMcpToken","summary":"Revoke a personal MCP token; a client using it is cut off on its next request","parameters":[{"name":"token_id","in":"path","required":true,"schema":{"type":"string","description":"The MCP token id","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"}}],"responses":{"204":{"description":"No content"},"400":{"description":"Response for status 400","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"401":{"description":"Response for status 401","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"402":{"description":"Response for status 402","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"403":{"description":"Response for status 403","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"404":{"description":"Response for status 404","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"409":{"description":"Response for status 409","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"429":{"description":"Response for status 429","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"500":{"description":"Response for status 500","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"503":{"description":"Response for status 503","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}}}}},"/v1/sites/{site_id}/funnels":{"get":{"tags":["Funnels"],"operationId":"listFunnels","summary":"List the funnels of a site","parameters":[{"name":"site_id","in":"path","required":true,"schema":{"type":"string","description":"The site id"}},{"name":"include_archived","in":"query","required":false,"schema":{"enum":["true","false"]}}],"responses":{"200":{"description":"Response for status 200","content":{"application/json":{"schema":{"type":"object","required":["items"],"properties":{"items":{"type":"array","items":{"type":"object","required":["id","name","steps","created_by_user_id","created_at","updated_at","archived_at"],"properties":{"id":{"type":"string"},"name":{"type":"string"},"steps":{"type":"array","items":{"type":"string"}},"created_by_user_id":{"type":["string","null"]},"created_at":{"type":"string","format":"date-time","pattern":"Z$"},"updated_at":{"type":"string","format":"date-time","pattern":"Z$"},"archived_at":{"type":["string","null"],"format":"date-time","pattern":"Z$"}}}}}}}}},"400":{"description":"Response for status 400","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"401":{"description":"Response for status 401","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"402":{"description":"Response for status 402","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"403":{"description":"Response for status 403","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"404":{"description":"Response for status 404","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"409":{"description":"Response for status 409","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"429":{"description":"Response for status 429","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"500":{"description":"Response for status 500","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"503":{"description":"Response for status 503","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}}}},"post":{"tags":["Funnels"],"operationId":"createFunnel","summary":"Create a funnel","parameters":[{"name":"site_id","in":"path","required":true,"schema":{"type":"string","description":"The site id"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["name","steps"],"properties":{"name":{"type":"string"},"steps":{"type":"array","items":{"type":"string","minLength":1,"maxLength":512},"minItems":2,"maxItems":8}},"additionalProperties":false}}},"required":true},"responses":{"201":{"description":"Response for status 201","content":{"application/json":{"schema":{"type":"object","required":["id","name","steps","created_by_user_id","created_at","updated_at","archived_at"],"properties":{"id":{"type":"string"},"name":{"type":"string"},"steps":{"type":"array","items":{"type":"string"}},"created_by_user_id":{"type":["string","null"]},"created_at":{"type":"string","format":"date-time","pattern":"Z$"},"updated_at":{"type":"string","format":"date-time","pattern":"Z$"},"archived_at":{"type":["string","null"],"format":"date-time","pattern":"Z$"}}}}}},"400":{"description":"Response for status 400","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"401":{"description":"Response for status 401","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"402":{"description":"Response for status 402","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"403":{"description":"Response for status 403","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"404":{"description":"Response for status 404","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"409":{"description":"Response for status 409","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"429":{"description":"Response for status 429","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"500":{"description":"Response for status 500","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"503":{"description":"Response for status 503","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}}}}},"/v1/sites/{site_id}/funnels/{funnel_id}":{"patch":{"tags":["Funnels"],"operationId":"updateFunnel","summary":"Rename a funnel or change its steps","parameters":[{"name":"site_id","in":"path","required":true,"schema":{"type":"string","description":"The site id"}},{"name":"funnel_id","in":"path","required":true,"schema":{"type":"string","description":"The funnel id"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"steps":{"type":"array","items":{"type":"string","minLength":1,"maxLength":512},"minItems":2,"maxItems":8}},"additionalProperties":false}}},"required":true},"responses":{"200":{"description":"Response for status 200","content":{"application/json":{"schema":{"type":"object","required":["id","name","steps","created_by_user_id","created_at","updated_at","archived_at"],"properties":{"id":{"type":"string"},"name":{"type":"string"},"steps":{"type":"array","items":{"type":"string"}},"created_by_user_id":{"type":["string","null"]},"created_at":{"type":"string","format":"date-time","pattern":"Z$"},"updated_at":{"type":"string","format":"date-time","pattern":"Z$"},"archived_at":{"type":["string","null"],"format":"date-time","pattern":"Z$"}}}}}},"400":{"description":"Response for status 400","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"401":{"description":"Response for status 401","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"402":{"description":"Response for status 402","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"403":{"description":"Response for status 403","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"404":{"description":"Response for status 404","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"409":{"description":"Response for status 409","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"429":{"description":"Response for status 429","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"500":{"description":"Response for status 500","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"503":{"description":"Response for status 503","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}}}},"delete":{"tags":["Funnels"],"operationId":"archiveFunnel","summary":"Archive a funnel","parameters":[{"name":"site_id","in":"path","required":true,"schema":{"type":"string","description":"The site id"}},{"name":"funnel_id","in":"path","required":true,"schema":{"type":"string","description":"The funnel id"}}],"responses":{"204":{"description":"No content"},"400":{"description":"Response for status 400","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"401":{"description":"Response for status 401","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"402":{"description":"Response for status 402","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"403":{"description":"Response for status 403","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"404":{"description":"Response for status 404","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"409":{"description":"Response for status 409","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"429":{"description":"Response for status 429","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"500":{"description":"Response for status 500","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"503":{"description":"Response for status 503","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}}}}},"/v1/sites/{site_id}/links":{"get":{"tags":["Links"],"operationId":"listLinks","summary":"List the short links of a site, newest first","parameters":[{"name":"site_id","in":"path","required":true,"schema":{"type":"string","description":"The site id"}},{"name":"q","in":"query","required":false,"schema":{"type":"string","maxLength":200}},{"name":"status","in":"query","required":false,"schema":{"enum":["active","disabled"]}},{"name":"limit","in":"query","required":false,"schema":{"type":"string","pattern":"^[0-9]{1,3}$"}},{"name":"cursor","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":200}}],"responses":{"200":{"description":"Response for status 200","content":{"application/json":{"schema":{"type":"object","required":["items","next_cursor","has_more","meta"],"properties":{"items":{"type":"array","items":{"type":"object","required":["id","short_url","domain_id","slug","destination","title","expires_at","click_limit","has_password","fallback_url","rules","og","status","safety","created_at","updated_at","clicks_30d"],"properties":{"id":{"type":"string"},"short_url":{"type":"string"},"domain_id":{"type":["string","null"]},"slug":{"type":"string"},"destination":{"type":"string"},"title":{"type":["string","null"]},"expires_at":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"click_limit":{"type":["number","null"]},"has_password":{"type":"boolean"},"fallback_url":{"type":["string","null"]},"rules":{"type":"array","items":{"anyOf":[{"type":"object","required":["id","when","to"],"properties":{"id":{"type":"string"},"when":{"type":"object","properties":{"country":{"type":"array","items":{"type":"string"}},"device":{"type":"array","items":{"enum":["desktop","mobile","tablet"]}},"os":{"type":"array","items":{"enum":["windows","harmonyos","kaios","tizen","webos","ipados","ios","macos","chromeos","android","ubuntu","fedora","debian","freebsd","linux"]}}}},"action":{"type":"string","const":"redirect"},"to":{"type":"string"}}},{"type":"object","required":["id","when","action"],"properties":{"id":{"type":"string"},"when":{"type":"object","properties":{"country":{"type":"array","items":{"type":"string"}},"device":{"type":"array","items":{"enum":["desktop","mobile","tablet"]}},"os":{"type":"array","items":{"enum":["windows","harmonyos","kaios","tizen","webos","ipados","ios","macos","chromeos","android","ubuntu","fedora","debian","freebsd","linux"]}}}},"action":{"type":"string","const":"block"}}}]}},"og":{"type":["object","null"],"properties":{"title":{"type":"string"},"description":{"type":"string"},"image_url":{"type":"string"}}},"status":{"enum":["active","disabled"]},"safety":{"type":"object","required":["status","reason","checked_at"],"properties":{"status":{"enum":["unchecked","clean","blocked"]},"reason":{"type":["string","null"]},"checked_at":{"type":["string","null"],"format":"date-time","pattern":"Z$"}}},"created_at":{"type":"string","format":"date-time","pattern":"Z$"},"updated_at":{"type":"string","format":"date-time","pattern":"Z$"},"clicks_30d":{"type":"number"}}}},"next_cursor":{"type":["string","null"]},"has_more":{"type":"boolean"},"meta":{"type":"object","required":["default_base_url","og_image_upload","total"],"properties":{"default_base_url":{"type":"string"},"og_image_upload":{"type":"boolean"},"total":{"type":"number"}}}}}}}},"400":{"description":"Response for status 400","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"401":{"description":"Response for status 401","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"402":{"description":"Response for status 402","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"403":{"description":"Response for status 403","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"404":{"description":"Response for status 404","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"409":{"description":"Response for status 409","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"429":{"description":"Response for status 429","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"500":{"description":"Response for status 500","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"503":{"description":"Response for status 503","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}}}},"post":{"tags":["Links"],"operationId":"createLink","summary":"Create a short link","parameters":[{"name":"site_id","in":"path","required":true,"schema":{"type":"string","description":"The site id"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["destination"],"properties":{"destination":{"type":"string","minLength":1,"maxLength":2048},"slug":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[A-Za-z0-9_-]{1,64}$"},"domain_id":{"type":["string","null"],"format":"uuid"},"title":{"type":["string","null"]},"expires_at":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"click_limit":{"type":["integer","null"],"minimum":1,"maximum":1000000000},"password":{"type":["string","null"],"minLength":4,"maxLength":128},"fallback_url":{"type":["string","null"],"minLength":1,"maxLength":2048},"rules":{"type":"array","items":{"anyOf":[{"type":"object","required":["id","when","to"],"properties":{"id":{"type":"string","minLength":1,"maxLength":8,"pattern":"^[A-Za-z0-9_-]+$"},"when":{"type":"object","properties":{"country":{"type":"array","items":{"type":"string","pattern":"^[A-Z]{2}$"},"minItems":1,"maxItems":50},"device":{"type":"array","items":{"enum":["desktop","mobile","tablet"]},"minItems":1,"maxItems":50},"os":{"type":"array","items":{"enum":["windows","harmonyos","kaios","tizen","webos","ipados","ios","macos","chromeos","android","ubuntu","fedora","debian","freebsd","linux"]},"minItems":1,"maxItems":50}},"additionalProperties":false},"action":{"type":"string","const":"redirect"},"to":{"type":"string","minLength":1,"maxLength":2048}},"additionalProperties":false},{"type":"object","required":["id","when","action"],"properties":{"id":{"type":"string","minLength":1,"maxLength":8,"pattern":"^[A-Za-z0-9_-]+$"},"when":{"type":"object","properties":{"country":{"type":"array","items":{"type":"string","pattern":"^[A-Z]{2}$"},"minItems":1,"maxItems":50},"device":{"type":"array","items":{"enum":["desktop","mobile","tablet"]},"minItems":1,"maxItems":50},"os":{"type":"array","items":{"enum":["windows","harmonyos","kaios","tizen","webos","ipados","ios","macos","chromeos","android","ubuntu","fedora","debian","freebsd","linux"]},"minItems":1,"maxItems":50}},"additionalProperties":false},"action":{"type":"string","const":"block"}},"additionalProperties":false}]},"maxItems":20},"og":{"type":["object","null"],"properties":{"title":{"type":"string"},"description":{"type":"string"},"image_url":{"type":"string","minLength":1,"maxLength":2048}},"additionalProperties":false},"utm":{"type":"object","properties":{"source":{"type":"string"},"medium":{"type":"string"},"campaign":{"type":"string"},"term":{"type":"string"},"content":{"type":"string"}},"additionalProperties":false}},"additionalProperties":false}}},"required":true},"responses":{"201":{"description":"Response for status 201","content":{"application/json":{"schema":{"type":"object","required":["id","short_url","domain_id","slug","destination","title","expires_at","click_limit","has_password","fallback_url","rules","og","status","safety","created_at","updated_at"],"properties":{"id":{"type":"string"},"short_url":{"type":"string"},"domain_id":{"type":["string","null"]},"slug":{"type":"string"},"destination":{"type":"string"},"title":{"type":["string","null"]},"expires_at":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"click_limit":{"type":["number","null"]},"has_password":{"type":"boolean"},"fallback_url":{"type":["string","null"]},"rules":{"type":"array","items":{"anyOf":[{"type":"object","required":["id","when","to"],"properties":{"id":{"type":"string"},"when":{"type":"object","properties":{"country":{"type":"array","items":{"type":"string"}},"device":{"type":"array","items":{"enum":["desktop","mobile","tablet"]}},"os":{"type":"array","items":{"enum":["windows","harmonyos","kaios","tizen","webos","ipados","ios","macos","chromeos","android","ubuntu","fedora","debian","freebsd","linux"]}}}},"action":{"type":"string","const":"redirect"},"to":{"type":"string"}}},{"type":"object","required":["id","when","action"],"properties":{"id":{"type":"string"},"when":{"type":"object","properties":{"country":{"type":"array","items":{"type":"string"}},"device":{"type":"array","items":{"enum":["desktop","mobile","tablet"]}},"os":{"type":"array","items":{"enum":["windows","harmonyos","kaios","tizen","webos","ipados","ios","macos","chromeos","android","ubuntu","fedora","debian","freebsd","linux"]}}}},"action":{"type":"string","const":"block"}}}]}},"og":{"type":["object","null"],"properties":{"title":{"type":"string"},"description":{"type":"string"},"image_url":{"type":"string"}}},"status":{"enum":["active","disabled"]},"safety":{"type":"object","required":["status","reason","checked_at"],"properties":{"status":{"enum":["unchecked","clean","blocked"]},"reason":{"type":["string","null"]},"checked_at":{"type":["string","null"],"format":"date-time","pattern":"Z$"}}},"created_at":{"type":"string","format":"date-time","pattern":"Z$"},"updated_at":{"type":"string","format":"date-time","pattern":"Z$"}}}}}},"400":{"description":"Response for status 400","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"401":{"description":"Response for status 401","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"402":{"description":"Response for status 402","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"403":{"description":"Response for status 403","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"404":{"description":"Response for status 404","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"409":{"description":"Response for status 409","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"429":{"description":"Response for status 429","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"500":{"description":"Response for status 500","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"503":{"description":"Response for status 503","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}}}}},"/v1/sites/{site_id}/links/{link_id}":{"get":{"tags":["Links"],"operationId":"getLink","summary":"Get a short link","parameters":[{"name":"site_id","in":"path","required":true,"schema":{"type":"string","description":"The site id"}},{"name":"link_id","in":"path","required":true,"schema":{"type":"string","description":"The link id"}}],"responses":{"200":{"description":"Response for status 200","content":{"application/json":{"schema":{"type":"object","required":["id","short_url","domain_id","slug","destination","title","expires_at","click_limit","has_password","fallback_url","rules","og","status","safety","created_at","updated_at"],"properties":{"id":{"type":"string"},"short_url":{"type":"string"},"domain_id":{"type":["string","null"]},"slug":{"type":"string"},"destination":{"type":"string"},"title":{"type":["string","null"]},"expires_at":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"click_limit":{"type":["number","null"]},"has_password":{"type":"boolean"},"fallback_url":{"type":["string","null"]},"rules":{"type":"array","items":{"anyOf":[{"type":"object","required":["id","when","to"],"properties":{"id":{"type":"string"},"when":{"type":"object","properties":{"country":{"type":"array","items":{"type":"string"}},"device":{"type":"array","items":{"enum":["desktop","mobile","tablet"]}},"os":{"type":"array","items":{"enum":["windows","harmonyos","kaios","tizen","webos","ipados","ios","macos","chromeos","android","ubuntu","fedora","debian","freebsd","linux"]}}}},"action":{"type":"string","const":"redirect"},"to":{"type":"string"}}},{"type":"object","required":["id","when","action"],"properties":{"id":{"type":"string"},"when":{"type":"object","properties":{"country":{"type":"array","items":{"type":"string"}},"device":{"type":"array","items":{"enum":["desktop","mobile","tablet"]}},"os":{"type":"array","items":{"enum":["windows","harmonyos","kaios","tizen","webos","ipados","ios","macos","chromeos","android","ubuntu","fedora","debian","freebsd","linux"]}}}},"action":{"type":"string","const":"block"}}}]}},"og":{"type":["object","null"],"properties":{"title":{"type":"string"},"description":{"type":"string"},"image_url":{"type":"string"}}},"status":{"enum":["active","disabled"]},"safety":{"type":"object","required":["status","reason","checked_at"],"properties":{"status":{"enum":["unchecked","clean","blocked"]},"reason":{"type":["string","null"]},"checked_at":{"type":["string","null"],"format":"date-time","pattern":"Z$"}}},"created_at":{"type":"string","format":"date-time","pattern":"Z$"},"updated_at":{"type":"string","format":"date-time","pattern":"Z$"}}}}}},"400":{"description":"Response for status 400","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"401":{"description":"Response for status 401","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"402":{"description":"Response for status 402","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"403":{"description":"Response for status 403","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"404":{"description":"Response for status 404","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"409":{"description":"Response for status 409","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"429":{"description":"Response for status 429","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"500":{"description":"Response for status 500","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"503":{"description":"Response for status 503","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}}}},"patch":{"tags":["Links"],"operationId":"updateLink","summary":"Update a short link","parameters":[{"name":"site_id","in":"path","required":true,"schema":{"type":"string","description":"The site id"}},{"name":"link_id","in":"path","required":true,"schema":{"type":"string","description":"The link id"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"destination":{"type":"string","minLength":1,"maxLength":2048},"slug":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[A-Za-z0-9_-]{1,64}$"},"domain_id":{"type":["string","null"],"format":"uuid"},"title":{"type":["string","null"]},"expires_at":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"click_limit":{"type":["integer","null"],"minimum":1,"maximum":1000000000},"password":{"type":["string","null"],"minLength":4,"maxLength":128},"fallback_url":{"type":["string","null"],"minLength":1,"maxLength":2048},"rules":{"type":"array","items":{"anyOf":[{"type":"object","required":["id","when","to"],"properties":{"id":{"type":"string","minLength":1,"maxLength":8,"pattern":"^[A-Za-z0-9_-]+$"},"when":{"type":"object","properties":{"country":{"type":"array","items":{"type":"string","pattern":"^[A-Z]{2}$"},"minItems":1,"maxItems":50},"device":{"type":"array","items":{"enum":["desktop","mobile","tablet"]},"minItems":1,"maxItems":50},"os":{"type":"array","items":{"enum":["windows","harmonyos","kaios","tizen","webos","ipados","ios","macos","chromeos","android","ubuntu","fedora","debian","freebsd","linux"]},"minItems":1,"maxItems":50}},"additionalProperties":false},"action":{"type":"string","const":"redirect"},"to":{"type":"string","minLength":1,"maxLength":2048}},"additionalProperties":false},{"type":"object","required":["id","when","action"],"properties":{"id":{"type":"string","minLength":1,"maxLength":8,"pattern":"^[A-Za-z0-9_-]+$"},"when":{"type":"object","properties":{"country":{"type":"array","items":{"type":"string","pattern":"^[A-Z]{2}$"},"minItems":1,"maxItems":50},"device":{"type":"array","items":{"enum":["desktop","mobile","tablet"]},"minItems":1,"maxItems":50},"os":{"type":"array","items":{"enum":["windows","harmonyos","kaios","tizen","webos","ipados","ios","macos","chromeos","android","ubuntu","fedora","debian","freebsd","linux"]},"minItems":1,"maxItems":50}},"additionalProperties":false},"action":{"type":"string","const":"block"}},"additionalProperties":false}]},"maxItems":20},"og":{"type":["object","null"],"properties":{"title":{"type":"string"},"description":{"type":"string"},"image_url":{"type":"string","minLength":1,"maxLength":2048}},"additionalProperties":false},"utm":{"type":"object","properties":{"source":{"type":"string"},"medium":{"type":"string"},"campaign":{"type":"string"},"term":{"type":"string"},"content":{"type":"string"}},"additionalProperties":false},"status":{"enum":["active","disabled"]}},"additionalProperties":false}}},"required":true},"responses":{"200":{"description":"Response for status 200","content":{"application/json":{"schema":{"type":"object","required":["id","short_url","domain_id","slug","destination","title","expires_at","click_limit","has_password","fallback_url","rules","og","status","safety","created_at","updated_at"],"properties":{"id":{"type":"string"},"short_url":{"type":"string"},"domain_id":{"type":["string","null"]},"slug":{"type":"string"},"destination":{"type":"string"},"title":{"type":["string","null"]},"expires_at":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"click_limit":{"type":["number","null"]},"has_password":{"type":"boolean"},"fallback_url":{"type":["string","null"]},"rules":{"type":"array","items":{"anyOf":[{"type":"object","required":["id","when","to"],"properties":{"id":{"type":"string"},"when":{"type":"object","properties":{"country":{"type":"array","items":{"type":"string"}},"device":{"type":"array","items":{"enum":["desktop","mobile","tablet"]}},"os":{"type":"array","items":{"enum":["windows","harmonyos","kaios","tizen","webos","ipados","ios","macos","chromeos","android","ubuntu","fedora","debian","freebsd","linux"]}}}},"action":{"type":"string","const":"redirect"},"to":{"type":"string"}}},{"type":"object","required":["id","when","action"],"properties":{"id":{"type":"string"},"when":{"type":"object","properties":{"country":{"type":"array","items":{"type":"string"}},"device":{"type":"array","items":{"enum":["desktop","mobile","tablet"]}},"os":{"type":"array","items":{"enum":["windows","harmonyos","kaios","tizen","webos","ipados","ios","macos","chromeos","android","ubuntu","fedora","debian","freebsd","linux"]}}}},"action":{"type":"string","const":"block"}}}]}},"og":{"type":["object","null"],"properties":{"title":{"type":"string"},"description":{"type":"string"},"image_url":{"type":"string"}}},"status":{"enum":["active","disabled"]},"safety":{"type":"object","required":["status","reason","checked_at"],"properties":{"status":{"enum":["unchecked","clean","blocked"]},"reason":{"type":["string","null"]},"checked_at":{"type":["string","null"],"format":"date-time","pattern":"Z$"}}},"created_at":{"type":"string","format":"date-time","pattern":"Z$"},"updated_at":{"type":"string","format":"date-time","pattern":"Z$"}}}}}},"400":{"description":"Response for status 400","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"401":{"description":"Response for status 401","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"402":{"description":"Response for status 402","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"403":{"description":"Response for status 403","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"404":{"description":"Response for status 404","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"409":{"description":"Response for status 409","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"429":{"description":"Response for status 429","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"500":{"description":"Response for status 500","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"503":{"description":"Response for status 503","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}}}},"delete":{"tags":["Links"],"operationId":"archiveLink","summary":"Unpublish and archive a short link","parameters":[{"name":"site_id","in":"path","required":true,"schema":{"type":"string","description":"The site id"}},{"name":"link_id","in":"path","required":true,"schema":{"type":"string","description":"The link id"}}],"responses":{"204":{"description":"No content"},"400":{"description":"Response for status 400","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"401":{"description":"Response for status 401","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"402":{"description":"Response for status 402","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"403":{"description":"Response for status 403","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"404":{"description":"Response for status 404","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"409":{"description":"Response for status 409","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"429":{"description":"Response for status 429","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"500":{"description":"Response for status 500","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"503":{"description":"Response for status 503","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}}}}},"/v1/sites/{site_id}/link-domains":{"get":{"tags":["Link domains"],"operationId":"listLinkDomains","summary":"List the custom link domains of a site","parameters":[{"name":"site_id","in":"path","required":true,"schema":{"type":"string","description":"The site id"}}],"responses":{"200":{"description":"Response for status 200","content":{"application/json":{"schema":{"type":"object","required":["items","available","limit"],"properties":{"items":{"type":"array","items":{"type":"object","required":["id","hostname","status","stage","verified_at","last_checked_at","last_error","auto_check","root_redirect_url","dns","created_at"],"properties":{"id":{"type":"string"},"hostname":{"type":"string"},"status":{"enum":["pending","active","failed"]},"stage":{"enum":["waiting_for_dns","issuing_certificate","active","needs_attention"]},"verified_at":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"last_checked_at":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"last_error":{"type":["string","null"]},"auto_check":{"type":"boolean"},"root_redirect_url":{"type":["string","null"]},"dns":{"type":"array","items":{"type":"object","required":["type","name","value","purpose","status"],"properties":{"type":{"enum":["CNAME","TXT"]},"name":{"type":"string"},"value":{"type":"string"},"purpose":{"enum":["routing","ownership","certificate"]},"status":{"enum":["pending","valid","invalid","unknown"]}}}},"created_at":{"type":"string","format":"date-time","pattern":"Z$"}}}},"available":{"type":"boolean"},"limit":{"type":"integer"}}}}}},"400":{"description":"Response for status 400","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"401":{"description":"Response for status 401","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"402":{"description":"Response for status 402","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"403":{"description":"Response for status 403","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"404":{"description":"Response for status 404","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"409":{"description":"Response for status 409","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"429":{"description":"Response for status 429","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"500":{"description":"Response for status 500","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"503":{"description":"Response for status 503","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}}}},"post":{"tags":["Link domains"],"operationId":"createLinkDomain","summary":"Add a custom link domain","parameters":[{"name":"site_id","in":"path","required":true,"schema":{"type":"string","description":"The site id"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["hostname"],"properties":{"hostname":{"type":"string","minLength":1,"maxLength":253}},"additionalProperties":false}}},"required":true},"responses":{"201":{"description":"Response for status 201","content":{"application/json":{"schema":{"type":"object","required":["id","hostname","status","stage","verified_at","last_checked_at","last_error","auto_check","root_redirect_url","dns","created_at"],"properties":{"id":{"type":"string"},"hostname":{"type":"string"},"status":{"enum":["pending","active","failed"]},"stage":{"enum":["waiting_for_dns","issuing_certificate","active","needs_attention"]},"verified_at":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"last_checked_at":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"last_error":{"type":["string","null"]},"auto_check":{"type":"boolean"},"root_redirect_url":{"type":["string","null"]},"dns":{"type":"array","items":{"type":"object","required":["type","name","value","purpose","status"],"properties":{"type":{"enum":["CNAME","TXT"]},"name":{"type":"string"},"value":{"type":"string"},"purpose":{"enum":["routing","ownership","certificate"]},"status":{"enum":["pending","valid","invalid","unknown"]}}}},"created_at":{"type":"string","format":"date-time","pattern":"Z$"}}}}}},"400":{"description":"Response for status 400","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"401":{"description":"Response for status 401","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"402":{"description":"Response for status 402","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"403":{"description":"Response for status 403","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"404":{"description":"Response for status 404","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"409":{"description":"Response for status 409","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"429":{"description":"Response for status 429","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"500":{"description":"Response for status 500","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"503":{"description":"Response for status 503","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}}}}},"/v1/sites/{site_id}/link-domains/{domain_id}/verify":{"post":{"tags":["Link domains"],"operationId":"verifyLinkDomain","summary":"Check the DNS and certificate of a link domain now","parameters":[{"name":"site_id","in":"path","required":true,"schema":{"type":"string","description":"The site id"}},{"name":"domain_id","in":"path","required":true,"schema":{"type":"string","description":"The link domain id"}}],"responses":{"200":{"description":"Response for status 200","content":{"application/json":{"schema":{"type":"object","required":["id","hostname","status","stage","verified_at","last_checked_at","last_error","auto_check","root_redirect_url","dns","created_at"],"properties":{"id":{"type":"string"},"hostname":{"type":"string"},"status":{"enum":["pending","active","failed"]},"stage":{"enum":["waiting_for_dns","issuing_certificate","active","needs_attention"]},"verified_at":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"last_checked_at":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"last_error":{"type":["string","null"]},"auto_check":{"type":"boolean"},"root_redirect_url":{"type":["string","null"]},"dns":{"type":"array","items":{"type":"object","required":["type","name","value","purpose","status"],"properties":{"type":{"enum":["CNAME","TXT"]},"name":{"type":"string"},"value":{"type":"string"},"purpose":{"enum":["routing","ownership","certificate"]},"status":{"enum":["pending","valid","invalid","unknown"]}}}},"created_at":{"type":"string","format":"date-time","pattern":"Z$"}}}}}},"400":{"description":"Response for status 400","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"401":{"description":"Response for status 401","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"402":{"description":"Response for status 402","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"403":{"description":"Response for status 403","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"404":{"description":"Response for status 404","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"409":{"description":"Response for status 409","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"429":{"description":"Response for status 429","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"500":{"description":"Response for status 500","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"503":{"description":"Response for status 503","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}}}}},"/v1/sites/{site_id}/link-domains/{domain_id}":{"patch":{"tags":["Link domains"],"operationId":"updateLinkDomain","summary":"Set where the root of a link domain redirects","parameters":[{"name":"site_id","in":"path","required":true,"schema":{"type":"string","description":"The site id"}},{"name":"domain_id","in":"path","required":true,"schema":{"type":"string","description":"The link domain id"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["root_redirect_url"],"properties":{"root_redirect_url":{"type":["string","null"],"minLength":1,"maxLength":2048}},"additionalProperties":false}}},"required":true},"responses":{"200":{"description":"Response for status 200","content":{"application/json":{"schema":{"type":"object","required":["id","hostname","status","stage","verified_at","last_checked_at","last_error","auto_check","root_redirect_url","dns","created_at"],"properties":{"id":{"type":"string"},"hostname":{"type":"string"},"status":{"enum":["pending","active","failed"]},"stage":{"enum":["waiting_for_dns","issuing_certificate","active","needs_attention"]},"verified_at":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"last_checked_at":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"last_error":{"type":["string","null"]},"auto_check":{"type":"boolean"},"root_redirect_url":{"type":["string","null"]},"dns":{"type":"array","items":{"type":"object","required":["type","name","value","purpose","status"],"properties":{"type":{"enum":["CNAME","TXT"]},"name":{"type":"string"},"value":{"type":"string"},"purpose":{"enum":["routing","ownership","certificate"]},"status":{"enum":["pending","valid","invalid","unknown"]}}}},"created_at":{"type":"string","format":"date-time","pattern":"Z$"}}}}}},"400":{"description":"Response for status 400","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"401":{"description":"Response for status 401","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"402":{"description":"Response for status 402","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"403":{"description":"Response for status 403","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"404":{"description":"Response for status 404","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"409":{"description":"Response for status 409","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"429":{"description":"Response for status 429","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"500":{"description":"Response for status 500","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"503":{"description":"Response for status 503","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}}}},"delete":{"tags":["Link domains"],"operationId":"deleteLinkDomain","summary":"Remove a custom link domain","parameters":[{"name":"site_id","in":"path","required":true,"schema":{"type":"string","description":"The site id"}},{"name":"domain_id","in":"path","required":true,"schema":{"type":"string","description":"The link domain id"}}],"responses":{"204":{"description":"No content"},"400":{"description":"Response for status 400","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"401":{"description":"Response for status 401","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"402":{"description":"Response for status 402","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"403":{"description":"Response for status 403","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"404":{"description":"Response for status 404","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"409":{"description":"Response for status 409","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"429":{"description":"Response for status 429","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"500":{"description":"Response for status 500","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"503":{"description":"Response for status 503","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}}}}},"/v1/sites/{site_id}/links/og-image":{"post":{"tags":["Links"],"operationId":"uploadLinkOgImage","summary":"Upload a social card image for a short link","requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"type":"object","required":["file"],"properties":{"file":{"type":"string","format":"binary","description":"A JPEG, PNG, WebP or GIF image of at most 5 MB"}}}}}},"parameters":[{"name":"site_id","in":"path","required":true,"schema":{"type":"string","description":"The site id"}}],"responses":{"201":{"description":"Response for status 201","content":{"application/json":{"schema":{"type":"object","required":["url","width","height","bytes"],"properties":{"url":{"type":"string"},"width":{"type":"number"},"height":{"type":"number"},"bytes":{"type":"number"}}}}}},"400":{"description":"Response for status 400","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"401":{"description":"Response for status 401","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"402":{"description":"Response for status 402","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"403":{"description":"Response for status 403","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"404":{"description":"Response for status 404","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"409":{"description":"Response for status 409","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"429":{"description":"Response for status 429","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"500":{"description":"Response for status 500","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"503":{"description":"Response for status 503","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}}}}},"/v1/sites/{site_id}/feedback":{"get":{"tags":["Feedback"],"operationId":"listFeedback","summary":"List the feedback messages of a site, newest first","parameters":[{"name":"site_id","in":"path","required":true,"schema":{"type":"string","description":"The site id"}},{"name":"status","in":"query","required":false,"schema":{"enum":["new","resolved"]}},{"name":"limit","in":"query","required":false,"schema":{"type":"string","pattern":"^[0-9]{1,3}$"}},{"name":"cursor","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":200}},{"name":"q","in":"query","required":false,"schema":{"type":"string","description":"Searches the message, email and page URL"}},{"name":"from","in":"query","required":false,"schema":{"type":"string","description":"ISO-8601 UTC instant; send with to"}},{"name":"to","in":"query","required":false,"schema":{"type":"string","description":"ISO-8601 UTC instant; send with from"}},{"name":"timezone","in":"query","required":false,"schema":{"type":"string","description":"IANA time zone of the range"}}],"responses":{"200":{"description":"Response for status 200","content":{"application/json":{"schema":{"type":"object","required":["items","next_cursor","has_more","meta"],"properties":{"items":{"type":"array","items":{"type":"object","required":["id","message","email","page_url","country","device_type","browser","os","visit_id","status","read","created_at","resolved_at"],"properties":{"id":{"type":"string"},"message":{"type":"string"},"email":{"type":["string","null"]},"page_url":{"type":["string","null"]},"country":{"type":["string","null"]},"device_type":{"type":["string","null"]},"browser":{"type":["string","null"]},"os":{"type":["string","null"]},"visit_id":{"type":["string","null"]},"status":{"enum":["new","resolved"]},"read":{"type":"boolean"},"created_at":{"type":"string","format":"date-time","pattern":"Z$"},"resolved_at":{"type":["string","null"],"format":"date-time","pattern":"Z$"}}}},"next_cursor":{"type":["string","null"]},"has_more":{"type":"boolean"},"meta":{"type":"object","required":["counts"],"properties":{"counts":{"type":"object","required":["new","resolved"],"properties":{"new":{"type":"number"},"resolved":{"type":"number"}}}}}}}}}},"400":{"description":"Response for status 400","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"401":{"description":"Response for status 401","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"402":{"description":"Response for status 402","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"403":{"description":"Response for status 403","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"404":{"description":"Response for status 404","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"409":{"description":"Response for status 409","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"429":{"description":"Response for status 429","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"500":{"description":"Response for status 500","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"503":{"description":"Response for status 503","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}}}}},"/v1/sites/{site_id}/feedback/{feedback_id}":{"get":{"tags":["Feedback"],"operationId":"getFeedback","summary":"Get a feedback message","parameters":[{"name":"site_id","in":"path","required":true,"schema":{"type":"string","description":"The site id"}},{"name":"feedback_id","in":"path","required":true,"schema":{"type":"string","description":"The feedback id"}}],"responses":{"200":{"description":"Response for status 200","content":{"application/json":{"schema":{"type":"object","required":["id","message","email","page_url","country","device_type","browser","os","visit_id","status","read","created_at","resolved_at"],"properties":{"id":{"type":"string"},"message":{"type":"string"},"email":{"type":["string","null"]},"page_url":{"type":["string","null"]},"country":{"type":["string","null"]},"device_type":{"type":["string","null"]},"browser":{"type":["string","null"]},"os":{"type":["string","null"]},"visit_id":{"type":["string","null"]},"status":{"enum":["new","resolved"]},"read":{"type":"boolean"},"created_at":{"type":"string","format":"date-time","pattern":"Z$"},"resolved_at":{"type":["string","null"],"format":"date-time","pattern":"Z$"}}}}}},"400":{"description":"Response for status 400","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"401":{"description":"Response for status 401","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"402":{"description":"Response for status 402","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"403":{"description":"Response for status 403","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"404":{"description":"Response for status 404","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"409":{"description":"Response for status 409","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"429":{"description":"Response for status 429","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"500":{"description":"Response for status 500","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"503":{"description":"Response for status 503","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}}}},"patch":{"tags":["Feedback"],"operationId":"updateFeedbackStatus","summary":"Resolve or reopen a feedback message","parameters":[{"name":"site_id","in":"path","required":true,"schema":{"type":"string","description":"The site id"}},{"name":"feedback_id","in":"path","required":true,"schema":{"type":"string","description":"The feedback id"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["status"],"properties":{"status":{"enum":["new","resolved"]}}}}},"required":true},"responses":{"200":{"description":"Response for status 200","content":{"application/json":{"schema":{"type":"object","required":["id","message","email","page_url","country","device_type","browser","os","visit_id","status","read","created_at","resolved_at"],"properties":{"id":{"type":"string"},"message":{"type":"string"},"email":{"type":["string","null"]},"page_url":{"type":["string","null"]},"country":{"type":["string","null"]},"device_type":{"type":["string","null"]},"browser":{"type":["string","null"]},"os":{"type":["string","null"]},"visit_id":{"type":["string","null"]},"status":{"enum":["new","resolved"]},"read":{"type":"boolean"},"created_at":{"type":"string","format":"date-time","pattern":"Z$"},"resolved_at":{"type":["string","null"],"format":"date-time","pattern":"Z$"}}}}}},"400":{"description":"Response for status 400","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"401":{"description":"Response for status 401","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"402":{"description":"Response for status 402","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"403":{"description":"Response for status 403","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"404":{"description":"Response for status 404","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"409":{"description":"Response for status 409","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"429":{"description":"Response for status 429","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"500":{"description":"Response for status 500","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"503":{"description":"Response for status 503","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}}}},"delete":{"tags":["Feedback"],"operationId":"deleteFeedback","summary":"Delete a feedback message","parameters":[{"name":"site_id","in":"path","required":true,"schema":{"type":"string","description":"The site id"}},{"name":"feedback_id","in":"path","required":true,"schema":{"type":"string","description":"The feedback id"}}],"responses":{"204":{"description":"No content"},"400":{"description":"Response for status 400","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"401":{"description":"Response for status 401","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"402":{"description":"Response for status 402","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"403":{"description":"Response for status 403","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"404":{"description":"Response for status 404","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"409":{"description":"Response for status 409","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"429":{"description":"Response for status 429","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"500":{"description":"Response for status 500","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"503":{"description":"Response for status 503","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}}}}},"/v1/sites/{site_id}/feedback/{feedback_id}/read":{"post":{"tags":["Feedback"],"operationId":"markFeedbackRead","summary":"Mark a feedback message as read by the signed-in user","parameters":[{"name":"site_id","in":"path","required":true,"schema":{"type":"string","description":"The site id"}},{"name":"feedback_id","in":"path","required":true,"schema":{"type":"string","description":"The feedback id"}}],"responses":{"204":{"description":"No content"},"400":{"description":"Response for status 400","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"401":{"description":"Response for status 401","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"402":{"description":"Response for status 402","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"403":{"description":"Response for status 403","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"404":{"description":"Response for status 404","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"409":{"description":"Response for status 409","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"429":{"description":"Response for status 429","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"500":{"description":"Response for status 500","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"503":{"description":"Response for status 503","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}}}}},"/v1/sites/{site_id}/feedback/{feedback_id}/visit":{"get":{"tags":["Feedback"],"operationId":"getFeedbackVisit","summary":"Get the visit trail around a feedback message","parameters":[{"name":"site_id","in":"path","required":true,"schema":{"type":"string","description":"The site id"}},{"name":"feedback_id","in":"path","required":true,"schema":{"type":"string","description":"The feedback id"}},{"name":"timezone","in":"query","required":true,"schema":{"type":"string","description":"IANA time zone for the visit trail"}}],"responses":{"200":{"description":"Response for status 200","content":{"application/json":{"schema":{"type":"object","required":["meta","visit_id","entries"],"properties":{"meta":{"type":"object","required":["requested_range","timezone","freshness","cached","truncated","provisional"],"properties":{"requested_range":{"type":"object","required":["from","to"],"properties":{"from":{"type":"string","format":"date-time","pattern":"Z$"},"to":{"type":"string","format":"date-time","pattern":"Z$"}}},"timezone":{"type":"string","description":"An IANA time zone, e.g. Europe/Istanbul"},"freshness":{"type":"object","required":["state","watermark","as_of"],"properties":{"state":{"enum":["ok","no_data","stale","degraded"]},"watermark":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"as_of":{"type":"string","format":"date-time","pattern":"Z$"}}},"cached":{"type":"boolean"},"truncated":{"type":"boolean"},"provisional":{"type":"boolean","const":true}}},"visit_id":{"type":"string"},"entries":{"type":"array","items":{"type":"object","required":["event_id","occurred_at","type","name","hostname","page_path","page_title","referrer_domain"],"properties":{"event_id":{"type":"string"},"occurred_at":{"type":"string","format":"date-time","pattern":"Z$"},"type":{"enum":["pageview","event"]},"name":{"type":["string","null"]},"hostname":{"type":"string"},"page_path":{"type":"string"},"page_title":{"type":"string"},"referrer_domain":{"type":"string"}}}}}}}}},"400":{"description":"Response for status 400","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"401":{"description":"Response for status 401","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"402":{"description":"Response for status 402","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"403":{"description":"Response for status 403","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"404":{"description":"Response for status 404","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"409":{"description":"Response for status 409","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"429":{"description":"Response for status 429","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"500":{"description":"Response for status 500","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"503":{"description":"Response for status 503","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}}}}},"/v1/sites/{site_id}/annotations":{"get":{"tags":["Annotations"],"operationId":"listAnnotations","summary":"List the annotations that overlap a time range","parameters":[{"name":"site_id","in":"path","required":true,"schema":{"type":"string","description":"The site id"}},{"name":"from","in":"query","required":true,"schema":{"type":"string","format":"date-time","pattern":"Z$"}},{"name":"to","in":"query","required":true,"schema":{"type":"string","format":"date-time","pattern":"Z$"}}],"responses":{"200":{"description":"Response for status 200","content":{"application/json":{"schema":{"type":"object","required":["items"],"properties":{"items":{"type":"array","items":{"type":"object","required":["id","starts_at","ends_at","title","description","color","created_by_user_id","created_at","updated_at"],"properties":{"id":{"type":"string","description":"A UUIDv7"},"starts_at":{"type":"string","format":"date-time","pattern":"Z$"},"ends_at":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"title":{"type":"string"},"description":{"type":["string","null"]},"color":{"enum":["gray","blue","green","amber","red","purple"]},"created_by_user_id":{"type":["string","null"],"description":"Null when an API key made it"},"created_at":{"type":"string","format":"date-time","pattern":"Z$"},"updated_at":{"type":"string","format":"date-time","pattern":"Z$"}}}}}}}}},"400":{"description":"Response for status 400","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"401":{"description":"Response for status 401","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"402":{"description":"Response for status 402","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"403":{"description":"Response for status 403","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"404":{"description":"Response for status 404","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"409":{"description":"Response for status 409","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"429":{"description":"Response for status 429","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"500":{"description":"Response for status 500","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"503":{"description":"Response for status 503","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}}}},"post":{"tags":["Annotations"],"operationId":"createAnnotation","summary":"Create an annotation","parameters":[{"name":"site_id","in":"path","required":true,"schema":{"type":"string","description":"The site id"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["starts_at","title","color"],"properties":{"starts_at":{"type":"string","format":"date-time","pattern":"Z$"},"ends_at":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"title":{"type":"string"},"description":{"type":["string","null"]},"color":{"enum":["gray","blue","green","amber","red","purple"],"default":"gray"}},"additionalProperties":false}}},"required":true},"responses":{"201":{"description":"Response for status 201","content":{"application/json":{"schema":{"type":"object","required":["id","starts_at","ends_at","title","description","color","created_by_user_id","created_at","updated_at"],"properties":{"id":{"type":"string","description":"A UUIDv7"},"starts_at":{"type":"string","format":"date-time","pattern":"Z$"},"ends_at":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"title":{"type":"string"},"description":{"type":["string","null"]},"color":{"enum":["gray","blue","green","amber","red","purple"]},"created_by_user_id":{"type":["string","null"],"description":"Null when an API key made it"},"created_at":{"type":"string","format":"date-time","pattern":"Z$"},"updated_at":{"type":"string","format":"date-time","pattern":"Z$"}}}}}},"400":{"description":"Response for status 400","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"401":{"description":"Response for status 401","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"402":{"description":"Response for status 402","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"403":{"description":"Response for status 403","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"404":{"description":"Response for status 404","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"409":{"description":"Response for status 409","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"429":{"description":"Response for status 429","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"500":{"description":"Response for status 500","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"503":{"description":"Response for status 503","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}}}}},"/v1/sites/{site_id}/annotations/{annotation_id}":{"patch":{"tags":["Annotations"],"operationId":"updateAnnotation","summary":"Update an annotation","parameters":[{"name":"site_id","in":"path","required":true,"schema":{"type":"string","description":"The site id"}},{"name":"annotation_id","in":"path","required":true,"schema":{"type":"string","description":"The annotation id"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"starts_at":{"type":"string","format":"date-time","pattern":"Z$"},"ends_at":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"title":{"type":"string"},"description":{"type":["string","null"]},"color":{"enum":["gray","blue","green","amber","red","purple"]}},"additionalProperties":false}}},"required":true},"responses":{"200":{"description":"Response for status 200","content":{"application/json":{"schema":{"type":"object","required":["id","starts_at","ends_at","title","description","color","created_by_user_id","created_at","updated_at"],"properties":{"id":{"type":"string","description":"A UUIDv7"},"starts_at":{"type":"string","format":"date-time","pattern":"Z$"},"ends_at":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"title":{"type":"string"},"description":{"type":["string","null"]},"color":{"enum":["gray","blue","green","amber","red","purple"]},"created_by_user_id":{"type":["string","null"],"description":"Null when an API key made it"},"created_at":{"type":"string","format":"date-time","pattern":"Z$"},"updated_at":{"type":"string","format":"date-time","pattern":"Z$"}}}}}},"400":{"description":"Response for status 400","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"401":{"description":"Response for status 401","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"402":{"description":"Response for status 402","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"403":{"description":"Response for status 403","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"404":{"description":"Response for status 404","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"409":{"description":"Response for status 409","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"429":{"description":"Response for status 429","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"500":{"description":"Response for status 500","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"503":{"description":"Response for status 503","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}}}},"delete":{"tags":["Annotations"],"operationId":"deleteAnnotation","summary":"Delete an annotation","parameters":[{"name":"site_id","in":"path","required":true,"schema":{"type":"string","description":"The site id"}},{"name":"annotation_id","in":"path","required":true,"schema":{"type":"string","description":"The annotation id"}}],"responses":{"204":{"description":"No content"},"400":{"description":"Response for status 400","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"401":{"description":"Response for status 401","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"402":{"description":"Response for status 402","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"403":{"description":"Response for status 403","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"404":{"description":"Response for status 404","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"409":{"description":"Response for status 409","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"429":{"description":"Response for status 429","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"500":{"description":"Response for status 500","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"503":{"description":"Response for status 503","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}}}}},"/v1/sites/{site_id}/tracker/install":{"get":{"tags":["Tracker"],"operationId":"getTrackerInstall","summary":"The script snippets and release hashes for installing the tracker","parameters":[{"name":"site_id","in":"path","required":true,"schema":{"type":"string","description":"The site id"}}],"responses":{"200":{"description":"Response for status 200","content":{"application/json":{"schema":{"type":"object","required":["site_id","collector_url","auto_update","pinned","release"],"properties":{"site_id":{"type":"string"},"collector_url":{"type":"string"},"auto_update":{"type":"object","required":["src","snippet"],"properties":{"src":{"type":"string"},"snippet":{"type":"string"}}},"pinned":{"type":["object","null"],"required":["version","src","integrity","crossorigin","chunk_integrity","snippet"],"properties":{"version":{"type":"string"},"src":{"type":"string"},"integrity":{"type":"string"},"crossorigin":{"type":"string","const":"anonymous"},"chunk_integrity":{"type":"object","required":["extras","notices","rules","interactions","overlay","feedback"],"properties":{"extras":{"type":"string"},"notices":{"type":"string"},"rules":{"type":"string"},"interactions":{"type":"string"},"overlay":{"type":"string"},"feedback":{"type":"string"}}},"snippet":{"type":"string"}}},"release":{"type":["object","null"],"required":["version","files"],"properties":{"version":{"type":"string"},"files":{"type":"array","items":{"type":"object","required":["file","path","integrity","bytes"],"properties":{"file":{"enum":["invisit.js","invisit-extras.js","invisit-notices.js","invisit-rules.js","invisit-interactions.js","invisit-overlay.js","invisit-feedback.js"]},"path":{"type":"string"},"integrity":{"type":"string"},"bytes":{"type":"number"}}}}}}}}}}},"400":{"description":"Response for status 400","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"401":{"description":"Response for status 401","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"402":{"description":"Response for status 402","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"403":{"description":"Response for status 403","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"404":{"description":"Response for status 404","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"409":{"description":"Response for status 409","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"429":{"description":"Response for status 429","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"500":{"description":"Response for status 500","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"503":{"description":"Response for status 503","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}}}}},"/v1/sites/{site_id}/event-definitions":{"get":{"tags":["Event definitions"],"operationId":"listEventDefinitions","summary":"List the event definitions of a site","parameters":[{"name":"site_id","in":"path","required":true,"schema":{"type":"string","description":"The site id"}},{"name":"include_archived","in":"query","required":false,"schema":{"enum":["true","false"]}}],"responses":{"200":{"description":"Response for status 200","content":{"application/json":{"schema":{"type":"object","required":["items"],"properties":{"items":{"type":"array","items":{"type":"object","required":["id","site_id","event_name","status","published_version","created_by_user_id","created_at","updated_at","archived_at"],"properties":{"id":{"type":"string"},"site_id":{"type":"string"},"event_name":{"type":"string"},"status":{"enum":["active","archived"]},"published_version":{"type":["integer","null"]},"created_by_user_id":{"type":["string","null"]},"created_at":{"type":"string","format":"date-time","pattern":"Z$"},"updated_at":{"type":"string","format":"date-time","pattern":"Z$"},"archived_at":{"type":["string","null"],"format":"date-time","pattern":"Z$"}}}}}}}}},"400":{"description":"Response for status 400","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"401":{"description":"Response for status 401","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"402":{"description":"Response for status 402","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"403":{"description":"Response for status 403","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"404":{"description":"Response for status 404","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"409":{"description":"Response for status 409","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"429":{"description":"Response for status 429","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"500":{"description":"Response for status 500","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"503":{"description":"Response for status 503","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}}}},"post":{"tags":["Event definitions"],"operationId":"createEventDefinition","summary":"Create an event definition with its first version","parameters":[{"name":"site_id","in":"path","required":true,"schema":{"type":"string","description":"The site id"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["event_name","display_name","description","category","property_schema","display_template","rules"],"properties":{"event_name":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[a-zA-Z][a-zA-Z0-9_.-]*$"},"display_name":{"type":"string"},"description":{"default":null,"type":["string","null"],"maxLength":1000},"category":{"default":null,"type":["string","null"]},"property_schema":{"type":"array","items":{"type":"object","required":["key","type"],"properties":{"key":{"type":"string","minLength":1,"maxLength":40,"pattern":"^[a-zA-Z_][a-zA-Z0-9_.-]*$"},"type":{"enum":["string","number","boolean"],"default":"string"}},"additionalProperties":false},"maxItems":32,"default":[]},"display_template":{"default":null,"type":["string","null"],"maxLength":200},"rules":{"type":"array","items":{"type":"object","required":["rule_id","trigger","properties"],"properties":{"rule_id":{"type":"string","format":"uuid"},"trigger":{"enum":["click","submit","url_pattern"]},"selector":{"type":"string","maxLength":256},"url_pattern":{"type":"string","maxLength":512},"properties":{"type":"array","items":{"type":"object","required":["key","source"],"properties":{"key":{"type":"string","minLength":1,"maxLength":40,"pattern":"^[a-zA-Z_][a-zA-Z0-9_.-]*$"},"source":{"enum":["text","element_tag","page_path","page_url","page_title","attribute","url_param","constant"]},"argument":{"type":"string","maxLength":256}},"additionalProperties":false},"maxItems":8,"default":[]}},"additionalProperties":false},"maxItems":50,"default":[]}},"additionalProperties":false}}},"required":true},"responses":{"201":{"description":"Response for status 201","content":{"application/json":{"schema":{"type":"object","required":["id","site_id","event_name","status","published_version","created_by_user_id","created_at","updated_at","archived_at","version"],"properties":{"id":{"type":"string"},"site_id":{"type":"string"},"event_name":{"type":"string"},"status":{"enum":["active","archived"]},"published_version":{"type":["integer","null"]},"created_by_user_id":{"type":["string","null"]},"created_at":{"type":"string","format":"date-time","pattern":"Z$"},"updated_at":{"type":"string","format":"date-time","pattern":"Z$"},"archived_at":{"type":["string","null"],"format":"date-time","pattern":"Z$"},"version":{"type":"object","required":["id","definition_id","version","display_name","description","category","property_schema","display_template","rules","source_version","created_by_user_id","created_at"],"properties":{"id":{"type":"string"},"definition_id":{"type":"string"},"version":{"type":"integer"},"display_name":{"type":"string"},"description":{"type":["string","null"]},"category":{"type":["string","null"]},"property_schema":{"type":"array","items":{"type":"object","required":["key","type"],"properties":{"key":{"type":"string"},"type":{"enum":["string","number","boolean"]}}}},"display_template":{"type":["string","null"]},"rules":{"type":"array","items":{"type":"object","required":["rule_id","trigger"],"properties":{"rule_id":{"type":"string"},"trigger":{"enum":["click","submit","url_pattern"]},"selector":{"type":"string"},"url_pattern":{"type":"string"},"properties":{"type":"array","items":{"type":"object","required":["key","source"],"properties":{"key":{"type":"string"},"source":{"enum":["text","element_tag","page_path","page_url","page_title","attribute","url_param","constant"]},"argument":{"type":"string"}}}}}}},"source_version":{"type":["integer","null"]},"created_by_user_id":{"type":["string","null"]},"created_at":{"type":"string","format":"date-time","pattern":"Z$"}}}}}}}},"400":{"description":"Response for status 400","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"401":{"description":"Response for status 401","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"402":{"description":"Response for status 402","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"403":{"description":"Response for status 403","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"404":{"description":"Response for status 404","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"409":{"description":"Response for status 409","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"429":{"description":"Response for status 429","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"500":{"description":"Response for status 500","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"503":{"description":"Response for status 503","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}}}}},"/v1/sites/{site_id}/event-definitions/{definition_id}":{"get":{"tags":["Event definitions"],"operationId":"getEventDefinition","summary":"Get an event definition","parameters":[{"name":"site_id","in":"path","required":true,"schema":{"type":"string","description":"The site id"}},{"name":"definition_id","in":"path","required":true,"schema":{"type":"string","description":"The event definition id"}}],"responses":{"200":{"description":"Response for status 200","content":{"application/json":{"schema":{"type":"object","required":["id","site_id","event_name","status","published_version","created_by_user_id","created_at","updated_at","archived_at"],"properties":{"id":{"type":"string"},"site_id":{"type":"string"},"event_name":{"type":"string"},"status":{"enum":["active","archived"]},"published_version":{"type":["integer","null"]},"created_by_user_id":{"type":["string","null"]},"created_at":{"type":"string","format":"date-time","pattern":"Z$"},"updated_at":{"type":"string","format":"date-time","pattern":"Z$"},"archived_at":{"type":["string","null"],"format":"date-time","pattern":"Z$"}}}}}},"400":{"description":"Response for status 400","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"401":{"description":"Response for status 401","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"402":{"description":"Response for status 402","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"403":{"description":"Response for status 403","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"404":{"description":"Response for status 404","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"409":{"description":"Response for status 409","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"429":{"description":"Response for status 429","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"500":{"description":"Response for status 500","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"503":{"description":"Response for status 503","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}}}},"delete":{"tags":["Event definitions"],"operationId":"archiveEventDefinition","summary":"Archive an event definition","parameters":[{"name":"site_id","in":"path","required":true,"schema":{"type":"string","description":"The site id"}},{"name":"definition_id","in":"path","required":true,"schema":{"type":"string","description":"The event definition id"}}],"responses":{"204":{"description":"No content"},"400":{"description":"Response for status 400","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"401":{"description":"Response for status 401","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"402":{"description":"Response for status 402","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"403":{"description":"Response for status 403","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"404":{"description":"Response for status 404","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"409":{"description":"Response for status 409","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"429":{"description":"Response for status 429","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"500":{"description":"Response for status 500","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"503":{"description":"Response for status 503","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}}}}},"/v1/sites/{site_id}/event-definitions/{definition_id}/versions":{"get":{"tags":["Event definitions"],"operationId":"listEventDefinitionVersions","summary":"List the versions of an event definition","parameters":[{"name":"site_id","in":"path","required":true,"schema":{"type":"string","description":"The site id"}},{"name":"definition_id","in":"path","required":true,"schema":{"type":"string","description":"The event definition id"}}],"responses":{"200":{"description":"Response for status 200","content":{"application/json":{"schema":{"type":"object","required":["published_version","items"],"properties":{"published_version":{"type":["integer","null"]},"items":{"type":"array","items":{"type":"object","required":["id","definition_id","version","display_name","description","category","property_schema","display_template","rules","source_version","created_by_user_id","created_at"],"properties":{"id":{"type":"string"},"definition_id":{"type":"string"},"version":{"type":"integer"},"display_name":{"type":"string"},"description":{"type":["string","null"]},"category":{"type":["string","null"]},"property_schema":{"type":"array","items":{"type":"object","required":["key","type"],"properties":{"key":{"type":"string"},"type":{"enum":["string","number","boolean"]}}}},"display_template":{"type":["string","null"]},"rules":{"type":"array","items":{"type":"object","required":["rule_id","trigger"],"properties":{"rule_id":{"type":"string"},"trigger":{"enum":["click","submit","url_pattern"]},"selector":{"type":"string"},"url_pattern":{"type":"string"},"properties":{"type":"array","items":{"type":"object","required":["key","source"],"properties":{"key":{"type":"string"},"source":{"enum":["text","element_tag","page_path","page_url","page_title","attribute","url_param","constant"]},"argument":{"type":"string"}}}}}}},"source_version":{"type":["integer","null"]},"created_by_user_id":{"type":["string","null"]},"created_at":{"type":"string","format":"date-time","pattern":"Z$"}}}}}}}}},"400":{"description":"Response for status 400","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"401":{"description":"Response for status 401","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"402":{"description":"Response for status 402","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"403":{"description":"Response for status 403","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"404":{"description":"Response for status 404","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"409":{"description":"Response for status 409","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"429":{"description":"Response for status 429","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"500":{"description":"Response for status 500","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"503":{"description":"Response for status 503","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}}}},"post":{"tags":["Event definitions"],"operationId":"createEventDefinitionVersion","summary":"Save a new draft version of an event definition","parameters":[{"name":"site_id","in":"path","required":true,"schema":{"type":"string","description":"The site id"}},{"name":"definition_id","in":"path","required":true,"schema":{"type":"string","description":"The event definition id"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["display_name","description","category","property_schema","display_template","rules"],"properties":{"display_name":{"type":"string"},"description":{"default":null,"type":["string","null"],"maxLength":1000},"category":{"default":null,"type":["string","null"]},"property_schema":{"type":"array","items":{"type":"object","required":["key","type"],"properties":{"key":{"type":"string","minLength":1,"maxLength":40,"pattern":"^[a-zA-Z_][a-zA-Z0-9_.-]*$"},"type":{"enum":["string","number","boolean"],"default":"string"}},"additionalProperties":false},"maxItems":32,"default":[]},"display_template":{"default":null,"type":["string","null"],"maxLength":200},"rules":{"type":"array","items":{"type":"object","required":["rule_id","trigger","properties"],"properties":{"rule_id":{"type":"string","format":"uuid"},"trigger":{"enum":["click","submit","url_pattern"]},"selector":{"type":"string","maxLength":256},"url_pattern":{"type":"string","maxLength":512},"properties":{"type":"array","items":{"type":"object","required":["key","source"],"properties":{"key":{"type":"string","minLength":1,"maxLength":40,"pattern":"^[a-zA-Z_][a-zA-Z0-9_.-]*$"},"source":{"enum":["text","element_tag","page_path","page_url","page_title","attribute","url_param","constant"]},"argument":{"type":"string","maxLength":256}},"additionalProperties":false},"maxItems":8,"default":[]}},"additionalProperties":false},"maxItems":50,"default":[]}},"additionalProperties":false}}},"required":true},"responses":{"201":{"description":"Response for status 201","content":{"application/json":{"schema":{"type":"object","required":["id","definition_id","version","display_name","description","category","property_schema","display_template","rules","source_version","created_by_user_id","created_at"],"properties":{"id":{"type":"string"},"definition_id":{"type":"string"},"version":{"type":"integer"},"display_name":{"type":"string"},"description":{"type":["string","null"]},"category":{"type":["string","null"]},"property_schema":{"type":"array","items":{"type":"object","required":["key","type"],"properties":{"key":{"type":"string"},"type":{"enum":["string","number","boolean"]}}}},"display_template":{"type":["string","null"]},"rules":{"type":"array","items":{"type":"object","required":["rule_id","trigger"],"properties":{"rule_id":{"type":"string"},"trigger":{"enum":["click","submit","url_pattern"]},"selector":{"type":"string"},"url_pattern":{"type":"string"},"properties":{"type":"array","items":{"type":"object","required":["key","source"],"properties":{"key":{"type":"string"},"source":{"enum":["text","element_tag","page_path","page_url","page_title","attribute","url_param","constant"]},"argument":{"type":"string"}}}}}}},"source_version":{"type":["integer","null"]},"created_by_user_id":{"type":["string","null"]},"created_at":{"type":"string","format":"date-time","pattern":"Z$"}}}}}},"400":{"description":"Response for status 400","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"401":{"description":"Response for status 401","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"402":{"description":"Response for status 402","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"403":{"description":"Response for status 403","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"404":{"description":"Response for status 404","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"409":{"description":"Response for status 409","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"429":{"description":"Response for status 429","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"500":{"description":"Response for status 500","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"503":{"description":"Response for status 503","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}}}}},"/v1/sites/{site_id}/event-definitions/{definition_id}/versions/{version}":{"get":{"tags":["Event definitions"],"operationId":"getEventDefinitionVersion","summary":"Get one version of an event definition","parameters":[{"name":"site_id","in":"path","required":true,"schema":{"type":"string","description":"The site id"}},{"name":"definition_id","in":"path","required":true,"schema":{"type":"string","description":"The event definition id"}},{"name":"version","in":"path","required":true,"schema":{"type":"string","pattern":"^[0-9]+$","description":"The version number"}}],"responses":{"200":{"description":"Response for status 200","content":{"application/json":{"schema":{"type":"object","required":["id","definition_id","version","display_name","description","category","property_schema","display_template","rules","source_version","created_by_user_id","created_at"],"properties":{"id":{"type":"string"},"definition_id":{"type":"string"},"version":{"type":"integer"},"display_name":{"type":"string"},"description":{"type":["string","null"]},"category":{"type":["string","null"]},"property_schema":{"type":"array","items":{"type":"object","required":["key","type"],"properties":{"key":{"type":"string"},"type":{"enum":["string","number","boolean"]}}}},"display_template":{"type":["string","null"]},"rules":{"type":"array","items":{"type":"object","required":["rule_id","trigger"],"properties":{"rule_id":{"type":"string"},"trigger":{"enum":["click","submit","url_pattern"]},"selector":{"type":"string"},"url_pattern":{"type":"string"},"properties":{"type":"array","items":{"type":"object","required":["key","source"],"properties":{"key":{"type":"string"},"source":{"enum":["text","element_tag","page_path","page_url","page_title","attribute","url_param","constant"]},"argument":{"type":"string"}}}}}}},"source_version":{"type":["integer","null"]},"created_by_user_id":{"type":["string","null"]},"created_at":{"type":"string","format":"date-time","pattern":"Z$"}}}}}},"400":{"description":"Response for status 400","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"401":{"description":"Response for status 401","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"402":{"description":"Response for status 402","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"403":{"description":"Response for status 403","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"404":{"description":"Response for status 404","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"409":{"description":"Response for status 409","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"429":{"description":"Response for status 429","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"500":{"description":"Response for status 500","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"503":{"description":"Response for status 503","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}}}}},"/v1/sites/{site_id}/event-definitions/{definition_id}/publish":{"post":{"tags":["Event definitions"],"operationId":"publishEventDefinition","summary":"Publish a version of an event definition","parameters":[{"name":"site_id","in":"path","required":true,"schema":{"type":"string","description":"The site id"}},{"name":"definition_id","in":"path","required":true,"schema":{"type":"string","description":"The event definition id"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["version","expected_published_version"],"properties":{"version":{"type":"integer","minimum":1},"expected_published_version":{"type":["integer","null"],"minimum":1}},"additionalProperties":false}}},"required":true},"responses":{"200":{"description":"Response for status 200","content":{"application/json":{"schema":{"type":"object","required":["published_version","config_version"],"properties":{"published_version":{"type":"integer"},"config_version":{"type":"integer"}}}}}},"400":{"description":"Response for status 400","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"401":{"description":"Response for status 401","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"402":{"description":"Response for status 402","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"403":{"description":"Response for status 403","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"404":{"description":"Response for status 404","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"409":{"description":"Response for status 409","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"429":{"description":"Response for status 429","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"500":{"description":"Response for status 500","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"503":{"description":"Response for status 503","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}}}}},"/v1/sites/{site_id}/event-definitions/{definition_id}/rollback":{"post":{"tags":["Event definitions"],"operationId":"rollbackEventDefinition","summary":"Publish a copy of an earlier version of an event definition","parameters":[{"name":"site_id","in":"path","required":true,"schema":{"type":"string","description":"The site id"}},{"name":"definition_id","in":"path","required":true,"schema":{"type":"string","description":"The event definition id"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["version","expected_published_version"],"properties":{"version":{"type":"integer","minimum":1},"expected_published_version":{"type":["integer","null"],"minimum":1}},"additionalProperties":false}}},"required":true},"responses":{"200":{"description":"Response for status 200","content":{"application/json":{"schema":{"type":"object","required":["published_version","source_version","config_version","version"],"properties":{"published_version":{"type":"integer"},"source_version":{"type":["integer","null"]},"config_version":{"type":"integer"},"version":{"type":"object","required":["id","definition_id","version","display_name","description","category","property_schema","display_template","rules","source_version","created_by_user_id","created_at"],"properties":{"id":{"type":"string"},"definition_id":{"type":"string"},"version":{"type":"integer"},"display_name":{"type":"string"},"description":{"type":["string","null"]},"category":{"type":["string","null"]},"property_schema":{"type":"array","items":{"type":"object","required":["key","type"],"properties":{"key":{"type":"string"},"type":{"enum":["string","number","boolean"]}}}},"display_template":{"type":["string","null"]},"rules":{"type":"array","items":{"type":"object","required":["rule_id","trigger"],"properties":{"rule_id":{"type":"string"},"trigger":{"enum":["click","submit","url_pattern"]},"selector":{"type":"string"},"url_pattern":{"type":"string"},"properties":{"type":"array","items":{"type":"object","required":["key","source"],"properties":{"key":{"type":"string"},"source":{"enum":["text","element_tag","page_path","page_url","page_title","attribute","url_param","constant"]},"argument":{"type":"string"}}}}}}},"source_version":{"type":["integer","null"]},"created_by_user_id":{"type":["string","null"]},"created_at":{"type":"string","format":"date-time","pattern":"Z$"}}}}}}}},"400":{"description":"Response for status 400","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"401":{"description":"Response for status 401","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"402":{"description":"Response for status 402","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"403":{"description":"Response for status 403","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"404":{"description":"Response for status 404","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"409":{"description":"Response for status 409","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"429":{"description":"Response for status 429","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"500":{"description":"Response for status 500","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"503":{"description":"Response for status 503","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}}}}},"/v1/revenue/providers":{"get":{"tags":["Revenue"],"operationId":"listRevenueProviders","summary":"List the revenue providers a site can connect","responses":{"200":{"description":"Response for status 200","content":{"application/json":{"schema":{"type":"object","required":["items"],"properties":{"items":{"type":"array","items":{"type":"object","required":["id","display_name","available","guide"],"properties":{"id":{"type":"string"},"display_name":{"type":"string"},"available":{"type":"boolean"},"guide":{"type":["object","null"],"required":["key_label","key_placeholder","key_url","key_access","key_note","webhook_url","webhook_secret_placeholder","webhook_events","webhook_note"],"properties":{"key_label":{"type":"string"},"key_placeholder":{"type":"string"},"key_url":{"type":"string"},"key_access":{"type":"array","items":{"type":"object","required":["resource","why"],"properties":{"resource":{"type":"string"},"why":{"type":"string"}}}},"key_note":{"type":["string","null"]},"webhook_url":{"type":"string"},"webhook_secret_placeholder":{"type":"string"},"webhook_events":{"type":"array","items":{"type":"string"}},"webhook_note":{"type":["string","null"]}}}}}}}}}}},"400":{"description":"Response for status 400","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"401":{"description":"Response for status 401","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"402":{"description":"Response for status 402","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"403":{"description":"Response for status 403","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"404":{"description":"Response for status 404","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"409":{"description":"Response for status 409","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"429":{"description":"Response for status 429","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"500":{"description":"Response for status 500","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"503":{"description":"Response for status 503","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}}}}},"/v1/sites/{site_id}/revenue/connection":{"get":{"tags":["Revenue"],"operationId":"getRevenueConnection","summary":"Read the site's revenue provider connection","parameters":[{"name":"site_id","in":"path","required":true,"schema":{"type":"string","description":"The site id"}}],"responses":{"200":{"description":"Response for status 200","content":{"application/json":{"schema":{"anyOf":[{"type":"object","required":["provider","status","api_key_last4","webhook_secret_set","webhook_url","connected_at","last_verified_at","last_synced_at","last_webhook_at","last_error"],"properties":{"provider":{"type":"string"},"status":{"enum":["active","degraded","disabled"]},"api_key_last4":{"type":"string"},"webhook_secret_set":{"type":"boolean"},"webhook_url":{"type":["string","null"]},"connected_at":{"type":"string"},"last_verified_at":{"type":["string","null"]},"last_synced_at":{"type":["string","null"]},"last_webhook_at":{"type":["string","null"]},"last_error":{"type":["string","null"]}}},{"type":"object","required":["status"],"properties":{"status":{"type":"string","const":"not_connected"}}}]}}}},"400":{"description":"Response for status 400","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"401":{"description":"Response for status 401","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"402":{"description":"Response for status 402","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"403":{"description":"Response for status 403","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"404":{"description":"Response for status 404","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"409":{"description":"Response for status 409","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"429":{"description":"Response for status 429","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"500":{"description":"Response for status 500","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"503":{"description":"Response for status 503","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}}}},"delete":{"tags":["Revenue"],"operationId":"disconnectRevenueProvider","summary":"Disconnect the site's revenue provider","parameters":[{"name":"site_id","in":"path","required":true,"schema":{"type":"string","description":"The site id"}}],"responses":{"204":{"description":"No content"},"400":{"description":"Response for status 400","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"401":{"description":"Response for status 401","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"402":{"description":"Response for status 402","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"403":{"description":"Response for status 403","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"404":{"description":"Response for status 404","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"409":{"description":"Response for status 409","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"429":{"description":"Response for status 429","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"500":{"description":"Response for status 500","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"503":{"description":"Response for status 503","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}}}},"post":{"tags":["Revenue"],"operationId":"connectRevenueProvider","summary":"Connect a revenue provider to the site","parameters":[{"name":"site_id","in":"path","required":true,"schema":{"type":"string","description":"The site id"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["provider","api_key"],"properties":{"provider":{"type":"string","maxLength":64,"description":"A provider id from the catalog"},"api_key":{"type":"string","maxLength":4096,"description":"A restricted read key; verified with the provider before it is stored"},"webhook_secret":{"type":"string","maxLength":4096,"description":"The signing secret of the provider webhook"}}}}},"required":true},"responses":{"201":{"description":"Response for status 201","content":{"application/json":{"schema":{"type":"object","required":["provider","status","api_key_last4","webhook_secret_set","webhook_url","connected_at","last_verified_at","last_synced_at","last_webhook_at","last_error"],"properties":{"provider":{"type":"string"},"status":{"enum":["active","degraded","disabled"]},"api_key_last4":{"type":"string"},"webhook_secret_set":{"type":"boolean"},"webhook_url":{"type":["string","null"]},"connected_at":{"type":"string"},"last_verified_at":{"type":["string","null"]},"last_synced_at":{"type":["string","null"]},"last_webhook_at":{"type":["string","null"]},"last_error":{"type":["string","null"]}}}}}},"400":{"description":"Response for status 400","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"401":{"description":"Response for status 401","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"402":{"description":"Response for status 402","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"403":{"description":"Response for status 403","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"404":{"description":"Response for status 404","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"409":{"description":"Response for status 409","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"422":{"description":"Response for status 422","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"429":{"description":"Response for status 429","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"500":{"description":"Response for status 500","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"503":{"description":"Response for status 503","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}}}},"patch":{"tags":["Revenue"],"operationId":"updateRevenueConnection","summary":"Rotate the revenue provider key or webhook signing secret","parameters":[{"name":"site_id","in":"path","required":true,"schema":{"type":"string","description":"The site id"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"api_key":{"type":"string","maxLength":4096,"description":"A replacement key; verified before it replaces the old one"},"webhook_secret":{"type":"string","maxLength":4096,"description":"A replacement webhook signing secret"}}}}},"required":true},"responses":{"200":{"description":"Response for status 200","content":{"application/json":{"schema":{"type":"object","required":["provider","status","api_key_last4","webhook_secret_set","webhook_url","connected_at","last_verified_at","last_synced_at","last_webhook_at","last_error"],"properties":{"provider":{"type":"string"},"status":{"enum":["active","degraded","disabled"]},"api_key_last4":{"type":"string"},"webhook_secret_set":{"type":"boolean"},"webhook_url":{"type":["string","null"]},"connected_at":{"type":"string"},"last_verified_at":{"type":["string","null"]},"last_synced_at":{"type":["string","null"]},"last_webhook_at":{"type":["string","null"]},"last_error":{"type":["string","null"]}}}}}},"400":{"description":"Response for status 400","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"401":{"description":"Response for status 401","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"402":{"description":"Response for status 402","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"403":{"description":"Response for status 403","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"404":{"description":"Response for status 404","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"409":{"description":"Response for status 409","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"422":{"description":"Response for status 422","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"429":{"description":"Response for status 429","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"500":{"description":"Response for status 500","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}},"503":{"description":"Response for status 503","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"enum":["UNAUTHENTICATED","FORBIDDEN","SHARE_LOCKED","NOT_FOUND","VALIDATION_FAILED","PAYLOAD_TOO_LARGE","IDEMPOTENCY_CONFLICT","ACCOUNT_DELETION_BLOCKED","ACCOUNT_EXISTS","SETUP_COMPLETE","REVENUE_ALREADY_CONNECTED","REVENUE_CREDENTIAL_REJECTED","RATE_LIMITED","RANGE_TOO_LARGE","RESOLUTION_NOT_AVAILABLE","EVENT_DEFINITION_NAME_TAKEN","EVENT_DEFINITION_VERSION_CONFLICT","LINK_SLUG_TAKEN","LINK_DOMAIN_TAKEN","LINK_DOMAIN_IN_USE","LINK_DOMAINS_UNAVAILABLE","LINK_DESTINATION_UNSAFE","PLAN_REQUIRED","SUBSCRIPTION_ACTIVE","TRIAL_UNAVAILABLE","COUPON_CODE_TAKEN","COUPON_IN_USE","EXPORT_NOT_READY","EXPORT_EXPIRED","PROVIDER_UNAVAILABLE","DATA_NOT_READY","SERVICE_UNAVAILABLE","INTERNAL_ERROR"]},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","patternProperties":{"^.*$":{}},"default":{}}}}}}}}}}}}}}