{"openapi":"3.1.0","info":{"title":"fastmon API","summary":"Real-time website performance monitoring.","description":"Fastmon is a real-time website performance monitoring platform: RUM (Real User\nMonitoring), Core Web Vitals, traffic analytics, and rule-based notifications.\n\nThis document is the authoritative reference for the fastmon API. It's\ngenerated from code and updated on every release. Anything not documented here\nis unsupported.\n\n## Base URL\n\n    https://api.fastmon.eu\n\nRequests to the historical `/v1` prefix (`https://api.fastmon.eu/v1/...`)\nkeep working: the prefix is stripped server-side and the request is served\nby the same endpoint. New integrations should use the unprefixed paths.\n\n## Authentication\n\nAll API endpoints require an authenticated principal via a **Bearer\ntoken**:\n\n    Authorization: Bearer fm_...\n\nGenerate a token from the fastmon dashboard (Account → API Token). Tokens\nare hashed server-side; only the prefix is queryable. Lost tokens\ncannot be recovered; regenerate instead.\n\nThe two public ingest endpoints (`POST /c/{collector_hash}` and\n`GET /s/{source_hash}.js`) are unauthenticated and authorize requests via\nthe per-site hash embedded in the URL.\n\n## Response shape\n\n* **Single resource**: returned raw: `{ \"id\": \"...\", \"name\": \"...\", ... }`\n* **List**: wrapped: `{ \"data\": [...], \"meta\": { \"limit\": 50, \"offset\": 0, \"total\": 242, \"has_more\": true } }`\n* **Error**: wrapped: `{ \"error\": { \"code\": \"...\", \"message\": \"...\", \"request_id\": \"...\", \"details\": {...} } }`\n\nSee §1 and §2 of `API_STANDARDS.md` for the full envelope spec.\n\n## IDs and timestamps\n\n* Resource IDs are **UUID v7** strings. Generated server-side via `uuid.uuid7()`.\n* Timestamps are **ISO 8601 UTC with `Z` suffix**: `2026-04-18T12:34:56.123456Z`.\n\n## Pagination\n\n* Default `limit=50`, max `100` on every list endpoint.\n* Most list endpoints use offset pagination: `?limit=50&offset=50`; responses\n  include `meta.total` and `meta.has_more`.\n* High-volume endpoints (notably analytics sessions and events) use **cursor**\n  pagination instead: responses carry `meta.next_cursor`, which the client\n  sends back as `?cursor=<token>` to fetch the next page. These responses do\n  not include `meta.total`.\n* Which scheme applies is visible from the response `meta` shape: check for\n  `next_cursor` (cursor) vs `offset`+`total` (offset).\n\n## Request correlation\n\nEvery response carries `X-Request-ID`. If a client sends one, the server\npropagates it; otherwise the server generates a UUID v7. The same ID is\nmirrored into `error.request_id` on failures; always include it when\nreporting issues.\n\n## Public ingest endpoints\n\n`POST /c/{collector_hash}` (beacon ingestion) and `GET /s/{source_hash}.js`\n(tracking script) are **not** part of the dashboard API and are exempt from\nthese standards. They have their own wire contract documented in\n`API_STANDARDS.md` §22.\n\n## Status\n\nThe API is actively developed.","contact":{"name":"fastmon","url":"https://fastmon.eu/","email":"support@fastmon.eu"},"version":"2026.11.15"},"servers":[{"url":"https://api.fastmon.eu"}],"paths":{"/c/{collector_hash}":{"get":{"tags":["collector"],"summary":"Collect a beacon through the pixel fallback","description":"Take a beacon from the query string and answer with a 1x1 GIF.\n\nWhat the tracker falls back to when it cannot POST. Unauthenticated: the\ncollector hash in the URL names the application, as it does for the POST.\nThe answer is the GIF whatever the beacon contained, so a browser never\nrenders a broken image, and nothing about the outcome is reported back.\n\nA pageview that arrives twice, once here and once by POST, is stored once.","operationId":"collectPixel","parameters":[{"name":"collector_hash","in":"path","required":true,"schema":{"type":"string","title":"Collector Hash"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"422":{"description":"Validation Error - Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"security":[],"x-fastmon-permissions":[]}},"/organizations":{"get":{"tags":["organizations"],"summary":"List Organizations","description":"List organizations the caller has access to (direct or via partner).\n\nAn API key sees only the organizations it was issued for, not every one its\nowner belongs to. Without that cut the reach restriction would still hold on\nevery other route but leak the tenant list here, which is exactly the thing\na key bound to one customer must not learn about the others.\n\nA credential the organization owns has no memberships to walk at all: its\nreach IS the answer, so it is returned directly rather than derived from a\nperson who does not exist.\n\n**Requires:** any credential. No organization permission applies.","operationId":"listOrganizations","security":[{"bearerAuth":[]},{"oauth2":[]}],"parameters":[{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0,"title":"Offset"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":50,"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedResponse_OrganizationResponse_"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"401":{"description":"Unauthorized - Invalid or missing authorization token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"},"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"422":{"description":"Validation Error - Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"429":{"description":"Too Many Requests - Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"x-fastmon-permissions":[]},"post":{"tags":["organizations"],"summary":"Create an organization","description":"Create a new organization.\n\nWhoever creates it becomes its owner. It starts out pending: members can\nlook around, but applications and sites, and with them data ingestion, wait\nfor a review. An account that was granted auto-approval skips that queue.\n\nA bearer token is refused because a key is bound to the organizations it\nwas issued for and must not be able to write its own reach.\n\n**Requires:** a signed-in session. An API key is refused.","operationId":"createOrganization","security":[{"bearerAuth":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrganizationCreate"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrganizationResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"401":{"description":"Unauthorized - Invalid or missing authorization token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"},"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"422":{"description":"Validation Error - Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"429":{"description":"Too Many Requests - Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"x-fastmon-permissions":[]}},"/organizations/{org_id}":{"get":{"tags":["organizations"],"summary":"Get Organization","description":"Get organization by ID, including what the caller may do in it.\n\nLoads the org itself rather than taking `OrgDep`: pairing that loader with\nan access alias would run `OrgAccessChecker` twice (two dependency objects,\ntwo identical membership SELECTs).\n\n**Requires:** `org:read`, held by every role.","operationId":"getOrganization","security":[{"bearerAuth":[]},{"oauth2":["org:read"]}],"parameters":[{"name":"org_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Org Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrganizationResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"401":{"description":"Unauthorized - Invalid or missing authorization token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"},"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"404":{"description":"Not Found - Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"422":{"description":"Validation Error - Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"429":{"description":"Too Many Requests - Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"x-fastmon-permissions":["org:read"]},"patch":{"tags":["organizations"],"summary":"Update Organization","description":"Update organization.\n\n`ai_enabled` is a compliance-grade kill-switch: when flipped off, every\n`/ai/*` endpoint returns 403 and no beacon data from this org\never reaches Mistral. Owner-level access is required so a single\nregular member can't unilaterally enable / disable AI for the whole\norganization.\n\n**Requires:** `org:update`, held by the owner role. An app connection is refused.","operationId":"updateOrganization","security":[{"bearerAuth":[]}],"parameters":[{"name":"org_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Org Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrganizationUpdate"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrganizationResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"401":{"description":"Unauthorized - Invalid or missing authorization token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"},"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"404":{"description":"Not Found - Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"422":{"description":"Validation Error - Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"429":{"description":"Too Many Requests - Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"x-fastmon-permissions":["org:update"]},"delete":{"tags":["organizations"],"summary":"Delete Organization","description":"Delete organization and all related data.\n\nIrreversibly cascades to sites, invites, partner links and memberships.\n\n**What gets deleted:**\n- All sites belonging to the organization\n- All pending invites\n- All member associations (memberships)\n- The organization itself\n\n**What is preserved:**\n- User accounts of all members (by default)\n\n**Optional: delete_account**\n\nIf `delete_account=true` is passed as a query parameter, the current user's\naccount will also be deleted after the organization is removed.\n\n**Requires:** `org:delete`, held by the owner role. Partner access never holds it. An app connection is refused.","operationId":"deleteOrganization","security":[{"bearerAuth":[]}],"parameters":[{"name":"org_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Org Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."},{"name":"delete_account","in":"query","required":false,"schema":{"type":"boolean","description":"If true, also delete the requesting user's account","default":false,"title":"Delete Account"},"description":"If true, also delete the requesting user's account"}],"responses":{"204":{"description":"Successful Response","headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"401":{"description":"Unauthorized - Invalid or missing authorization token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"},"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"404":{"description":"Not Found - Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"422":{"description":"Validation Error - Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"429":{"description":"Too Many Requests - Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"x-fastmon-permissions":["org:delete"]}},"/organizations/{org_id}/uptime":{"get":{"tags":["organizations"],"summary":"List the uptime state of every active site of the production applications","description":"The rows of `GET /applications/{app_id}/uptime` for every production\napplication of the organization in one call, by application and then by\nsite in creation order.\n\nNeeds `site:read` and `issue:read`, as the application route does.\n\n**Requires:** `issue:read` and `site:read`, held by every role.","operationId":"listOrganizationUptime","security":[{"bearerAuth":[]},{"oauth2":["issue:read","site:read"]}],"parameters":[{"name":"org_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Org Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."},{"name":"from","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"Inclusive start of the window. Defaults to 24 hours before `to`.","title":"From","examples":["2026-04-14T09:50:01Z"]},"description":"Inclusive start of the window. Defaults to 24 hours before `to`."},{"name":"to","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"Exclusive end of the window, at most 90 days after `from`. Defaults to now.","title":"To","examples":["2026-04-14T09:50:01Z"]},"description":"Exclusive end of the window, at most 90 days after `from`. Defaults to now."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SiteUptimeStatus"},"title":"Response Listorganizationuptime"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"401":{"description":"Unauthorized - Invalid or missing authorization token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"},"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"403":{"description":"Forbidden - Insufficient permissions","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"404":{"description":"Not Found - Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"422":{"description":"Validation Error - Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"429":{"description":"Too Many Requests - Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"x-fastmon-permissions":["issue:read","site:read"]}},"/organizations/{org_id}/uptime/availability":{"get":{"tags":["organizations"],"summary":"Get the availability of the monitored production applications, in total and each","description":"The availability and downtime over the window of every active production\napplication with the probe switched on, and over all of them together.\n\nNeeds `site:read` and `issue:read`, as `GET /organizations/{org_id}/uptime`\ndoes.\n\n**Requires:** `issue:read` and `site:read`, held by every role.","operationId":"getOrganizationUptimeAvailability","security":[{"bearerAuth":[]},{"oauth2":["issue:read","site:read"]}],"parameters":[{"name":"org_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Org Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."},{"name":"from","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"Inclusive start of the window. Defaults to 24 hours before `to`.","title":"From","examples":["2026-04-14T09:50:01Z"]},"description":"Inclusive start of the window. Defaults to 24 hours before `to`."},{"name":"to","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"Exclusive end of the window, at most 90 days after `from`. Defaults to now.","title":"To","examples":["2026-04-14T09:50:01Z"]},"description":"Exclusive end of the window, at most 90 days after `from`. Defaults to now."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrganizationUptimeAvailabilityResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"401":{"description":"Unauthorized - Invalid or missing authorization token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"},"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"403":{"description":"Forbidden - Insufficient permissions","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"404":{"description":"Not Found - Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"422":{"description":"Validation Error - Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"429":{"description":"Too Many Requests - Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"x-fastmon-permissions":["issue:read","site:read"]}},"/organizations/{org_id}/usage":{"get":{"tags":["organizations"],"summary":"Get Usage","description":"Get the pageviews of the current billing period (calendar month).\n\nPass `?by_site=true` to include per-site breakdown.\n\n**Requires:** `usage:read`, held by every role.","operationId":"getOrganizationUsage","security":[{"bearerAuth":[]},{"oauth2":["usage:read"]}],"parameters":[{"name":"org_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Org Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."},{"name":"by_site","in":"query","required":false,"schema":{"type":"boolean","description":"Include per-site breakdown","default":false,"title":"By Site"},"description":"Include per-site breakdown"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UsageResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"401":{"description":"Unauthorized - Invalid or missing authorization token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"},"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"404":{"description":"Not Found - Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"422":{"description":"Validation Error - Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"429":{"description":"Too Many Requests - Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"x-fastmon-permissions":["usage:read"]}},"/organizations/{org_id}/audit-log":{"get":{"tags":["organizations"],"summary":"List Audit Log","description":"Durable trail of relevant changes for this org (consent toggles, site\ndeletion, hash rotation, ...), newest first.\n\n**Requires:** `audit:read`, held by the owner role.","operationId":"listOrganizationAuditLog","security":[{"bearerAuth":[]},{"oauth2":["audit:read"]}],"parameters":[{"name":"org_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Org Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."},{"name":"action","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/AuditAction"},{"type":"null"}],"description":"Filter by action","title":"Action"},"description":"Filter by action"},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0,"title":"Offset"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":50,"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedResponse_AuditLogEntry_"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"401":{"description":"Unauthorized - Invalid or missing authorization token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"},"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"404":{"description":"Not Found - Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"422":{"description":"Validation Error - Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"429":{"description":"Too Many Requests - Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"x-fastmon-permissions":["audit:read"]}},"/organizations/{org_id}/members":{"get":{"tags":["organizations","members"],"summary":"List Members","description":"List organization members.\n\nReturns all members with their roles (owner/member).\n\n**Requires:** `member:read`, held by every role.","operationId":"listOrganizationMembers","security":[{"bearerAuth":[]},{"oauth2":["member:read"]}],"parameters":[{"name":"org_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Org Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0,"title":"Offset"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":50,"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedResponse_MemberResponse_"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"401":{"description":"Unauthorized - Invalid or missing authorization token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"},"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"404":{"description":"Not Found - Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"422":{"description":"Validation Error - Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"429":{"description":"Too Many Requests - Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"x-fastmon-permissions":["member:read"]},"post":{"tags":["organizations"],"summary":"Add Member","description":"Add a user to the organization. User must already exist.\n\nRequires *direct* membership: this seats a member with no invite handshake,\nso partner-via-partner access must not be able to inject members into a\nmanaged client org (it would route members in without their consent).\n\n**Requires:** `member:manage`, held by the owner role. An app connection is refused.","operationId":"addOrganizationMember","security":[{"bearerAuth":[]}],"parameters":[{"name":"org_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Org Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MemberAdd"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MemberResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"401":{"description":"Unauthorized - Invalid or missing authorization token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"},"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"404":{"description":"Not Found - Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"409":{"description":"Conflict - Resource already exists or operation not allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"422":{"description":"Validation Error - Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"429":{"description":"Too Many Requests - Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"x-fastmon-permissions":["member:manage"]}},"/organizations/{org_id}/transfer-ownership":{"post":{"tags":["organizations","members"],"summary":"Transfer Ownership","description":"Transfer ownership of the organization to another member.\n\nThe target user must be an existing member of the organization.\n\n**Process:**\n- The caller becomes a regular member, the target becomes an owner\n- A swap of exactly these two seats: organizations may hold SEVERAL\n  owners (seated via add_member, invites or role promotion), and any\n  other owner keeps their seat. This route exists for the common\n  single-owner handoff, it does not enforce owner uniqueness.\n\n**Request Body:**\n- `new_owner_user_id`: UUID of the member who will become the new owner\n\n**Requires:** `org:transfer`, held by the owner role. Partner access never holds it. An app connection is refused.","operationId":"transferOrganizationOwnership","security":[{"bearerAuth":[]}],"parameters":[{"name":"org_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Org Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OwnershipTransferRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Message"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"400":{"description":"Bad Request - Invalid input","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"401":{"description":"Unauthorized - Invalid or missing authorization token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"},"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"403":{"description":"Forbidden - Insufficient permissions","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"404":{"description":"Not Found - Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"422":{"description":"Validation Error - Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"429":{"description":"Too Many Requests - Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"x-fastmon-permissions":["org:transfer"]}},"/organizations/{org_id}/invites":{"get":{"tags":["organizations"],"summary":"List Invites","description":"List pending invites.\n\n**Requires:** `invite:read`, held by every role.","operationId":"listOrganizationInvites","security":[{"bearerAuth":[]},{"oauth2":["invite:read"]}],"parameters":[{"name":"org_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Org Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0,"title":"Offset"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":50,"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedResponse_InviteResponse_"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"401":{"description":"Unauthorized - Invalid or missing authorization token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"},"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"404":{"description":"Not Found - Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"422":{"description":"Validation Error - Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"429":{"description":"Too Many Requests - Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"x-fastmon-permissions":["invite:read"]},"post":{"tags":["organizations"],"summary":"Create Invite","description":"Create an organization invite and send email.\n\n**Request Body:**\n- `email`: Email address to invite\n- `role`: Role to assign (default: \"member\"). Inviting an \"owner\" requires\n  the caller to be an owner of the org. Otherwise a regular member could\n  invite a second account as owner and escalate. \"viewer\" and \"member\" need\n  no extra authority: neither grants more than the inviter already holds.\n\nRequires *direct* membership. Sends an invitation email with a unique token\nthat expires in 7 days.\n\n**Requires:** `invite:manage`, held by the member and owner roles. An app connection is refused.","operationId":"createOrganizationInvite","security":[{"bearerAuth":[]}],"parameters":[{"name":"org_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Org Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InviteCreate"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InviteResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"401":{"description":"Unauthorized - Invalid or missing authorization token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"},"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"403":{"description":"Forbidden - Insufficient permissions","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"404":{"description":"Not Found - Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"409":{"description":"Conflict - Resource already exists or operation not allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"422":{"description":"Validation Error - Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"429":{"description":"Too Many Requests - Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"x-fastmon-permissions":["invite:manage"]}},"/members/{member_id}":{"patch":{"tags":["members"],"summary":"Update Member Role","description":"Change a member's role.\n\nThe only way to move someone between viewer / member / owner after they\njoined. Two rules beyond the `member:manage` gate, both of which a role\nbundle cannot express:\n\n- **Granting OWNER** goes through the same check as an owner invite, so a\n  partner organization cannot mint owners in a client it merely manages.\n- **The last owner cannot be demoted.** An organization without an owner has\n  nobody who can change settings, invite, or delete it.\n\n**Requires:** `member:manage`, held by the owner role. An app connection is refused.","operationId":"updateOrganizationMemberRole","security":[{"bearerAuth":[]}],"parameters":[{"name":"member_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Member Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MemberRoleUpdate"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MemberResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"400":{"description":"Bad Request - Invalid input","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"401":{"description":"Unauthorized - Invalid or missing authorization token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"},"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"403":{"description":"Forbidden - Insufficient permissions","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"404":{"description":"Not Found - Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"422":{"description":"Validation Error - Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"429":{"description":"Too Many Requests - Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"x-fastmon-permissions":["member:manage"]},"delete":{"tags":["members"],"summary":"Remove Member","description":"Remove a member from the organization or leave the organization.\n\n**Permissions:**\n- Only owners can remove other members\n- Any member can leave the organization (remove themselves)\n- Leaving as the last member deletes the organization, an API key needs `org:delete` for it\n\n**Use cases:**\n- Remove another member from your organization (owner only)\n- Leave an organization yourself (when the membership's user_id matches your own)\n\n**Behavior when multiple members exist:**\n- Only the specified member's association is removed\n- Organization, sites, and invites remain intact\n\n**Behavior when this is the LAST member:**\n- All sites are deleted\n- All pending invites are deleted\n- The organization itself is deleted\n- The user account is preserved (NOT deleted)\n\n**Requires:** `member:read`, held by every role. An app connection is refused.","operationId":"removeOrganizationMember","security":[{"bearerAuth":[]}],"parameters":[{"name":"member_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Member Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."}],"responses":{"204":{"description":"Successful Response","headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"401":{"description":"Unauthorized - Invalid or missing authorization token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"},"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"403":{"description":"Forbidden - Insufficient permissions","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"404":{"description":"Not Found - Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"422":{"description":"Validation Error - Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"429":{"description":"Too Many Requests - Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"x-fastmon-permissions":["member:read"]}},"/organizations/{org_id}/api-keys":{"get":{"tags":["api-keys"],"summary":"List the organization's API keys","description":"The organization's keys - display metadata only, never the secret.\n\nLists what this organization issued: the keys that act here, and the ones\nit issued as an agency to act for its clients.\n\nEach entry carries `editable`, the answer to \"may I change this one\":\nfalse for a key that holds permissions the caller does not. Revoking is\nnever gated by it, so no second flag says so: whoever sees this list may\npull anything on it.\n\n**Requires:** `org_key:manage`, held by the member and owner roles.","operationId":"listOrgApiKeys","security":[{"bearerAuth":[]}],"parameters":[{"name":"org_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Org Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."},{"name":"include_revoked","in":"query","required":false,"schema":{"type":"boolean","description":"Also return revoked keys. Off by default so the list keeps meaning 'what can authenticate right now'.","default":false,"title":"Include Revoked"},"description":"Also return revoked keys. Off by default so the list keeps meaning 'what can authenticate right now'."},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0,"title":"Offset"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":50,"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedResponse_ApiKeyInfo_"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"401":{"description":"Unauthorized - Invalid or missing authorization token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"},"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"404":{"description":"Not Found - Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"422":{"description":"Validation Error - Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"429":{"description":"Too Many Requests - Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"x-fastmon-permissions":["org_key:manage"]},"post":{"tags":["api-keys"],"summary":"Mint an API key","description":"Mint an org key. The response carries the secret, and nothing shows it again.\n\nThe key is bound to this organization by construction and capped at what the\ncaller holds here - the same rule as for a personal key, applied to a\ndifferent owner. The one thing it can never carry is `org_key:manage`: a key\nthat can mint keys would hand its holder a second one without the session and\nthe step-up the first one cost.\n\nNothing else is subtracted, so an owner may give an org key owner-grade\nscopes. `audience: \"clients\"` mints a key that acts in this partner's client\norganizations instead of in this one.\n\n**Requires:** `org_key:manage`, held by the member and owner roles. An API key is refused, a signed-in session is required.","operationId":"createOrgApiKey","security":[{"bearerAuth":[]}],"parameters":[{"name":"org_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Org Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrgKeyCreate"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKeyCreated"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"400":{"description":"Bad Request - Invalid input","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"401":{"description":"Unauthorized - Invalid or missing authorization token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"},"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"403":{"description":"Forbidden - Insufficient permissions","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"404":{"description":"Not Found - Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"429":{"description":"Too Many Requests - Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"422":{"description":"Validation Error - Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"x-fastmon-permissions":["org_key:manage"]}},"/organizations/{org_id}/api-keys/{key_id}":{"patch":{"tags":["api-keys"],"summary":"Rename or rescope an API key","description":"Rename an org key, change what it may do, or both. The secret is untouched.\n\nOpen only to someone who holds what the key holds: an owner-grade key is not\neditable by a member, not downwards and not even to rename it. Revoking it\nstays open to them, which is the move that matters when a key is suspected.\n\nWithin that, step-up is asked only when the edit gives the key MORE than it\nhad - a scope it did not carry, or a later expiry. Both are re-granting\nauthority and are a mint in all but name. Narrowing and renaming pass\nwithout a factor. The ceiling for a widening is what the person editing\nholds today, never what the original minter held.\n\n**Requires:** `org_key:manage`, held by the member and owner roles. An API key is refused, a signed-in session is required.","operationId":"updateOrgApiKey","security":[{"bearerAuth":[]}],"parameters":[{"name":"org_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Org Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."},{"name":"key_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Key Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrgKeyUpdate"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKeyInfo"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"400":{"description":"Bad Request - Invalid input","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"401":{"description":"Unauthorized - Invalid or missing authorization token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"},"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"403":{"description":"Forbidden - Insufficient permissions","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"404":{"description":"Not Found - Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"429":{"description":"Too Many Requests - Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"422":{"description":"Validation Error - Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"x-fastmon-permissions":["org_key:manage"]},"delete":{"tags":["api-keys"],"summary":"Revoke an API key","description":"Revoke an org key. It stops authenticating immediately, and no other key\nis affected.\n\nNo step-up, matching the personal revoke route: revocation is the fail-safe\ndirection, and a password prompt during a leak is a cost paid at exactly the\nwrong time. No authority check either - a member may not reshape an\nowner-grade key but must always be able to kill one. Anyone who may see the\nlist may pull anything on it.\n\n**Requires:** `org_key:manage`, held by the member and owner roles. An API key is refused, a signed-in session is required.","operationId":"revokeOrgApiKey","security":[{"bearerAuth":[]}],"parameters":[{"name":"org_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Org Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."},{"name":"key_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Key Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."}],"responses":{"204":{"description":"Successful Response","headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"401":{"description":"Unauthorized - Invalid or missing authorization token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"},"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"404":{"description":"Not Found - Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"422":{"description":"Validation Error - Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"429":{"description":"Too Many Requests - Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"x-fastmon-permissions":["org_key:manage"]}},"/organizations/{org_id}/api-keys/{key_id}/rotate":{"post":{"tags":["api-keys"],"summary":"Rotate an API key","description":"Issue a successor with the same name, scopes and reach, and retire this\none. The response carries the new secret, and nothing shows it again.\n\nMint conditions apply, because whoever rotates walks away with a working\nsecret: the scopes are re-checked against what this person holds today, so a\nkey cannot outlive its creator's authority by being rotated. That is the\nsame precondition editing carries, and it is literally the same call.\n\n`grace_period_hours` keeps the old secret alive for a while, so a deploy can\nreach every consumer before it stops.\n\n**Requires:** `org_key:manage`, held by the member and owner roles. An API key is refused, a signed-in session is required.","operationId":"rotateOrgApiKey","security":[{"bearerAuth":[]}],"parameters":[{"name":"org_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Org Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."},{"name":"key_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Key Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKeyRotate"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKeyCreated"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"400":{"description":"Bad Request - Invalid input","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"401":{"description":"Unauthorized - Invalid or missing authorization token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"},"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"403":{"description":"Forbidden - Insufficient permissions","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"404":{"description":"Not Found - Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"429":{"description":"Too Many Requests - Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"422":{"description":"Validation Error - Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"x-fastmon-permissions":["org_key:manage"]}},"/organizations/{org_id}/connections":{"get":{"tags":["connections"],"summary":"List the organization's app connections","description":"The apps connected to this organization, newest first.\n\nOnly the ones the organization owns. A connection a member made for\nthemselves is theirs to end: it cannot outlive their membership and cannot\ndo more than their role allows, so it is not on this list.\n\n**Requires:** `org_key:manage`, held by the member and owner roles.","operationId":"listOrgConnections","security":[{"bearerAuth":[]}],"parameters":[{"name":"org_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Org Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."},{"name":"include_revoked","in":"query","required":false,"schema":{"type":"boolean","description":"Also return disconnected apps. Off by default so the list keeps meaning 'what can act for this organization right now'.","default":false,"title":"Include Revoked"},"description":"Also return disconnected apps. Off by default so the list keeps meaning 'what can act for this organization right now'."},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0,"title":"Offset"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":50,"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedResponse_ConnectionInfo_"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"401":{"description":"Unauthorized - Invalid or missing authorization token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"},"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"403":{"description":"Forbidden - Insufficient permissions","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"404":{"description":"Not Found - Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"422":{"description":"Validation Error - Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"429":{"description":"Too Many Requests - Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"x-fastmon-permissions":["org_key:manage"]}},"/organizations/{org_id}/connections/{grant_id}":{"delete":{"tags":["connections"],"summary":"Disconnect an app","description":"Disconnect an app.\n\nSpends every refresh token under the grant at once, so the app cannot rotate\nits way back in and has to go through consent again. Access tokens already\nissued are not hunted down - they expire on their own within minutes, which\nis the price of not keeping a revocation list and the reason that lifetime\nis short.\n\nNo step-up, like every other revoke here: revocation is the fail-safe\ndirection, and a password prompt is a cost paid at exactly the wrong moment.\nSession-only, because ending the credentials an incident response depends on\nmust not itself be doable with a credential.\n\n**Requires:** `org_key:manage`, held by the member and owner roles. An API key is refused, a signed-in session is required.","operationId":"revokeOrgConnection","security":[{"bearerAuth":[]}],"parameters":[{"name":"org_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Org Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."},{"name":"grant_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Grant Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."}],"responses":{"204":{"description":"Successful Response","headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"401":{"description":"Unauthorized - Invalid or missing authorization token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"},"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"403":{"description":"Forbidden - Insufficient permissions","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"404":{"description":"Not Found - Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"422":{"description":"Validation Error - Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"429":{"description":"Too Many Requests - Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"x-fastmon-permissions":["org_key:manage"]}},"/organizations/{org_id}/sites":{"get":{"tags":["sites"],"summary":"List Sites","description":"List all sites for an organization. Filter by tag(s) (AND semantics) and/or\nby `application_id` (the app's domains).\n\n**Requires:** `site:read`, held by every role.","operationId":"listSites","security":[{"bearerAuth":[]},{"oauth2":["site:read"]}],"parameters":[{"name":"org_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Org Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."},{"name":"tag","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"},"default":[],"title":"Tag"}},{"name":"application_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"description":"Filter to the domains (sites) of one application","title":"Application Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"Filter to the domains (sites) of one application"},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0,"title":"Offset"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":50,"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedResponse_SiteResponse_"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"401":{"description":"Unauthorized - Invalid or missing authorization token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"},"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"404":{"description":"Not Found - Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"422":{"description":"Validation Error - Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"429":{"description":"Too Many Requests - Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"x-fastmon-permissions":["site:read"]}},"/organizations/{org_id}/sites/status":{"get":{"tags":["sites"],"summary":"Get Org Sites Status","description":"Beacon and checkout-pixel status for every site in the org in one call.\n\nOrg-scoped twin of `get_site_status` (same per-site fields), so the\ndashboard header widget can render all sites without N status calls. One\nClickHouse aggregate grouped by `site_id`; sites with no beacons still\nappear with zeroed counts. Ordering follows the site list (id/creation\norder from the SELECT). Membership is enforced by `OrgSiteRead`.\n\n**Requires:** `site:read`, held by every role.","operationId":"getOrgSitesStatus","security":[{"bearerAuth":[]},{"oauth2":["site:read"]}],"parameters":[{"name":"org_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Org Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."},{"name":"timezone","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":64},{"type":"null"}],"description":"IANA time zone whose midnight starts `beacons_today` and `events_today`, such as `Europe/Berlin`. Without it both count from midnight UTC","title":"Timezone"},"description":"IANA time zone whose midnight starts `beacons_today` and `events_today`, such as `Europe/Berlin`. Without it both count from midnight UTC"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/OrgSiteStatusItem"},"title":"Response Getorgsitesstatus"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"401":{"description":"Unauthorized - Invalid or missing authorization token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"},"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"404":{"description":"Not Found - Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"422":{"description":"Validation Error - Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"429":{"description":"Too Many Requests - Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"x-fastmon-permissions":["site:read"]}},"/organizations/{org_id}/tags":{"get":{"tags":["sites"],"summary":"List Tags","description":"List all unique tags in use across the organization's sites.\n\n**Requires:** `site:read`, held by every role.","operationId":"listSiteTags","security":[{"bearerAuth":[]},{"oauth2":["site:read"]}],"parameters":[{"name":"org_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Org Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"},"title":"Response Listsitetags"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"401":{"description":"Unauthorized - Invalid or missing authorization token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"},"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"404":{"description":"Not Found - Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"422":{"description":"Validation Error - Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"429":{"description":"Too Many Requests - Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"x-fastmon-permissions":["site:read"]}},"/sites/{site_id}":{"get":{"tags":["sites"],"summary":"Get Site","description":"Get site by ID.\n\n**Requires:** `site:read`, held by every role.","operationId":"getSite","security":[{"bearerAuth":[]},{"oauth2":["site:read"]}],"parameters":[{"name":"site_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Site Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SiteResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"401":{"description":"Unauthorized - Invalid or missing authorization token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"},"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"404":{"description":"Not Found - Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"422":{"description":"Validation Error - Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"429":{"description":"Too Many Requests - Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"x-fastmon-permissions":["site:read"]},"patch":{"tags":["sites"],"summary":"Update Site","description":"Update a site's own (per-domain) fields. Collection config + hashes live on\nthe Application (one baked bundle per app) and are edited there, not per Site.\n\n**Requires:** `site:write`, held by the member and owner roles.","operationId":"updateSite","security":[{"bearerAuth":[]},{"oauth2":["site:write"]}],"parameters":[{"name":"site_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Site Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SiteUpdate"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SiteResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"401":{"description":"Unauthorized - Invalid or missing authorization token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"},"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"404":{"description":"Not Found - Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"422":{"description":"Validation Error - Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"429":{"description":"Too Many Requests - Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"x-fastmon-permissions":["site:write"]},"delete":{"tags":["sites"],"summary":"Delete Site","description":"Delete site. If it was the sole domain of its application, the application\n(and its releases) is removed too; a shared application is kept for its\nsiblings.\n\n**Requires:** `site:delete`, held by the member and owner roles.","operationId":"deleteSite","security":[{"bearerAuth":[]},{"oauth2":["site:delete"]}],"parameters":[{"name":"site_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Site Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."}],"responses":{"204":{"description":"Successful Response","headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"401":{"description":"Unauthorized - Invalid or missing authorization token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"},"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"404":{"description":"Not Found - Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"422":{"description":"Validation Error - Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"429":{"description":"Too Many Requests - Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"x-fastmon-permissions":["site:delete"]}},"/sites/{site_id}/status":{"get":{"tags":["sites"],"summary":"Get Site Status","description":"Site status: today's beacons, the current rate, and the checkout pixel.\n\n**Requires:** `site:read`, held by every role.","operationId":"getSiteStatus","security":[{"bearerAuth":[]},{"oauth2":["site:read"]}],"parameters":[{"name":"site_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Site Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."},{"name":"timezone","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":64},{"type":"null"}],"description":"IANA time zone whose midnight starts `beacons_today` and `events_today`, such as `Europe/Berlin`. Without it both count from midnight UTC","title":"Timezone"},"description":"IANA time zone whose midnight starts `beacons_today` and `events_today`, such as `Europe/Berlin`. Without it both count from midnight UTC"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SiteStatusResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"401":{"description":"Unauthorized - Invalid or missing authorization token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"},"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"404":{"description":"Not Found - Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"422":{"description":"Validation Error - Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"429":{"description":"Too Many Requests - Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"x-fastmon-permissions":["site:read"]}},"/sites/{site_id}/uptime":{"get":{"tags":["sites"],"summary":"Get the site's uptime: open outage, certificate and the checks of a window","description":"What the uptime probe knows about the site: its open outage, the\ncertificate of the newest check, and the checks of the window as samples\nand as a series per target. The window defaults to the last 24 hours.\n\nNeeds `site:read` and `issue:read`, since the outage is a Watchdog\nobservation. Every role holds both.\n\n**Requires:** `issue:read` and `site:read`, held by every role.","operationId":"getSiteUptime","security":[{"bearerAuth":[]},{"oauth2":["issue:read","site:read"]}],"parameters":[{"name":"site_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Site Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."},{"name":"from","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"Inclusive start of the window. Defaults to 24 hours before `to`.","title":"From","examples":["2026-04-14T09:50:01Z"]},"description":"Inclusive start of the window. Defaults to 24 hours before `to`."},{"name":"to","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"Exclusive end of the window, at most 90 days after `from`. Defaults to now.","title":"To","examples":["2026-04-14T09:50:01Z"]},"description":"Exclusive end of the window, at most 90 days after `from`. Defaults to now."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SiteUptimeResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"401":{"description":"Unauthorized - Invalid or missing authorization token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"},"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"403":{"description":"Forbidden - Insufficient permissions","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"404":{"description":"Not Found - Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"422":{"description":"Validation Error - Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"429":{"description":"Too Many Requests - Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"x-fastmon-permissions":["issue:read","site:read"]}},"/sites/{site_id}/uptime/summary":{"get":{"tags":["sites"],"summary":"Summarize the site's uptime in a few sentences","description":"The sentences of the site's uptime summary box: its outage, a slow or\nunreliable answer, its certificate, and its availability over the window.\n\nRead from the row `GET /applications/{app_id}/uptime` answers for the site.\nNeeds `site:read` and `issue:read`, as `GET /sites/{site_id}/uptime` does.\n\n**Requires:** `issue:read` and `site:read`, held by every role.","operationId":"getSiteUptimeSummary","security":[{"bearerAuth":[]},{"oauth2":["issue:read","site:read"]}],"parameters":[{"name":"site_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Site Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."},{"name":"from","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"Inclusive start of the window. Defaults to 24 hours before `to`.","title":"From","examples":["2026-04-14T09:50:01Z"]},"description":"Inclusive start of the window. Defaults to 24 hours before `to`."},{"name":"to","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"Exclusive end of the window, at most 90 days after `from`. Defaults to now.","title":"To","examples":["2026-04-14T09:50:01Z"]},"description":"Exclusive end of the window, at most 90 days after `from`. Defaults to now."},{"name":"language","in":"query","required":false,"schema":{"type":"string","maxLength":16,"description":"The language of the sentences, `en` or `de`. A tag such as `de-AT` counts by its first two letters, and any other language falls back to `en`.","default":"en","title":"Language"},"description":"The language of the sentences, `en` or `de`. A tag such as `de-AT` counts by its first two letters, and any other language falls back to `en`."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UptimeSummaryResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"401":{"description":"Unauthorized - Invalid or missing authorization token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"},"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"403":{"description":"Forbidden - Insufficient permissions","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"404":{"description":"Not Found - Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"422":{"description":"Validation Error - Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"429":{"description":"Too Many Requests - Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"x-fastmon-permissions":["issue:read","site:read"]}},"/sites/{site_id}/uptime/checks":{"get":{"tags":["sites"],"summary":"List the uptime checks of the site in a window, filtered and paged","description":"The checks of the window that pass the filters, the newest first, one\npage at a time with their count in `meta.total`.\n\nNeeds `site:read` and `issue:read`, as the site's samples do.\n\n**Requires:** `issue:read` and `site:read`, held by every role.","operationId":"listSiteUptimeChecks","security":[{"bearerAuth":[]},{"oauth2":["issue:read","site:read"]}],"parameters":[{"name":"site_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Site Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."},{"name":"from","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"Inclusive start of the window. Defaults to 24 hours before `to`.","title":"From","examples":["2026-04-14T09:50:01Z"]},"description":"Inclusive start of the window. Defaults to 24 hours before `to`."},{"name":"to","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"Exclusive end of the window, at most 90 days after `from`. Defaults to now.","title":"To","examples":["2026-04-14T09:50:01Z"]},"description":"Exclusive end of the window, at most 90 days after `from`. Defaults to now."},{"name":"chain_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"description":"Only the checks of this check chain. On a site only the chain's checks of that site. An unknown chain matches nothing.","title":"Chain Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"Only the checks of this check chain. On a site only the chain's checks of that site. An unknown chain matches nothing."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":500,"minimum":1,"description":"Checks per page, at most 500.","default":100,"title":"Limit"},"description":"Checks per page, at most 500."},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"description":"Checks to skip, in the order of the list.","default":0,"title":"Offset"},"description":"Checks to skip, in the order of the list."},{"name":"page_type","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"Only checks of these targets: `home`, `category`, `product` or `search`. Comma separated or repeated.","title":"Page Type"},"description":"Only checks of these targets: `home`, `category`, `product` or `search`. Comma separated or repeated."},{"name":"status_code","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"Only checks that ended in one of these HTTP status codes, 0 for no HTTP response. Comma separated or repeated.","title":"Status Code"},"description":"Only checks that ended in one of these HTTP status codes, 0 for no HTTP response. Comma separated or repeated."},{"name":"is_ok","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"`true` for the successful checks only, `false` for the failed ones only. Both where absent.","title":"Is Ok"},"description":"`true` for the successful checks only, `false` for the failed ones only. Both where absent."},{"name":"is_redirected","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"`true` for the checks that followed a redirect only, `false` for those that followed none. Both where absent.","title":"Is Redirected"},"description":"`true` for the checks that followed a redirect only, `false` for those that followed none. Both where absent."},{"name":"min_ttfb_ms","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}],"description":"Only checks whose `ttfb_ms` is at least this.","title":"Min Ttfb Ms"},"description":"Only checks whose `ttfb_ms` is at least this."},{"name":"cache_status","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"Only checks with one of these cache statuses, compared uppercase. An empty value keeps the checks whose response reported none. Comma separated or repeated.","title":"Cache Status"},"description":"Only checks with one of these cache statuses, compared uppercase. An empty value keeps the checks whose response reported none. Comma separated or repeated."},{"name":"check_type","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"Only checks scheduled as one of these: `regular`, `recheck`, `priority` or `watch`. Comma separated or repeated.","title":"Check Type"},"description":"Only checks scheduled as one of these: `regular`, `recheck`, `priority` or `watch`. Comma separated or repeated."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UptimeCheckListResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"401":{"description":"Unauthorized - Invalid or missing authorization token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"},"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"403":{"description":"Forbidden - Insufficient permissions","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"404":{"description":"Not Found - Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"422":{"description":"Validation Error - Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"429":{"description":"Too Many Requests - Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"x-fastmon-permissions":["issue:read","site:read"]}},"/sites/{site_id}/uptime/checks/groups":{"get":{"tags":["sites"],"summary":"Group the uptime checks of the site in a window by one or two keys","description":"The checks of the window that pass the filters, counted per\ncombination of the `group_by` keys with their quantiles, their TTFB\nbreakdown and their newest check.\n\nNeeds `site:read` and `issue:read`, as the site's samples do.\n\n**Requires:** `issue:read` and `site:read`, held by every role.","operationId":"listSiteUptimeCheckGroups","security":[{"bearerAuth":[]},{"oauth2":["issue:read","site:read"]}],"parameters":[{"name":"site_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Site Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."},{"name":"group_by","in":"query","required":true,"schema":{"type":"string","maxLength":64,"description":"One or two group keys, comma separated: `page_type`, `status_code`, `cache_status`, and `site_id` on the application route.","title":"Group By"},"description":"One or two group keys, comma separated: `page_type`, `status_code`, `cache_status`, and `site_id` on the application route."},{"name":"from","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"Inclusive start of the window. Defaults to 24 hours before `to`.","title":"From","examples":["2026-04-14T09:50:01Z"]},"description":"Inclusive start of the window. Defaults to 24 hours before `to`."},{"name":"to","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"Exclusive end of the window, at most 90 days after `from`. Defaults to now.","title":"To","examples":["2026-04-14T09:50:01Z"]},"description":"Exclusive end of the window, at most 90 days after `from`. Defaults to now."},{"name":"page_type","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"Only checks of these targets: `home`, `category`, `product` or `search`. Comma separated or repeated.","title":"Page Type"},"description":"Only checks of these targets: `home`, `category`, `product` or `search`. Comma separated or repeated."},{"name":"status_code","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"Only checks that ended in one of these HTTP status codes, 0 for no HTTP response. Comma separated or repeated.","title":"Status Code"},"description":"Only checks that ended in one of these HTTP status codes, 0 for no HTTP response. Comma separated or repeated."},{"name":"is_ok","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"`true` for the successful checks only, `false` for the failed ones only. Both where absent.","title":"Is Ok"},"description":"`true` for the successful checks only, `false` for the failed ones only. Both where absent."},{"name":"is_redirected","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"`true` for the checks that followed a redirect only, `false` for those that followed none. Both where absent.","title":"Is Redirected"},"description":"`true` for the checks that followed a redirect only, `false` for those that followed none. Both where absent."},{"name":"min_ttfb_ms","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}],"description":"Only checks whose `ttfb_ms` is at least this.","title":"Min Ttfb Ms"},"description":"Only checks whose `ttfb_ms` is at least this."},{"name":"cache_status","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"Only checks with one of these cache statuses, compared uppercase. An empty value keeps the checks whose response reported none. Comma separated or repeated.","title":"Cache Status"},"description":"Only checks with one of these cache statuses, compared uppercase. An empty value keeps the checks whose response reported none. Comma separated or repeated."},{"name":"check_type","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"Only checks scheduled as one of these: `regular`, `recheck`, `priority` or `watch`. Comma separated or repeated.","title":"Check Type"},"description":"Only checks scheduled as one of these: `regular`, `recheck`, `priority` or `watch`. Comma separated or repeated."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UptimeCheckGroupsResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"401":{"description":"Unauthorized - Invalid or missing authorization token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"},"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"403":{"description":"Forbidden - Insufficient permissions","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"404":{"description":"Not Found - Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"422":{"description":"Validation Error - Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"429":{"description":"Too Many Requests - Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"x-fastmon-permissions":["issue:read","site:read"]}},"/sites/{site_id}/uptime/checks/{check_id}":{"get":{"tags":["sites"],"summary":"Get one uptime check of the site with the shop's answer","description":"One check of the site by the `check_id` of a sample, with the body\nexcerpt, the response headers and the raw Server-Timing header.\n\nNeeds `site:read` and `issue:read`, as the site's samples do.\n\n**Requires:** `issue:read` and `site:read`, held by every role.","operationId":"getSiteUptimeCheck","security":[{"bearerAuth":[]},{"oauth2":["issue:read","site:read"]}],"parameters":[{"name":"check_id","in":"path","required":true,"schema":{"type":"string","title":"Check Id"}},{"name":"site_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Site Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UptimeSampleDetail"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"401":{"description":"Unauthorized - Invalid or missing authorization token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"},"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"403":{"description":"Forbidden - Insufficient permissions","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"404":{"description":"Not Found - Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"422":{"description":"Validation Error - Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"429":{"description":"Too Many Requests - Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"x-fastmon-permissions":["issue:read","site:read"]}},"/sites/{site_id}/uptime/chains/{chain_id}":{"get":{"tags":["sites"],"summary":"Get one check chain of the site with every check of every step","description":"One check chain the site's failed check started, by the `chain_id` of\na sample: its outcome, the observation it opened and its checks per step.\n\nNeeds `site:read` and `issue:read`, as the site's samples do.\n\n**Requires:** `issue:read` and `site:read`, held by every role.","operationId":"getSiteUptimeChain","security":[{"bearerAuth":[]},{"oauth2":["issue:read","site:read"]}],"parameters":[{"name":"chain_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Chain Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."},{"name":"site_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Site Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UptimeChainResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"401":{"description":"Unauthorized - Invalid or missing authorization token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"},"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"403":{"description":"Forbidden - Insufficient permissions","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"404":{"description":"Not Found - Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"422":{"description":"Validation Error - Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"429":{"description":"Too Many Requests - Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"x-fastmon-permissions":["issue:read","site:read"]}},"/sites/{site_id}/uptime/check":{"post":{"tags":["sites"],"summary":"Queue an immediate uptime check of every target of the site","description":"Queue the site's home page and page type URLs for the next poll of the probe.\n\nThe results arrive as samples of `GET /sites/{site_id}/uptime` newer than\n`requested_at`.\n\n**Requires:** `site:write`, held by the member and owner roles.","operationId":"checkSiteUptime","security":[{"bearerAuth":[]},{"oauth2":["site:write"]}],"parameters":[{"name":"site_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Site Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."}],"responses":{"202":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UptimeCheckResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"401":{"description":"Unauthorized - Invalid or missing authorization token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"},"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"403":{"description":"Forbidden - Insufficient permissions","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"404":{"description":"Not Found - Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"409":{"description":"Conflict - Resource already exists or operation not allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"422":{"description":"Validation Error - Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"429":{"description":"Too Many Requests - Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"503":{"description":"Service Unavailable - A backing service is not configured or not reachable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"x-fastmon-permissions":["site:write"]}},"/sites/{site_id}/events/{event_id}":{"patch":{"tags":["analytics"],"summary":"Change the name or props of one event","description":"Change the name or the props of one event, for a wrong name or a wrong value.\n\n`event_id` comes from a row of `POST /analytics/events` or a visitor's\n`events`. The time, the visitor, the pageview and the source stay as they\nwere: they are facts of the visit. The event list shows the change at once,\nevery other reader within its 30 s cache, the live summary's week-old\nday within an hour. Each edit is an `event.updated` entry in the audit log.\n\n**Requires:** `analytics:read` and `site:write`, held by the member and owner roles.","operationId":"updateSiteEvent","security":[{"bearerAuth":[]},{"oauth2":["analytics:read","site:write"]}],"parameters":[{"name":"event_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Event Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."},{"name":"site_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Site Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventUpdate"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventRow"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"401":{"description":"Unauthorized - Invalid or missing authorization token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"},"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"403":{"description":"Forbidden - Insufficient permissions","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"404":{"description":"Not Found - Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"409":{"description":"Conflict - Resource already exists or operation not allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"422":{"description":"Validation Error - Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"429":{"description":"Too Many Requests - Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"x-fastmon-permissions":["analytics:read","site:write"]},"delete":{"tags":["analytics"],"summary":"Delete one event","description":"Delete one event, such as a test purchase, from every count and list.\n\nThe event list leaves it out at once, every other reader within its 30 s\ncache, the live summary's week-old day within an hour. A second delete of\nthe same id is a 404. Each delete is an `event.deleted` entry in the audit\nlog that keeps the event's name and props.\n\n**Requires:** `analytics:read` and `site:write`, held by the member and owner roles.","operationId":"deleteSiteEvent","security":[{"bearerAuth":[]},{"oauth2":["analytics:read","site:write"]}],"parameters":[{"name":"event_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Event Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."},{"name":"site_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Site Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."}],"responses":{"204":{"description":"Successful Response","headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"401":{"description":"Unauthorized - Invalid or missing authorization token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"},"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"403":{"description":"Forbidden - Insufficient permissions","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"404":{"description":"Not Found - Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"409":{"description":"Conflict - Resource already exists or operation not allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"422":{"description":"Validation Error - Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"429":{"description":"Too Many Requests - Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"x-fastmon-permissions":["analytics:read","site:write"]}},"/organizations/{org_id}/applications":{"get":{"tags":["applications"],"summary":"List Applications","description":"List the organization's applications, each with its domain (site) count.\n\n**Requires:** `app:read`, held by every role.","operationId":"listApplications","security":[{"bearerAuth":[]},{"oauth2":["app:read"]}],"parameters":[{"name":"org_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Org Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0,"title":"Offset"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":50,"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedResponse_ApplicationResponse_"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"401":{"description":"Unauthorized - Invalid or missing authorization token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"},"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"404":{"description":"Not Found - Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"422":{"description":"Validation Error - Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"429":{"description":"Too Many Requests - Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"x-fastmon-permissions":["app:read"]},"post":{"tags":["applications"],"summary":"Create Application","description":"Provision an application: one embed whose collection config applies to every\ndomain it runs on, with the concrete Site for each beacon resolved at ingest by\nthe page-URL host. Sites are added by adopting/assigning domains (or\nauto-provision).\n\n**Requires:** `app:write`, held by the member and owner roles.","operationId":"createApplication","security":[{"bearerAuth":[]},{"oauth2":["app:write"]}],"parameters":[{"name":"org_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Org Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationCreate"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"401":{"description":"Unauthorized - Invalid or missing authorization token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"},"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"403":{"description":"Forbidden - Insufficient permissions","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"404":{"description":"Not Found - Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"422":{"description":"Validation Error - Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"429":{"description":"Too Many Requests - Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"x-fastmon-permissions":["app:write"]}},"/organizations/{org_id}/applications/unknown-hostnames":{"get":{"tags":["applications"],"summary":"List Unknown Hostnames","description":"Hostnames observed hitting an application that matched no registered site\n- candidates to adopt as new sites, each tagged with the application that\nobserved it. Backed by a best-effort Valkey counter (7-day TTL); empty if\nValkey is unavailable.\n\n**Requires:** `app:read`, held by every role.","operationId":"listApplicationUnknownHostnames","security":[{"bearerAuth":[]},{"oauth2":["app:read"]}],"parameters":[{"name":"org_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Org Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"default":50,"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnknownHostnamesResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"401":{"description":"Unauthorized - Invalid or missing authorization token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"},"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"404":{"description":"Not Found - Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"422":{"description":"Validation Error - Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"429":{"description":"Too Many Requests - Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"x-fastmon-permissions":["app:read"]}},"/organizations/{org_id}/applications/unknown-hostnames/{domain}":{"delete":{"tags":["applications"],"summary":"Dismiss Unknown Hostname","description":"Dismiss a discovered host (after adopting it, or to hide noise).\n\nRemoves it for EVERY application that observed it - once the domain is a Site\n(or the customer hid it) it's no longer a suggestion regardless of source.\nThe path segment is unchanged on the wire: only the parameter's name moved,\nso a caller's URL keeps working.\n\n**Requires:** `app:write`, held by the member and owner roles.","operationId":"dismissApplicationUnknownHostname","security":[{"bearerAuth":[]},{"oauth2":["app:write"]}],"parameters":[{"name":"org_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Org Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."},{"name":"domain","in":"path","required":true,"schema":{"type":"string","maxLength":255,"title":"Domain"}}],"responses":{"204":{"description":"Successful Response","headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"401":{"description":"Unauthorized - Invalid or missing authorization token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"},"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"404":{"description":"Not Found - Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"422":{"description":"Validation Error - Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"429":{"description":"Too Many Requests - Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"x-fastmon-permissions":["app:write"]}},"/applications/{app_id}":{"get":{"tags":["applications"],"summary":"Get one application","description":"One application: its embed hashes, what it collects, and how many domains\nrun on it. The collector secret is only included for a caller who may change\nthe application.\n\n**Requires:** `app:read`, held by every role.","operationId":"getApplication","security":[{"bearerAuth":[]},{"oauth2":["app:read"]}],"parameters":[{"name":"app_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"App Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"401":{"description":"Unauthorized - Invalid or missing authorization token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"},"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"404":{"description":"Not Found - Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"422":{"description":"Validation Error - Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"429":{"description":"Too Many Requests - Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"x-fastmon-permissions":["app:read"]},"patch":{"tags":["applications"],"summary":"Update Application","description":"Update an application. Config changes re-render the served bundle (cache\ninvalidated).\n\n**Requires:** `app:write`, held by the member and owner roles.","operationId":"updateApplication","security":[{"bearerAuth":[]},{"oauth2":["app:write"]}],"parameters":[{"name":"app_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"App Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationUpdate"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"401":{"description":"Unauthorized - Invalid or missing authorization token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"},"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"403":{"description":"Forbidden - Insufficient permissions","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"404":{"description":"Not Found - Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"422":{"description":"Validation Error - Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"429":{"description":"Too Many Requests - Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"x-fastmon-permissions":["app:write"]},"delete":{"tags":["applications"],"summary":"Delete Application","description":"Delete an application and all its sites (their beacon data included - the\nembed is gone, so the domains can no longer collect). The embed stops\nresolving immediately.\n\n**Requires:** `app:delete`, held by the member and owner roles.","operationId":"deleteApplication","security":[{"bearerAuth":[]},{"oauth2":["app:delete"]}],"parameters":[{"name":"app_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"App Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."}],"responses":{"204":{"description":"Successful Response","headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"401":{"description":"Unauthorized - Invalid or missing authorization token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"},"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"404":{"description":"Not Found - Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"422":{"description":"Validation Error - Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"429":{"description":"Too Many Requests - Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"x-fastmon-permissions":["app:delete"]}},"/applications/{app_id}/page-type-sources":{"get":{"tags":["applications"],"summary":"List the page type sources of an application","description":"What the collector reads this application's page type from, in precedence order.\n\n**Requires:** `app:read`, held by every role.","operationId":"getApplicationPageTypeSources","security":[{"bearerAuth":[]},{"oauth2":["app:read"]}],"parameters":[{"name":"app_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"App Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageTypeSources"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"401":{"description":"Unauthorized - Invalid or missing authorization token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"},"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"404":{"description":"Not Found - Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"422":{"description":"Validation Error - Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"429":{"description":"Too Many Requests - Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"x-fastmon-permissions":["app:read"]}},"/applications/{app_id}/rotate-hashes":{"post":{"tags":["applications"],"summary":"Rotate Application Hashes","description":"Rotate the application's script and collector hashes. Existing embeds stop\nworking until the snippet is updated everywhere!\n\nA Shopify application has a second place to update: the custom pixel in the\nShopify admin embeds the old source hash, so `/s/e/{old}.js` becomes a 404\nand the checkout events stop without an error anywhere. Paste the new\nsnippet from the Shopify checkout guide there as well.\n\n**Requires:** `app:rotate_hashes`, held by the member and owner roles.","operationId":"rotateApplicationHashes","security":[{"bearerAuth":[]},{"oauth2":["app:rotate_hashes"]}],"parameters":[{"name":"app_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"App Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"401":{"description":"Unauthorized - Invalid or missing authorization token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"},"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"404":{"description":"Not Found - Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"422":{"description":"Validation Error - Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"429":{"description":"Too Many Requests - Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"x-fastmon-permissions":["app:rotate_hashes"]}},"/applications/{app_id}/proxy-secret":{"post":{"tags":["applications"],"summary":"Rotate Application Proxy Secret","description":"Generate the application's proxy-trust secret, or rotate it if one exists.\n\nThe secret authorizes a customer-run beacon proxy (via the FM-Proxy-Key\nheader) to forward the real visitor IP in X-Forwarded-For. On rotation the\nold secret stays valid as `proxy_secret_previous` until the next rotation,\nso proxy configs can be updated without losing geo/session quality. The\nedge picks the change up within its sync interval, not instantly.\n\n**Requires:** `app:write`, held by the member and owner roles.","operationId":"rotateApplicationProxySecret","security":[{"bearerAuth":[]},{"oauth2":["app:write"]}],"parameters":[{"name":"app_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"App Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"401":{"description":"Unauthorized - Invalid or missing authorization token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"},"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"404":{"description":"Not Found - Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"422":{"description":"Validation Error - Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"429":{"description":"Too Many Requests - Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"x-fastmon-permissions":["app:write"]},"delete":{"tags":["applications"],"summary":"Disable Application Proxy Secret","description":"Disable proxy trust: invalidate both the current and the previous secret.\n\nBeacons from the customer's proxy keep flowing afterwards; the edge just\nfalls back to the proxy server's IP as the client IP (the pre-feature\nbehavior). Idempotent: deleting an absent secret is a no-op.\n\n**Requires:** `app:write`, held by the member and owner roles.","operationId":"disableApplicationProxySecret","security":[{"bearerAuth":[]},{"oauth2":["app:write"]}],"parameters":[{"name":"app_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"App Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."}],"responses":{"204":{"description":"Successful Response","headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"401":{"description":"Unauthorized - Invalid or missing authorization token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"},"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"404":{"description":"Not Found - Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"422":{"description":"Validation Error - Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"429":{"description":"Too Many Requests - Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"x-fastmon-permissions":["app:write"]}},"/applications/{app_id}/sampling-recommendation":{"get":{"tags":["applications"],"summary":"Recommend a sampling rate","description":"The sampling rate the last seven days of traffic allow. Reading it changes nothing.\n\n**Requires:** `app:write`, held by the member and owner roles.","operationId":"getApplicationSamplingRecommendation","security":[{"bearerAuth":[]},{"oauth2":["app:write"]}],"parameters":[{"name":"app_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"App Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SamplingRecommendation"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"401":{"description":"Unauthorized - Invalid or missing authorization token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"},"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"403":{"description":"Forbidden - Insufficient permissions","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"404":{"description":"Not Found - Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"422":{"description":"Validation Error - Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"429":{"description":"Too Many Requests - Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"x-fastmon-permissions":["app:write"]}},"/applications/{app_id}/sites":{"get":{"tags":["applications"],"summary":"List Application Sites","description":"List the domains (sites) this application runs on.\n\n**Requires:** `site:read`, held by every role.","operationId":"listApplicationSites","security":[{"bearerAuth":[]},{"oauth2":["site:read"]}],"parameters":[{"name":"app_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"App Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0,"title":"Offset"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":50,"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedResponse_SiteResponse_"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"401":{"description":"Unauthorized - Invalid or missing authorization token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"},"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"404":{"description":"Not Found - Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"422":{"description":"Validation Error - Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"429":{"description":"Too Many Requests - Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"x-fastmon-permissions":["site:read"]},"post":{"tags":["applications"],"summary":"Create Application Site","description":"Adopt a domain into the application as a member site. The site is a pure\ndomain/analytics unit - it carries no hashes/config of its own; the\napplication's config applies at ingest, so only the domain is needed.\nTypically fed a hostname from the discovery list; on success that hostname is\ncleared from the list.\n\n**Requires:** `site:write`, held by the member and owner roles.","operationId":"createApplicationSite","security":[{"bearerAuth":[]},{"oauth2":["site:write"]}],"parameters":[{"name":"app_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"App Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationSiteCreate"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SiteResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"401":{"description":"Unauthorized - Invalid or missing authorization token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"},"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"403":{"description":"Forbidden - Insufficient permissions","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"404":{"description":"Not Found - Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"409":{"description":"Conflict - Resource already exists or operation not allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"422":{"description":"Validation Error - Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"429":{"description":"Too Many Requests - Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"x-fastmon-permissions":["site:write"]}},"/applications/{app_id}/uptime":{"get":{"tags":["applications"],"summary":"List the uptime state of the application's active sites","description":"Per active site of the application: its open outage, whether it answers\nslowly or unreliably, its certificate, its newest check, and its\navailability and downtime over the window, by default the last 24 hours.\n\nNeeds `site:read` and `issue:read`, as `GET /sites/{site_id}/uptime` does.\n\n**Requires:** `issue:read` and `site:read`, held by every role.","operationId":"listApplicationUptime","security":[{"bearerAuth":[]},{"oauth2":["issue:read","site:read"]}],"parameters":[{"name":"app_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"App Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."},{"name":"from","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"Inclusive start of the window. Defaults to 24 hours before `to`.","title":"From","examples":["2026-04-14T09:50:01Z"]},"description":"Inclusive start of the window. Defaults to 24 hours before `to`."},{"name":"to","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"Exclusive end of the window, at most 90 days after `from`. Defaults to now.","title":"To","examples":["2026-04-14T09:50:01Z"]},"description":"Exclusive end of the window, at most 90 days after `from`. Defaults to now."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SiteUptimeStatus"},"title":"Response Listapplicationuptime"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"401":{"description":"Unauthorized - Invalid or missing authorization token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"},"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"403":{"description":"Forbidden - Insufficient permissions","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"404":{"description":"Not Found - Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"422":{"description":"Validation Error - Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"429":{"description":"Too Many Requests - Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"x-fastmon-permissions":["issue:read","site:read"]}},"/applications/{app_id}/uptime/summary":{"get":{"tags":["applications"],"summary":"Summarize the uptime of the application's active sites in a few sentences","description":"The sentences of the application's uptime summary box: the outages, the\nslow or unreliable sites, the certificates, and the availability of all\nactive sites together over the window.\n\nRead from the rows `GET /applications/{app_id}/uptime` answers. Needs\n`site:read` and `issue:read`, as that route does.\n\n**Requires:** `issue:read` and `site:read`, held by every role.","operationId":"getApplicationUptimeSummary","security":[{"bearerAuth":[]},{"oauth2":["issue:read","site:read"]}],"parameters":[{"name":"app_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"App Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."},{"name":"from","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"Inclusive start of the window. Defaults to 24 hours before `to`.","title":"From","examples":["2026-04-14T09:50:01Z"]},"description":"Inclusive start of the window. Defaults to 24 hours before `to`."},{"name":"to","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"Exclusive end of the window, at most 90 days after `from`. Defaults to now.","title":"To","examples":["2026-04-14T09:50:01Z"]},"description":"Exclusive end of the window, at most 90 days after `from`. Defaults to now."},{"name":"language","in":"query","required":false,"schema":{"type":"string","maxLength":16,"description":"The language of the sentences, `en` or `de`. A tag such as `de-AT` counts by its first two letters, and any other language falls back to `en`.","default":"en","title":"Language"},"description":"The language of the sentences, `en` or `de`. A tag such as `de-AT` counts by its first two letters, and any other language falls back to `en`."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UptimeSummaryResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"401":{"description":"Unauthorized - Invalid or missing authorization token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"},"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"403":{"description":"Forbidden - Insufficient permissions","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"404":{"description":"Not Found - Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"422":{"description":"Validation Error - Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"429":{"description":"Too Many Requests - Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"x-fastmon-permissions":["issue:read","site:read"]}},"/applications/{app_id}/uptime/series":{"get":{"tags":["applications"],"summary":"Get the uptime checks of the application's active sites over a window, pooled","description":"The checks of every active site of the application over the window, by\ndefault the last 24 hours: one series per target with the quantiles over\nthe sites' checks together, the samples with their `site_id`, at most\n3000 over the application, and the availability over the sites' merged\noutages. `by_site` adds the counts per site and bucket. The open outage\nand the certificate per site stay on `GET /applications/{app_id}/uptime`.\n\nNeeds `site:read` and `issue:read`, as the other uptime routes do.\n\n**Requires:** `issue:read` and `site:read`, held by every role.","operationId":"getApplicationUptimeSeries","security":[{"bearerAuth":[]},{"oauth2":["issue:read","site:read"]}],"parameters":[{"name":"app_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"App Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."},{"name":"from","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"Inclusive start of the window. Defaults to 24 hours before `to`.","title":"From","examples":["2026-04-14T09:50:01Z"]},"description":"Inclusive start of the window. Defaults to 24 hours before `to`."},{"name":"to","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"Exclusive end of the window, at most 90 days after `from`. Defaults to now.","title":"To","examples":["2026-04-14T09:50:01Z"]},"description":"Exclusive end of the window, at most 90 days after `from`. Defaults to now."},{"name":"by_site","in":"query","required":false,"schema":{"type":"boolean","description":"Also answer `site_series`, the checks and failed checks per active site and bucket.","default":false,"title":"By Site"},"description":"Also answer `site_series`, the checks and failed checks per active site and bucket."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationUptimeSeriesResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"401":{"description":"Unauthorized - Invalid or missing authorization token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"},"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"403":{"description":"Forbidden - Insufficient permissions","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"404":{"description":"Not Found - Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"422":{"description":"Validation Error - Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"429":{"description":"Too Many Requests - Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"x-fastmon-permissions":["issue:read","site:read"]}},"/applications/{app_id}/uptime/checks":{"get":{"tags":["applications"],"summary":"List the uptime checks of the application's active sites in a window, paged","description":"The checks of every active site of the application in the window that\npass the filters, each with its `site_id`, the newest first, one page at a\ntime with their count in `meta.total`.\n\nNeeds `site:read` and `issue:read`, as the other uptime routes do.\n\n**Requires:** `issue:read` and `site:read`, held by every role.","operationId":"listApplicationUptimeChecks","security":[{"bearerAuth":[]},{"oauth2":["issue:read","site:read"]}],"parameters":[{"name":"app_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"App Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."},{"name":"site_id","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"Only checks of these sites, comma separated or repeated. A site that is not an active site of the application matches nothing.","title":"Site Id"},"description":"Only checks of these sites, comma separated or repeated. A site that is not an active site of the application matches nothing."},{"name":"from","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"Inclusive start of the window. Defaults to 24 hours before `to`.","title":"From","examples":["2026-04-14T09:50:01Z"]},"description":"Inclusive start of the window. Defaults to 24 hours before `to`."},{"name":"to","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"Exclusive end of the window, at most 90 days after `from`. Defaults to now.","title":"To","examples":["2026-04-14T09:50:01Z"]},"description":"Exclusive end of the window, at most 90 days after `from`. Defaults to now."},{"name":"chain_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"description":"Only the checks of this check chain. On a site only the chain's checks of that site. An unknown chain matches nothing.","title":"Chain Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"Only the checks of this check chain. On a site only the chain's checks of that site. An unknown chain matches nothing."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":500,"minimum":1,"description":"Checks per page, at most 500.","default":100,"title":"Limit"},"description":"Checks per page, at most 500."},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"description":"Checks to skip, in the order of the list.","default":0,"title":"Offset"},"description":"Checks to skip, in the order of the list."},{"name":"page_type","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"Only checks of these targets: `home`, `category`, `product` or `search`. Comma separated or repeated.","title":"Page Type"},"description":"Only checks of these targets: `home`, `category`, `product` or `search`. Comma separated or repeated."},{"name":"status_code","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"Only checks that ended in one of these HTTP status codes, 0 for no HTTP response. Comma separated or repeated.","title":"Status Code"},"description":"Only checks that ended in one of these HTTP status codes, 0 for no HTTP response. Comma separated or repeated."},{"name":"is_ok","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"`true` for the successful checks only, `false` for the failed ones only. Both where absent.","title":"Is Ok"},"description":"`true` for the successful checks only, `false` for the failed ones only. Both where absent."},{"name":"is_redirected","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"`true` for the checks that followed a redirect only, `false` for those that followed none. Both where absent.","title":"Is Redirected"},"description":"`true` for the checks that followed a redirect only, `false` for those that followed none. Both where absent."},{"name":"min_ttfb_ms","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}],"description":"Only checks whose `ttfb_ms` is at least this.","title":"Min Ttfb Ms"},"description":"Only checks whose `ttfb_ms` is at least this."},{"name":"cache_status","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"Only checks with one of these cache statuses, compared uppercase. An empty value keeps the checks whose response reported none. Comma separated or repeated.","title":"Cache Status"},"description":"Only checks with one of these cache statuses, compared uppercase. An empty value keeps the checks whose response reported none. Comma separated or repeated."},{"name":"check_type","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"Only checks scheduled as one of these: `regular`, `recheck`, `priority` or `watch`. Comma separated or repeated.","title":"Check Type"},"description":"Only checks scheduled as one of these: `regular`, `recheck`, `priority` or `watch`. Comma separated or repeated."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UptimeCheckListResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"401":{"description":"Unauthorized - Invalid or missing authorization token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"},"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"403":{"description":"Forbidden - Insufficient permissions","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"404":{"description":"Not Found - Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"422":{"description":"Validation Error - Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"429":{"description":"Too Many Requests - Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"x-fastmon-permissions":["issue:read","site:read"]}},"/applications/{app_id}/uptime/checks/groups":{"get":{"tags":["applications"],"summary":"Group the uptime checks of the application's active sites by one or two keys","description":"The checks of every active site of the application in the window that\npass the filters, counted per combination of the `group_by` keys with\ntheir quantiles, their TTFB breakdown and their newest check.\n\nNeeds `site:read` and `issue:read`, as the other uptime routes do.\n\n**Requires:** `issue:read` and `site:read`, held by every role.","operationId":"listApplicationUptimeCheckGroups","security":[{"bearerAuth":[]},{"oauth2":["issue:read","site:read"]}],"parameters":[{"name":"app_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"App Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."},{"name":"group_by","in":"query","required":true,"schema":{"type":"string","maxLength":64,"description":"One or two group keys, comma separated: `page_type`, `status_code`, `cache_status`, and `site_id` on the application route.","title":"Group By"},"description":"One or two group keys, comma separated: `page_type`, `status_code`, `cache_status`, and `site_id` on the application route."},{"name":"site_id","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"Only checks of these sites, comma separated or repeated. A site that is not an active site of the application matches nothing.","title":"Site Id"},"description":"Only checks of these sites, comma separated or repeated. A site that is not an active site of the application matches nothing."},{"name":"from","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"Inclusive start of the window. Defaults to 24 hours before `to`.","title":"From","examples":["2026-04-14T09:50:01Z"]},"description":"Inclusive start of the window. Defaults to 24 hours before `to`."},{"name":"to","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"Exclusive end of the window, at most 90 days after `from`. Defaults to now.","title":"To","examples":["2026-04-14T09:50:01Z"]},"description":"Exclusive end of the window, at most 90 days after `from`. Defaults to now."},{"name":"page_type","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"Only checks of these targets: `home`, `category`, `product` or `search`. Comma separated or repeated.","title":"Page Type"},"description":"Only checks of these targets: `home`, `category`, `product` or `search`. Comma separated or repeated."},{"name":"status_code","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"Only checks that ended in one of these HTTP status codes, 0 for no HTTP response. Comma separated or repeated.","title":"Status Code"},"description":"Only checks that ended in one of these HTTP status codes, 0 for no HTTP response. Comma separated or repeated."},{"name":"is_ok","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"`true` for the successful checks only, `false` for the failed ones only. Both where absent.","title":"Is Ok"},"description":"`true` for the successful checks only, `false` for the failed ones only. Both where absent."},{"name":"is_redirected","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"`true` for the checks that followed a redirect only, `false` for those that followed none. Both where absent.","title":"Is Redirected"},"description":"`true` for the checks that followed a redirect only, `false` for those that followed none. Both where absent."},{"name":"min_ttfb_ms","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}],"description":"Only checks whose `ttfb_ms` is at least this.","title":"Min Ttfb Ms"},"description":"Only checks whose `ttfb_ms` is at least this."},{"name":"cache_status","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"Only checks with one of these cache statuses, compared uppercase. An empty value keeps the checks whose response reported none. Comma separated or repeated.","title":"Cache Status"},"description":"Only checks with one of these cache statuses, compared uppercase. An empty value keeps the checks whose response reported none. Comma separated or repeated."},{"name":"check_type","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"Only checks scheduled as one of these: `regular`, `recheck`, `priority` or `watch`. Comma separated or repeated.","title":"Check Type"},"description":"Only checks scheduled as one of these: `regular`, `recheck`, `priority` or `watch`. Comma separated or repeated."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UptimeCheckGroupsResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"401":{"description":"Unauthorized - Invalid or missing authorization token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"},"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"403":{"description":"Forbidden - Insufficient permissions","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"404":{"description":"Not Found - Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"422":{"description":"Validation Error - Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"429":{"description":"Too Many Requests - Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"x-fastmon-permissions":["issue:read","site:read"]}},"/applications/{app_id}/uptime/chains/{chain_id}":{"get":{"tags":["applications"],"summary":"Get one check chain of an active site of the application","description":"One check chain started by any active site of the application, by the\n`chain_id` of a sample of any of its sites, with its outcome, the\nobservation it opened and its checks per step.\n\nNeeds `site:read` and `issue:read`, as the other uptime routes do.\n\n**Requires:** `issue:read` and `site:read`, held by every role.","operationId":"getApplicationUptimeChain","security":[{"bearerAuth":[]},{"oauth2":["issue:read","site:read"]}],"parameters":[{"name":"chain_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Chain Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."},{"name":"app_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"App Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UptimeChainResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"401":{"description":"Unauthorized - Invalid or missing authorization token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"},"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"403":{"description":"Forbidden - Insufficient permissions","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"404":{"description":"Not Found - Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"422":{"description":"Validation Error - Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"429":{"description":"Too Many Requests - Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"x-fastmon-permissions":["issue:read","site:read"]}},"/applications/{app_id}/sites/{site_id}":{"put":{"tags":["applications"],"summary":"Assign Application Site","description":"Move an existing site into this application. The application claims the\ndomain for ingest + releases. Re-assigning to the same application is a no-op.\n\nThe site's previous application is left in place even if it ends up with no\nsites - an empty application keeps its embed/config and can take on new\ndomains later; deleting it is an explicit action (DELETE /applications/{id}).\n\n**Requires:** `site:write`, held by the member and owner roles.","operationId":"assignApplicationSite","security":[{"bearerAuth":[]},{"oauth2":["site:write"]}],"parameters":[{"name":"site_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Site Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."},{"name":"app_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"App Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SiteResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"401":{"description":"Unauthorized - Invalid or missing authorization token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"},"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"404":{"description":"Not Found - Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"409":{"description":"Conflict - Resource already exists or operation not allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"422":{"description":"Validation Error - Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"429":{"description":"Too Many Requests - Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"x-fastmon-permissions":["site:write"]}},"/applications/{app_id}/detect-pagetype":{"post":{"tags":["applications"],"summary":"Detect Application Pagetype","description":"Find out which shop system this application runs, by reading its home page.\n\nAnswers the question the `pagetype_ruleset` setting asks, without making\nanybody open DevTools and read `document.body.className`. The probe target is\nthe application's own domain, never a URL from the caller: this endpoint makes\nthe server fetch a page, so the only address it ever visits is one the\ncustomer registered here.\n\nDetection only. The result is not written, because a probe reads one page of\none domain while the setting governs every page of the application.\n\n**Requires:** `app:write`, held by the member and owner roles.","operationId":"detectApplicationPageType","security":[{"bearerAuth":[]},{"oauth2":["app:write"]}],"parameters":[{"name":"app_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"App Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageTypeDetectionResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"401":{"description":"Unauthorized - Invalid or missing authorization token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"},"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"404":{"description":"Not Found - Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"409":{"description":"Conflict - Resource already exists or operation not allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"429":{"description":"Too Many Requests - Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"503":{"description":"Service Unavailable - A backing service is not configured or not reachable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"422":{"description":"Validation Error - Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"x-fastmon-permissions":["app:write"]}},"/applications/{app_id}/pagetype/discover":{"post":{"tags":["applications"],"summary":"Discover Application Pagetype Rules","description":"Propose `pagetype_rules` from a few pages the customer labelled.\n\nThe customer says \"this URL is a product page\". scout reads it, and the\nclass that appears there and on nothing else is the proposal. The home page\nis read alongside as the contrast, because a single page cannot say which of\nits thirty classes means \"product\".\n\nProposals only. The response carries a `rules` list shaped exactly like the\nfield, and somebody PATCHes it after looking.\n\n**Requires:** `app:write`, held by the member and owner roles.","operationId":"discoverApplicationPageTypeRules","security":[{"bearerAuth":[]},{"oauth2":["app:write"]}],"parameters":[{"name":"app_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"App Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageTypeDiscoverRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageTypeDiscoverResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"401":{"description":"Unauthorized - Invalid or missing authorization token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"},"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"404":{"description":"Not Found - Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"409":{"description":"Conflict - Resource already exists or operation not allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"422":{"description":"Validation Error - Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"429":{"description":"Too Many Requests - Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"503":{"description":"Service Unavailable - A backing service is not configured or not reachable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"x-fastmon-permissions":["app:write"]}},"/platforms/{platform}/page-types":{"get":{"tags":["applications"],"summary":"Get Platform Page Types","description":"The page types a platform produces, in the groups a layout draws, in display order.\n\n`default` answers for an application without a known platform, whose `platform.key` is empty.\n\n**Requires:** any credential. No organization permission applies.","operationId":"getPlatformPageTypes","security":[{"bearerAuth":[]},{"oauth2":[]}],"parameters":[{"name":"platform","in":"path","required":true,"schema":{"type":"string","title":"Platform"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageTypeCatalog"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"401":{"description":"Unauthorized - Invalid or missing authorization token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"},"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"404":{"description":"Not Found - Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"422":{"description":"Validation Error - Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"429":{"description":"Too Many Requests - Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"x-fastmon-permissions":[]}},"/organizations/{org_id}/releases":{"get":{"tags":["releases"],"summary":"List Org Releases","description":"List all releases across an organization, newest first. Optionally restrict\nto one application.\n\n**Requires:** `release:read`, held by every role.","operationId":"listOrgReleases","security":[{"bearerAuth":[]},{"oauth2":["release:read"]}],"parameters":[{"name":"org_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Org Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."},{"name":"application_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"description":"Optional: restrict to one application","title":"Application Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"Optional: restrict to one application"},{"name":"from","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"Inclusive start of the window.","title":"From","examples":["2026-04-14T09:50:01Z"]},"description":"Inclusive start of the window."},{"name":"to","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"Exclusive end of the window.","title":"To","examples":["2026-04-14T09:50:01Z"]},"description":"Exclusive end of the window."},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0,"title":"Offset"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":50,"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedResponse_ReleaseResponse_"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"401":{"description":"Unauthorized - Invalid or missing authorization token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"},"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"404":{"description":"Not Found - Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"422":{"description":"Validation Error - Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"429":{"description":"Too Many Requests - Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"x-fastmon-permissions":["release:read"]}},"/applications/{app_id}/releases":{"get":{"tags":["releases"],"summary":"List Application Releases","description":"List an application's releases, newest first.\n\n**Requires:** `release:read`, held by every role.","operationId":"listApplicationReleases","security":[{"bearerAuth":[]},{"oauth2":["release:read"]}],"parameters":[{"name":"app_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"App Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."},{"name":"from","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"Inclusive start of the window.","title":"From","examples":["2026-04-14T09:50:01Z"]},"description":"Inclusive start of the window."},{"name":"to","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"Exclusive end of the window.","title":"To","examples":["2026-04-14T09:50:01Z"]},"description":"Exclusive end of the window."},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0,"title":"Offset"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":50,"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedResponse_ReleaseResponse_"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"401":{"description":"Unauthorized - Invalid or missing authorization token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"},"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"404":{"description":"Not Found - Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"422":{"description":"Validation Error - Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"429":{"description":"Too Many Requests - Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"x-fastmon-permissions":["release:read"]},"post":{"tags":["releases"],"summary":"Create Application Release","description":"Create a release on an application (a one-site app = that site; a multi-site\napp = a coordinated marker across all its domains).\n\n**Requires:** `release:write`, held by the member and owner roles.","operationId":"createApplicationRelease","security":[{"bearerAuth":[]},{"oauth2":["release:write"]}],"parameters":[{"name":"app_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"App Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReleaseCreate"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReleaseResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"401":{"description":"Unauthorized - Invalid or missing authorization token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"},"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"404":{"description":"Not Found - Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"409":{"description":"Conflict - Resource already exists or operation not allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"422":{"description":"Validation Error - Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"429":{"description":"Too Many Requests - Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"x-fastmon-permissions":["release:write"]}},"/sites/{site_id}/releases":{"get":{"tags":["releases"],"summary":"List Releases","description":"List releases for a site (its application's releases).\n\n**Requires:** `release:read`, held by every role.","operationId":"listReleases","security":[{"bearerAuth":[]},{"oauth2":["release:read"]}],"parameters":[{"name":"site_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Site Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."},{"name":"from","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"Inclusive start of the window.","title":"From","examples":["2026-04-14T09:50:01Z"]},"description":"Inclusive start of the window."},{"name":"to","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"Exclusive end of the window.","title":"To","examples":["2026-04-14T09:50:01Z"]},"description":"Exclusive end of the window."},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0,"title":"Offset"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":50,"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedResponse_ReleaseResponse_"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"401":{"description":"Unauthorized - Invalid or missing authorization token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"},"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"404":{"description":"Not Found - Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"422":{"description":"Validation Error - Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"429":{"description":"Too Many Requests - Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"x-fastmon-permissions":["release:read"]},"post":{"tags":["releases"],"summary":"Create Release","description":"Create a release for a site (on its application).\n\n**Requires:** `release:write`, held by the member and owner roles.","operationId":"createRelease","security":[{"bearerAuth":[]},{"oauth2":["release:write"]}],"parameters":[{"name":"site_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Site Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReleaseCreate"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReleaseResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"401":{"description":"Unauthorized - Invalid or missing authorization token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"},"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"404":{"description":"Not Found - Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"409":{"description":"Conflict - Resource already exists or operation not allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"422":{"description":"Validation Error - Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"429":{"description":"Too Many Requests - Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"x-fastmon-permissions":["release:write"]}},"/releases/{release_id}":{"get":{"tags":["releases"],"summary":"Get Release","description":"Get a single release by ID.\n\n**Requires:** `release:read`, held by every role.","operationId":"getRelease","security":[{"bearerAuth":[]},{"oauth2":["release:read"]}],"parameters":[{"name":"release_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Release Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReleaseResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"401":{"description":"Unauthorized - Invalid or missing authorization token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"},"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"404":{"description":"Not Found - Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"422":{"description":"Validation Error - Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"429":{"description":"Too Many Requests - Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"x-fastmon-permissions":["release:read"]},"patch":{"tags":["releases"],"summary":"Update Release","description":"Update a release.\n\n**Requires:** `release:write`, held by the member and owner roles.","operationId":"updateRelease","security":[{"bearerAuth":[]},{"oauth2":["release:write"]}],"parameters":[{"name":"release_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Release Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReleaseUpdate"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReleaseResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"401":{"description":"Unauthorized - Invalid or missing authorization token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"},"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"404":{"description":"Not Found - Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"409":{"description":"Conflict - Resource already exists or operation not allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"422":{"description":"Validation Error - Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"429":{"description":"Too Many Requests - Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"x-fastmon-permissions":["release:write"]},"delete":{"tags":["releases"],"summary":"Delete Release","description":"Delete a release.\n\n**Requires:** `release:delete`, held by the member and owner roles.","operationId":"deleteRelease","security":[{"bearerAuth":[]},{"oauth2":["release:delete"]}],"parameters":[{"name":"release_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Release Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."}],"responses":{"204":{"description":"Successful Response","headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"401":{"description":"Unauthorized - Invalid or missing authorization token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"},"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"404":{"description":"Not Found - Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"422":{"description":"Validation Error - Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"429":{"description":"Too Many Requests - Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"x-fastmon-permissions":["release:delete"]}},"/organizations/{org_id}/analytics/live":{"post":{"tags":["analytics"],"summary":"List the visitors of the window, 5 minutes by default","description":"The visitors seen in the window, 5 minutes by default, each by their newest pageview.\n\nRead from `live_beacons`, every beacon of the last three hours ordered by time,\nso a poll reads the window and not the site's day. A snapshot with no cursor:\neach response stands alone. `meta.next_poll_ms` sets the cadence.\n\n**Requires:** `analytics:read`, held by every role.","operationId":"queryAnalyticsLive","security":[{"bearerAuth":[]},{"oauth2":["analytics:read"]}],"parameters":[{"name":"org_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Org Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LiveRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LiveResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"400":{"description":"Bad Request - Invalid input","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"401":{"description":"Unauthorized - Invalid or missing authorization token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"},"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"404":{"description":"Not Found - Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"422":{"description":"Validation Error - Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"429":{"description":"Too Many Requests - Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"x-fastmon-permissions":["analytics:read"]}},"/organizations/{org_id}/analytics/beacons":{"post":{"tags":["analytics"],"summary":"List individual beacons","description":"Row-level drill-down: return individual beacons matching the filter.\n\nPaired with `/analytics/query` (which aggregates). A dashboard click on an\naggregate row sends the same filters here to get the specific beacons behind\nit. No metric aggregation: raw column values only, projected through the\n`fields` whitelist.\n\nBeyond the shared `filters`, two scopes are specific to this endpoint because\nthey read columns the aggregate rollups do not carry: `error_fingerprint`\n(Nested) and `server_timing` (Map), e.g. `{\"pop\": [\"DE-1331\"]}` for one CDN\nPoP or `{\"elasticsearch\": []}` for every pageview that reported that key.\n\nResponse is uncached (rows change every ingest). Total-count is fetched in\nthe same round-trip via asyncio.gather so the UI knows whether pagination\nis worth showing.\n\n**Requires:** `analytics:read`, held by every role.","operationId":"queryAnalyticsBeacons","security":[{"bearerAuth":[]},{"oauth2":["analytics:read"]}],"parameters":[{"name":"org_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Org Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BeaconsRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BeaconsResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"400":{"description":"Bad Request - Invalid input","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"401":{"description":"Unauthorized - Invalid or missing authorization token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"},"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"404":{"description":"Not Found - Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"422":{"description":"Validation Error - Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"429":{"description":"Too Many Requests - Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"x-fastmon-permissions":["analytics:read"]}},"/organizations/{org_id}/analytics/beacon-breakdowns":{"post":{"tags":["analytics"],"summary":"Break beacons down by ingestion facts","description":"Get the orthogonal beacon-ingestion breakdowns: privacy class,\ndelivery channel, lifecycle stage, and tracker bundle version. See\n`BeaconBreakdownsResponse` for the semantics of each dimension.\n\n**Requires:** `analytics:read`, held by every role.","operationId":"queryAnalyticsBeaconBreakdowns","security":[{"bearerAuth":[]},{"oauth2":["analytics:read"]}],"parameters":[{"name":"org_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Org Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BeaconBreakdownsRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BeaconBreakdownsResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"400":{"description":"Bad Request - Invalid input","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"401":{"description":"Unauthorized - Invalid or missing authorization token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"},"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"404":{"description":"Not Found - Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"422":{"description":"Validation Error - Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"429":{"description":"Too Many Requests - Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"x-fastmon-permissions":["analytics:read"]}},"/organizations/{org_id}/analytics/resource-breakdown":{"post":{"tags":["analytics"],"summary":"Resources by type","description":"Get resource breakdown by type (script, css, img, font, other).\n\n**Requires:** `analytics:read`, held by every role.","operationId":"queryAnalyticsResourceBreakdown","security":[{"bearerAuth":[]},{"oauth2":["analytics:read"]}],"parameters":[{"name":"org_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Org Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceBreakdownRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceBreakdownResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"400":{"description":"Bad Request - Invalid input","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"401":{"description":"Unauthorized - Invalid or missing authorization token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"},"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"404":{"description":"Not Found - Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"422":{"description":"Validation Error - Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"429":{"description":"Too Many Requests - Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"x-fastmon-permissions":["analytics:read"]}},"/organizations/{org_id}/analytics/third-party":{"post":{"tags":["analytics"],"summary":"Top third-party domains","description":"Top third-party domains by request count.\n\nPer-domain blocking duration is not available here; if you need a duration\nproxy, query `/analytics/query` with the `dominant_third_party_category`\ndimension.\n\n**Requires:** `analytics:read`, held by every role.","operationId":"queryAnalyticsThirdParty","security":[{"bearerAuth":[]},{"oauth2":["analytics:read"]}],"parameters":[{"name":"org_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Org Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThirdPartyRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThirdPartyResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"400":{"description":"Bad Request - Invalid input","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"401":{"description":"Unauthorized - Invalid or missing authorization token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"},"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"404":{"description":"Not Found - Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"422":{"description":"Validation Error - Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"429":{"description":"Too Many Requests - Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"x-fastmon-permissions":["analytics:read"]}},"/organizations/{org_id}/analytics/server-timing":{"post":{"tags":["analytics"],"summary":"Server-Timing panel","description":"Server-Timing dashboard panel: five blocks.\n\n- `cache`: cdn / origin cache-status distribution (count per status).\n- `cache_age`: p50/p75/p95 of the cache age per layer, in SECONDS (the\n  phases are milliseconds), plus the `content` layer = cdn + origin under a\n  CDN hit, which is the age of what the visitor actually saw.\n- `cache_ttl`: p50/p75/p95 of the remaining cache lifetime per layer, in\n  SECONDS, cdn and origin only.\n- `phases`: p50/p75/p95 of the eight backend-phase durations (NULLs\n  skipped), plus `count` = pageviews reporting the phase, so a percentile\n  over 12 pageviews is distinguishable from one over 50k.\n- `top_keys`: custom server-timing keys. Timed keys (`server_timing_dur`)\n  come first, ranked by p75; categorical keys that only ever carried a desc\n  (`server_timing_desc`, e.g. `pop;desc=\"DE-1331\"`) follow with p75_ms=None\n  and their top values. `limit` applies to each group, so the block holds at\n  most 2×limit items.\n\n**Requires:** `analytics:read`, held by every role.","operationId":"queryAnalyticsServerTiming","security":[{"bearerAuth":[]},{"oauth2":["analytics:read"]}],"parameters":[{"name":"org_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Org Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerTimingRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerTimingResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"400":{"description":"Bad Request - Invalid input","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"401":{"description":"Unauthorized - Invalid or missing authorization token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"},"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"404":{"description":"Not Found - Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"422":{"description":"Validation Error - Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"429":{"description":"Too Many Requests - Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"x-fastmon-permissions":["analytics:read"]}},"/organizations/{org_id}/analytics/fetch-xhr":{"post":{"tags":["analytics"],"summary":"Fetch and XHR panel","description":"FetchXhr (fetch/XHR) dashboard panel: three blocks.\n\n- `totals`: aggregate calls, errors, and worst-case duration.\n- `endpoints`: per-endpoint aggregates grouped by method/host/path (the\n  `other` rollup bucket is excluded, reflected only in totals), sorted by\n  impact.\n- `outliers`: the slowest individual calls.\n\n**Requires:** `analytics:read`, held by every role.","operationId":"queryAnalyticsFetchXhr","security":[{"bearerAuth":[]},{"oauth2":["analytics:read"]}],"parameters":[{"name":"org_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Org Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FetchXhrRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FetchXhrResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"400":{"description":"Bad Request - Invalid input","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"401":{"description":"Unauthorized - Invalid or missing authorization token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"},"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"404":{"description":"Not Found - Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"422":{"description":"Validation Error - Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"429":{"description":"Too Many Requests - Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"x-fastmon-permissions":["analytics:read"]}},"/organizations/{org_id}/analytics/fetch-xhr/detail":{"post":{"tags":["analytics"],"summary":"Detail for one fetch or XHR host","description":"Host (or endpoint) drill-down - the analogue of `/error-types/detail` (which\nkeys on `fingerprint`). Keyed by `host`; `method`/`path` are optional\nrefinements (omit for the whole host, give `path` for one endpoint).\n\nFour `ARRAY JOIN`s over one row per pageview (`pageviews_final`, or\n`beacons FINAL` for a realtime window, which folds the cumulative per-pvid\nstate), sharing one scope filter (`host` [+ method] [+ path]): a summary, the\nper-endpoint list (group by method/path), the per-page breakdown (group by\nthe beacon `url`) and the individual trace calls (`fetch_xhr_outliers`, with\nstatus + the page they ran on). No 037/L1 dependency - `url` lives on the\nsame row as the Nested columns. Status distribution beyond these trace\nsamples needs the Phase-2 per-endpoint status counters.\n\n**Requires:** `analytics:read`, held by every role.","operationId":"queryAnalyticsFetchXhrDetail","security":[{"bearerAuth":[]},{"oauth2":["analytics:read"]}],"parameters":[{"name":"org_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Org Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FetchXhrDetailRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FetchXhrDetailResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"400":{"description":"Bad Request - Invalid input","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"401":{"description":"Unauthorized - Invalid or missing authorization token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"},"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"404":{"description":"Not Found - Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"422":{"description":"Validation Error - Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"429":{"description":"Too Many Requests - Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"x-fastmon-permissions":["analytics:read"]}},"/organizations/{org_id}/analytics/loaf":{"post":{"tags":["analytics"],"summary":"Long Animation Frames","description":"Get Long Animation Frames (LoAF) data.\n\nTwo-part query:\n- Summary (`total_frames`, `avg_duration`) is sourced from the cheap\n  `loaf_count` / `loaf_total_duration` Phase-3 columns.\n- Per-script breakdown (`data`) ARRAY JOINs the `loaf` Nested.\n\n**Requires:** `analytics:read`, held by every role.","operationId":"queryAnalyticsLoAF","security":[{"bearerAuth":[]},{"oauth2":["analytics:read"]}],"parameters":[{"name":"org_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Org Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LoAFRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LoAFResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"400":{"description":"Bad Request - Invalid input","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"401":{"description":"Unauthorized - Invalid or missing authorization token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"},"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"404":{"description":"Not Found - Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"422":{"description":"Validation Error - Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"429":{"description":"Too Many Requests - Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"x-fastmon-permissions":["analytics:read"]}},"/organizations/{org_id}/analytics/funnels/checkout":{"post":{"tags":["analytics"],"summary":"Checkout funnel and its series","description":"The cart -> checkout -> success funnel and its series - observed facts only.\n\nEach visitor is counted once per step they reached at least once, in the\nbucket of their funnel ENTRY. The window totals are therefore exactly the\ncolumn sums of the series, which is why one query answers all of them.\n\n`conversion_rate` divides the last step by ALL visitors, not by the first\nstep. Against the cart step the number is unbounded, because a drawer\ncart, an express checkout or a deep link skips the cart. Everyone who was\non the site is a denominator no shop configuration can undercount, and it\nis the one every e-commerce benchmark is quoted against. How the funnel\nitself narrows is still reported, as `reach_rate` and\n`step_conversion_rate`, and those stay unclamped.\n\nBuyers are counted exactly from events, which are never sampled, and\nvisitors are estimated from the sampled RUM data. A step is reached\nthrough an event only, whatever its source, and a pageview's\n`checkout_stage` never counts.\n\nThe two halves are attributed differently, which shows at the window's\nedges: the steps count an entry COHORT (a run that entered on the last day\ncounts its success even if that success lands after the window), the\ndenominator counts window TRAFFIC. A visitor who entered the funnel the day\nbefore the window and succeeded inside it is therefore in the denominator\nand not in the numerator. The two edges pull in opposite directions and are\nbounded by the 24h stitch window either way.\n\n**Requires:** `analytics:read`, held by every role.","operationId":"queryAnalyticsCheckoutFunnel","security":[{"bearerAuth":[]},{"oauth2":["analytics:read"]}],"parameters":[{"name":"org_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Org Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckoutFunnelRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckoutFunnelResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"400":{"description":"Bad Request - Invalid input","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"401":{"description":"Unauthorized - Invalid or missing authorization token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"},"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"404":{"description":"Not Found - Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"422":{"description":"Validation Error - Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"429":{"description":"Too Many Requests - Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"x-fastmon-permissions":["analytics:read"]}},"/organizations/{org_id}/analytics/funnels/checkout/journeys":{"post":{"tags":["analytics"],"summary":"Journeys through one funnel stage","description":"The pageview journeys of the visitors who hit one funnel stage.\n\nTwo steps, because the second one has to be bounded by the first: pick the\nmost recent `limit` visitors that hit the stage inside the window, then\nread their pageviews back out of the same table (`full_journey=True`) or\njust the matching ones (`False`).\n\nThe read-back window is widened by +-24h so a journey that straddles the\nwindow edge comes back whole. It cannot need more than that: the stitch's\nsalt rotates daily, so no row older or newer than that belongs to the same\nvisitor anyway.\n\n**Requires:** `analytics:read`, held by every role.","operationId":"queryAnalyticsCheckoutJourneys","security":[{"bearerAuth":[]},{"oauth2":["analytics:read"]}],"parameters":[{"name":"org_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Org Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckoutJourneysRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckoutJourneysResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"400":{"description":"Bad Request - Invalid input","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"401":{"description":"Unauthorized - Invalid or missing authorization token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"},"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"404":{"description":"Not Found - Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"422":{"description":"Validation Error - Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"429":{"description":"Too Many Requests - Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"x-fastmon-permissions":["analytics:read"]}},"/organizations/{org_id}/analytics/funnels/checkout/cohorts":{"post":{"tags":["analytics"],"summary":"Buyers next to visitors who did not buy","description":"Buyers next to visitors whose purchase was never observed: vitals and cart calls.\n\nAnswers \"was the site slower for the people who did not finish\" - about the\nPEOPLE, so the vitals cover each cohort's whole journey, not only its funnel\npages. Per-stage numbers ride along for the page-level view.\n\n`checkout_no_success` is a cohort, not an abandonment count. It means no\nsuccess pageview was OBSERVED, and a real buyer falls into it whenever the\nsuccess is invisible: a payment redirect landing on a thank-you page\nwithout the tracker, a purchase finished after the 24h stitch rotation or\non another device, Shopify's off-site checkout. Comparing what was measured\nfor two observed groups is a fact; calling the second group lost is not.\n\n**Requires:** `analytics:read`, held by every role.","operationId":"queryAnalyticsCheckoutCohorts","security":[{"bearerAuth":[]},{"oauth2":["analytics:read"]}],"parameters":[{"name":"org_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Org Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckoutCohortsRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckoutCohortsResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"400":{"description":"Bad Request - Invalid input","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"401":{"description":"Unauthorized - Invalid or missing authorization token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"},"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"404":{"description":"Not Found - Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"422":{"description":"Validation Error - Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"429":{"description":"Too Many Requests - Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"x-fastmon-permissions":["analytics:read"]}},"/organizations/{org_id}/analytics/funnels/checkout/stages":{"post":{"tags":["analytics"],"summary":"Checkout stages per bucket, by hit time","description":"Visitors who reached each checkout stage, per bucket, at the time they reached it.\n\nThe trend and the tile the analytics page draws beside its pageview\nnumbers, counted from `events` alone.\n\nNOT the funnel's `timeseries.reached_by_stage`. That one counts an entry\nCOHORT over a window widened by 24h, so a purchase at 14:00 by a visitor\nwho entered at 09:00 lands in the 09:00 bucket. Here the requested range\napplies to the row's own time, and the window totals are distinct visitors over the window rather than the column\nsums of the series.\n\n`compare_to` takes a mode, a `{from, to}` window or a `{release_id}`,\nresolved as on /analytics/query.\n\n**Requires:** `analytics:read`, held by every role.","operationId":"queryAnalyticsCheckoutStages","security":[{"bearerAuth":[]},{"oauth2":["analytics:read"]}],"parameters":[{"name":"org_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Org Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckoutStagesRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckoutStagesResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"400":{"description":"Bad Request - Invalid input","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"401":{"description":"Unauthorized - Invalid or missing authorization token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"},"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"404":{"description":"Not Found - Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"422":{"description":"Validation Error - Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"429":{"description":"Too Many Requests - Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"x-fastmon-permissions":["analytics:read"]}},"/organizations/{org_id}/analytics/csp":{"post":{"tags":["analytics"],"summary":"Content Security Policy reports browsers sent","description":"Content Security Policy violations on the organization's sites.\n\nA site whose policy names fastmon in `report-to` or `report-uri` gets a\nreport from the browser for every script, style or request the policy\nblocked, or would have blocked under `Content-Security-Policy-Report-Only`.\nThe answer counts them over the window, per bucket, per directive and per\ndisposition.\n\nBeside each count stands `affected_visitors`, the distinct visitors behind\nit. A visitor is a non-zero `stitch`, so only sites with `store_stitch`\ncount them, and `meta.stitchless_site_ids` names the sites that do not.\n\nThe counts are the reports the browsers sent. The edge does not sample\nthem, so `meta.sampling` does not describe them. `disposition` tells\nblocked violations (`enforce`) from merely reported ones (`report`), and\n`''` counts the reports whose browser did not say.\n\nFilters: the site scope, `stitch`, the report's own `report_id`,\n`disposition`, `effective_directive`, `blocked_url`, `source_url`,\n`page_url` and `status_code_range`, and the edge-derived dimensions\n(`country`, `asn`, `device_type`, `browser`, `browser_version`, `os`,\n`bot_class`, `is_bot`, `is_datacenter`, `bot_name`, `bot_type`,\n`datacenter`, `ua_anomaly`), as well as `hour_of_day` on the report's own\ntime in `timezone`. `exclude` takes `disposition`,\n`effective_directive`, `blocked_url`, `source_url`, `page_url` and the\nnine edge labels. Any other filter is a 422 naming it, since an empty\nanswer would read as \"no violations\".\n\n**Requires:** `analytics:read`, held by every role.","operationId":"queryAnalyticsCsp","security":[{"bearerAuth":[]},{"oauth2":["analytics:read"]}],"parameters":[{"name":"org_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Org Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CspRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CspResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"400":{"description":"Bad Request - Invalid input","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"401":{"description":"Unauthorized - Invalid or missing authorization token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"},"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"404":{"description":"Not Found - Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"422":{"description":"Validation Error - Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"429":{"description":"Too Many Requests - Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"x-fastmon-permissions":["analytics:read"]}},"/organizations/{org_id}/analytics/csp/breakdown":{"post":{"tags":["analytics"],"summary":"CSP reports grouped by one dimension","description":"The reports of `POST /analytics/csp` grouped by one `dimension`.\n\nOne row per value with its `report_count`, its `affected_visitors`, its\n`share` of the reports of the whole answer, and `first_seen_at` and\n`last_seen_at`, the browser's time of its first and latest report in the\nwindow. `order_by` puts the most reports first by default, or the newest\ngroup first with `last_seen_at`, a tie by `key`. The filters and the\nlimits of the visitor count are those of the aggregate route.\n\n`blocked_url` answers which source a policy would break, `page_url` on\nwhich pages, `source_url` which script caused it, `stitch` which visitors.\nA key passed back to the filter of the same name selects its row, unless\nit holds a `*`, which the filter reads as a wildcard. A `stitch` key goes\nback as `filters.stitch: [key]`, a `status_code_range` key as\n`filters.status_code_range: {gte: key, lte: key}`. The empty key of\n`page_url`, `blocked_url` and `source_url` goes back as `\"\"` and selects\nthe reports without that URL. Reports without a `disposition`, a stitch\nor a status code form a row with an empty `key`, which no filter selects.\n\nA `site_id` row's `last_seen_at` tells whether a site's policy reaches\nfastmon at all.\n\n**Requires:** `analytics:read`, held by every role.","operationId":"queryAnalyticsCspBreakdown","security":[{"bearerAuth":[]},{"oauth2":["analytics:read"]}],"parameters":[{"name":"org_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Org Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CspBreakdownRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CspBreakdownResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"400":{"description":"Bad Request - Invalid input","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"401":{"description":"Unauthorized - Invalid or missing authorization token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"},"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"404":{"description":"Not Found - Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"422":{"description":"Validation Error - Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"429":{"description":"Too Many Requests - Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"x-fastmon-permissions":["analytics:read"]}},"/organizations/{org_id}/analytics/csp/reports":{"post":{"tags":["analytics"],"summary":"List single CSP reports","description":"The reports of `POST /analytics/csp` one by one, newest first.\n\nOne row per stored report: when and on which page the policy broke, what\nit blocked, which directive, the script behind it, the visitor and the\nedge labels. `report_count` says how many identical reports of one upload\nthe row stands for. The filters are those of the aggregate route.\n\nCursor paginated over `(timestamp, id)`, with no total. `visitor_id` is\nabsent where the report carries no stitch.\n\n**Requires:** `analytics:read`, held by every role.","operationId":"listAnalyticsCspReports","security":[{"bearerAuth":[]},{"oauth2":["analytics:read"]}],"parameters":[{"name":"org_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Org Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CspReportsRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CursorPaginatedResponse_CspReportRow_"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"400":{"description":"Bad Request - Invalid input","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"401":{"description":"Unauthorized - Invalid or missing authorization token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"},"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"404":{"description":"Not Found - Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"422":{"description":"Validation Error - Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"429":{"description":"Too Many Requests - Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"x-fastmon-permissions":["analytics:read"]}},"/organizations/{org_id}/analytics/element-targets":{"post":{"tags":["analytics"],"summary":"Rank the elements behind LCP, CLS and INP","description":"Rank the attributed elements (CSS selector paths) for lcp / cls / inp.\n\n**Requires:** `analytics:read`, held by every role.","operationId":"queryAnalyticsElementTargets","security":[{"bearerAuth":[]},{"oauth2":["analytics:read"]}],"parameters":[{"name":"org_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Org Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ElementTargetsRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ElementTargetsResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"400":{"description":"Bad Request - Invalid input","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"401":{"description":"Unauthorized - Invalid or missing authorization token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"},"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"404":{"description":"Not Found - Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"422":{"description":"Validation Error - Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"429":{"description":"Too Many Requests - Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"x-fastmon-permissions":["analytics:read"]}},"/organizations/{org_id}/analytics/error-types":{"post":{"tags":["analytics"],"summary":"Break errors down by signature","description":"Get breakdown of error signatures from collected beacons.\n\nReads the structured `errors` Nested column. Each beacon stores up to 5\n(type, count, sample_message, frame_hosts, frame_lines, frame_cols,\nfingerprint, is_first_party) entries; we ARRAY JOIN and aggregate by\n`fingerprint`, the canonical server-computed signature key.\n\nDisplay projections such as `error_type` are aggregated via `any()`,\nsince the fingerprint hashes those exact inputs. The frames are the\nexception, see the query.\n\n`compare_to` takes a mode, a `{from, to}` window or a `{release_id}`, and\nadds each row's count over that window as `comparison`.\n\n**Requires:** `analytics:read`, held by every role.","operationId":"queryAnalyticsErrorTypes","security":[{"bearerAuth":[]},{"oauth2":["analytics:read"]}],"parameters":[{"name":"org_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Org Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorTypesRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorTypesResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"400":{"description":"Bad Request - Invalid input","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"401":{"description":"Unauthorized - Invalid or missing authorization token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"},"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"404":{"description":"Not Found - Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"422":{"description":"Validation Error - Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"429":{"description":"Too Many Requests - Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"x-fastmon-permissions":["analytics:read"]}},"/organizations/{org_id}/analytics/error-types/detail":{"post":{"tags":["analytics"],"summary":"Detail for one error signature","description":"Drill-down for a single error signature, keyed by `fingerprint`.\n\nReturns summary stats, a time series, top-N breakdowns across the requested\ndimensions, and recent sample beacons, all in one request.\n\n**Requires:** `analytics:read`, held by every role.","operationId":"queryAnalyticsErrorDetail","security":[{"bearerAuth":[]},{"oauth2":["analytics:read"]}],"parameters":[{"name":"org_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Org Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorDetailRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorDetailResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"400":{"description":"Bad Request - Invalid input","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"401":{"description":"Unauthorized - Invalid or missing authorization token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"},"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"404":{"description":"Not Found - Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"422":{"description":"Validation Error - Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"429":{"description":"Too Many Requests - Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"x-fastmon-permissions":["analytics:read"]}},"/organizations/{org_id}/analytics/error-types/correlated-requests":{"post":{"tags":["analytics"],"summary":"Requests that fail alongside an error","description":"Which fetch/XHR endpoints fail in the pageviews this error signature fires in.\n\nAnswers the detail-less rejection: the error carries no message and no\nframe, the failing request carries the URL, the method and the status. The\ntwo are never linked per event, so the answer is a correlation with a\nbaseline, and the response says so.\n\n**Requires:** `analytics:read`, held by every role.","operationId":"queryAnalyticsErrorCorrelatedRequests","security":[{"bearerAuth":[]},{"oauth2":["analytics:read"]}],"parameters":[{"name":"org_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Org Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CorrelatedRequestsRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CorrelatedRequestsResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"400":{"description":"Bad Request - Invalid input","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"401":{"description":"Unauthorized - Invalid or missing authorization token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"},"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"404":{"description":"Not Found - Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"422":{"description":"Validation Error - Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"429":{"description":"Too Many Requests - Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"x-fastmon-permissions":["analytics:read"]}},"/organizations/{org_id}/analytics/error-types/symbolicate":{"post":{"tags":["analytics"],"summary":"Resolve an error's frames to a code location","description":"Resolve the stack frames of one error signature to a code location.\n\nSeparate from `/error-types/detail` on purpose. It leaves the process to\nfetch the customer's bundle, so it is slower than every other analytics\nread and it fails in ways the drill-down must survive. The dashboard asks\nfor it after the detail has rendered, and a frame that cannot be resolved\ncomes back with a status rather than an error.\n\n**Requires:** `analytics:read`, held by every role.","operationId":"queryAnalyticsErrorSymbolication","security":[{"bearerAuth":[]},{"oauth2":["analytics:read"]}],"parameters":[{"name":"org_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Org Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorSymbolicationRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorSymbolicationResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"400":{"description":"Bad Request - Invalid input","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"401":{"description":"Unauthorized - Invalid or missing authorization token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"},"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"404":{"description":"Not Found - Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"422":{"description":"Validation Error - Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"429":{"description":"Too Many Requests - Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"x-fastmon-permissions":["analytics:read"]}},"/organizations/{org_id}/analytics/events":{"post":{"tags":["analytics"],"summary":"List events","description":"List the events of this organization, newest first.\n\nThe row-level view of the events: the Shopify checkout pixel's steps, the\nstage events the collector derives from checkout pageviews, and the events\na shop sends itself. One row is one event: when it happened, its name, its\nprops, its stage where the name has one, the site, the visitor and the\nedge-derived dimensions. Use it to hold a test order against the shop's\norder list, or to check what an event of your own carries.\n\nCursor paginated over `(timestamp, pvid, seq, site_id)`. An empty page with no cursor\nmeans no event matched, including on an installation whose `events` table\nthe operator has not created yet. `event_id` addresses the row for\nPATCH and DELETE /sites/{site_id}/events/{event_id}, and an edit or a delete\nshows here at once.\n\n**Requires:** `analytics:read`, held by every role.","operationId":"listAnalyticsEvents","security":[{"bearerAuth":[]},{"oauth2":["analytics:read"]}],"parameters":[{"name":"org_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Org Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventsRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CursorPaginatedResponse_EventRow_"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"400":{"description":"Bad Request - Invalid input","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"401":{"description":"Unauthorized - Invalid or missing authorization token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"},"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"404":{"description":"Not Found - Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"422":{"description":"Validation Error - Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"429":{"description":"Too Many Requests - Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"x-fastmon-permissions":["analytics:read"]}},"/organizations/{org_id}/analytics/events/overview":{"post":{"tags":["analytics"],"summary":"Count events per name, over time, as value sums, as orders and per prop value","description":"The events of a window counted, the overview beside the row list.\n\n`names` lists the most frequent names with their visitors, their first\nand last event and their events per page view, `series` the events per\nbucket with the same names broken out and the bucket's `order_revenue`,\nwhich add up to the window's. `derived_names` lists the stage events the\ncollector derives from checkout page views, one per page view, which\nevery other figure leaves out. `value_sums` sums the `value` prop\nper event name and `currency` prop, where `value` reads as a number, and\nnames the funnel stage of each name. That is no revenue: a `view_item`\nsums item prices. `order_revenue` is the money: per currency, one value per\npageview with an `order_placed` or `purchase` event, the largest of them.\nEach row carries its `average_order_value` and its `revenue_per_visitor`\nover the visitors of `POST /analytics/funnels/checkout`.\nNothing is converted between currencies, and nothing checks that\n`currency` is an ISO code. `prop_keys` lists the keys carried by the most\nevents with their most frequent values, array positions folded into one\nkey. Name one event in `names` to read its own props.\n\nEvents are never sampled, so every count is exact. `visitor_share`,\n`events_per_pageview` and the revenue per visitor divide by the page\nviews and visitors, which are estimates on a sampled application. The\nfilters are the ones of `POST /analytics/events`, and a filter without a\ncolumn on the events table is a 422. `hour_of_day` reads the event's own\ntime in `timezone`. `compare_to` adds the counts, the visitors, the orders\nand the series of a second window as `comparison`, and the figures of\neach name over that window as its own `comparison`.\n\n**Requires:** `analytics:read`, held by every role.","operationId":"getAnalyticsEventsOverview","security":[{"bearerAuth":[]},{"oauth2":["analytics:read"]}],"parameters":[{"name":"org_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Org Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventsOverviewRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventsOverviewResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"400":{"description":"Bad Request - Invalid input","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"401":{"description":"Unauthorized - Invalid or missing authorization token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"},"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"404":{"description":"Not Found - Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"422":{"description":"Validation Error - Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"429":{"description":"Too Many Requests - Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"x-fastmon-permissions":["analytics:read"]}},"/organizations/{org_id}/analytics/events/breakdown":{"post":{"tags":["analytics"],"summary":"The events of one name grouped by one dimension","description":"The events of one sent `name` grouped by one `dimension`.\n\nOne row per value with its `event_count` and its `share` of the events of\nthe whole answer, the most events first and a tie by `key`. `meta.total`\nis the number of values before `limit` cuts them. `page_type` and\n`page_url` group by the page the event was sent from, `device_type` by\nthe edge label. `next_event` groups by the name of the visit's next sent\nevent, the stitch's next event on any page up to 24 hours past the\nwindow, and counts only the events of `name` with a stitch. The filters\nare those of `POST /analytics/events/overview` and narrow the events of\n`name`, never the event after them. The empty key holds the events\nwithout a value, for `next_event` those with no event after them. The\ncount, the series and the hours of the name are the overview's with\n`names: [name]`.\n\n**Requires:** `analytics:read`, held by every role.","operationId":"queryAnalyticsEventsBreakdown","security":[{"bearerAuth":[]},{"oauth2":["analytics:read"]}],"parameters":[{"name":"org_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Org Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventBreakdownRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventBreakdownResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"400":{"description":"Bad Request - Invalid input","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"401":{"description":"Unauthorized - Invalid or missing authorization token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"},"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"404":{"description":"Not Found - Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"422":{"description":"Validation Error - Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"429":{"description":"Too Many Requests - Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"x-fastmon-permissions":["analytics:read"]}},"/organizations/{org_id}/analytics/experience-score":{"post":{"tags":["analytics"],"summary":"Experience score per visitor segment","description":"Compute experience scores per visitor segment.\n\nReturns letter grades (A+ through F) and numeric scores (0.0-10.0)\nfor Desktop, Mobile, Slow Connections, and All Visitors.\n\n**Requires:** `analytics:read`, held by every role.","operationId":"queryAnalyticsExperienceScore","security":[{"bearerAuth":[]},{"oauth2":["analytics:read"]}],"parameters":[{"name":"org_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Org Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExperienceScoreRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExperienceScoreResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"401":{"description":"Unauthorized - Invalid or missing authorization token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"},"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"403":{"description":"Forbidden - Insufficient permissions","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"404":{"description":"Not Found - Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"422":{"description":"Validation Error - Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"429":{"description":"Too Many Requests - Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"x-fastmon-permissions":["analytics:read"]}},"/organizations/{org_id}/analytics/failed-resources":{"post":{"tags":["analytics"],"summary":"Resources that failed to load","description":"Resources that failed to load, grouped by host and path.\n\nThe host of the failing resource is always there. Its path is not: stack\nframes are opt-in per site and off by default, and without them a path is\nkept only when the resource is served from the page host itself. A resource\non the shop's own CDN subdomain therefore counts as first party but still\narrives host-only.\n\n`count` is the number of failed loads, `pageviews` the pageviews they\nhappened on.\n\n**Requires:** `analytics:read`, held by every role.","operationId":"queryAnalyticsFailedResources","security":[{"bearerAuth":[]},{"oauth2":["analytics:read"]}],"parameters":[{"name":"org_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Org Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FailedResourcesRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FailedResourcesResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"400":{"description":"Bad Request - Invalid input","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"401":{"description":"Unauthorized - Invalid or missing authorization token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"},"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"404":{"description":"Not Found - Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"422":{"description":"Validation Error - Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"429":{"description":"Too Many Requests - Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"x-fastmon-permissions":["analytics:read"]}},"/organizations/{org_id}/analytics/failed-resources/detail":{"post":{"tags":["analytics"],"summary":"Detail for one failed resource","description":"Drill-down for a single failed resource, keyed by `fingerprint`.\n\nThe mirror of `/analytics/error-types/detail` for the other population, and\ndeliberately the same shape: summary, time series, top-N breakdowns and\nrecent samples in one request. It is a separate route rather than a mode of\nthe error one because the two differ in the only place that matters, the\ndenominator: a share of the JavaScript `error_count` is meaningless for a\nsignal that migration 073 took out of that count.\n\n`count` and `pageviews` mean what they mean on the list endpoint next to\nit, on purpose.\n\n**Requires:** `analytics:read`, held by every role.","operationId":"queryAnalyticsFailedResourceDetail","security":[{"bearerAuth":[]},{"oauth2":["analytics:read"]}],"parameters":[{"name":"org_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Org Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FailedResourceDetailRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FailedResourceDetailResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"400":{"description":"Bad Request - Invalid input","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"401":{"description":"Unauthorized - Invalid or missing authorization token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"},"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"404":{"description":"Not Found - Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"422":{"description":"Validation Error - Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"429":{"description":"Too Many Requests - Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"x-fastmon-permissions":["analytics:read"]}},"/organizations/{org_id}/analytics/goals/factors":{"post":{"tags":["analytics"],"summary":"Features of a visit against the rest, by order rate","description":"Every value of every dimension of a visit, with the goal rate of its visitors and of the rest.\n\nA visitor is one stitch whose first pageview lies in the window, read over\nthe window widened by the stitch's 24 hours as the checkout funnel reads\nit. The goal is an event of that stitch: one of a checkout stage or one by\nname, an order where `goal` is absent. `base` narrows the visitors the\nsame way, and equal to `goal` is a 422.\nEvery number is weighted by the visitor's sampling, so on a sampled\napplication all of them are estimates.\n\nThe values nearly every goal visitor has are the steps of the goal and\nleave the factors for `steps`. `order_by.field` defaults to\n`confident_reached_delta`, the goal visitors a group surely has above or\nbelow the rest's rate. `lift` orders by the absolute of its logarithm.\n\n**Requires:** `analytics:read`, held by every role.","operationId":"queryAnalyticsGoalFactors","security":[{"bearerAuth":[]},{"oauth2":["analytics:read"]}],"parameters":[{"name":"org_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Org Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoalFactorsRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoalFactorsResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"400":{"description":"Bad Request - Invalid input","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"401":{"description":"Unauthorized - Invalid or missing authorization token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"},"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"404":{"description":"Not Found - Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"422":{"description":"Validation Error - Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"429":{"description":"Too Many Requests - Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"x-fastmon-permissions":["analytics:read"]}},"/organizations/{org_id}/analytics/histogram":{"post":{"tags":["analytics"],"summary":"Distribution of one metric","description":"Get histogram distribution for a metric.\n\n**Metrics:** lcp, fcp, cls, inp, ttfb, tbt, dns_lookup, tcp_connection, etc.\n\n**Buckets:** Define boundaries as array, e.g., [0, 500, 1000, 2500, 4000]\ncreates buckets: <0, 0-500, 500-1000, 1000-2500, 2500-4000, 4000+\n\n**Comparison:** `compare_to` takes a mode, a `{from, to}` window or a\n`{release_id}`, resolved as on /analytics/query. The same edges over that\nwindow come back as `comparison`, its shares of its own samples.\n\n**Example for LCP histogram:**\n```json\n{\n    \"time_range\": {\"from\": \"2024-01-01\", \"to\": \"2024-01-08\"},\n    \"metric\": \"lcp\",\n    \"buckets\": [0, 500, 1000, 2500, 4000]\n}\n```\n\n**Requires:** `analytics:read`, held by every role.","operationId":"queryAnalyticsHistogram","security":[{"bearerAuth":[]},{"oauth2":["analytics:read"]}],"parameters":[{"name":"org_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Org Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HistogramRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HistogramResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"400":{"description":"Bad Request - Invalid input","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"401":{"description":"Unauthorized - Invalid or missing authorization token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"},"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"404":{"description":"Not Found - Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"422":{"description":"Validation Error - Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"429":{"description":"Too Many Requests - Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"x-fastmon-permissions":["analytics:read"]}},"/organizations/{org_id}/analytics/live-summary":{"post":{"tags":["analytics"],"summary":"Summarize the traffic around the live floor","description":"Traffic per page type, today's totals, LCP per page type and the floor's shares.\n\nThe traffic blocks count the requested window, 5 minutes by default. The\nother blocks keep their own. Each block has its own server cache, so every\ntab of a scope shares one entry per block. `meta.next_poll_ms` sets the cadence.\n\n**Requires:** `analytics:read`, held by every role.","operationId":"queryAnalyticsLiveSummary","security":[{"bearerAuth":[]},{"oauth2":["analytics:read"]}],"parameters":[{"name":"org_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Org Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LiveSummaryRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LiveSummaryResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"400":{"description":"Bad Request - Invalid input","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"401":{"description":"Unauthorized - Invalid or missing authorization token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"},"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"404":{"description":"Not Found - Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"422":{"description":"Validation Error - Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"429":{"description":"Too Many Requests - Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"x-fastmon-permissions":["analytics:read"]}},"/organizations/{org_id}/analytics/metric-summary":{"post":{"tags":["analytics"],"summary":"Summarize a metric page in a few sentences","description":"The sentences of a metric page's summary box, and the numbers they rest on.\n\nThe text is plain and already in the requested language. A part with a\n`section` names the page section that shows its evidence. `facts` carries\nthe numbers, so the tiles above the box read the same values. Every\nstatement is served from the analytics result cache, the rendering is not\ncached.\n\n`compare_to` takes a mode, a `{from, to}` window or a `{release_id}`,\nresolved as on /analytics/query, and picks the window of\n`facts.comparison`. Set in any form, the sentences say what changed\nagainst that window instead of how the metric stands. Unset, the window is\n`previous_period` and the sentences are the plain ones.\n\n**Requires:** `analytics:read`, held by every role.","operationId":"queryAnalyticsMetricSummary","security":[{"bearerAuth":[]},{"oauth2":["analytics:read"]}],"parameters":[{"name":"org_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Org Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MetricSummaryRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MetricSummaryResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"400":{"description":"Bad Request - Invalid input","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"401":{"description":"Unauthorized - Invalid or missing authorization token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"},"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"404":{"description":"Not Found - Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"422":{"description":"Validation Error - Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"429":{"description":"Too Many Requests - Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"x-fastmon-permissions":["analytics:read"]}},"/organizations/{org_id}/analytics/nel":{"post":{"tags":["analytics"],"summary":"Network Error Logging reports browsers sent","description":"Failed requests to the organization's sites, from Network Error Logging reports.\n\nA site that sends the `Report-To` and `NEL` headers gets a report from a\nChromium browser for every request that failed, including pages that never\nloaded and so never ran the tracker. The answer counts them over the\nwindow, per bucket, per error type, per HTTP status code and per host and\npath.\n\nBeside each count stands `affected_visitors`, the distinct visitors behind\nit, and per error type the percentiles of the time until the failure. A\nvisitor is a non-zero `stitch`, so only sites with `store_stitch` count\nthem, and `meta.stitchless_site_ids` names the sites that do not.\n\nEvery count is weighted by `1 / sampling_fraction`, the share of failures\nthe site's `NEL` header asks browsers to report. `meta.sampling` describes\nthat failure sampling and not the application's rate: `is_sampled` is true\nwhen a report of the window was sampled below 1.0, and `estimated_metrics`\nthen names the weighted fields. A status code of 0 means the request got no\nHTTP response.\n\nFilters: the site scope, `stitch`, the report's own `report_id`,\n`error_type`, `nel_class`, `status_code_range`, `host`, `path` and\n`page_url`, and the edge-derived\ndimensions (`country`, `asn`, `device_type`, `browser`, `os`, `bot_class`,\n`is_bot`, `is_datacenter`, `bot_name`, `bot_type`, `datacenter`,\n`ua_anomaly`), as well as `hour_of_day` on the report's own time in\n`timezone`. `exclude` takes `error_type`, `nel_class`, `host`,\n`path`, `page_url` and the eight edge labels. Any other filter is a 422 naming it, since an\nempty answer would read as \"no errors\". An entry of `paths` is a `host`\nand a `path` value that together match exactly it. Without an\n`error_type` filter every type counts, `abandoned` included: a visitor who left while a\nrequest loaded, which every site has. `exclude: {\"error_type\": [\"abandoned\"]}`\nleaves it out of every count and the path list. `nel_class` has\nno default either.\n\n**Requires:** `analytics:read`, held by every role.","operationId":"queryAnalyticsNel","security":[{"bearerAuth":[]},{"oauth2":["analytics:read"]}],"parameters":[{"name":"org_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Org Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NelRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NelResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"400":{"description":"Bad Request - Invalid input","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"401":{"description":"Unauthorized - Invalid or missing authorization token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"},"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"404":{"description":"Not Found - Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"422":{"description":"Validation Error - Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"429":{"description":"Too Many Requests - Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"x-fastmon-permissions":["analytics:read"]}},"/organizations/{org_id}/analytics/nel/breakdown":{"post":{"tags":["analytics"],"summary":"NEL reports grouped by one dimension","description":"The reports of `POST /analytics/nel` grouped by one `dimension`.\n\nOne row per value with its weighted `error_count`, its `affected_visitors`,\nits `share` of the weighted reports of the whole answer, and\n`first_seen_at` and `last_seen_at`, the browser's time of its first and\nlatest report in the window. `order_by` puts the most weighted reports\nfirst by default, or the newest group first with `last_seen_at`, a tie by\n`key`. The filters, the weighting, `meta.sampling` and the limits of the\nvisitor count are those of the aggregate route.\n\nEvery key but those of `phase`, `method` and `protocol`, which have no\nfilter, is a filter value that selects its row's reports. `page_url`\ngroups by the page the failed request was sent from, as stored. Reports\nwithout one form a row with an empty `key`, which `filters.page_url: \"\"`\nselects. The same holds for the empty `path` key, and a `request_url` key\nwithout a `/` goes back with `filters.path: \"\"`. A `page_url` or `path`\nkey holding `*` is read by its filter as a wildcard. `host`, `bot_name`\nand `error_type` keys go back as one-value lists of the filter of the same\nname. A `stitch` key goes back as `filters.stitch: [key]`, a\n`status_code_range` key as `filters.status_code_range: {gte: key, lte:\nkey}`. A `request_url` key is host and path in one, and splits at its\nfirst `/` into `filters.host: [host]` and `filters.path: path`. Reports\nwithout a stitch or without an HTTP response form the row with the empty\nkey of these dimensions, which no filter selects.\n\nA `site_id` row's `last_seen_at` tells whether a site's `NEL` header\nreaches browsers.\n\n**Requires:** `analytics:read`, held by every role.","operationId":"queryAnalyticsNelBreakdown","security":[{"bearerAuth":[]},{"oauth2":["analytics:read"]}],"parameters":[{"name":"org_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Org Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NelBreakdownRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NelBreakdownResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"400":{"description":"Bad Request - Invalid input","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"401":{"description":"Unauthorized - Invalid or missing authorization token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"},"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"404":{"description":"Not Found - Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"422":{"description":"Validation Error - Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"429":{"description":"Too Many Requests - Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"x-fastmon-permissions":["analytics:read"]}},"/organizations/{org_id}/analytics/nel/reports":{"post":{"tags":["analytics"],"summary":"List single NEL reports","description":"The reports of `POST /analytics/nel` one by one, newest first.\n\nOne row per report as stored: when and where the request failed, how, the\npage it was sent from, the visitor and the edge labels. The rows are not\nweighted, and `failure_sampling_rate` says how many failures each one\nstands for. The filters are those of the aggregate route.\n\nCursor paginated over `(timestamp, id)`, with no total. `visitor_id` is\nabsent where the report carries no stitch.\n\n**Requires:** `analytics:read`, held by every role.","operationId":"listAnalyticsNelReports","security":[{"bearerAuth":[]},{"oauth2":["analytics:read"]}],"parameters":[{"name":"org_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Org Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NelReportsRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CursorPaginatedResponse_NelReportRow_"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"400":{"description":"Bad Request - Invalid input","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"401":{"description":"Unauthorized - Invalid or missing authorization token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"},"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"404":{"description":"Not Found - Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"422":{"description":"Validation Error - Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"429":{"description":"Too Many Requests - Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"x-fastmon-permissions":["analytics:read"]}},"/organizations/{org_id}/analytics/query":{"post":{"tags":["analytics"],"summary":"Run an analytics query","description":"Execute a flexible analytics query against RUM data.\n\n**Metrics:** lcp, fcp, cls, inp, ttfb, tbt, page_load_time, requests,\n`visitors` (distinct visitors; `identity`=stitch|session picks the backing\nidentifier, stitch preferred), etc.\n\n**Aggregations:** count, avg, p50, p75, p90, p95, p99, min, max, sum, and\nfor lcp, inp, cls, ttfb, fcp and page_load_time good_share,\nneeds_improvement_share and poor_share: the part of the page views that\nreported the metric in that web vitals rating, 0..1.\n\n**Grouping:** By time intervals (hour, day, week, month) and/or dimensions\n(browser, device_type, country, etc.)\n\n**Filters:** site_id, browser, device_type, country, url (with wildcards), etc.\n\n**Comparison:** `compare_to` takes a mode (previous_period, previous_day,\nprevious_week, previous_month), a `{from, to}` window of any length, or a\n`{release_id}` whose window starts at that release. The resolved window is\nechoed as `request.comparison_time_range`. `compare_to_release_id` is\ndeprecated.\n\n**Limits:**\n- Time range up to the organization's `history_days`, 90 or 395 days\n- Max 20 metrics per query\n- Max 2 GROUP BY dimensions\n- Max 10,000 rows per response\n\n**Requires:** `analytics:read`, held by every role.","operationId":"queryAnalytics","security":[{"bearerAuth":[]},{"oauth2":["analytics:read"]}],"parameters":[{"name":"org_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Org Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnalyticsQueryRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnalyticsQueryResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"400":{"description":"Bad Request - Invalid input","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"401":{"description":"Unauthorized - Invalid or missing authorization token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"},"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"404":{"description":"Not Found - Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"422":{"description":"Validation Error - Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"429":{"description":"Too Many Requests - Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"x-fastmon-permissions":["analytics:read"]}},"/organizations/{org_id}/analytics/sparse-hours":{"post":{"tags":["analytics"],"summary":"Find the hours of a window with too few page views","description":"The thin hours of a window and the threshold in page views that makes them thin.\n\nThe raw page views are counted per whole, complete UTC hour of the window,\nan hour without any counts 0. A cut, running or unfinalized hour is not\njudged. With `share` the threshold is the nearest-rank quantile of\nthose counts at that share, at least 30 raw measurements. With\n`min_pageviews` it is that number. An hour below the threshold is thin.\nOne call per page and window: every card of the page then applies the same\n`min_pageviews`.\n\n**Requires:** `analytics:read`, held by every role.","operationId":"queryAnalyticsSparseHours","security":[{"bearerAuth":[]},{"oauth2":["analytics:read"]}],"parameters":[{"name":"org_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Org Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SparseHoursRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SparseHoursResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"400":{"description":"Bad Request - Invalid input","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"401":{"description":"Unauthorized - Invalid or missing authorization token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"},"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"404":{"description":"Not Found - Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"422":{"description":"Validation Error - Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"429":{"description":"Too Many Requests - Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"x-fastmon-permissions":["analytics:read"]}},"/organizations/{org_id}/analytics/visitors":{"post":{"tags":["analytics"],"summary":"List visitors","description":"List visitors with summary stats, grouped by the resolved `identity`\n(stitch - preferred - or session).\n\nEach row is one visitor: page count, duration, device info, average\nperformance, the visit's pageviews as `journey` and its `outcome`. Cursor\npaginated, ordered by (start_time DESC, id DESC). The full pageview record\nof one visitor is `/visitors/detail`.\n\n**Requires:** `analytics:read`, held by every role.","operationId":"listAnalyticsVisitors","security":[{"bearerAuth":[]},{"oauth2":["analytics:read"]}],"parameters":[{"name":"org_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Org Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VisitorsListRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CursorPaginatedResponse_VisitorSummaryItem_"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"400":{"description":"Bad Request - Invalid input","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"401":{"description":"Unauthorized - Invalid or missing authorization token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"},"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"422":{"description":"Validation Error - Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"429":{"description":"Too Many Requests - Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"x-fastmon-permissions":["analytics:read"]}},"/organizations/{org_id}/analytics/visitors/segments":{"post":{"tags":["analytics"],"summary":"Count the visitors of each list segment","description":"How many visitors each fixed segment of the list holds.\n\nOne statement over the visitors grouped the way `/visitors` groups them,\nthen a `sumIf` of the visitor weight per segment. A visitor counts with\nthe weight of its loosest kept row, as in the pageview stats. On an\nunsampled application a chip's count is the row count its click produces,\non a sampled one it is the weighted estimate of that count.\n\nA scope that collects neither identifier has no visitor grain, the 404\nthe pageview stats answer too.\n\n**Requires:** `analytics:read`, held by every role.","operationId":"listAnalyticsVisitorSegments","security":[{"bearerAuth":[]},{"oauth2":["analytics:read"]}],"parameters":[{"name":"org_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Org Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VisitorSegmentsRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VisitorSegmentsResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"400":{"description":"Bad Request - Invalid input","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"401":{"description":"Unauthorized - Invalid or missing authorization token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"},"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"404":{"description":"Not Found - Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"422":{"description":"Validation Error - Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"429":{"description":"Too Many Requests - Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"x-fastmon-permissions":["analytics:read"]}},"/organizations/{org_id}/analytics/visitors/detail":{"post":{"tags":["analytics"],"summary":"One visitor's page visits","description":"Get all page visits for one visitor, ordered chronologically.\n\nReturns one row per page view with URL, start and end time, navigation\ntype, and performance metrics.\n\nNeeds a per-visitor identifier: `identity=session` or `identity=stitch`\n(whichever the site collects - the caller passes the same identity the\nvisitor list used). A site collecting neither (the `minimal` posture) simply\nhas no visitors to drill into. Any other identity value is rejected with 422.\n\n`events` carries the visitor's checkout events beside the pages, for the\nclient to interleave by time. Absent when they were not consulted, see the\nfield description. `nel_reports` does\nthe same for the visitor's Network Error Logging reports, and\n`csp_reports` for their Content Security Policy reports.\n\nUnder `identity=stitch` an `id` that is not 32 hex, or is the all-zero\nstitch, answers an empty detail. The same answer an unknown visitor gets,\nbecause that is what it is.\n\n**Requires:** `analytics:read`, held by every role.","operationId":"getAnalyticsVisitorDetail","security":[{"bearerAuth":[]},{"oauth2":["analytics:read"]}],"parameters":[{"name":"org_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Org Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VisitorDetailRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VisitorDetailResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"400":{"description":"Bad Request - Invalid input","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"401":{"description":"Unauthorized - Invalid or missing authorization token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"},"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"404":{"description":"Not Found - Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"422":{"description":"Validation Error - Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"429":{"description":"Too Many Requests - Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"x-fastmon-permissions":["analytics:read"]}},"/metric-thresholds":{"get":{"tags":["analytics"],"summary":"List Metric Thresholds","description":"The good and poor cutoff of every metric fastmon rates, with the source of each pair.\n\nA value equal to `good` rates good. A value equal to `poor` still needs improvement:\npoor starts strictly beyond it. A metric missing from the list is not rated.\n\n**Requires:** any credential. No organization permission applies.","operationId":"listMetricThresholds","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MetricThresholdsResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"401":{"description":"Unauthorized - Invalid or missing authorization token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"},"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"429":{"description":"Too Many Requests - Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"security":[{"bearerAuth":[]},{"oauth2":[]}],"x-fastmon-permissions":[]}},"/organizations/{org_id}/synthetic/pages":{"get":{"tags":["synthetic"],"summary":"List Org Synthetic Pages","description":"List monitored pages across all sites of the org (manual first, then auto).\n\nOrg-scoped twin of `list_synthetic_pages`: `SyntheticPage` has no\n`organization_id`, so scope is resolved by joining `sites.organization_id`;\neach row still carries its own `site_id`. Optional `site_id` narrows to one\nsite. `summary=true` attaches the cached latest-result health snapshot per\npage (concurrency-capped), same as the site-scoped list.\n\n**Requires:** `synthetic:read`, held by every role.","operationId":"listOrgSyntheticPages","security":[{"bearerAuth":[]},{"oauth2":["synthetic:read"]}],"parameters":[{"name":"org_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Org Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."},{"name":"site_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"description":"Optional: restrict to one site","title":"Site Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"Optional: restrict to one site"},{"name":"source","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/SyntheticPageSource"},{"type":"null"}],"description":"Filter by manual/auto","title":"Source"},"description":"Filter by manual/auto"},{"name":"q","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":2048},{"type":"null"}],"description":"Substring match on URL","title":"Q"},"description":"Substring match on URL"},{"name":"summary","in":"query","required":false,"schema":{"type":"boolean","description":"Attach the latest-result health summary per page","default":false,"title":"Summary"},"description":"Attach the latest-result health summary per page"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":50,"title":"Limit"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0,"title":"Offset"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedResponse_SyntheticPageListItem_"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"401":{"description":"Unauthorized - Invalid or missing authorization token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"},"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"404":{"description":"Not Found - Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"422":{"description":"Validation Error - Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"429":{"description":"Too Many Requests - Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"x-fastmon-permissions":["synthetic:read"]}},"/sites/{site_id}/synthetic/pages":{"post":{"tags":["synthetic"],"summary":"Create Synthetic Page","description":"Create a synthetic page (URL normalized + must be under the site domain).\n\nRegistering the CS site always kicks off exactly one immediate analysis - you\ncan't create a CS site without it running once - so even a paused page\n(`schedule=false`) produces this one creation run; its id is returned so the\nclient polls `analyses/{commerce_score_analysis_id}/status` instead of firing a\nredundant `run`.\n\n`mode=monitor` (default) is a sticky, quota-counted page honoring the schedule\nflags. `mode=oneshot` is an unbudgeted \"measure now\": schedules forced off,\n`nocache` forced true, and a missing creation-run id is fatal (502) rather than\ntolerated - the run *is* the deliverable. A one-shot stays viewable via the normal\ndetail/run endpoints and can be promoted later via PATCH (source→manual + schedule).\n\nOne-shot is intentionally **unbounded** (no quota) - note the cost: CS has no\nreliable teardown, so each one-shot on a *new* URL leaves a CS site we can't reap.\nAdd a cap here once CS supports teardown.\n\n**Requires:** `synthetic:read` and `synthetic:write`, held by the member and owner roles. An app connection is refused.","operationId":"createSyntheticPage","security":[{"bearerAuth":[]}],"parameters":[{"name":"site_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Site Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SyntheticPageCreate"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SyntheticPageCreateResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"401":{"description":"Unauthorized - Invalid or missing authorization token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"},"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"403":{"description":"Forbidden - Insufficient permissions","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"404":{"description":"Not Found - Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"409":{"description":"Conflict - Resource already exists or operation not allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"422":{"description":"Validation Error - Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"429":{"description":"Too Many Requests - Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"x-fastmon-permissions":["synthetic:read","synthetic:write"]},"get":{"tags":["synthetic"],"summary":"List Synthetic Pages","description":"List monitored pages (manual first, then auto by rank). Paginated + filterable.\nWith `summary=true`, each row carries its latest-result score/last-run (one\nbackend call per page, cached) - avoids the client doing N result calls.\n\n**Requires:** `synthetic:read`, held by every role.","operationId":"listSyntheticPages","security":[{"bearerAuth":[]},{"oauth2":["synthetic:read"]}],"parameters":[{"name":"site_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Site Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."},{"name":"source","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/SyntheticPageSource"},{"type":"null"}],"description":"Filter by manual/auto","title":"Source"},"description":"Filter by manual/auto"},{"name":"q","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":2048},{"type":"null"}],"description":"Substring match on URL","title":"Q"},"description":"Substring match on URL"},{"name":"summary","in":"query","required":false,"schema":{"type":"boolean","description":"Attach the latest-result health summary per page","default":false,"title":"Summary"},"description":"Attach the latest-result health summary per page"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":50,"title":"Limit"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0,"title":"Offset"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedResponse_SyntheticPageListItem_"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"401":{"description":"Unauthorized - Invalid or missing authorization token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"},"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"404":{"description":"Not Found - Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"422":{"description":"Validation Error - Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"429":{"description":"Too Many Requests - Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"x-fastmon-permissions":["synthetic:read"]}},"/sites/{site_id}/synthetic/summary":{"get":{"tags":["synthetic"],"summary":"Get Synthetic Summary","description":"Site-wide overview: a per-page sparkline (recent per-run scores + run count)\nplus the aggregate latest score across pages and total run count.\n\nBuilt live from the 1h-cached per-page series - no stored aggregate, so CS stays\nthe single source of truth. Concurrency-capped like the list summary.\n\n**Requires:** `synthetic:read`, held by every role.","operationId":"getSyntheticSummary","security":[{"bearerAuth":[]},{"oauth2":["synthetic:read"]}],"parameters":[{"name":"site_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Site Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SyntheticSummaryResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"401":{"description":"Unauthorized - Invalid or missing authorization token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"},"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"404":{"description":"Not Found - Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"422":{"description":"Validation Error - Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"429":{"description":"Too Many Requests - Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"x-fastmon-permissions":["synthetic:read"]}},"/sites/{site_id}/synthetic/auto/refresh":{"post":{"tags":["synthetic"],"summary":"Refresh Auto Pages","description":"Populate auto pages from the site's Top-N RUM URLs (additive in v1).\n\n**Requires:** `synthetic:read` and `synthetic:write`, held by the member and owner roles. An app connection is refused.","operationId":"refreshSyntheticAutoPages","security":[{"bearerAuth":[]}],"parameters":[{"name":"site_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Site Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SyntheticPageResponse"},"title":"Response Refreshsyntheticautopages"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"401":{"description":"Unauthorized - Invalid or missing authorization token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"},"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"404":{"description":"Not Found - Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"422":{"description":"Validation Error - Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"429":{"description":"Too Many Requests - Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"x-fastmon-permissions":["synthetic:read","synthetic:write"]}},"/sites/{site_id}/synthetic/pages/{page_id}":{"patch":{"tags":["synthetic"],"summary":"Update Synthetic Page","description":"Update monitoring config: `schedule`, `ttfb_schedule`, `nocache`.\n\nTurning a schedule off pushes the new schedule state to CS; `schedule=false`\npauses the recurring Lighthouse run (the page stays and is still runnable on\ndemand). Turning it back on restores the recurring run. `nocache` toggles CS\ncache-bypass for the page's future runs (it is persisted and applied on the\nnext trigger; a `nocache`-only change does not itself fire a new CS run).\n\n**Requires:** `synthetic:read` and `synthetic:write`, held by the member and owner roles. An app connection is refused.","operationId":"updateSyntheticPage","security":[{"bearerAuth":[]}],"parameters":[{"name":"page_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Page Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."},{"name":"site_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Site Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SyntheticPageUpdate"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SyntheticPageResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"401":{"description":"Unauthorized - Invalid or missing authorization token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"},"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"404":{"description":"Not Found - Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"422":{"description":"Validation Error - Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"429":{"description":"Too Many Requests - Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"x-fastmon-permissions":["synthetic:read","synthetic:write"]},"delete":{"tags":["synthetic"],"summary":"Delete Synthetic Page","description":"Delete a monitored page. Tears down the CS site (stops its schedules) via\nthe provider's delete endpoint; if that call fails the local page is still\nremoved and the CS site is flagged cs_orphan for later reconciliation.\n\n**Requires:** `synthetic:delete` and `synthetic:read`, held by the member and owner roles. An app connection is refused.","operationId":"deleteSyntheticPage","security":[{"bearerAuth":[]}],"parameters":[{"name":"page_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Page Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."},{"name":"site_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Site Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."}],"responses":{"204":{"description":"Successful Response","headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"401":{"description":"Unauthorized - Invalid or missing authorization token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"},"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"404":{"description":"Not Found - Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"422":{"description":"Validation Error - Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"429":{"description":"Too Many Requests - Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"x-fastmon-permissions":["synthetic:delete","synthetic:read"]}},"/sites/{site_id}/synthetic/pages/{page_id}/run":{"post":{"tags":["synthetic"],"summary":"Run Synthetic Page","description":"Trigger an on-demand analysis (the run completes asynchronously at CS).\n\nAlways allowed for an existing page - a paused page (`schedule=false`) can still\nbe run on demand; the page's recurring schedules are preserved on the rerun.\nUses the page's `nocache` setting unless the `nocache` query param overrides it\nfor this single run.\n\n**Requires:** `synthetic:read` and `synthetic:run`, held by the member and owner roles.","operationId":"runSyntheticPage","security":[{"bearerAuth":[]},{"oauth2":["synthetic:read","synthetic:run"]}],"parameters":[{"name":"page_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Page Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."},{"name":"site_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Site Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."},{"name":"nocache","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Override cache-busting for this run; omit to use the page's `nocache` setting. true = bust the page's CDN cache (fresh origin fetch), false = measure with normal CDN caching.","title":"Nocache"},"description":"Override cache-busting for this run; omit to use the page's `nocache` setting. true = bust the page's CDN cache (fresh origin fetch), false = measure with normal CDN caching."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SyntheticRunResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"401":{"description":"Unauthorized - Invalid or missing authorization token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"},"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"404":{"description":"Not Found - Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"422":{"description":"Validation Error - Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"429":{"description":"Too Many Requests - Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"x-fastmon-permissions":["synthetic:read","synthetic:run"]}},"/sites/{site_id}/synthetic/pages/{page_id}/analyses/{commerce_score_analysis_id}/status":{"get":{"tags":["synthetic"],"summary":"Get Synthetic Analysis Status","description":"Progress of an in-flight analysis (for run UX). Not cached - status changes\nwhile the run is in progress.\n\nWhen the run reports done, we drop the page's 1h overview caches (sparkline +\nlatest summary) so the just-finished run shows up immediately - our only\ninvalidation signal, since CS has no completion webhook.\n\n**Requires:** `synthetic:read`, held by every role.","operationId":"getSyntheticAnalysisStatus","security":[{"bearerAuth":[]},{"oauth2":["synthetic:read"]}],"parameters":[{"name":"page_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Page Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."},{"name":"commerce_score_analysis_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Commerce Score Analysis Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."},{"name":"site_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Site Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SyntheticAnalysisStatus"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"401":{"description":"Unauthorized - Invalid or missing authorization token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"},"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"404":{"description":"Not Found - Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"422":{"description":"Validation Error - Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"429":{"description":"Too Many Requests - Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"x-fastmon-permissions":["synthetic:read"]}},"/sites/{site_id}/synthetic/pages/{page_id}/results":{"get":{"tags":["synthetic"],"summary":"List Synthetic Results","description":"Fetch synthetic-monitoring result history for a page, shaped to our\nasset-free schema.\n\n**Requires:** `synthetic:read`, held by every role.","operationId":"listSyntheticResults","security":[{"bearerAuth":[]},{"oauth2":["synthetic:read"]}],"parameters":[{"name":"page_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Page Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."},{"name":"site_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Site Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."},{"name":"result_type","in":"query","required":false,"schema":{"type":"string","pattern":"^(cs|ttfb|all)$","default":"cs","title":"Result Type"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":10,"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SyntheticResultsResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"401":{"description":"Unauthorized - Invalid or missing authorization token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"},"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"404":{"description":"Not Found - Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"422":{"description":"Validation Error - Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"429":{"description":"Too Many Requests - Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"x-fastmon-permissions":["synthetic:read"]}},"/sites/{site_id}/synthetic/pages/{page_id}/runs":{"get":{"tags":["synthetic"],"summary":"List Synthetic Runs","description":"Lightweight run list backing the run-selector: per-run id + timestamp +\nper-device score only - no scores[]/ttfb/curation, so the selector payload stays\nsmall. Fetched live from CS (the system of record); pick a run, then use its\n`commerce_score_analysis_id` on the detail endpoints.\n\n**Requires:** `synthetic:read`, held by every role.","operationId":"listSyntheticRuns","security":[{"bearerAuth":[]},{"oauth2":["synthetic:read"]}],"parameters":[{"name":"page_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Page Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."},{"name":"site_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Site Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":20,"title":"Limit"}},{"name":"from","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":64},{"type":"null"}],"description":"ISO 8601 lower bound","title":"From"},"description":"ISO 8601 lower bound"},{"name":"to","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":64},{"type":"null"}],"description":"ISO 8601 upper bound","title":"To"},"description":"ISO 8601 upper bound"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SyntheticRunsResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"401":{"description":"Unauthorized - Invalid or missing authorization token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"},"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"404":{"description":"Not Found - Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"422":{"description":"Validation Error - Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"429":{"description":"Too Many Requests - Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"x-fastmon-permissions":["synthetic:read"]}},"/sites/{site_id}/synthetic/pages/{page_id}/lab-vs-field":{"get":{"tags":["synthetic"],"summary":"Get Lab Vs Field","description":"Compare a CS lab run against RUM field p75, per device. The comparison axis is\nthe lab-measurable CWV (LCP/FCP/CLS/TTFB); INP is field-only (shown beside the lab\nTBT proxy). Also returns the CS lab CommerceScore and our field Experience Score\nside by side. Latest run unless a run id is given; field reflects `window_days`.\n\n**Requires:** `synthetic:read`, held by every role.","operationId":"getSyntheticLabVsField","security":[{"bearerAuth":[]},{"oauth2":["synthetic:read"]}],"parameters":[{"name":"page_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Page Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."},{"name":"site_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Site Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."},{"name":"window_days","in":"query","required":false,"schema":{"type":"integer","maximum":90,"minimum":1,"default":7,"title":"Window Days"}},{"name":"commerce_score_analysis_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"description":"Target a specific run; default latest","title":"Commerce Score Analysis Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"Target a specific run; default latest"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LabVsFieldResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"401":{"description":"Unauthorized - Invalid or missing authorization token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"},"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"404":{"description":"Not Found - Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"422":{"description":"Validation Error - Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"429":{"description":"Too Many Requests - Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"x-fastmon-permissions":["synthetic:read"]}},"/sites/{site_id}/synthetic/pages/{page_id}/ttfb":{"get":{"tags":["synthetic"],"summary":"Get Synthetic Ttfb","description":"Diagnose TTFB: CS server-side phase breakdown vs RUM field p75, classifying\nserver-bound vs network/geo-bound. CS phases are per-page; field p75 per device.\nLatest run unless a run id is given.\n\n**Requires:** `synthetic:read`, held by every role.","operationId":"getSyntheticTtfb","security":[{"bearerAuth":[]},{"oauth2":["synthetic:read"]}],"parameters":[{"name":"page_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Page Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."},{"name":"site_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Site Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."},{"name":"window_days","in":"query","required":false,"schema":{"type":"integer","maximum":90,"minimum":1,"default":7,"title":"Window Days"}},{"name":"commerce_score_analysis_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"description":"Target a specific run; default latest","title":"Commerce Score Analysis Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"Target a specific run; default latest"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TtfbDiagnosisResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"401":{"description":"Unauthorized - Invalid or missing authorization token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"},"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"404":{"description":"Not Found - Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"422":{"description":"Validation Error - Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"429":{"description":"Too Many Requests - Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"x-fastmon-permissions":["synthetic:read"]}},"/sites/{site_id}/synthetic/pages/{page_id}/timeseries":{"get":{"tags":["synthetic"],"summary":"Get Synthetic Timeseries","description":"Chart series for the device: sparse `lab` points (one per CS Lighthouse run,\nscore + CWV from that run's scores[]) and raw `ttfb` points (one per dedicated\n5-min TTFB run, full DNS→transfer phases) overlaid on the regular `field` p75 line\n(RUM). `lab.ttfb` is Lighthouse's server-only TTFB; the `ttfb` series is the full\nphase breakdown - different measurements, kept in separate series. The `ttfb`\nseries is device-independent (CS measures TTFB once per run).\n\n`series` selects which to compute - only the requested ones are fetched; the rest\nreturn as empty lists.\n\n**Requires:** `synthetic:read`, held by every role.","operationId":"getSyntheticTimeseries","security":[{"bearerAuth":[]},{"oauth2":["synthetic:read"]}],"parameters":[{"name":"page_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Page Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."},{"name":"site_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Site Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."},{"name":"device_type","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/SyntheticDeviceType"},{"type":"null"}],"description":"The device class to answer for. Defaults to `desktop`.","title":"Device Type"},"description":"The device class to answer for. Defaults to `desktop`."},{"name":"window_days","in":"query","required":false,"schema":{"type":"integer","maximum":90,"minimum":1,"default":30,"title":"Window Days"}},{"name":"granularity","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/BucketGranularity"},{"type":"null"}],"description":"Bucket width of the `field` series: `hour` or `day`. Defaults to `day`.","title":"Granularity"},"description":"Bucket width of the `field` series: `hour` or `day`. Defaults to `day`."},{"name":"series","in":"query","required":false,"schema":{"type":"string","maxLength":64,"description":"Comma-separated subset of lab,ttfb,field to compute. Unrequested series come back empty; use it to skip the expensive TTFB pull when unneeded. An empty/blank value means all series.","default":"lab,ttfb,field","title":"Series"},"description":"Comma-separated subset of lab,ttfb,field to compute. Unrequested series come back empty; use it to skip the expensive TTFB pull when unneeded. An empty/blank value means all series."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TimeseriesResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"401":{"description":"Unauthorized - Invalid or missing authorization token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"},"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"404":{"description":"Not Found - Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"422":{"description":"Validation Error - Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"429":{"description":"Too Many Requests - Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"x-fastmon-permissions":["synthetic:read"]}},"/sites/{site_id}/synthetic/pages/{page_id}/lighthouse":{"get":{"tags":["synthetic"],"summary":"Get Synthetic Lighthouse","description":"Curated Lighthouse report (latest run unless a run id is given): category\nscores, metrics, opportunities, and native LH audit objects for waterfall /\nthird-party /\nresource-summary / filmstrip / main-thread).\n\n**Requires:** `synthetic:read`, held by every role.","operationId":"getSyntheticLighthouse","security":[{"bearerAuth":[]},{"oauth2":["synthetic:read"]}],"parameters":[{"name":"page_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Page Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."},{"name":"site_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Site Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."},{"name":"device_type","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/SyntheticDeviceType"},{"type":"null"}],"description":"The device class to answer for. Defaults to `desktop`.","title":"Device Type"},"description":"The device class to answer for. Defaults to `desktop`."},{"name":"commerce_score_analysis_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"description":"Target a specific run; default latest","title":"Commerce Score Analysis Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"Target a specific run; default latest"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LighthouseReportResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"401":{"description":"Unauthorized - Invalid or missing authorization token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"},"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"404":{"description":"Not Found - Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"422":{"description":"Validation Error - Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"429":{"description":"Too Many Requests - Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"x-fastmon-permissions":["synthetic:read"]}},"/sites/{site_id}/synthetic/pages/{page_id}/lighthouse/raw":{"get":{"tags":["synthetic"],"summary":"Get Synthetic Lighthouse Raw","description":"The complete, unshaped Lighthouse report for a run + device (~250KB; latest\nunless a run id is given). Use the smaller `/lighthouse` unless you need it.\n\n**Requires:** `synthetic:read`, held by every role.","operationId":"getSyntheticLighthouseRaw","security":[{"bearerAuth":[]},{"oauth2":["synthetic:read"]}],"parameters":[{"name":"page_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Page Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."},{"name":"site_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Site Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."},{"name":"device_type","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/SyntheticDeviceType"},{"type":"null"}],"description":"The device class to answer for. Defaults to `desktop`.","title":"Device Type"},"description":"The device class to answer for. Defaults to `desktop`."},{"name":"commerce_score_analysis_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"description":"Target a specific run; default latest","title":"Commerce Score Analysis Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"Target a specific run; default latest"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Getsyntheticlighthouseraw"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"401":{"description":"Unauthorized - Invalid or missing authorization token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"},"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"404":{"description":"Not Found - Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"422":{"description":"Validation Error - Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"429":{"description":"Too Many Requests - Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"x-fastmon-permissions":["synthetic:read"]}},"/sites/{site_id}/synthetic/pages/{page_id}/lighthouse/summary":{"get":{"tags":["synthetic"],"summary":"Get Stored Lighthouse Summary","description":"Read-only: the stored AI summary for a run (latest unless `analysis_uuid`), or\n**404** if none has been generated yet. NEVER generates - no LLM call, no rate-limit\ncost - so the UI can decide between a \"View\" and a \"Generate\" affordance without\ntriggering (and paying for) generation. Use `POST` to actually generate.\n\nRun resolution is the same domain-guarded, cached path the other Lighthouse routes\nuse (so a foreign run id can't be read); only the LLM work is skipped.\n\n**Requires:** `synthetic:read`, held by every role.","operationId":"getStoredSyntheticLighthouseSummary","security":[{"bearerAuth":[]},{"oauth2":["synthetic:read"]}],"parameters":[{"name":"page_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Page Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."},{"name":"site_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Site Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."},{"name":"device_type","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/SyntheticDeviceType"},{"type":"null"}],"description":"The device class to answer for. Defaults to `desktop`.","title":"Device Type"},"description":"The device class to answer for. Defaults to `desktop`."},{"name":"language","in":"query","required":false,"schema":{"type":"string","pattern":"^(en|de)$","default":"en","title":"Language"}},{"name":"commerce_score_analysis_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"description":"Target a specific run; default latest","title":"Commerce Score Analysis Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"Target a specific run; default latest"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LighthouseSummaryResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"401":{"description":"Unauthorized - Invalid or missing authorization token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"},"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"403":{"description":"Forbidden - Insufficient permissions","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"404":{"description":"Not Found - Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"422":{"description":"Validation Error - Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"429":{"description":"Too Many Requests - Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"x-fastmon-permissions":["synthetic:read"]},"post":{"tags":["synthetic"],"summary":"Get Synthetic Lighthouse Summary","description":"An AI summary of a page's Lighthouse run (latest unless a run id is given).\n\nGenerated once per (run, device): English first, then translated to German, and\n**both stored** in `lighthouse_summaries` - a completed run is immutable, so repeat\nrequests are served from the DB (`cached=true`) at no LLM cost. Requires the org's\nAI to be enabled (`require_ai_enabled`).\n\n**Requires:** `ai:ask` and `synthetic:read`, held by the member and owner roles. An app connection is refused.","operationId":"getSyntheticLighthouseSummary","security":[{"bearerAuth":[]}],"parameters":[{"name":"page_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Page Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."},{"name":"site_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Site Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."},{"name":"device_type","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/SyntheticDeviceType"},{"type":"null"}],"description":"The device class to answer for. Defaults to `desktop`.","title":"Device Type"},"description":"The device class to answer for. Defaults to `desktop`."},{"name":"language","in":"query","required":false,"schema":{"type":"string","pattern":"^(en|de)$","default":"en","title":"Language"}},{"name":"commerce_score_analysis_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"description":"Target a specific run; default latest","title":"Commerce Score Analysis Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"Target a specific run; default latest"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LighthouseSummaryResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"401":{"description":"Unauthorized - Invalid or missing authorization token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"},"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"403":{"description":"Forbidden - Insufficient permissions","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"404":{"description":"Not Found - Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"429":{"description":"Too Many Requests - Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"422":{"description":"Validation Error - Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"x-fastmon-permissions":["ai:ask","synthetic:read"]}},"/organizations/{org_id}/observations":{"get":{"tags":["observations"],"summary":"List the organization's observations","description":"The organization's observations, the newest first.\n\nNarrow the list by kind, direction, metric, status, application or a\nwindow. Pass `status=open` for what is going on now and\n`direction=better` for the highlights.\n\n**Requires:** `issue:read`, held by every role.","operationId":"listObservations","security":[{"bearerAuth":[]},{"oauth2":["issue:read"]}],"parameters":[{"name":"org_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Org Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."},{"name":"kind","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/ObservationKind"},{"type":"null"}],"description":"Only shifts or only trends.","title":"Kind"},"description":"Only shifts or only trends."},{"name":"direction","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/ObservationDirection"},{"type":"null"}],"description":"Only problems, only highlights or only neutral information.","title":"Direction"},"description":"Only problems, only highlights or only neutral information."},{"name":"metric","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/ObservationMetric"},{"type":"null"}],"description":"Only this metric.","title":"Metric"},"description":"Only this metric."},{"name":"status","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/ObservationStatus"},{"type":"null"}],"description":"Only open, only acknowledged or only ended observations.","title":"Status"},"description":"Only open, only acknowledged or only ended observations."},{"name":"application_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Application Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."},{"name":"from","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"Inclusive start of the window the observation overlaps.","title":"From","examples":["2026-04-14T09:50:01Z"]},"description":"Inclusive start of the window the observation overlaps."},{"name":"to","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"Exclusive end of the window the observation overlaps.","title":"To","examples":["2026-04-14T09:50:01Z"]},"description":"Exclusive end of the window the observation overlaps."},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0,"title":"Offset"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":50,"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedResponse_ObservationResponse_"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"401":{"description":"Unauthorized - Invalid or missing authorization token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"},"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"403":{"description":"Forbidden - Insufficient permissions","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"404":{"description":"Not Found - Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"422":{"description":"Validation Error - Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"429":{"description":"Too Many Requests - Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"x-fastmon-permissions":["issue:read"]}},"/observations/{observation_id}":{"get":{"tags":["observations"],"summary":"Get one observation","description":"One observation with its occurrences and evidence.\n\n**Requires:** `issue:read`, held by every role.","operationId":"getObservation","security":[{"bearerAuth":[]},{"oauth2":["issue:read"]}],"parameters":[{"name":"observation_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Observation Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ObservationResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"401":{"description":"Unauthorized - Invalid or missing authorization token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"},"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"403":{"description":"Forbidden - Insufficient permissions","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"404":{"description":"Not Found - Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"422":{"description":"Validation Error - Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"429":{"description":"Too Many Requests - Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"x-fastmon-permissions":["issue:read"]},"patch":{"tags":["observations"],"summary":"Acknowledge an observation or leave a note on it","description":"The observation after acknowledging it, taking that back or setting its note.\n\n**Requires:** `observation:write`, held by the member and owner roles.","operationId":"updateObservation","security":[{"bearerAuth":[]},{"oauth2":["observation:write"]}],"parameters":[{"name":"observation_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Observation Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ObservationUpdate"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ObservationResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"401":{"description":"Unauthorized - Invalid or missing authorization token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"},"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"403":{"description":"Forbidden - Insufficient permissions","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"404":{"description":"Not Found - Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"422":{"description":"Validation Error - Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"429":{"description":"Too Many Requests - Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"x-fastmon-permissions":["observation:write"]}},"/organizations/{org_id}/error-acknowledgements":{"post":{"tags":["analytics"],"summary":"Acknowledge an error signature","description":"The acknowledgement of the fault a fingerprint of the last 30 days belongs to.\n\n**Requires:** `observation:write`, held by the member and owner roles.","operationId":"createErrorAcknowledgement","security":[{"bearerAuth":[]},{"oauth2":["observation:write"]}],"parameters":[{"name":"org_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Org Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorAcknowledgementCreate"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorAcknowledgementResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"200":{"description":"The signature was already acknowledged. The existing row.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorAcknowledgementResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"401":{"description":"Unauthorized - Invalid or missing authorization token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"},"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"403":{"description":"Forbidden - Insufficient permissions","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"404":{"description":"Not Found - Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"422":{"description":"Validation Error - Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"429":{"description":"Too Many Requests - Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"x-fastmon-permissions":["observation:write"]},"get":{"tags":["analytics"],"summary":"List the organization's acknowledged error signatures","description":"The organization's acknowledgements, the newest first.\n\n**Requires:** `issue:read`, held by every role.","operationId":"listErrorAcknowledgements","security":[{"bearerAuth":[]},{"oauth2":["issue:read"]}],"parameters":[{"name":"org_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Org Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0,"title":"Offset"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":50,"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedResponse_ErrorAcknowledgementResponse_"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"401":{"description":"Unauthorized - Invalid or missing authorization token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"},"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"403":{"description":"Forbidden - Insufficient permissions","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"404":{"description":"Not Found - Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"422":{"description":"Validation Error - Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"429":{"description":"Too Many Requests - Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"x-fastmon-permissions":["issue:read"]}},"/error-acknowledgements/{acknowledgement_id}":{"get":{"tags":["analytics"],"summary":"Get one error acknowledgement","description":"One acknowledgement with its key and note.\n\n**Requires:** `issue:read`, held by every role.","operationId":"getErrorAcknowledgement","security":[{"bearerAuth":[]},{"oauth2":["issue:read"]}],"parameters":[{"name":"acknowledgement_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Acknowledgement Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorAcknowledgementResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"401":{"description":"Unauthorized - Invalid or missing authorization token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"},"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"403":{"description":"Forbidden - Insufficient permissions","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"404":{"description":"Not Found - Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"422":{"description":"Validation Error - Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"429":{"description":"Too Many Requests - Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"x-fastmon-permissions":["issue:read"]},"patch":{"tags":["analytics"],"summary":"Change the note of an error acknowledgement","description":"Set the note, or remove it with `null`. An absent note stays as it is.\n\n**Requires:** `observation:write`, held by the member and owner roles.","operationId":"updateErrorAcknowledgement","security":[{"bearerAuth":[]},{"oauth2":["observation:write"]}],"parameters":[{"name":"acknowledgement_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Acknowledgement Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorAcknowledgementUpdate"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorAcknowledgementResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"401":{"description":"Unauthorized - Invalid or missing authorization token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"},"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"403":{"description":"Forbidden - Insufficient permissions","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"404":{"description":"Not Found - Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"422":{"description":"Validation Error - Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"429":{"description":"Too Many Requests - Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"x-fastmon-permissions":["observation:write"]},"delete":{"tags":["analytics"],"summary":"Reopen an error signature","description":"Remove the acknowledgement, so the signature reads as open again.\n\n**Requires:** `observation:write`, held by the member and owner roles.","operationId":"deleteErrorAcknowledgement","security":[{"bearerAuth":[]},{"oauth2":["observation:write"]}],"parameters":[{"name":"acknowledgement_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Acknowledgement Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."}],"responses":{"204":{"description":"Successful Response","headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"401":{"description":"Unauthorized - Invalid or missing authorization token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"},"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"403":{"description":"Forbidden - Insufficient permissions","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"404":{"description":"Not Found - Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"422":{"description":"Validation Error - Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"429":{"description":"Too Many Requests - Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"x-fastmon-permissions":["observation:write"]}},"/organizations/{org_id}/notifications/rules":{"get":{"tags":["notifications"],"summary":"List notification rules","description":"List the organization's notification rules, newest first, with their targets.\n\n**Requires:** `notification:read`, held by every role.","operationId":"listNotificationRules","security":[{"bearerAuth":[]},{"oauth2":["notification:read"]}],"parameters":[{"name":"org_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Org Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0,"title":"Offset"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":50,"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedResponse_RuleResponse_"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"401":{"description":"Unauthorized - Invalid or missing authorization token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"},"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"404":{"description":"Not Found - Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"422":{"description":"Validation Error - Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"429":{"description":"Too Many Requests - Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"x-fastmon-permissions":["notification:read"]},"post":{"tags":["notifications"],"summary":"Create a notification rule","description":"Create a rule on a production application of the organization, posting to\nits channels and mailing its members.\n\n**Requires:** `notification:write`, held by the owner role. An app connection is refused.","operationId":"createNotificationRule","security":[{"bearerAuth":[]}],"parameters":[{"name":"org_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Org Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RuleCreate"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RuleResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"401":{"description":"Unauthorized - Invalid or missing authorization token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"},"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"404":{"description":"Not Found - Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"422":{"description":"Validation Error - Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"429":{"description":"Too Many Requests - Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"x-fastmon-permissions":["notification:write"]}},"/organizations/{org_id}/notifications/rules/preview":{"post":{"tags":["notifications"],"summary":"Preview a notification rule over past data","description":"Replay a rule shape, saved or not, over the past days as the worker\nwould have evaluated it: one bucket per window, the last ending now, each\ncompared like an evaluation at its end, and the firing messages counted\nafter re-notify. Powers the chart in the rule editor.\n\n**Requires:** `notification:read`, held by every role.","operationId":"previewNotificationRule","security":[{"bearerAuth":[]},{"oauth2":["notification:read"]}],"parameters":[{"name":"org_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Org Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RulePreviewRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RulePreviewResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"401":{"description":"Unauthorized - Invalid or missing authorization token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"},"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"404":{"description":"Not Found - Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"422":{"description":"Validation Error - Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"429":{"description":"Too Many Requests - Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"x-fastmon-permissions":["notification:read"]}},"/organizations/{org_id}/notifications/channels":{"get":{"tags":["notifications"],"summary":"List notification channels","description":"List the organization's Slack, Discord and webhook channels, oldest first.\nURLs are shortened and secrets masked.\n\n**Requires:** `notification:read`, held by every role.","operationId":"listNotificationChannels","security":[{"bearerAuth":[]},{"oauth2":["notification:read"]}],"parameters":[{"name":"org_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Org Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0,"title":"Offset"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":50,"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedResponse_ChannelResponse_"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"401":{"description":"Unauthorized - Invalid or missing authorization token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"},"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"404":{"description":"Not Found - Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"422":{"description":"Validation Error - Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"429":{"description":"Too Many Requests - Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"x-fastmon-permissions":["notification:read"]},"post":{"tags":["notifications"],"summary":"Create a notification channel","description":"Create a Slack, Discord or webhook channel. The URL must resolve to a\npublic address, else the answer is 422. A webhook channel gets a generated\nsigning secret, which this answer carries in full and none after it.\n\n**Requires:** `notification:write`, held by the owner role.","operationId":"createNotificationChannel","security":[{"bearerAuth":[]},{"oauth2":["notification:write"]}],"parameters":[{"name":"org_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Org Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChannelCreate"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChannelResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"401":{"description":"Unauthorized - Invalid or missing authorization token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"},"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"404":{"description":"Not Found - Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"422":{"description":"Validation Error - Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"429":{"description":"Too Many Requests - Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"x-fastmon-permissions":["notification:write"]}},"/organizations/{org_id}/notifications/subscriptions":{"get":{"tags":["notifications"],"summary":"List observation subscriptions","description":"List which channels receive which observations of which application,\noldest first. Partner access sees the organization's own observations alone.\n\n**Requires:** `notification:read`, held by every role.","operationId":"listObservationSubscriptions","security":[{"bearerAuth":[]},{"oauth2":["notification:read"]}],"parameters":[{"name":"org_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Org Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0,"title":"Offset"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":50,"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedResponse_ObservationSubscriptionResponse_"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"401":{"description":"Unauthorized - Invalid or missing authorization token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"},"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"404":{"description":"Not Found - Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"422":{"description":"Validation Error - Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"429":{"description":"Too Many Requests - Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"x-fastmon-permissions":["notification:read"]},"post":{"tags":["notifications"],"summary":"Subscribe a channel to observations","description":"Post the observations of one application, or of every one without\n`application_id`, to a channel of the organization, the worse ones unless\n`directions` says otherwise. The observations are the organization's own,\nthose of one partner client with `client_organization_id`, or those of\nevery client with `all_clients`.\n\n**Requires:** `notification:write`, held by the owner role.","operationId":"createObservationSubscription","security":[{"bearerAuth":[]},{"oauth2":["notification:write"]}],"parameters":[{"name":"org_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Org Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ObservationSubscriptionCreate"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ObservationSubscriptionResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"401":{"description":"Unauthorized - Invalid or missing authorization token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"},"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"403":{"description":"Forbidden - Insufficient permissions","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"404":{"description":"Not Found - Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"409":{"description":"Conflict - Resource already exists or operation not allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"422":{"description":"Validation Error - Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"429":{"description":"Too Many Requests - Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"x-fastmon-permissions":["notification:write"]}},"/notifications/rules/metadata":{"get":{"tags":["notifications"],"summary":"List notification rule inputs","description":"Every metric, aggregation, filter dimension and window a rule can name.\nA static catalog, the same for every organization.\n\n**Requires:** any credential. No organization permission applies.","operationId":"getNotificationRuleMetadata","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MetadataResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"401":{"description":"Unauthorized - Invalid or missing authorization token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"},"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"429":{"description":"Too Many Requests - Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"security":[{"bearerAuth":[]},{"oauth2":[]}],"x-fastmon-permissions":[]}},"/notifications/rules/presets":{"get":{"tags":["notifications"],"summary":"List rule presets","description":"The ready-made rules the editor starts from. The user adds the\napplication and the targets. A static catalog and a bare list.\n\n**Requires:** any credential. No organization permission applies.","operationId":"listNotificationRulePresets","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/PresetResponse"},"type":"array","title":"Response Listnotificationrulepresets"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"401":{"description":"Unauthorized - Invalid or missing authorization token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"},"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"429":{"description":"Too Many Requests - Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"security":[{"bearerAuth":[]},{"oauth2":[]}],"x-fastmon-permissions":[]}},"/notifications/rules/{rule_id}":{"get":{"tags":["notifications"],"summary":"Get a notification rule","description":"Fetch one rule with its targets.\n\n**Requires:** `notification:read`, held by every role.","operationId":"getNotificationRule","security":[{"bearerAuth":[]},{"oauth2":["notification:read"]}],"parameters":[{"name":"rule_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Rule Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RuleResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"401":{"description":"Unauthorized - Invalid or missing authorization token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"},"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"404":{"description":"Not Found - Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"422":{"description":"Validation Error - Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"429":{"description":"Too Many Requests - Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"x-fastmon-permissions":["notification:read"]},"patch":{"tags":["notifications"],"summary":"Update a notification rule","description":"Change a rule's name, state, comparison, window, filters, re-notify\ncadence or targets. Application, site, metric, aggregation, identity and\ncondition type are fixed, another one is a new rule. A target list sent\nreplaces the stored one. Switching a rule on starts it from a clear state,\nso a condition that already holds fires on the next evaluation.\n\n**Requires:** `notification:write`, held by the owner role.","operationId":"updateNotificationRule","security":[{"bearerAuth":[]},{"oauth2":["notification:write"]}],"parameters":[{"name":"rule_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Rule Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RuleUpdate"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RuleResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"401":{"description":"Unauthorized - Invalid or missing authorization token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"},"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"404":{"description":"Not Found - Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"422":{"description":"Validation Error - Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"429":{"description":"Too Many Requests - Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"x-fastmon-permissions":["notification:write"]},"delete":{"tags":["notifications"],"summary":"Delete a notification rule","description":"Delete a rule with its targets, state and send history. Cannot be undone.\n\n**Requires:** `notification:delete`, held by the owner role.","operationId":"deleteNotificationRule","security":[{"bearerAuth":[]},{"oauth2":["notification:delete"]}],"parameters":[{"name":"rule_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Rule Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."}],"responses":{"204":{"description":"Successful Response","headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"401":{"description":"Unauthorized - Invalid or missing authorization token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"},"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"404":{"description":"Not Found - Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"422":{"description":"Validation Error - Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"429":{"description":"Too Many Requests - Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"x-fastmon-permissions":["notification:delete"]}},"/notifications/rules/{rule_id}/test":{"post":{"tags":["notifications"],"summary":"Send a test notification of a rule","description":"Send a made-up firing message to every channel and member of the rule,\nwhatever its state, and answer what each target made of it. Nothing is\nrecorded and the rule's state stays. At most five tests per organization\nin ten minutes.\n\n**Requires:** `notification:test`, held by the member and owner roles.","operationId":"testNotificationRule","security":[{"bearerAuth":[]},{"oauth2":["notification:test"]}],"parameters":[{"name":"rule_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Rule Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RuleTestResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"401":{"description":"Unauthorized - Invalid or missing authorization token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"},"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"404":{"description":"Not Found - Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"429":{"description":"Too Many Requests - Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"422":{"description":"Validation Error - Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"x-fastmon-permissions":["notification:test"]}},"/notifications/rules/{rule_id}/evaluate":{"post":{"tags":["notifications"],"summary":"Evaluate a notification rule now","description":"Evaluate the rule once over its application's sites pooled and answer\nwhether the condition holds now. Nothing is sent and no state changes.\n\n**Requires:** `notification:test`, held by the member and owner roles.","operationId":"evaluateNotificationRule","security":[{"bearerAuth":[]},{"oauth2":["notification:test"]}],"parameters":[{"name":"rule_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Rule Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RuleEvaluationResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"401":{"description":"Unauthorized - Invalid or missing authorization token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"},"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"404":{"description":"Not Found - Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"422":{"description":"Validation Error - Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"429":{"description":"Too Many Requests - Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"x-fastmon-permissions":["notification:test"]}},"/notifications/rules/{rule_id}/sends":{"get":{"tags":["notifications"],"summary":"List the sends of a notification rule","description":"The firing and resolved events the rule sent, newest first, with what\neach target made of them. Tests are not recorded.\n\n**Requires:** `notification:read`, held by every role.","operationId":"listNotificationRuleSends","security":[{"bearerAuth":[]},{"oauth2":["notification:read"]}],"parameters":[{"name":"rule_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Rule Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0,"title":"Offset"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":50,"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedResponse_RuleSendResponse_"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"401":{"description":"Unauthorized - Invalid or missing authorization token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"},"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"404":{"description":"Not Found - Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"422":{"description":"Validation Error - Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"429":{"description":"Too Many Requests - Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"x-fastmon-permissions":["notification:read"]}},"/notifications/channels/{channel_id}":{"get":{"tags":["notifications"],"summary":"Get a notification channel","description":"Fetch one channel, its URL shortened and its secret masked.\n\n**Requires:** `notification:read`, held by every role.","operationId":"getNotificationChannel","security":[{"bearerAuth":[]},{"oauth2":["notification:read"]}],"parameters":[{"name":"channel_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Channel Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChannelResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"401":{"description":"Unauthorized - Invalid or missing authorization token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"},"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"404":{"description":"Not Found - Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"422":{"description":"Validation Error - Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"429":{"description":"Too Many Requests - Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"x-fastmon-permissions":["notification:read"]},"patch":{"tags":["notifications"],"summary":"Update a notification channel","description":"Change a channel's name, URL, state or language. The type is fixed, a\nchannel of another type is a new channel.\n\n**Requires:** `notification:write`, held by the owner role.","operationId":"updateNotificationChannel","security":[{"bearerAuth":[]},{"oauth2":["notification:write"]}],"parameters":[{"name":"channel_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Channel Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChannelUpdate"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChannelResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"401":{"description":"Unauthorized - Invalid or missing authorization token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"},"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"403":{"description":"Forbidden - Insufficient permissions","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"404":{"description":"Not Found - Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"422":{"description":"Validation Error - Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"429":{"description":"Too Many Requests - Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"x-fastmon-permissions":["notification:write"]},"delete":{"tags":["notifications"],"summary":"Delete a notification channel","description":"Delete a channel. Cannot be undone.\n\n**Requires:** `notification:delete`, held by the owner role.","operationId":"deleteNotificationChannel","security":[{"bearerAuth":[]},{"oauth2":["notification:delete"]}],"parameters":[{"name":"channel_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Channel Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."}],"responses":{"204":{"description":"Successful Response","headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"401":{"description":"Unauthorized - Invalid or missing authorization token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"},"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"404":{"description":"Not Found - Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"422":{"description":"Validation Error - Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"429":{"description":"Too Many Requests - Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"x-fastmon-permissions":["notification:delete"]}},"/notifications/channels/{channel_id}/rotate-secret":{"post":{"tags":["notifications"],"summary":"Rotate a webhook channel's signing secret","description":"Replace a webhook channel's signing secret with a new one, which this\nanswer carries in full and none after it. The old secret stops at once.\n\n**Requires:** `notification:write`, held by the owner role.","operationId":"rotateNotificationChannelSecret","security":[{"bearerAuth":[]},{"oauth2":["notification:write"]}],"parameters":[{"name":"channel_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Channel Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChannelResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"401":{"description":"Unauthorized - Invalid or missing authorization token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"},"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"403":{"description":"Forbidden - Insufficient permissions","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"404":{"description":"Not Found - Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"422":{"description":"Validation Error - Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"429":{"description":"Too Many Requests - Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"x-fastmon-permissions":["notification:write"]}},"/notifications/channels/{channel_id}/test":{"post":{"tags":["notifications"],"summary":"Send a test message to a channel","description":"Post a test message to the channel in its language, whether it is active\nor not. A webhook gets it signed like every message. Nothing is recorded.\n\n**Requires:** `notification:test`, held by the member and owner roles.","operationId":"testNotificationChannel","security":[{"bearerAuth":[]},{"oauth2":["notification:test"]}],"parameters":[{"name":"channel_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Channel Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChannelTestResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"401":{"description":"Unauthorized - Invalid or missing authorization token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"},"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"404":{"description":"Not Found - Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"422":{"description":"Validation Error - Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"429":{"description":"Too Many Requests - Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"x-fastmon-permissions":["notification:test"]}},"/notifications/subscriptions/{subscription_id}":{"get":{"tags":["notifications"],"summary":"Get an observation subscription","description":"Fetch one subscription. One of the organization's partner clients takes a\ndirect member.\n\n**Requires:** `notification:read`, held by every role.","operationId":"getObservationSubscription","security":[{"bearerAuth":[]},{"oauth2":["notification:read"]}],"parameters":[{"name":"subscription_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Subscription Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ObservationSubscriptionResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"401":{"description":"Unauthorized - Invalid or missing authorization token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"},"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"403":{"description":"Forbidden - Insufficient permissions","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"404":{"description":"Not Found - Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"422":{"description":"Validation Error - Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"429":{"description":"Too Many Requests - Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"x-fastmon-permissions":["notification:read"]},"patch":{"tags":["notifications"],"summary":"Update an observation subscription","description":"Change which directions and metrics reach the channel. Channel and\napplication are fixed, another one is a new subscription. A post already\nqueued is dropped at send time when the new filter refuses it.\n\n**Requires:** `notification:write`, held by the owner role.","operationId":"updateObservationSubscription","security":[{"bearerAuth":[]},{"oauth2":["notification:write"]}],"parameters":[{"name":"subscription_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Subscription Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ObservationSubscriptionUpdate"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ObservationSubscriptionResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"401":{"description":"Unauthorized - Invalid or missing authorization token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"},"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"403":{"description":"Forbidden - Insufficient permissions","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"404":{"description":"Not Found - Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"422":{"description":"Validation Error - Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"429":{"description":"Too Many Requests - Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"x-fastmon-permissions":["notification:write"]},"delete":{"tags":["notifications"],"summary":"Delete an observation subscription","description":"Stop posting these observations to the channel. A post still queued is dropped.\n\n**Requires:** `notification:delete`, held by the owner role.","operationId":"deleteObservationSubscription","security":[{"bearerAuth":[]},{"oauth2":["notification:delete"]}],"parameters":[{"name":"subscription_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Subscription Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."}],"responses":{"204":{"description":"Successful Response","headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"401":{"description":"Unauthorized - Invalid or missing authorization token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"},"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"404":{"description":"Not Found - Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"422":{"description":"Validation Error - Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"429":{"description":"Too Many Requests - Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"x-fastmon-permissions":["notification:delete"]}},"/organizations/{org_id}/partner/clients":{"get":{"tags":["partners"],"summary":"List Clients","description":"List client organizations managed by this partner org.\n\n**Requires:** `partner:read`, held by every role.","operationId":"listPartnerClients","security":[{"bearerAuth":[]},{"oauth2":["partner:read"]}],"parameters":[{"name":"org_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Org Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0,"title":"Offset"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":50,"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedResponse_PartnerClientResponse_"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"401":{"description":"Unauthorized - Invalid or missing authorization token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"},"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"403":{"description":"Forbidden - Insufficient permissions","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"404":{"description":"Not Found - Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"422":{"description":"Validation Error - Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"429":{"description":"Too Many Requests - Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"x-fastmon-permissions":["partner:read"]},"post":{"tags":["partners"],"summary":"Create Client","description":"Create a brand-new organization and link it to this partner as a client.\n\nRequires *direct* membership of the partner org at member level or above,\nand the org must carry the partner entitlement (`is_partner`).\n\nUnlike `POST /admin/partners` (which links an existing org and is admin-only),\nthis lets a partner self-provision client orgs. By default the new org gets\n**no direct member** - it is managed through partner access until a real\ncustomer takes ownership. Pass `owner_email` to invite that customer as OWNER\nin the same step (an invite email is sent; on accept they become owner).\n\n**Requires:** `partner:manage`, held by the member and owner roles. An app connection is refused.","operationId":"createPartnerClient","security":[{"bearerAuth":[]}],"parameters":[{"name":"org_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Org Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerClientCreate"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerClientResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"401":{"description":"Unauthorized - Invalid or missing authorization token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"},"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"403":{"description":"Forbidden - Insufficient permissions","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"404":{"description":"Not Found - Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"422":{"description":"Validation Error - Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"429":{"description":"Too Many Requests - Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"x-fastmon-permissions":["partner:manage"]}},"/organizations/{org_id}/partner/clients/{client_org_id}":{"patch":{"tags":["partners"],"summary":"Update Client","description":"Change what this partner covers for one client, within its contract.\n\nDirect membership of the partner org is required, as on the other partner\nroutes. A field left out keeps its value.\n\n**Requires:** `partner:manage`, held by the member and owner roles. An app connection is refused.","operationId":"updatePartnerClient","security":[{"bearerAuth":[]}],"parameters":[{"name":"org_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Org Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."},{"name":"client_org_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Client Org Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerClientUpdate"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerClientResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"401":{"description":"Unauthorized - Invalid or missing authorization token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"},"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"403":{"description":"Forbidden - Insufficient permissions","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"404":{"description":"Not Found - Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"409":{"description":"Conflict - Resource already exists or operation not allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"422":{"description":"Validation Error - Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"429":{"description":"Too Many Requests - Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"x-fastmon-permissions":["partner:manage"]},"delete":{"tags":["partners"],"summary":"Remove Client","description":"Detach a client org from this partner, and delete it if orphaned.\n\nDirect membership of the partner org is required. Only links owned by *this*\npartner org can be removed (you can't detach another partner's client).\n\nIf, after detaching, the client org has no members and no other partner\nlinks, it is unreachable by anyone and gets fully deleted (sites, invites,\nmemberships) - mirroring the \"last member leaves → org is removed\"\nlifecycle. If the client still has members (a real customer was onboarded)\nor other partners, it survives; only this link is removed.\n\n**Requires:** `partner:manage`, held by the member and owner roles. An app connection is refused.","operationId":"removePartnerClient","security":[{"bearerAuth":[]}],"parameters":[{"name":"org_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Org Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."},{"name":"client_org_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Client Org Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."}],"responses":{"204":{"description":"Successful Response","headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"401":{"description":"Unauthorized - Invalid or missing authorization token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"},"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"403":{"description":"Forbidden - Insufficient permissions","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"404":{"description":"Not Found - Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"422":{"description":"Validation Error - Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"429":{"description":"Too Many Requests - Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"x-fastmon-permissions":["partner:manage"]}},"/organizations/{org_id}/partner/contract":{"get":{"tags":["partners"],"summary":"Get Contract","description":"The most this partner may cover per client, as fastmon sold it.\n\n**Requires:** `partner:read`, held by every role.","operationId":"getPartnerContract","security":[{"bearerAuth":[]},{"oauth2":["partner:read"]}],"parameters":[{"name":"org_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Org Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerContractResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"401":{"description":"Unauthorized - Invalid or missing authorization token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"},"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"403":{"description":"Forbidden - Insufficient permissions","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"404":{"description":"Not Found - Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"422":{"description":"Validation Error - Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"429":{"description":"Too Many Requests - Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"x-fastmon-permissions":["partner:read"]}},"/organizations/{org_id}/partner/usage":{"get":{"tags":["partners"],"summary":"Get Partner Usage","description":"Get the pageviews of the current billing period across all client organizations.\n\n**Requires:** `partner:read`, held by every role.","operationId":"getPartnerUsage","security":[{"bearerAuth":[]},{"oauth2":["partner:read"]}],"parameters":[{"name":"org_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Org Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerUsageResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"401":{"description":"Unauthorized - Invalid or missing authorization token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"},"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"403":{"description":"Forbidden - Insufficient permissions","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"404":{"description":"Not Found - Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"422":{"description":"Validation Error - Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"429":{"description":"Too Many Requests - Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"x-fastmon-permissions":["partner:read"]}},"/organizations/{org_id}/partner/live":{"post":{"tags":["partners"],"summary":"Show every live client of the partner on one floor","description":"One row per client organization with its traffic of the window, its LCP and its day.\n\nA client is a row when it is active, approved and has an activated site on\nan active production application, also without visitors. `data_total`\ncounts the listed clients together, `recent_purchases` lists the\nnewest orders, and `meta.next_poll_ms` sets the cadence.\n\n**Requires:** `analytics:read` and `partner:read`, held by every role.","operationId":"queryPartnerLive","security":[{"bearerAuth":[]},{"oauth2":["analytics:read","partner:read"]}],"parameters":[{"name":"org_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Org Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerLiveRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerLiveResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"401":{"description":"Unauthorized - Invalid or missing authorization token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"},"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"403":{"description":"Forbidden - Insufficient permissions","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"404":{"description":"Not Found - Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"422":{"description":"Validation Error - Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"429":{"description":"Too Many Requests - Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"x-fastmon-permissions":["analytics:read","partner:read"]}},"/organizations/{org_id}/partner-access":{"get":{"tags":["partners"],"summary":"List Partner Access","description":"List the partner organizations that have access to this org, newest\nfirst, one page at a time.\n\nThe client's view of the `partners` relationship: shows whether - and which -\npartner org manages this org (empty `data` = none). Requires *direct*\nmembership, so a partner inspecting a client via partner access can't use\nthis to enumerate the client's relationships.\n\n**Requires:** `partner:read`, held by every role.","operationId":"listPartnerAccess","security":[{"bearerAuth":[]},{"oauth2":["partner:read"]}],"parameters":[{"name":"org_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Org Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0,"title":"Offset"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":50,"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedResponse_PartnerAccessResponse_"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"401":{"description":"Unauthorized - Invalid or missing authorization token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"},"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"403":{"description":"Forbidden - Insufficient permissions","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"404":{"description":"Not Found - Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"422":{"description":"Validation Error - Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"429":{"description":"Too Many Requests - Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"x-fastmon-permissions":["partner:read"]}},"/organizations/{org_id}/partner-access/{partner_org_id}":{"delete":{"tags":["partners"],"summary":"Revoke Partner Access","description":"Revoke a partner organization's access to this (client) org.\n\nThe mirror of `DELETE /partner/clients/{client_org_id}`, but initiated by the\n*client*. Direct membership of this org is required, which means a partner\ncan't use its own partner access to revoke itself or a rival agency, and the\nacting member always remains, so this call never orphans the org (no cascade\ndelete, unlike the partner-side removal).\n\n**Requires:** `partner:manage`, held by the member and owner roles. An app connection is refused.","operationId":"revokePartnerAccess","security":[{"bearerAuth":[]}],"parameters":[{"name":"org_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Org Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."},{"name":"partner_org_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Partner Org Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"description":"An ID, a UUID in lowercase with hyphens."}],"responses":{"204":{"description":"Successful Response","headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"401":{"description":"Unauthorized - Invalid or missing authorization token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"},"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"403":{"description":"Forbidden - Insufficient permissions","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"404":{"description":"Not Found - Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"422":{"description":"Validation Error - Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"429":{"description":"Too Many Requests - Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"x-fastmon-permissions":["partner:manage"]}},"/search":{"get":{"tags":["search"],"summary":"Search","description":"Search organizations, applications and sites the caller may act in.\n\nEvery organization the credential reaches is searched: direct memberships,\npartner clients, and for a platform admin's session every active\norganization. A key is cut to the organizations it was issued for and to\nits scopes - a key without `site:read` gets no sites, whatever its owner's\nrole is. Inactive organizations never appear; inactive sites and\napplications do, flagged `is_active: false`, because reactivating one\nstarts with finding it.\n\nResults come per kind, each capped at `limit`, best match first: exact\nname, then prefix, then substring, then alphabetical. Applications and\nsites list prod before dev within each match class, so an exact dev match\nstill beats a prefix prod match. A site's environment is its\napplication's.\n\n**Requires:** any credential. No organization permission applies.","operationId":"search","security":[{"bearerAuth":[]},{"oauth2":[]}],"parameters":[{"name":"q","in":"query","required":false,"schema":{"type":"string","maxLength":100,"description":"Substring to match, case-insensitive. Empty lists the first entries of each kind, applications and sites prod before dev, then by name.","default":"","title":"Q"},"description":"Substring to match, case-insensitive. Empty lists the first entries of each kind, applications and sites prod before dev, then by name."},{"name":"kinds","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"enum":["organization","application","site"],"type":"string"}},{"type":"null"}],"description":"Which kinds to search. Defaults to all three.","title":"Kinds"},"description":"Which kinds to search. Defaults to all three."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":50,"minimum":1,"description":"Per-kind cap.","default":20,"title":"Limit"},"description":"Per-kind cap."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"401":{"description":"Unauthorized - Invalid or missing authorization token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"},"WWW-Authenticate":{"$ref":"#/components/headers/WWW-Authenticate"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"422":{"description":"Validation Error - Request validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"429":{"description":"Too Many Requests - Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"x-fastmon-permissions":[]}}},"webhooks":{"observation.opened":{"post":{"tags":["notifications"],"summary":"An observation opened","description":"Posted to a webhook channel subscribed to the observation. Signed per Standard Webhooks with the headers `webhook-id`, `webhook-timestamp` and `webhook-signature`.","operationId":"observationOpenedWebhook","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ObservationOpenedWebhook"}}},"required":true},"responses":{"200":{"description":"Any 2xx accepts the delivery. A 4xx other than 408 and 429 is final, anything else is retried."}},"security":[],"parameters":[{"name":"webhook-id","in":"header","required":true,"description":"Unique per delivery and the same on its retries, the key to dedupe by.","schema":{"type":"string"}},{"name":"webhook-timestamp","in":"header","required":true,"description":"The attempt's time in Unix seconds. Refuse one older than 5 minutes.","schema":{"type":"string"}},{"name":"webhook-signature","in":"header","required":true,"description":"`v1,` and the base64 HMAC-SHA256 of `{webhook-id}.{webhook-timestamp}.{body}`, keyed with the base64-decoded part of the channel's secret after `whsec_`.","schema":{"type":"string"}}]}},"observation.occurrence":{"post":{"tags":["notifications"],"summary":"An observation recurred","description":"Posted once, for the first recurrence of a shift, to a webhook channel subscribed to the observation. Signed per Standard Webhooks with the headers `webhook-id`, `webhook-timestamp` and `webhook-signature`.","operationId":"observationOccurrenceWebhook","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ObservationOccurrenceWebhook"}}},"required":true},"responses":{"200":{"description":"Any 2xx accepts the delivery. A 4xx other than 408 and 429 is final, anything else is retried."}},"security":[],"parameters":[{"name":"webhook-id","in":"header","required":true,"description":"Unique per delivery and the same on its retries, the key to dedupe by.","schema":{"type":"string"}},{"name":"webhook-timestamp","in":"header","required":true,"description":"The attempt's time in Unix seconds. Refuse one older than 5 minutes.","schema":{"type":"string"}},{"name":"webhook-signature","in":"header","required":true,"description":"`v1,` and the base64 HMAC-SHA256 of `{webhook-id}.{webhook-timestamp}.{body}`, keyed with the base64-decoded part of the channel's secret after `whsec_`.","schema":{"type":"string"}}]}},"channel.test":{"post":{"tags":["notifications"],"summary":"A channel test","description":"Posted by `POST /notifications/channels/{channel_id}/test`. Signed per Standard Webhooks with the headers `webhook-id`, `webhook-timestamp` and `webhook-signature`.","operationId":"channelTestWebhook","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChannelTestWebhook"}}},"required":true},"responses":{"200":{"description":"Any 2xx accepts the delivery. A 4xx other than 408 and 429 is final, anything else is retried."}},"security":[],"parameters":[{"name":"webhook-id","in":"header","required":true,"description":"Unique per delivery and the same on its retries, the key to dedupe by.","schema":{"type":"string"}},{"name":"webhook-timestamp","in":"header","required":true,"description":"The attempt's time in Unix seconds. Refuse one older than 5 minutes.","schema":{"type":"string"}},{"name":"webhook-signature","in":"header","required":true,"description":"`v1,` and the base64 HMAC-SHA256 of `{webhook-id}.{webhook-timestamp}.{body}`, keyed with the base64-decoded part of the channel's secret after `whsec_`.","schema":{"type":"string"}}]}},"rule.firing":{"post":{"tags":["notifications"],"summary":"A rule fired","description":"Posted to a webhook channel of the rule, again at a re-notify. Signed per Standard Webhooks with the headers `webhook-id`, `webhook-timestamp` and `webhook-signature`.","operationId":"ruleFiringWebhook","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RuleFiringWebhook"}}},"required":true},"responses":{"200":{"description":"Any 2xx accepts the delivery. A 4xx other than 408 and 429 is final, anything else is retried."}},"security":[],"parameters":[{"name":"webhook-id","in":"header","required":true,"description":"Unique per delivery and the same on its retries, the key to dedupe by.","schema":{"type":"string"}},{"name":"webhook-timestamp","in":"header","required":true,"description":"The attempt's time in Unix seconds. Refuse one older than 5 minutes.","schema":{"type":"string"}},{"name":"webhook-signature","in":"header","required":true,"description":"`v1,` and the base64 HMAC-SHA256 of `{webhook-id}.{webhook-timestamp}.{body}`, keyed with the base64-decoded part of the channel's secret after `whsec_`.","schema":{"type":"string"}}]}},"rule.resolved":{"post":{"tags":["notifications"],"summary":"A rule resolved","description":"Posted to a webhook channel of the rule once its condition stopped. Signed per Standard Webhooks with the headers `webhook-id`, `webhook-timestamp` and `webhook-signature`.","operationId":"ruleResolvedWebhook","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RuleResolvedWebhook"}}},"required":true},"responses":{"200":{"description":"Any 2xx accepts the delivery. A 4xx other than 408 and 429 is final, anything else is retried."}},"security":[],"parameters":[{"name":"webhook-id","in":"header","required":true,"description":"Unique per delivery and the same on its retries, the key to dedupe by.","schema":{"type":"string"}},{"name":"webhook-timestamp","in":"header","required":true,"description":"The attempt's time in Unix seconds. Refuse one older than 5 minutes.","schema":{"type":"string"}},{"name":"webhook-signature","in":"header","required":true,"description":"`v1,` and the base64 HMAC-SHA256 of `{webhook-id}.{webhook-timestamp}.{body}`, keyed with the base64-decoded part of the channel's secret after `whsec_`.","schema":{"type":"string"}}]}},"rule.test":{"post":{"tags":["notifications"],"summary":"A rule test","description":"Posted by `POST /notifications/rules/{rule_id}/test`. Signed per Standard Webhooks with the headers `webhook-id`, `webhook-timestamp` and `webhook-signature`.","operationId":"ruleTestWebhook","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RuleTestWebhook"}}},"required":true},"responses":{"200":{"description":"Any 2xx accepts the delivery. A 4xx other than 408 and 429 is final, anything else is retried."}},"security":[],"parameters":[{"name":"webhook-id","in":"header","required":true,"description":"Unique per delivery and the same on its retries, the key to dedupe by.","schema":{"type":"string"}},{"name":"webhook-timestamp","in":"header","required":true,"description":"The attempt's time in Unix seconds. Refuse one older than 5 minutes.","schema":{"type":"string"}},{"name":"webhook-signature","in":"header","required":true,"description":"`v1,` and the base64 HMAC-SHA256 of `{webhook-id}.{webhook-timestamp}.{body}`, keyed with the base64-decoded part of the channel's secret after `whsec_`.","schema":{"type":"string"}}]}}},"components":{"schemas":{"AbsenceReason":{"type":"string","title":"AbsenceReason","description":"Why a metric the browser supports is missing on a pageview.","x-extensible-enum":["hidden_before_paint","no_interaction"]},"AggregationType":{"type":"string","enum":["count","avg","sum","min","max","p50","p75","p90","p95","p99","good_share","needs_improvement_share","poor_share"],"title":"AggregationType","description":"Supported aggregation functions."},"AnalyticsDataPoint":{"properties":{"timestamp":{"title":"Timestamp","description":"Start of the bucket, absent when the query groups by no granularity.","examples":["2026-04-14T09:50:01Z"],"type":"string","format":"date-time"},"values_by_dimension":{"additionalProperties":{"type":"string"},"type":"object","title":"Values By Dimension","description":"This row's value for each grouped dimension id. A group by `asn` also carries `isp`, the network's name, '' when unknown"},"metrics":{"items":{"$ref":"#/components/schemas/MetricValue"},"type":"array","title":"Metrics","description":"Metric values"},"sample_count":{"type":"integer","title":"Sample Count","description":"Pageviews behind the row's values, unweighted under sampling"},"is_sparse":{"type":"boolean","title":"Is Sparse","description":"The row holds fewer page views than `meta.sparse_buckets.min_pageviews`, so its values rest on few measurements. Always false without `sparse_buckets`"},"comparison":{"description":"Comparison data (when compare_to is set)","$ref":"#/components/schemas/ComparisonData"},"beacons":{"type":"integer","title":"Beacons","description":"Deprecated, use `sample_count`. It always counted pageviews.","deprecated":true,"readOnly":true,"x-replaced-by":"sample_count"}},"type":"object","required":["metrics","sample_count","is_sparse","beacons","values_by_dimension"],"title":"AnalyticsDataPoint","description":"Single data point in query results."},"AnalyticsMeta":{"properties":{"execution_time_ms":{"type":"number","title":"Execution Time Ms","description":"How long the query took, in milliseconds"},"total":{"title":"Total","description":"Rows the query matched before paging, absent where the response is not a paged list.","type":"integer"},"limit":{"title":"Limit","description":"Rows per page the query applied, absent where the response is not paged","type":"integer"},"offset":{"title":"Offset","description":"Rows the query skipped, absent where the response is not paged","type":"integer"},"has_more":{"title":"Has More","description":"Whether a further page exists, absent where the response is not paged","type":"boolean"},"next_cursor":{"title":"Next Cursor","description":"Cursor for the next page, absent on the last page and where the response is not cursor-paged.","type":"string"},"sampling":{"description":"Sampling configured for the applications behind this result. Traffic counts are scaled by the weight each stored row carries, not by this rate. The beacon explorer's counts stay raw, as they count stored beacons, and so do the checkout funnel's stage counts.","$ref":"#/components/schemas/SamplingMeta"},"is_identity_mixed":{"title":"Is Identity Mixed","description":"Whether the applications in scope store different visitor identifiers and the count ran over `request.identity`, which some of them do not store. Their visitors are then left out, so the count is a lower bound for the scope. Absent where the response counts no visitors or the request named the identity.","type":"boolean"},"complete_until":{"title":"Complete Until","description":"The moment up to which the result holds every pageview. Data after it is still arriving, so the newest bucket is partial past this point. On a window of 6 hours or less it trails the request time by the ingest lag, on a longer one it is how far the finalizer has written the running hour. Absent where the route reads neither, or where that is unknown.","examples":["2026-04-14T09:50:01Z"],"type":"string","format":"date-time"},"sparse_buckets":{"description":"The sparse threshold this response applied, absent where the request sent no `sparse_buckets`. On `POST /analytics/query` always present","$ref":"#/components/schemas/SparseBucketsApplied"}},"type":"object","required":["execution_time_ms"],"title":"AnalyticsMeta","description":"Facts about the result an analytics query produced (§1, §28)."},"AnalyticsQueryMeta":{"properties":{"execution_time_ms":{"type":"number","title":"Execution Time Ms","description":"How long the query took, in milliseconds"},"total":{"type":"integer","title":"Total","description":"Rows the query matched before paging"},"limit":{"title":"Limit","description":"Rows per page the query applied, absent where the response is not paged","type":"integer"},"offset":{"title":"Offset","description":"Rows the query skipped, absent where the response is not paged","type":"integer"},"has_more":{"title":"Has More","description":"Whether a further page exists, absent where the response is not paged","type":"boolean"},"next_cursor":{"title":"Next Cursor","description":"Cursor for the next page, absent on the last page and where the response is not cursor-paged.","type":"string"},"sampling":{"description":"Sampling configured for the applications behind this result. Traffic counts are scaled by the weight each stored row carries, not by this rate. The beacon explorer's counts stay raw, as they count stored beacons, and so do the checkout funnel's stage counts.","$ref":"#/components/schemas/SamplingMeta"},"is_identity_mixed":{"title":"Is Identity Mixed","description":"Whether the applications in scope store different visitor identifiers and the count ran over `request.identity`, which some of them do not store. Their visitors are then left out, so the count is a lower bound for the scope. Absent where the response counts no visitors or the request named the identity.","type":"boolean"},"complete_until":{"title":"Complete Until","description":"The moment up to which the result holds every pageview. Data after it is still arriving, so the newest bucket is partial past this point. On a window of 6 hours or less it trails the request time by the ingest lag, on a longer one it is how far the finalizer has written the running hour. Absent where the route reads neither, or where that is unknown.","examples":["2026-04-14T09:50:01Z"],"type":"string","format":"date-time"},"sparse_buckets":{"$ref":"#/components/schemas/SparseBucketsApplied","description":"The sparse threshold this response applied, always present. `min_pageviews` is 0 without `sparse_buckets` in the request"},"query_hash":{"type":"string","title":"Query Hash","description":"Hash for debugging/caching reference"},"granularity_options":{"title":"Granularity Options","description":"The bucket widths the window can be shown in, in width order: every width with between 4 and 1500 buckets. Absent where the query groups by no granularity","items":{"$ref":"#/components/schemas/BucketGranularity"},"type":"array"},"pageviews":{"title":"Pageviews","description":"The page views of the window after every filter, weighted like the `requests` metric and not narrowed by `top_n`. With a group by `url_key`, where a page view counts once per key it carries, so the rows add up to more than the window. With a group by `url_param`, the page views that carry `url_param_key`. The share of a row is its `requests` over this. Absent for every other dimension","type":"integer"}},"type":"object","required":["execution_time_ms","total","sparse_buckets","query_hash"],"title":"AnalyticsQueryMeta","description":"Metadata about the query execution.\n\nThe three untyped echoes below are what `request` now carries as typed\nobjects. They keep serving until PR 13 drops the twins of the stack."},"AnalyticsQueryRequest":{"properties":{"time_range":{"$ref":"#/components/schemas/TimeRange","description":"Time range for the query (required)"},"metrics":{"items":{"anyOf":[{"type":"string"},{"$ref":"#/components/schemas/MapMetric"}]},"type":"array","maxItems":20,"minItems":1,"title":"Metrics","description":"Metrics to query. Strings for flat or Nested (errors.count) metrics; objects for Map-key access (e.g. resource_sizes['script']). `first_party_error_rate` and `third_party_error_rate` split `error_rate`, the share of pageviews with any JavaScript error, by `error_origin`. AVG-only ratios 0-1. Grouped by `errors.fingerprint` alone, `error_beacons` is the weighted pageviews carrying each signature and `error_rate` their share of every pageview of the bucket or window. `performed_dns_lookup` and `new_tcp_connection` are `dns_lookup` and `tcp_connection` over the pageviews that did a lookup or opened a connection, the rated durations. `skipped_dns_lookup_rate` and `reused_tcp_connection_rate` are the AVG-only share 0-1 of the pageviews reporting the timing that did not. `total_byte_weight` is the bytes a view downloaded, `page_weight` the bytes the page weighs on a first view, the rated one, and `browser_cache_bytes` the part of `page_weight` the browser cache answered. A warm view took more than half of its page weight from the browser cache: `browser_cache_saving` is `browser_cache_bytes` over the warm views, `warm_view_rate` the AVG-only share 0-1 of the views reporting both that were warm. `cdn_served_rate`/`origin_served_rate` are the share answered from the layer's stored copy, the sum of its hit, stale, updating and revalidated status rates below. Cache-status rates follow the pattern `(cdn|origin)_status_rate_<status>` (lowercase, e.g. cdn_status_rate_miss; `unreported` = no status sent) - AVG-only ratio 0-1 over all pageviews. `cdn_hit_rate`/`origin_hit_rate` are legacy aliases for `*_status_rate_hit`. The `ttfb_phase_*` ids split `coalesce(ttfb_final, ttfb)` per pageview, and the `avg` of `ttfb_phase_redirect`, `_connect`, `_edge`, `_origin`, `_backend`, `_unattributed` and `_unmeasured` sum to its average over the pageviews they cover, those whose first byte is at least the DNS lookup plus the TCP connection."},"aggregations":{"items":{"$ref":"#/components/schemas/AggregationType"},"type":"array","maxItems":7,"minItems":1,"title":"Aggregations","description":"Aggregation functions to apply. `good_share`, `needs_improvement_share` and `poor_share` are the part of the bucket's page views that reported the metric and fall in that rating of `GET /metric-thresholds`, 0..1 and unweighted. They take only lcp, inp, cls, ttfb, fcp, performed_dns_lookup, new_tcp_connection and page_weight. For performed_dns_lookup and new_tcp_connection the denominator is the page views that did a lookup or opened a connection.","default":["p75"]},"group_by":{"$ref":"#/components/schemas/GroupBy","description":"Grouping configuration (time and/or dimensions)"},"timezone":{"anyOf":[{"type":"string","maxLength":64},{"type":"null"}],"title":"Timezone","description":"IANA time zone whose boundaries start the `six_hours`, `day`, `week` and `month` buckets, such as `Europe/Berlin`. A day is 23 or 25 hours long across a DST switch. Bucket timestamps stay UTC. In a zone whose offset is not whole hours a bucket starts at the UTC hour that holds the local boundary. Without it the buckets start at UTC boundaries"},"filters":{"$ref":"#/components/schemas/Filters","description":"Optional filters"},"compare_to":{"anyOf":[{"$ref":"#/components/schemas/CompareMode","description":"A window derived from `time_range` by `TimeRange.get_comparison_range`."},{"$ref":"#/components/schemas/TimeRange","description":"Any window, validated like `time_range`. It may differ in length and may overlap the main window."},{"$ref":"#/components/schemas/CompareToRelease"},{"type":"null"}],"title":"Compare To","description":"The window to compare with, in one of three forms. A mode: previous_period is the smallest whole number of weeks earlier that covers the window, at least one, previous_day 24 hours earlier, previous_week 7 days earlier, previous_month 30 days earlier. A window `{from, to}` of any length. A release `{release_id}`: from its `released_at`, as long as `time_range`, cut at the next release of its application and at now. Time buckets pair by their offset from the start of each window."},"compare_to_release_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Compare To Release Id","description":"Compare before against after a release inside the window. Deprecated: send the two sides as `time_range` and a `compare_to` window.","deprecated":true,"x-replaced-by":"compare_to","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"limit":{"type":"integer","maximum":10000.0,"minimum":1.0,"title":"Limit","description":"Maximum rows to return","default":2500},"offset":{"type":"integer","minimum":0.0,"title":"Offset","description":"Offset for pagination","default":0},"order_by":{"anyOf":[{"$ref":"#/components/schemas/OrderBy"},{"type":"null"}],"description":"Sort configuration"},"identity":{"anyOf":[{"type":"string","enum":["stitch","session"]},{"type":"null"}],"title":"Identity","description":"Backing identifier for the `visitors` metric: 'stitch' (preferred - edge-derived, present under ANONYMOUS) or 'session' (consent-gated session_id). Null resolves to the application's default (stitch unless the application only collects sessions). Ignored by all other metrics."},"url_param_key":{"anyOf":[{"type":"string","pattern":"^[A-Za-z0-9_-]{1,64}$"},{"type":"null"}],"title":"Url Param Key","description":"The query key whose value the `url_param` dimension groups by, required with it and refused without it. The key has to keep its value in every application of the scope: listed in `collection.query_values_for`, or, in an application that does not keep query keys, a search term key a page type keeps (`q`, `search`, `searchparam`) or the platform's controller key (`cl` on OXID). Any other key answers 422"},"sparse_buckets":{"anyOf":[{"$ref":"#/components/schemas/SparseBuckets"},{"$ref":"#/components/schemas/SparseBucketsByMode","deprecated":true},{"type":"null"}],"title":"Sparse Buckets","description":"The threshold below which a row carries `is_sparse`. Absent flags no row, so a row is flagged only where the client asked for it. Derive the number with `POST /analytics/sparse-hours` and send it here. The `{mode, min_pageviews}` form is deprecated"}},"additionalProperties":false,"type":"object","required":["time_range","metrics"],"title":"AnalyticsQueryRequest","description":"Main request schema for analytics queries."},"AnalyticsQueryResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/AnalyticsDataPoint"},"type":"array","title":"Data","description":"Query result data points"},"meta":{"$ref":"#/components/schemas/AnalyticsQueryMeta","description":"Query metadata"},"request":{"$ref":"#/components/schemas/AnalyticsRequestEcho","description":"The request as the server resolved it"}},"type":"object","required":["data","meta","request"],"title":"AnalyticsQueryResponse","description":"Response for analytics queries."},"AnalyticsRequestEcho":{"properties":{"time_range":{"$ref":"#/components/schemas/TimeRange","description":"The window the query ran over, concrete even where the caller asked for a relative one"},"comparison_time_range":{"description":"The earlier window, absent unless a comparison ran","$ref":"#/components/schemas/TimeRange"},"granularity":{"description":"Bucket width of the series, absent where the response is not bucketed","$ref":"#/components/schemas/BucketGranularity"},"identity":{"description":"Identifier the visitors were counted by, absent where the response counts none","$ref":"#/components/schemas/VisitorIdentity"},"window_seconds":{"title":"Window Seconds","description":"Length of the window ending now, absent where the request names none","type":"integer"},"filters":{"additionalProperties":true,"type":"object","title":"Filters","description":"The filter values the query applied"},"url_param_key":{"title":"Url Param Key","description":"The query key the `url_param` rows of `/analytics/query` are the values of, absent without that dimension","type":"string"}},"type":"object","required":["time_range","filters"],"title":"AnalyticsRequestEcho","description":"The analytics request as the server resolved it (§1, §28).\n\nNamed `...Echo` and not `AnalyticsRequest` because every request BODY of\nthis package is a `<Topic>Request`, and a reader of the schema list would\ntake a bare `AnalyticsRequest` for one more of them."},"ApiKeyCreated":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":"Identifier of the key.","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"kind":{"$ref":"#/components/schemas/ApiKeyKind","description":"Whether the key belongs to a person or to an organization."},"name":{"title":"Name","description":"Label the key is recognised by.","type":"string"},"prefix":{"type":"string","title":"Prefix","description":"Non-secret lookup prefix: the scheme (`fm_` for a personal key, `fmo_` for an organization's) plus the first characters of the secret."},"last4":{"title":"Last4","description":"Last four characters of the secret, to tell two keys apart.","type":"string"},"scopes":{"items":{"type":"string"},"type":"array","title":"Scopes","description":"Permissions this key carries.","default":[]},"expires_at":{"title":"Expires At","description":"When the key stops working; absent means never.","examples":["2026-04-14T09:50:01Z"],"type":"string","format":"date-time"},"last_used_at":{"title":"Last Used At","description":"Absent until the key is first used.","examples":["2026-04-14T09:50:01Z"],"type":"string","format":"date-time"},"reach":{"$ref":"#/components/schemas/CredentialReach","description":"Which organizations the key may act in: the ones it was issued for, or, for a key issued to an agency, its clients as they stand right now."},"created_at":{"type":"string","format":"date-time","title":"Created At","description":"When the key was minted.","examples":["2026-04-14T09:50:01Z"]},"revoked_at":{"title":"Revoked At","description":"Absent while the key is live. Only listings that ask for revoked keys ever see a value here.","examples":["2026-04-14T09:50:01Z"],"type":"string","format":"date-time"},"editable":{"type":"boolean","title":"Editable","description":"Whether the caller may change this key: its scopes, its expiry, its name, and rotating it. False for a key that holds permissions the caller does not. Revoking is never gated by it.","default":true},"via_partner_org_id":{"title":"Via Partner Org Id","description":"The partner organization whose member minted this org key. The key keeps working after that partnership ends. Absent otherwise.","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"],"type":"string","format":"uuid"},"key":{"type":"string","title":"Key","description":"The secret, in full. It is returned here and nowhere else, and it is not stored - a lost secret is replaced by rotating the key."}},"type":"object","required":["id","kind","prefix","reach","created_at","key","scopes","editable"],"title":"ApiKeyCreated","description":"Response to minting: the info plus the cleartext secret, which is\nreturned exactly once and never stored."},"ApiKeyInfo":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":"Identifier of the key.","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"kind":{"$ref":"#/components/schemas/ApiKeyKind","description":"Whether the key belongs to a person or to an organization."},"name":{"title":"Name","description":"Label the key is recognised by.","type":"string"},"prefix":{"type":"string","title":"Prefix","description":"Non-secret lookup prefix: the scheme (`fm_` for a personal key, `fmo_` for an organization's) plus the first characters of the secret."},"last4":{"title":"Last4","description":"Last four characters of the secret, to tell two keys apart.","type":"string"},"scopes":{"items":{"type":"string"},"type":"array","title":"Scopes","description":"Permissions this key carries.","default":[]},"expires_at":{"title":"Expires At","description":"When the key stops working; absent means never.","examples":["2026-04-14T09:50:01Z"],"type":"string","format":"date-time"},"last_used_at":{"title":"Last Used At","description":"Absent until the key is first used.","examples":["2026-04-14T09:50:01Z"],"type":"string","format":"date-time"},"reach":{"$ref":"#/components/schemas/CredentialReach","description":"Which organizations the key may act in: the ones it was issued for, or, for a key issued to an agency, its clients as they stand right now."},"created_at":{"type":"string","format":"date-time","title":"Created At","description":"When the key was minted.","examples":["2026-04-14T09:50:01Z"]},"revoked_at":{"title":"Revoked At","description":"Absent while the key is live. Only listings that ask for revoked keys ever see a value here.","examples":["2026-04-14T09:50:01Z"],"type":"string","format":"date-time"},"editable":{"type":"boolean","title":"Editable","description":"Whether the caller may change this key: its scopes, its expiry, its name, and rotating it. False for a key that holds permissions the caller does not. Revoking is never gated by it.","default":true},"via_partner_org_id":{"title":"Via Partner Org Id","description":"The partner organization whose member minted this org key. The key keeps working after that partnership ends. Absent otherwise.","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"],"type":"string","format":"uuid"}},"type":"object","required":["id","kind","prefix","reach","created_at","scopes","editable"],"title":"ApiKeyInfo","description":"A key as it is displayed. The secret is never returned - only enough\nmetadata to recognise a key and revoke it."},"ApiKeyKind":{"type":"string","enum":["personal","org"],"title":"ApiKeyKind","description":"Where a key came from. Not a capability - only provenance.\n\nAll kinds are the same credential (same digest scheme, same auth path, same\ntable); they differ in who holds the secret, how it is presented in the UI,\nand - for an organization's key - the prefix it carries, so that a found\nsecret says where it has to be revoked. Keeping them in one table keeps one\nlookup in the hot auth path and one place where scopes are enforced."},"ApiKeyRotate":{"properties":{"current_password":{"anyOf":[{"type":"string","maxLength":1024},{"type":"null"}],"title":"Current Password","description":"The account's password, when it has neither a passkey nor 2FA."},"totp_code":{"anyOf":[{"type":"string","maxLength":6},{"type":"null"}],"title":"Totp Code","description":"Code from the authenticator app, when 2FA is on and there is no passkey."},"passkey_challenge_id":{"anyOf":[{"type":"string","maxLength":64},{"type":"null"}],"title":"Passkey Challenge Id","description":"Challenge from `POST /auth/session/webauthn/options`, required together with `passkey_assertion` whenever the account has a passkey."},"passkey_assertion":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Passkey Assertion","description":"The WebAuthn assertion answering that challenge."},"grace_period_hours":{"type":"integer","maximum":24.0,"minimum":0.0,"title":"Grace Period Hours","description":"How long the old secret keeps working, in hours. `0`, the default, kills it immediately, which is what a leak wants. At most 24.","default":0}},"type":"object","title":"ApiKeyRotate","description":"Replace a key's secret, optionally letting the old one live a little.\n\nThe successor copies name, scopes and reach, so nothing about what the\ncredential may do changes - only the secret does. Rotating therefore carries\nthe mint conditions: whoever does it sees a new secret, and it is checked\nagainst what they hold today rather than what the original minter held."},"ApplicationCreate":{"properties":{"name":{"type":"string","maxLength":255,"title":"Name","description":"Display name of the application.","default":"Default"},"environment":{"$ref":"#/components/schemas/Environment","description":"Deployment environment. Production applications are billed, development ones are not.","default":"prod"},"site_policy":{"$ref":"#/components/schemas/SitePolicy","description":"What happens to a beacon whose hostname is not a registered domain of this application.","default":"open"},"pagetype_ruleset":{"type":"string","maxLength":24,"title":"Pagetype Ruleset","description":"Shorthand that sets `platform` and turns `pagetype_body_class` on, or turns it off with an empty string. Kept for older clients.","default":"","deprecated":true},"page_type":{"anyOf":[{"$ref":"#/components/schemas/PageTypeInput"},{"type":"null"}],"description":"Page-type detection."},"shop":{"anyOf":[{"$ref":"#/components/schemas/ShopInput"},{"type":"null"}],"description":"Shop settings."},"collection":{"anyOf":[{"$ref":"#/components/schemas/CollectionInput"},{"type":"null"}],"description":"What the tracker collects."},"collector":{"anyOf":[{"$ref":"#/components/schemas/CollectorInput"},{"type":"null"}],"description":"Where beacons are posted."},"script":{"anyOf":[{"$ref":"#/components/schemas/ScriptInput"},{"type":"null"}],"description":"The served tracker bundle."},"site_defaults":{"anyOf":[{"$ref":"#/components/schemas/SiteDefaultsInput"},{"type":"null"}],"description":"Defaults the application's domains inherit."},"platform":{"anyOf":[{"$ref":"#/components/schemas/PlatformInput"},{"type":"null"}],"description":"The system the application runs on, when it is known."},"spa":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Spa","description":"Whether the application is a single-page app."},"preset":{"anyOf":[{"type":"string","maxLength":64},{"type":"null"}],"title":"Preset","description":"Shortcut that expands into the `collection` flags. Accepted when creating only."},"collector_mode":{"$ref":"#/components/schemas/CollectorMode","description":"Where the served bundle posts its beacons. Deprecated, use `collector.mode`.","default":"default","deprecated":true},"collector_endpoint":{"anyOf":[{"type":"string","maxLength":255},{"type":"null"}],"title":"Collector Endpoint","description":"The URL beacons are posted to. Only with `collector_mode=custom`. Deprecated, use `collector.endpoint`.","deprecated":true}},"additionalProperties":false,"type":"object","title":"ApplicationCreate","description":"Provision an application (a tracking embed). The `collection` config applies\nto every domain the app is embedded on. `site_defaults` holds the privacy\nvalues every member site takes, a site cannot override them."},"ApplicationHit":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"],"description":"An ID, a UUID in lowercase with hyphens."},"name":{"type":"string","title":"Name"},"environment":{"$ref":"#/components/schemas/Environment"},"is_active":{"type":"boolean","title":"Is Active"},"organization":{"$ref":"#/components/schemas/SearchOrganizationRef"}},"type":"object","required":["id","name","environment","is_active","organization"],"title":"ApplicationHit"},"ApplicationRef":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"],"description":"An ID, a UUID in lowercase with hyphens."},"name":{"type":"string","title":"Name"}},"type":"object","required":["id","name"],"title":"ApplicationRef","description":"An application another resource belongs to or points at."},"ApplicationResponse":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":"Identifier of the application.","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"organization_id":{"type":"string","format":"uuid","title":"Organization Id","description":"The organization this application belongs to.","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"name":{"type":"string","title":"Name","description":"Display name of the application."},"environment":{"$ref":"#/components/schemas/Environment","description":"Deployment environment. Production applications are billed, development ones are not."},"site_policy":{"$ref":"#/components/schemas/SitePolicy","description":"What happens to a beacon whose hostname is not a registered domain of this application."},"source_hash":{"type":"string","title":"Source Hash","description":"Names this application's bundle in the script URL, `/s/{source_hash}.js`.","deprecated":true},"collector_hash":{"type":"string","title":"Collector Hash","description":"Names this application in the beacon URL, `/c/{collector_hash}`.","deprecated":true},"pagetype_ruleset":{"type":"string","title":"Pagetype Ruleset","description":"The platform when `pagetype_body_class` is on and the platform has a ruleset, else an empty string. Derived, write the two fields instead.","default":"","deprecated":true},"platform":{"$ref":"#/components/schemas/PlatformResponse","description":"The system the application runs on and how that is known."},"collector_mode":{"$ref":"#/components/schemas/CollectorMode","description":"Where the served bundle posts its beacons. Deprecated, use `collector.mode`.","deprecated":true},"collector_endpoint":{"title":"Collector Endpoint","description":"The URL beacons are posted to. Only with `collector_mode=custom`. Deprecated, use `collector.endpoint`.","deprecated":true,"type":"string"},"proxy_secret":{"title":"Proxy Secret","description":"Secret a first-party beacon proxy presents in `FM-Proxy-Key`. Returned only to a caller who may change the application, and absent when the feature is off.","deprecated":true,"type":"string"},"is_active":{"type":"boolean","title":"Is Active","description":"Whether the application is enabled."},"uptime_enabled":{"type":"boolean","title":"Uptime Enabled","description":"Whether the uptime probe checks the domains of this application. Off until switched on. Only production applications are checked, whatever this says.","default":false},"uptime_cache_buster":{"type":"boolean","title":"Uptime Cache Buster","description":"Whether the uptime probe adds `nocache` to the URLs it checks, so the check reaches the origin and not the CDN. On until switched off.","default":true},"uptime_headers":{"additionalProperties":{"type":"string"},"type":"object","title":"Uptime Headers","description":"Request headers the uptime probe sends with every check, names lowercase. Empty when none are set. Each value is empty for a caller who may not change the application."},"uptime_headers_redacted":{"type":"boolean","title":"Uptime Headers Redacted","description":"True when headers exist but the caller may not read their values.","default":false},"uptime_page_types":{"additionalProperties":{"$ref":"#/components/schemas/UptimePageTypeSetting"},"propertyNames":{"$ref":"#/components/schemas/UptimePageType"},"type":"object","title":"Uptime Page Types","description":"How the uptime probe checks each page type besides the home page, keyed by page type. Every page type is listed, `automatic` unless set."},"site_count":{"type":"integer","title":"Site Count","description":"How many domains run on this application.","default":0},"data_starts_at":{"title":"Data Starts At","description":"The UTC midnight a complete analytics window of this application starts at: the day of the first pageview over its domains, but never before the organization's `history_days` ago. Absent until the first pageview is 3 hours old.","examples":["2026-04-14T09:50:01Z"],"type":"string","format":"date-time"},"created_at":{"type":"string","format":"date-time","title":"Created At","description":"When the application was created.","examples":["2026-04-14T09:50:01Z"]},"updated_at":{"type":"string","format":"date-time","title":"Updated At","description":"When it last changed.","examples":["2026-04-14T09:50:01Z"]},"page_type":{"$ref":"#/components/schemas/PageTypeResponse","description":"Page-type detection.","readOnly":true},"shop":{"$ref":"#/components/schemas/ShopResponse","description":"Shop settings.","readOnly":true},"spa":{"type":"boolean","title":"Spa","description":"Whether the application is a single-page app, set by hand.","readOnly":true},"collection":{"$ref":"#/components/schemas/CollectionResponse","description":"What the tracker collects.","readOnly":true},"collector":{"$ref":"#/components/schemas/CollectorResponse","description":"Where beacons are posted.","readOnly":true},"script":{"$ref":"#/components/schemas/ScriptResponse","description":"The served tracker bundle.","readOnly":true},"site_defaults":{"$ref":"#/components/schemas/SiteDefaultsResponse","description":"Defaults the application's domains inherit.","readOnly":true}},"type":"object","required":["id","organization_id","name","environment","site_policy","source_hash","collector_hash","collector_mode","is_active","created_at","updated_at","page_type","shop","spa","collection","collector","script","site_defaults","pagetype_ruleset","platform","uptime_enabled","uptime_cache_buster","uptime_headers","uptime_headers_redacted","uptime_page_types","site_count"],"title":"ApplicationResponse"},"ApplicationSiteCreate":{"properties":{"domain":{"type":"string","maxLength":8192,"title":"Domain","description":"The domain to adopt, without scheme or port. A pasted URL keeps its host."},"name":{"anyOf":[{"type":"string","maxLength":255},{"type":"null"}],"title":"Name","description":"Display name for the new domain. Defaults to the domain itself."}},"type":"object","required":["domain"],"title":"ApplicationSiteCreate","description":"Adopt a domain into an application as a child site.\n\nDeliberately minimal: the collection config is the application's, applied at\ningest, so only the domain (and an optional display name) are needed. The\ncreated site carries NO own embed - it is served/collected via the\napplication's. Typically called with a hostname from the discovery list."},"ApplicationUpdate":{"properties":{"name":{"anyOf":[{"type":"string","maxLength":255},{"type":"null"}],"title":"Name","description":"Display name of the application."},"environment":{"anyOf":[{"$ref":"#/components/schemas/Environment"},{"type":"null"}],"description":"Deployment environment. Production applications are billed, development ones are not."},"site_policy":{"anyOf":[{"$ref":"#/components/schemas/SitePolicy"},{"type":"null"}],"description":"What happens to a beacon whose hostname is not a registered domain of this application."},"pagetype_ruleset":{"anyOf":[{"type":"string","maxLength":24},{"type":"null"}],"title":"Pagetype Ruleset","description":"Shorthand that sets `platform` and turns `pagetype_body_class` on, or turns it off with an empty string. Kept for older clients.","deprecated":true},"page_type":{"anyOf":[{"$ref":"#/components/schemas/PageTypeInput"},{"type":"null"}],"description":"Page-type detection."},"shop":{"anyOf":[{"$ref":"#/components/schemas/ShopInput"},{"type":"null"}],"description":"Shop settings."},"collection":{"anyOf":[{"$ref":"#/components/schemas/CollectionInput"},{"type":"null"}],"description":"What the tracker collects."},"collector":{"anyOf":[{"$ref":"#/components/schemas/CollectorInput"},{"type":"null"}],"description":"Where beacons are posted."},"script":{"anyOf":[{"$ref":"#/components/schemas/ScriptInput"},{"type":"null"}],"description":"The served tracker bundle."},"site_defaults":{"anyOf":[{"$ref":"#/components/schemas/SiteDefaultsInput"},{"type":"null"}],"description":"Defaults the application's domains inherit."},"platform":{"anyOf":[{"$ref":"#/components/schemas/PlatformInput"},{"type":"null"}],"description":"The system the application runs on, when it is known."},"spa":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Spa","description":"Whether the application is a single-page app."},"collector_mode":{"anyOf":[{"$ref":"#/components/schemas/CollectorMode"},{"type":"null"}],"description":"Where the served bundle posts its beacons. Deprecated, use `collector.mode`.","deprecated":true},"collector_endpoint":{"anyOf":[{"type":"string","maxLength":255},{"type":"null"}],"title":"Collector Endpoint","description":"The URL beacons are posted to. Only with `collector_mode=custom`. Deprecated, use `collector.endpoint`.","deprecated":true},"is_active":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Active","description":"Whether the application is enabled."},"uptime_enabled":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Uptime Enabled","description":"Whether the uptime probe checks the domains of this application. Off ends their open outage and slow response observations at once."},"uptime_cache_buster":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Uptime Cache Buster","description":"Whether the uptime probe adds `nocache` to the URLs it checks, so the check reaches the origin and not the CDN. Takes effect within a minute."},"uptime_headers":{"anyOf":[{"additionalProperties":{"type":"string"},"type":"object"},{"type":"null"}],"title":"Uptime Headers","description":"Request headers the uptime probe sends with every check, such as a WAF allow token. At most 5, names are stored lowercase, and `host`, `content-length`, `transfer-encoding`, `connection` and `user-agent` are refused. Values are printable ASCII of at most 256 characters, without a space at either end. Replaces the stored set, `null` or `{}` removes it. An empty value keeps the stored value of that name, so a response with hidden values sent back changes nothing."},"uptime_page_types":{"anyOf":[{"additionalProperties":{"$ref":"#/components/schemas/UptimePageTypeSetting"},"propertyNames":{"$ref":"#/components/schemas/UptimePageType"},"type":"object"},{"type":"null"}],"title":"Uptime Page Types","description":"How the uptime probe checks each page type besides the home page, keyed by page type. A type left out is `automatic`. Replaces the stored settings, `null` or `{}` sets every type back to `automatic`. Takes effect within a minute. The home page cannot be switched off or fixed."}},"additionalProperties":false,"type":"object","title":"ApplicationUpdate"},"ApplicationUptimeAvailability":{"properties":{"application_id":{"type":"string","format":"uuid","title":"Application Id","description":"Identifier of the application.","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"availability":{"type":"number","title":"Availability","description":"Share 0..1 of the window in which no active site of the application had an open outage, rounded to 4 decimals. An overlap of two sites counts once. 1 without an outage in the window."},"downtime_seconds":{"type":"integer","title":"Downtime Seconds","description":"Seconds of the window in which at least one active site of the application had an open outage, an open one up to now. 0 without an outage in the window."}},"type":"object","required":["application_id","availability","downtime_seconds"],"title":"ApplicationUptimeAvailability","description":"The availability of one production application with the probe switched on."},"ApplicationUptimeSeriesResponse":{"properties":{"series":{"items":{"$ref":"#/components/schemas/UptimeTargetSeries"},"type":"array","title":"Series","description":"The checks of the window per target over all active sites of the application together, bucketed: one series per target with a check in the window, the home page first, then the page types in rotation order. The quantiles are over the pooled checks, not a mean of the sites'. Empty while no check ran or the application has no active site."},"samples":{"items":{"$ref":"#/components/schemas/UptimeSample"},"type":"array","title":"Samples","description":"The checks of the window over all active sites of the application, each with its `site_id`, the newest first, at most 3000 together. A longer window holds the newest 3000 only. Empty while no check ran or the application has no active site."},"site_series":{"title":"Site Series","description":"With `by_site=true` only: one series per active site of the application in the order of `GET /applications/{app_id}/uptime`, every bucket of the window with the checks and the failed checks of all its targets together. A site without a check in the window has every bucket at 0. Absent without `by_site`.","items":{"$ref":"#/components/schemas/UptimeSiteSeries"},"type":"array"},"availability":{"type":"number","title":"Availability","description":"Share 0..1 of the window in which no active site of the application had an open outage, rounded to 4 decimals. The outages of the sites are merged in time, so an overlap counts once. 1 without an outage in the window or without an active site."},"downtime_seconds":{"type":"integer","title":"Downtime Seconds","description":"Seconds of the window in which at least one active site of the application had an open outage, an open one up to now. Wall-clock time, not the sum over the sites. 0 without an outage in the window."},"time_range":{"$ref":"#/components/schemas/TimeRange","description":"The window the samples, the series and the availability cover, as the server resolved it."}},"type":"object","required":["series","samples","availability","downtime_seconds","time_range"],"title":"ApplicationUptimeSeriesResponse","description":"The checks of every active site of an application over a window, pooled."},"ArrivalType":{"type":"string","enum":["first","return"],"title":"ArrivalType","description":"Why a journey step counts as an arrival from outside (section 28).\n\nNo `payment_return`: the referrer host is not stored, so a return from a\npayment or 3-D Secure page cannot be told apart at query time."},"AuditAction":{"type":"string","enum":["org.created","org.deleted","org.consent_changed","org.plan_changed","org.partner_changed","org.approval_changed","org.ownership_transferred","org.member_added","org.member_removed","org.member_role_changed","partner.added","partner.removed","partner.coverage_changed","partner.contract_changed","org.grants_changed","org.included_pageviews_changed","billing.trial_requested","billing.trial_granted","billing.trial_rejected","billing.trial_ended","billing.checkout_started","billing.activated","billing.payment_failed","billing.past_due","billing.canceled","billing.discount_changed","billing.plan_changed","billing.downgrade_scheduled","billing.addon_purchased","billing.addon_changed","billing.payment_method_updated","billing.chargeback","billing.refunded","site.created","site.updated","site.deleted","site.hashes_rotated","event.updated","event.deleted","org_tracker.created","org_tracker.updated","org_tracker.deleted","org_tracker.hashes_rotated","org_tracker.proxy_secret_rotated","org_tracker.proxy_secret_disabled","org_tracker.site_assigned","org_tracker.site_unassigned","synthetic_page.created","synthetic_page.updated","synthetic_page.deleted","user.status_changed","user.2fa_reset","api_key.regenerated","app_token.issued","app_token.revoked","api_key.issued","api_key.revoked","api_key.updated","api_key.rotated","passkey.registered","passkey.removed","application.sampling_rate_changed","observation.deleted","observation.updated","error.acknowledged","error.reopened"],"title":"AuditAction","description":"Audited actions. Extend as more events become worth recording."},"AuditLogEntry":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":"Identifier of the entry.","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"action":{"$ref":"#/components/schemas/AuditAction","description":"What was done."},"actor_user_id":{"title":"Actor User Id","description":"The person who acted.","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"],"type":"string","format":"uuid"},"actor_email":{"title":"Actor Email","description":"Their address, snapshotted, so a deleted account still says who it was.","type":"string"},"actor_api_key_id":{"title":"Actor Api Key Id","description":"The organization's own key, when no person was behind the request.","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"],"type":"string","format":"uuid"},"actor_grant_id":{"title":"Actor Grant Id","description":"The app connection, when a connected app made the request.","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"],"type":"string","format":"uuid"},"actor_system":{"title":"Actor System","description":"The scheduled job that acted, such as `sampling-controller`, when no person or credential was behind the change.","type":"string"},"actor_label":{"title":"Actor Label","description":"Display name for a credential actor: the key's name, or the app's client id. Absent for a person and for a credential that no longer exists.","type":"string"},"target_type":{"description":"What kind of thing was changed.","$ref":"#/components/schemas/AuditTargetType"},"target_id":{"title":"Target Id","description":"Which one.","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"],"type":"string","format":"uuid"},"changes":{"additionalProperties":true,"type":"object","title":"Changes","description":"What changed, as recorded at the time."},"created_at":{"type":"string","format":"date-time","title":"Created At","description":"When it happened.","examples":["2026-04-14T09:50:01Z"]}},"type":"object","required":["id","action","changes","created_at"],"title":"AuditLogEntry","description":"One recorded change in the audit trail.\n\n**Who acted**, and a credential is as real an answer as a person:\n\n- a person acted: `actor_user_id` + `actor_email`\n- an organization's own key acted: `actor_api_key_id` + `actor_label`\n- an org-owned connected app acted: `actor_grant_id` + `actor_label`\n- a **personal** connected app acted: both - `actor_user_id` + `actor_email`\n  for the person who is accountable, and `actor_grant_id` + `actor_label`\n  for the connection they acted through. It is the one combination that\n  appears, and it exists because \"she did it herself\" and \"the assistant she\n  connected did it\" are different events.\n- a scheduled job acted: `actor_system` alone, the job's name\n\n`actor_label` is resolved when the entry is read, so an entry whose\ncredential has since been deleted comes back with the id and no label. The\nperson's address is snapshotted instead (`actor_email`), because a deleted\nuser leaves nothing to resolve against."},"AuditTargetType":{"type":"string","enum":["organization","site","org_tracker","synthetic_page","user","partner","app_token","api_key","passkey","observation","error_acknowledgement"],"title":"AuditTargetType"},"BeaconBreakdownsRequest":{"properties":{"time_range":{"$ref":"#/components/schemas/TimeRange","description":"Time range for the query"},"filters":{"$ref":"#/components/schemas/Filters","description":"Optional filters"},"timezone":{"anyOf":[{"type":"string","maxLength":64},{"type":"null"}],"title":"Timezone","description":"IANA time zone the local hours of `filters.hour_of_day` are read in, such as `Europe/Berlin`. The filter requires it. This route buckets nothing, so the zone changes nothing else"},"sparse_buckets":{"anyOf":[{"$ref":"#/components/schemas/SparseBuckets"},{"type":"null"}],"description":"The sparse threshold of the page, the number `POST /analytics/sparse-hours` derives. With `exclude` the rows of the thin hours are left out. Without it the route only echoes the number in `meta.sparse_buckets`"}},"additionalProperties":false,"type":"object","required":["time_range"],"title":"BeaconBreakdownsRequest","description":"Request for the orthogonal beacon-ingestion breakdowns."},"BeaconBreakdownsResponse":{"properties":{"beacon_count":{"type":"integer","title":"Beacon Count"},"beacons_by_collection_mode":{"additionalProperties":{"type":"integer"},"type":"object","title":"Beacons By Collection Mode"},"beacons_by_delivery_method":{"additionalProperties":{"type":"integer"},"type":"object","title":"Beacons By Delivery Method"},"beacons_by_lifecycle":{"additionalProperties":{"type":"integer"},"type":"object","title":"Beacons By Lifecycle"},"beacons_by_tracker_version":{"additionalProperties":{"type":"integer"},"type":"object","title":"Beacons By Tracker Version"}},"type":"object","required":["beacon_count","beacons_by_collection_mode","beacons_by_delivery_method","beacons_by_lifecycle","beacons_by_tracker_version"],"title":"BeaconBreakdownsResponse","description":"Response with orthogonal beacon-count breakdowns across the\ningestion-side dimensions of the same row set.\n\nEvery count here is a count of STORED beacons, never scaled by the sampling\nweight: the values double as row filters for the beacon explorer, so they\nhave to match the rows that tool can actually show.\n\nThe first three maps are fixed-enum and each sums to `beacon_count`;\n`beacons_by_tracker_version` is open-valued and capped at the top-20:\n\n- `beacons_by_collection_mode`: privacy class. Inferred from `session_id`:\n  non-empty means the beacon was collected in full mode (consent given or\n  site set to FULL), empty means anonymous.\n- `beacons_by_delivery_method`: transport channel. Server-classified at\n  ingest from request shape + tracker marker (see migration 024).\n- `beacons_by_lifecycle`: pageview-lifecycle stage when the beacon was\n  emitted (init / loaded / hidden / ...). Useful to gauge how often\n  pageviews reach the loaded state vs. bounce before LCP.\n- `beacons_by_tracker_version`: top tracker bundles by beacon volume, format\n  `YYMMDD-<git-sha>[-dirty]`. Open value space (one per build), so\n  capped at the top-20 by count to bound response size. Lets you watch\n  cache-rollover progress and spot stale builds. Empty string covers\n  legacy beacons (pre-stamp migration) and the static `<noscript>`\n  pixel which has no runtime to stamp.\n\nMaps over flat `*_count` fields so new values (additional delivery\nchannels, future lifecycle stages, new tracker builds) flow through\nwithout a schema change on either side. Frontend computes percentages\nfrom `count / beacon_count`."},"BeaconError":{"properties":{"fingerprint":{"type":"string","title":"Fingerprint","description":"Stable group-by key for this error signature."},"error_type":{"type":"string","title":"Error Type","description":"Error class name. Never ResourceLoadError: those are `failed_resource_loads` on the same row. The engine names the class, so the set grows without us: TypeError | ReferenceError | ..."},"ownership":{"$ref":"#/components/schemas/Ownership","description":"`first_party` if any captured frame sits on the page's own registrable domain, so an own bundle on a CDN subdomain counts as the site's. Never `mixed`: one beacon error is one attribution."},"count":{"type":"integer","title":"Count","description":"Occurrences of this signature on this beacon"},"sample_message":{"type":"string","title":"Sample Message","description":"Short PII-stripped message fingerprint (≤80 chars after sanitization)"},"frames":{"items":{"$ref":"#/components/schemas/ErrorFrameInfo"},"type":"array","title":"Frames","description":"Captured stack frames (max 5). frames[0] is the throw site."},"error_class":{"type":"string","title":"Error Class","description":"Classification (migration 048): '' = real error, 'blocked' = ad-blocked tracker request (a status-0 ResourceLoadError against a known tracker host, excluded from error_count).","default":""}},"type":"object","required":["fingerprint","error_type","ownership","count","sample_message","frames","error_class"],"title":"BeaconError","description":"One bucketed error from a beacon's structured `errors` Nested column.\n\nServer-side projection of the parallel arrays (`errors.type`,\n`errors.frame_*`, `errors.fingerprint`, …) introduced in migration 010\nand extended to multi-frame in migration 017. The tracker emits up to\nfive entries per beacon, deduplicated locally by an internal hash key\nand capped via `errors.js`."},"BeaconFailedResource":{"properties":{"host":{"type":"string","title":"Host","description":"Host that should have served the resource."},"path":{"type":"string","title":"Path","description":"Path of the resource. Empty unless the site collects error frames: without them the privacy strip keeps a path only for the exact page host, while ownership asks the registrable domain.","default":""},"count":{"type":"integer","title":"Count","description":"Failed load events for this resource on this beacon."},"ownership":{"$ref":"#/components/schemas/Ownership","description":"`first_party` when the host is on the site's own registrable domain, so the failure is the operator's to fix. Never `mixed`: one row is one host."},"fingerprint":{"type":"string","title":"Fingerprint","description":"Group key, the same one `/analytics/failed-resources` returns."}},"type":"object","required":["host","count","ownership","fingerprint","path"],"title":"BeaconFailedResource","description":"One failed resource load from a beacon's `errors` Nested column.\n\nSame storage as BeaconError, other population: an `<img>`/`<script>`/\n`<link>` whose load failed carries exactly one frame, and that frame IS the\nresource. It is projected apart from `errors` because `error_count` stopped\ncounting these in migration 073, so a row that listed both under one name\ncontradicted its own scalars."},"BeaconFetchXhr":{"properties":{"method":{"type":"string","title":"Method","description":"HTTP method"},"host":{"type":"string","title":"Host","description":"Target host ('' = same-origin)"},"path":{"type":"string","title":"Path","description":"Templated path"},"calls":{"type":"integer","title":"Calls","description":"Calls to this endpoint on this pageview"},"sum_ms":{"type":"integer","title":"Sum Ms","description":"Total duration (ms)"},"max_ms":{"type":"integer","title":"Max Ms","description":"Slowest single call (ms)"},"error_count":{"type":"integer","title":"Error Count","description":"Errored calls (status >= 400 or network)"},"errors_by_status_code":{"additionalProperties":{"type":"integer"},"type":"object","title":"Errors By Status Code","description":"Error-status distribution on this pageview (code → count)"},"duration_buckets":{"additionalProperties":{"type":"integer"},"type":"object","title":"Duration Buckets","description":"Latency histogram (bucket-upper-ms → count)"},"sync_calls":{"type":"integer","title":"Sync Calls","description":"Synchronous XHR (main-thread-blocking) calls","default":0},"aborts":{"type":"integer","title":"Aborts","description":"Aborted calls (user/navigation cancellation)","default":0},"blocked":{"type":"integer","title":"Blocked","description":"Ad-blocked status-0 calls to tracker hosts (not real failures)","default":0},"sum_bytes":{"type":"integer","title":"Sum Bytes","description":"Σ transferSize (same-origin/TAO; 0 masked)","default":0},"max_bytes":{"type":"integer","title":"Max Bytes","description":"Largest response (bytes); 0 masked","default":0},"sum_offset_ms":{"type":"integer","title":"Sum Offset Ms","description":"Σ start-offset from PV start (ms); sum_offset_ms/calls ≈ the endpoint's average waterfall position","default":0}},"type":"object","required":["method","host","path","calls","sum_ms","max_ms","error_count","errors_by_status_code","duration_buckets","sync_calls","aborts","blocked","sum_bytes","max_bytes","sum_offset_ms"],"title":"BeaconFetchXhr","description":"One fetch_xhr endpoint this pageview called (from fetch_xhr_endpoints)."},"BeaconFetchXhrOutlier":{"properties":{"method":{"type":"string","title":"Method","description":"HTTP method"},"host":{"type":"string","title":"Host","description":"Target host ('' = same-origin)"},"path":{"type":"string","title":"Path","description":"Templated path"},"duration_ms":{"type":"integer","title":"Duration Ms","description":"Call duration (ms)"},"status_code":{"type":"integer","title":"Status Code","description":"HTTP status (0 = network error / unknown)"},"ttfb_ms":{"title":"Ttfb Ms","description":"TTFB (ms); absent = cross-origin masked","type":"integer"},"server_timing_phases":{"additionalProperties":{"type":"number"},"type":"object","title":"Server Timing Phases","description":"The call's own backend phases (name → ms) from Server-Timing - same-origin/TAO only (empty cross-origin)."}},"type":"object","required":["method","host","path","duration_ms","status_code","server_timing_phases"],"title":"BeaconFetchXhrOutlier","description":"One slow fetch_xhr (>500 ms) captured on this pageview (fetch_xhr_outliers)."},"BeaconLoAF":{"properties":{"script_host":{"type":"string","title":"Script Host","description":"Attributed script host ('' = unattributed)"},"script_path":{"type":"string","title":"Script Path","description":"Attributed script path (origin-relative)"},"invoker_type":{"type":"string","title":"Invoker Type","description":"'eval' when the script's URL is neither a document URL nor a resource the page loaded, so its code ran through eval and the host and path are a name the code gave itself. '' otherwise and on beacons of older trackers","default":""},"total_ms":{"type":"integer","title":"Total Ms","description":"Total blocking time attributed to this script (ms)"},"frame_count":{"type":"integer","title":"Frame Count","description":"Number of long-animation-frame occurrences"}},"type":"object","required":["script_host","script_path","total_ms","frame_count","invoker_type"],"title":"BeaconLoAF","description":"One Long-Animation-Frame script attribution on this pageview (from the `loaf` Nested)."},"BeaconRow":{"properties":{"started_at":{"type":"string","format":"date-time","title":"Started At","examples":["2026-04-14T09:50:01Z"],"description":"ISO 8601 in UTC with a `Z` suffix."},"ended_at":{"type":"string","format":"date-time","title":"Ended At","examples":["2026-04-14T09:50:01Z"],"description":"ISO 8601 in UTC with a `Z` suffix."},"session_id":{"type":"string","title":"Session Id"},"stitch":{"title":"Stitch","type":"string"},"pvid":{"title":"Pvid","type":"string"},"url":{"type":"string","title":"Url"},"site_id":{"title":"Site Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"],"description":"An ID, a UUID in lowercase with hyphens.","type":"string","format":"uuid"},"beacon_version":{"title":"Beacon Version","type":"integer"},"tracker_version":{"title":"Tracker Version","type":"string"},"lifecycle":{"title":"Lifecycle","type":"string"},"delivery_method":{"title":"Delivery Method","type":"string"},"domain":{"title":"Domain","type":"string"},"referrer_source":{"title":"Referrer Source","type":"string"},"referrer_medium":{"title":"Referrer Medium","type":"string"},"utm_source":{"title":"Utm Source","type":"string"},"utm_medium":{"title":"Utm Medium","type":"string"},"utm_campaign":{"title":"Utm Campaign","type":"string"},"utm_term":{"title":"Utm Term","type":"string"},"utm_content":{"title":"Utm Content","type":"string"},"click_id_param":{"title":"Click Id Param","type":"string"},"browser":{"title":"Browser","type":"string"},"browser_version":{"title":"Browser Version","type":"string"},"device_type":{"$ref":"#/components/schemas/DeviceType"},"os":{"title":"Os","type":"string"},"country":{"title":"Country","type":"string"},"asn":{"title":"Asn","description":"Autonomous system number of the visitor's network, absent when unknown","type":"integer"},"isp":{"title":"Isp","description":"Name of that network, absent when unknown","type":"string"},"connection_type":{"title":"Connection Type","type":"string"},"viewport_class":{"title":"Viewport Class","type":"string"},"lcp":{"title":"Lcp","type":"number"},"fcp":{"title":"Fcp","type":"number"},"cls":{"title":"Cls","type":"number"},"inp":{"title":"Inp","type":"number"},"tbt":{"title":"Tbt","type":"number"},"ttfb":{"title":"Ttfb","type":"number"},"ttfb_final":{"title":"Ttfb Final","type":"number"},"page_load_time":{"title":"Page Load Time","type":"number"},"dom_interactive":{"title":"Dom Interactive","type":"number"},"start_render":{"title":"Start Render","type":"number"},"fetch_start":{"title":"Fetch Start","description":"When the browser began fetching the final document, ms from the navigation start. Redirects lie before it. Absent on soft navigation, BFCache and prerender","type":"number"},"request_start":{"title":"Request Start","description":"When the browser began sending the request, ms from the navigation start. Absent on soft navigation, BFCache and prerender, and dropped on its own when it is later than the first byte or earlier than `fetch_start`","type":"number"},"redirect_count":{"title":"Redirect Count","description":"Redirects before the document, 0 once one of them was cross-origin. Absent on soft navigation and BFCache","type":"integer"},"content_transfer_duration":{"title":"Content Transfer Duration","type":"number"},"dns_lookup":{"title":"Dns Lookup","type":"number"},"tcp_connection":{"title":"Tcp Connection","type":"number"},"tls_handshake":{"title":"Tls Handshake","description":"The TLS handshake in ms, a part of `tcp_connection`. Absent without a handshake, as on a reused connection, on soft navigation, BFCache and prerender","type":"number"},"worker_start":{"title":"Worker Start","description":"When the service worker started, ms from the navigation start. Redirects lie before it, the worker's own start between it and `fetch_start`. Absent without a worker, on soft navigation, BFCache and prerender","type":"number"},"total_byte_weight":{"title":"Total Byte Weight","description":"Bytes the visitor downloaded for the page, the `transferSize` of the document and every resource. A resource from the browser cache adds 0","type":"integer"},"page_weight":{"title":"Page Weight","description":"Bytes the page weighs on a first view, the `encodedBodySize` of the document and every resource whether it came from the network or the browser cache. A lower bound, as a cross-origin resource without `Timing-Allow-Origin` reports no size. Absent on a soft navigation, a back/forward cache restore and a view where a visible resource reported no size","type":"integer"},"browser_cache_bytes":{"title":"Browser Cache Bytes","description":"The part of `page_weight` the browser cache answered, in bytes. Absent where `page_weight` is","type":"integer"},"cache_hit_rate":{"title":"Cache Hit Rate","type":"number"},"cached_resources":{"title":"Cached Resources","type":"integer"},"page_cached":{"title":"Page Cached","type":"integer"},"service_worker_active":{"title":"Service Worker Active","type":"integer"},"error_count":{"title":"Error Count","type":"integer"},"errors":{"items":{"$ref":"#/components/schemas/BeaconError"},"type":"array","title":"Errors","description":"Structured per-beacon JavaScript errors (top 5 by occurrence). Sourced from the ClickHouse `errors` Nested column. Failed resource loads share that column and are NOT in this list, they are `failed_resource_loads`. Empty list when no errors were captured on this beacon."},"failed_resources":{"title":"Failed Resources","type":"integer"},"failed_resource_loads":{"items":{"$ref":"#/components/schemas/BeaconFailedResource"},"type":"array","title":"Failed Resource Loads","description":"Resources whose load failed (top 3 by occurrence). `failed_resources` counts ALL of them, this list carries the ones that fit on the wire, so the two disagree on a page with many broken resources."},"slowest_resource_duration":{"title":"Slowest Resource Duration","type":"integer"},"resource_count":{"title":"Resource Count","type":"integer"},"bfcache_hit":{"title":"Bfcache Hit","type":"integer"},"nav_type":{"title":"Nav Type","type":"string"},"status_code":{"title":"Status Code","type":"integer"},"protocol":{"title":"Protocol","type":"string"},"lcp_element":{"title":"Lcp Element","type":"string"},"lcp_url":{"title":"Lcp Url","type":"string"},"lcp_bytes":{"title":"Lcp Bytes","description":"Bytes of the LCP image, the `encodedBodySize` of its resource, compressed like `page_weight`. Absent where the LCP element is no image, the browser hid the size, as on a cross-origin image without `Timing-Allow-Origin`, and on a soft navigation","type":"integer"},"cls_element":{"title":"Cls Element","type":"string"},"third_party_duration":{"title":"Third Party Duration","type":"integer"},"third_party_count":{"title":"Third Party Count","type":"integer"},"connection_rtt":{"title":"Connection Rtt","type":"integer"},"connection_downlink":{"title":"Connection Downlink","type":"number"},"visibility_dirty":{"title":"Visibility Dirty","type":"integer"},"prerendered":{"title":"Prerendered","type":"integer"},"activation_delta":{"title":"Activation Delta","type":"number"},"lcp_is_image":{"title":"Lcp Is Image","type":"integer"},"lcp_discovered_via":{"title":"Lcp Discovered Via","type":"string"},"lcp_fetch_priority":{"title":"Lcp Fetch Priority","type":"string"},"lcp_loading":{"title":"Lcp Loading","type":"string"},"lcp_delivery":{"title":"Lcp Delivery","description":"Where the LCP resource came from: `memory` or `disk` for the browser cache, `cache` where the browser allows no split, `network`, or `''` where the tracker could not tell. Extensible","type":"string"},"lcp_area":{"title":"Lcp Area","description":"The painted area of the LCP element in CSS px², two significant digits. On soft navigations too","type":"integer"},"cls_shift_time":{"title":"Cls Shift Time","description":"When the largest layout shift of the window that set `cls` happened, ms from the navigation start, activation adjusted. Absent on soft navigation and BFCache","type":"number"},"scroll_depth_max":{"title":"Scroll Depth Max","description":"How far through the document's scroll range the viewport got, 0 at the top to 1 at the bottom, in steps of 0.01. The furthest of the pageview, measured anew on every soft navigation. Absent without a scroll range, and on a soft navigation until its first scroll, shift or interaction","type":"number"},"cls_scroll_depth":{"title":"Cls Scroll Depth","description":"The scroll depth, 0..1 like `scroll_depth_max`, when the shift `cls_target` names was observed. Absent without that shift or a scroll range","type":"number"},"inp_scroll_depth":{"title":"Inp Scroll Depth","description":"The scroll depth, 0..1 like `scroll_depth_max`, when the interaction `inp` reports was observed. Absent without `inp` or a scroll range","type":"number"},"inp_loaf_duration":{"title":"Inp Loaf Duration","description":"The duration in ms of the longest Long Animation Frame overlapping the interaction `inp` reports, from its start to its next paint. Chromium only, absent elsewhere, without `inp` and without such a frame","type":"number"},"inp_loaf_script":{"title":"Inp Loaf Script","description":"The URL of that frame's longest script, origin and path only, `self` for code of the document itself, `''` for a frame without a script","type":"string"},"inp_loaf_invoker_type":{"title":"Inp Loaf Invoker Type","description":"How that script came to run, the Long Animation Frame API's `invokerType`: `user-callback`, `event-listener`, `resolve-promise`, `reject-promise`, `classic-script`, `module-script`, or `''` where unknown","type":"string"},"inp_loaf_function":{"title":"Inp Loaf Function","description":"That script's function name as the browser reports it, minified names included, `''` when anonymous","type":"string"},"inp_loaf_forced_layout":{"title":"Inp Loaf Forced Layout","description":"The ms of style and layout the frame's scripts forced, summed, a part of `inp_loaf_duration`. Absent without that frame","type":"number"},"client_anomalies":{"title":"Client Anomalies","description":"What the browser gave away about itself, a label that changes no number on its own: a driver's global on `window` (`automation`, which also sets `ua_anomaly`), no languages, a Chromium without `window.chrome` or plugins, a vendor string the engine contradicts, a viewport the device class contradicts, a version claiming an API the browser lacks. Empty for an unremarkable browser and for a beacon from a tracker without the checks","items":{"$ref":"#/components/schemas/ClientAnomaly"},"type":"array"},"dominant_third_party_category":{"title":"Dominant Third Party Category","type":"string"},"loaf_count":{"title":"Loaf Count","type":"integer"},"loaf_total_duration":{"title":"Loaf Total Duration","type":"integer"},"error_origin":{"title":"Error Origin","type":"string"},"cdn_cache_status":{"title":"Cdn Cache Status","type":"string"},"origin_cache_status":{"title":"Origin Cache Status","type":"string"},"edge_dur":{"title":"Edge Dur","type":"number"},"origin_dur":{"title":"Origin Dur","type":"number"},"backend_dur":{"title":"Backend Dur","type":"number"},"db_dur":{"title":"Db Dur","type":"number"},"http_dur":{"title":"Http Dur","type":"number"},"render_dur":{"title":"Render Dur","type":"number"},"search_dur":{"title":"Search Dur","type":"number"},"kv_dur":{"title":"Kv Dur","type":"number"},"code_dur":{"title":"Code Dur","type":"number"},"page_type":{"title":"Page Type","type":"string"},"origin_host":{"title":"Origin Host","type":"string"},"logged_in":{"title":"Logged In","type":"string"},"cdn_age":{"title":"Cdn Age","type":"integer"},"origin_age":{"title":"Origin Age","type":"integer"},"cdn_ttl":{"title":"Cdn Ttl","type":"integer"},"origin_ttl":{"title":"Origin Ttl","type":"integer"},"checkout_stage":{"title":"Checkout Stage","type":"string"},"cart_interactions":{"title":"Cart Interactions","type":"integer"},"cart_interaction_errors":{"title":"Cart Interaction Errors","type":"integer"},"datacenter":{"title":"Datacenter","type":"string"},"bot_name":{"title":"Bot Name","type":"string"},"bot_type":{"title":"Bot Type","type":"string"},"ua_anomaly":{"title":"Ua Anomaly","type":"string"},"is_datacenter":{"title":"Is Datacenter","type":"boolean"},"is_bot":{"title":"Is Bot","type":"boolean"},"bot_class":{"$ref":"#/components/schemas/BotClass"},"fetch_xhr_total_calls":{"title":"Fetch Xhr Total Calls","type":"integer"},"fetch_xhr_total_errors":{"title":"Fetch Xhr Total Errors","type":"integer"},"fetch_xhr_worst_ms":{"title":"Fetch Xhr Worst Ms","type":"integer"},"fetch_xhrs":{"items":{"$ref":"#/components/schemas/BeaconFetchXhr"},"type":"array","title":"Fetch Xhrs","description":"Endpoints this pageview called (fetch_xhr_endpoints)"},"fetch_xhr_outliers":{"items":{"$ref":"#/components/schemas/BeaconFetchXhrOutlier"},"type":"array","title":"Fetch Xhr Outliers","description":"Slow fetch_xhrs (>500ms) on this pageview"},"server_timing":{"items":{"$ref":"#/components/schemas/BeaconServerTiming"},"type":"array","title":"Server Timing","description":"Server-Timing custom keys (server_timing_dur + server_timing_desc maps)"},"loaf":{"items":{"$ref":"#/components/schemas/BeaconLoAF"},"type":"array","title":"Loaf","description":"Long-Animation-Frame per-script attribution on this pageview (loaf Nested)"},"third_party_by_category":{"additionalProperties":{"type":"integer"},"type":"object","title":"Third Party By Category","description":"Third-party blocking time by category (category → ms)"},"third_parties":{"additionalProperties":{"type":"integer"},"type":"object","title":"Third Parties","description":"Third-party blocking time by domain (domain → ms). Empty for beacons ingested in ANONYMOUS mode (domain keys suppressed at the edge)."},"resource_counts":{"additionalProperties":{"type":"integer"},"type":"object","title":"Resource Counts","description":"Resource count by type (type → count)"},"resource_sizes":{"additionalProperties":{"type":"integer"},"type":"object","title":"Resource Sizes","description":"Resource transfer size by type (type → bytes)"},"resource_durations":{"additionalProperties":{"type":"integer"},"type":"object","title":"Resource Durations","description":"Resource duration by type (type → ms)"},"cart_interaction_kinds":{"additionalProperties":{"type":"integer"},"type":"object","title":"Cart Interaction Kinds","description":"Cart-interaction kind → calls (add/change/remove/other), where the endpoint reveals it. Empty when the pageview issued none."},"metric_states":{"additionalProperties":{"$ref":"#/components/schemas/MetricState"},"type":"object","title":"Metric States","description":"The state of each metric on this pageview, by metric id: `lcp`, `inp`, `cls`, `tbt`, `fcp`, `ttfb`, `ttfb_final`, `status_code`, `loaf`, `lcp_element` for the LCP attribution, `dns_lookup`, `tcp_connection`, `fetch_start` and `request_start`. Tells a browser without the API from a pageview that ended before the value. Empty when `fields` leaves it out."},"redirect_kind":{"description":"What the time before the document request holds. `same_origin`: the browser counted redirects. `cross_origin`: it counted none, but the request starts too late for browser overhead alone, as a redirect through a foreign origin zeroes the count. Blink shows that time before `fetch_start`, WebKit moves `fetch_start` to 0 or 1 and shows it before `request_start`. `none`: no redirect. `not_applicable`: a soft navigation or a BFCache restore, which fetch no document. `unknown`: no `fetch_start`, as on a prerender or an older tracker, or an active service worker, whose start also lies before the fetch. Absent when `fields` leaves it out.","$ref":"#/components/schemas/RedirectKind"}},"type":"object","required":["started_at","ended_at","session_id","url","errors","failed_resource_loads","fetch_xhrs","fetch_xhr_outliers","server_timing","loaf","third_party_by_category","third_parties","resource_counts","resource_sizes","resource_durations","cart_interaction_kinds","metric_states"],"title":"BeaconRow","description":"One beacon (page view) row. Matches BEACON_ROW_FIELD_MAP.\n\nClosed schema: adding new columns requires updating both BEACON_ROW_FIELD_MAP\nand this model. The TS OpenAPI client is more useful with a closed shape than\na permissive `extra: allow`."},"BeaconServerTiming":{"properties":{"key":{"type":"string","title":"Key","description":"Server-Timing metric name"},"dur":{"type":"number","title":"Dur","description":"Reported duration (ms); 0 = desc-only categorical key"},"desc":{"type":"string","title":"Desc","description":"Server-Timing description (operator header text)","default":""}},"type":"object","required":["key","dur","desc"],"title":"BeaconServerTiming","description":"One Server-Timing custom key on this pageview.\n\nBuilt from the union of the `server_timing_dur` and `server_timing_desc`\nmaps, so a categorical key the operator sent without a duration (e.g.\n`Server-Timing: pop;desc=\"DE-1331\"`) is surfaced too: it arrives with\ndur=0.0 and a non-empty desc."},"BeaconsOrderBy":{"properties":{"field":{"type":"string","maxLength":64,"title":"Field","description":"Row field to sort by (any scalar BeaconRow field)"},"direction":{"$ref":"#/components/schemas/SortDirection","description":"Sort direction","default":"desc"}},"additionalProperties":false,"type":"object","required":["field"],"title":"BeaconsOrderBy","description":"Sort configuration for /analytics/beacons: any scalar row field.\n\nRows with a NULL sort value always sink to the end regardless of\ndirection (matching the client-side sort the dashboard applies), and\nstarted_at + session_id act as tiebreakers so pagination stays stable."},"BeaconsRequest":{"properties":{"time_range":{"$ref":"#/components/schemas/TimeRange","description":"Time range for the query"},"filters":{"$ref":"#/components/schemas/Filters","description":"Optional filters"},"timezone":{"anyOf":[{"type":"string","maxLength":64},{"type":"null"}],"title":"Timezone","description":"IANA time zone the local hours of `filters.hour_of_day` are read in, such as `Europe/Berlin`. The filter requires it. This route buckets nothing, so the zone changes nothing else"},"sparse_buckets":{"anyOf":[{"$ref":"#/components/schemas/SparseBuckets"},{"type":"null"}],"description":"The sparse threshold of the page, the number `POST /analytics/sparse-hours` derives. With `exclude` the rows of the thin hours are left out. Without it the route only echoes the number in `meta.sparse_buckets`"},"error_fingerprint":{"anyOf":[{"type":"string","maxLength":16},{"type":"null"}],"title":"Error Fingerprint","description":"Scope the list to pageviews carrying this signature (`errors.fingerprint`). Handled here, NOT via the shared Filters, because it's a Nested-array column that only exists on `beacons` - putting it in Filters would break the rollup-routed aggregate endpoints. Powers the /error page's 'open in Explorer' drill-down."},"error_fingerprint_kind":{"$ref":"#/components/schemas/ErrorFingerprintKind","description":"Which population `error_fingerprint` belongs to. Both halves of the `errors` column carry fingerprints, so a resource signature scoped as an error would silently return nothing.","default":"error"},"server_timing":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","title":"Server Timing","description":"Scope the list by custom Server-Timing keys: `{key: [desc, ...]}`. An empty value list matches on key PRESENCE (`{\"elasticsearch\": []}` = every pageview whose origin reported that key, timed or categorical); a non-empty list matches the categorical desc value (`{\"pop\": [\"DE-1331\"]}`). Multiple keys are ANDed, multiple values for one key are ORed. Handled here, NOT via the shared Filters, for the same reason as `error_fingerprint`: `server_timing_dur`/`server_timing_desc` are Map columns that the aggregate rollups do not store, so putting this in Filters would let it be silently ignored on the rollup-routed endpoints."},"limit":{"type":"integer","maximum":1000.0,"minimum":1.0,"title":"Limit","description":"Max rows per page","default":100},"offset":{"type":"integer","minimum":0.0,"title":"Offset","description":"Pagination offset (0-based)","default":0},"order_by":{"$ref":"#/components/schemas/BeaconsOrderBy","description":"Sort order, a {field, direction} object over any scalar row field; NULL values always sort last. Default shows most recent first (§11)."},"fields":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Fields","description":"Optional field projection. Null/omitted returns the full whitelist. started_at, session_id, url are always included regardless."},"live":{"type":"boolean","title":"Live","description":"Live view: skip the 30s-cached total count so brand-new beacons surface immediately. `has_more` is derived by over-fetching one row; `total_matched` is returned as null (unknown). Use for an auto-refreshing 'latest requests' table; leave off for normal paginated browsing where the exact total matters. Each call still reads the site's whole day, so poll no faster than every 10 s: the live branch allows 60 requests per minute per organization, then answers 429. Off, a window of 6 hours or less still reads the raw beacons like the charts do, and a longer one reads finalized pageviews, which miss the newest minutes and hold preliminary values for the running hour.","default":false}},"additionalProperties":false,"type":"object","required":["time_range"],"title":"BeaconsRequest","description":"Row-level drill-down request: individual beacons matching filters.\n\nResponse shape is row-per-beacon (no metric aggregation). Pair with\n/analytics/query when the user needs to go from an aggregate row to the\nspecific beacons behind it."},"BeaconsResponse":{"properties":{"meta":{"$ref":"#/components/schemas/AnalyticsMeta","description":"Facts about the result"},"request":{"$ref":"#/components/schemas/AnalyticsRequestEcho","description":"The request as the server resolved it"},"data":{"items":{"$ref":"#/components/schemas/BeaconRow"},"type":"array","title":"Data","description":"Matching beacons, at most `meta.limit`"}},"type":"object","required":["meta","request","data"],"title":"BeaconsResponse","description":"Response for /analytics/beacons.\n\nThe one ClickHouse list that pages by offset, so `meta` carries the full\npaging set (§9). `meta.total` is absent in `live` mode, where the cached\ncount is skipped for freshness and only `meta.has_more` is known."},"BotChange":{"type":"string","enum":["up","down"],"title":"BotChange","description":"Which way the bot page views of one occurrence went."},"BotClass":{"type":"string","enum":["bot","suspect","none"],"title":"BotClass","description":"Derived traffic verdict (never stored; see constants.BOT_CLASS_PREDICATES\nfor the SQL rules - a lockstep test pins the two value sets together)."},"BucketGranularity":{"type":"string","enum":["minute","five_minutes","fifteen_minutes","hour","six_hours","day","week","month"],"title":"BucketGranularity","description":"The bucket width an endpoint answers, `auto` already resolved (§28)."},"CacheAgeLayer":{"type":"string","enum":["cdn","origin","content"],"title":"CacheAgeLayer","description":"The tier a cache age belongs to, `content` being the computed sum."},"CacheLayer":{"type":"string","enum":["cdn","origin"],"title":"CacheLayer","description":"The tier a cache status was reported by."},"CappedListMeta":{"properties":{"total":{"type":"integer","title":"Total"},"limit":{"type":"integer","title":"Limit"}},"type":"object","required":["total","limit"],"title":"CappedListMeta","description":"Meta for a list that is capped at `limit` and has no page after it.\n\n`offset` and `has_more` are absent because they would be a promise: the\nupstream list takes a cap and nothing else, so there is no second page to\nask for. A caller that wants more raises `limit`."},"ChannelCreate":{"properties":{"channel_type":{"$ref":"#/components/schemas/NotificationChannelType","description":"Where the channel posts. Fixed once created."},"name":{"type":"string","maxLength":100,"minLength":1,"title":"Name","description":"What the channel is called in the list."},"webhook_url":{"type":"string","maxLength":2000,"minLength":1,"title":"Webhook Url","description":"The endpoint messages are posted to. Slack and Discord take their incoming webhook URL. Must use https and resolve to a public address."},"is_active":{"type":"boolean","title":"Is Active","description":"Whether the channel receives messages.","default":true},"language":{"type":"string","enum":["en","de"],"title":"Language","description":"The language the channel's messages are written in.","default":"en"}},"additionalProperties":false,"type":"object","required":["channel_type","name","webhook_url"],"title":"ChannelCreate"},"ChannelDeliveryStatus":{"type":"string","enum":["delivered","failed"],"title":"ChannelDeliveryStatus","description":"Whether the endpoint of a channel accepted a message."},"ChannelRef":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"],"description":"An ID, a UUID in lowercase with hyphens."},"name":{"type":"string","title":"Name"}},"type":"object","required":["id","name"],"title":"ChannelRef","description":"A notification channel another resource was sent to."},"ChannelResponse":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"],"description":"An ID, a UUID in lowercase with hyphens."},"organization":{"$ref":"#/components/schemas/OrganizationRef","description":"The organization the channel belongs to."},"channel_type":{"$ref":"#/components/schemas/NotificationChannelType","description":"Where the channel posts."},"name":{"type":"string","title":"Name","description":"What the channel is called in the list."},"webhook_url":{"type":"string","title":"Webhook Url","description":"The endpoint, cut to at most its first 40 characters and half its length, then `…`. The full URL is never read back, a change sends it again."},"secret":{"title":"Secret","description":"The `whsec_` key a webhook channel signs each body with per Standard Webhooks. Generated by fastmon: in full in the answer to the create and to `POST /notifications/channels/{channel_id}/rotate-secret`, `***` in every other answer. Absent on Slack and Discord.","type":"string"},"is_active":{"type":"boolean","title":"Is Active","description":"Whether the channel receives messages."},"language":{"type":"string","enum":["en","de"],"title":"Language","description":"The language the channel's messages are written in."},"created_at":{"type":"string","format":"date-time","title":"Created At","examples":["2026-04-14T09:50:01Z"],"description":"ISO 8601 in UTC with a `Z` suffix."},"updated_at":{"type":"string","format":"date-time","title":"Updated At","examples":["2026-04-14T09:50:01Z"],"description":"ISO 8601 in UTC with a `Z` suffix."}},"type":"object","required":["id","organization","channel_type","name","webhook_url","is_active","language","created_at","updated_at"],"title":"ChannelResponse","description":"A channel with its URL shortened and its secret masked."},"ChannelTestResponse":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelRef","description":"The channel the test message was posted to."},"status":{"$ref":"#/components/schemas/ChannelDeliveryStatus","description":"Whether the endpoint accepted the test message."},"delivery_error":{"title":"Delivery Error","description":"Why the endpoint did not accept it. Absent when delivered.","type":"string"}},"type":"object","required":["channel","status"],"title":"ChannelTestResponse"},"ChannelTestWebhook":{"properties":{"type":{"type":"string","const":"channel.test","title":"Type"},"timestamp":{"type":"string","format":"date-time","title":"Timestamp","description":"When the event happened: the start of the observation, for a trend midnight UTC of its first day, or of the occurrence, the evaluation of a rule, and the moment of sending for a test. The same on every attempt of one delivery.","examples":["2026-04-14T09:50:01Z"]},"data":{"$ref":"#/components/schemas/ChannelTestWebhookData"}},"type":"object","required":["type","timestamp","data"],"title":"ChannelTestWebhook","description":"Someone sent the channel a test message."},"ChannelTestWebhookData":{"properties":{"organization":{"$ref":"#/components/schemas/OrganizationRef","description":"The organization that owns the channel."},"channel":{"$ref":"#/components/schemas/ChannelRef","description":"The channel the test was posted to."},"message":{"$ref":"#/components/schemas/WebhookMessage"}},"type":"object","required":["organization","channel","message"],"title":"ChannelTestWebhookData"},"ChannelUpdate":{"properties":{"name":{"anyOf":[{"type":"string","maxLength":100,"minLength":1},{"type":"null"}],"title":"Name","description":"What the channel is called in the list."},"webhook_url":{"anyOf":[{"type":"string","maxLength":2000,"minLength":1},{"type":"null"}],"title":"Webhook Url","description":"The endpoint messages are posted to. Slack and Discord take their incoming webhook URL. Must use https and resolve to a public address."},"is_active":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Active","description":"Whether the channel receives messages."},"language":{"anyOf":[{"type":"string","enum":["en","de"]},{"type":"null"}],"title":"Language","description":"The language the channel's messages are written in."}},"additionalProperties":false,"type":"object","title":"ChannelUpdate","description":"Merge-patch of a channel. No field takes null. The secret changes by rotation alone."},"CheckoutCohort":{"properties":{"name":{"type":"string","title":"Name","description":"success = at least one success pageview was observed. checkout_no_success = reached the checkout and NO success was observed. The second one is NOT an abandonment count: a real buyer lands in it whenever the success is invisible to the tracker - a payment redirect returning to a thank-you page without the script, a purchase finished after the 24h stitch rotation or on another device, or Shopify's off-site checkout."},"visitors":{"type":"integer","title":"Visitors","description":"Visitors in the cohort, counted from the checkout events, so it reconciles with the funnel's steps. A visitor without a kept pageview counts here and adds nothing to `pageviews` or `vitals`. Weighted per visitor under a campaign or referrer filter, as the funnel's steps."},"pageviews":{"type":"integer","title":"Pageviews","description":"Their pageviews in the scanned window, weighted by the sampling permille of each stored pageview"},"vitals":{"additionalProperties":{"$ref":"#/components/schemas/MetricDistribution"},"type":"object","title":"Vitals","description":"Metric name -> distribution over the cohort's WHOLE journey, not just its funnel pages: the question is about the people, so a slow product page counts too."},"stages":{"items":{"$ref":"#/components/schemas/CohortStage"},"type":"array","title":"Stages","description":"The same numbers split by funnel stage"},"cart_calls":{"$ref":"#/components/schemas/CohortCartCalls"},"cart_interactions":{"type":"integer","title":"Cart Interactions","description":"Cart interactions the cohort's pageviews issued, weighted like `pageviews`","default":0},"cart_interaction_errors":{"type":"integer","title":"Cart Interaction Errors","description":"Of those, the failed ones - the 'cart is broken' signal, weighted like `pageviews`. Counted from the per-pageview marker, which is derived before the tracker's 24-endpoint cap.","default":0}},"type":"object","required":["name","visitors","pageviews","vitals","stages","cart_calls","cart_interactions","cart_interaction_errors"],"title":"CheckoutCohort","description":"One observationally defined group of visitors, and how they experienced the site."},"CheckoutCohortsRequest":{"properties":{"time_range":{"$ref":"#/components/schemas/TimeRange","description":"Time range for the query"},"filters":{"$ref":"#/components/schemas/Filters","description":"Optional filters"},"timezone":{"anyOf":[{"type":"string","maxLength":64},{"type":"null"}],"title":"Timezone","description":"IANA time zone the local hours of `filters.hour_of_day` are read in, such as `Europe/Berlin`. The filter requires it. This route buckets nothing, so the zone changes nothing else"},"sparse_buckets":{"anyOf":[{"$ref":"#/components/schemas/SparseBuckets"},{"type":"null"}],"description":"The sparse threshold of the page, the number `POST /analytics/sparse-hours` derives. With `exclude` the rows of the thin hours are left out. Without it the route only echoes the number in `meta.sparse_buckets`"},"identity":{"anyOf":[{"type":"string","enum":["stitch","session"]},{"type":"null"}],"title":"Identity","description":"Identifier to group visitors by: 'stitch' or 'session'. Null → the application's default (stitch preferred). Without a stored identifier there are no cohorts to build."}},"additionalProperties":false,"type":"object","required":["time_range"],"title":"CheckoutCohortsRequest","description":"Request for the buyer / non-buyer comparison."},"CheckoutCohortsResponse":{"properties":{"meta":{"$ref":"#/components/schemas/AnalyticsMeta","description":"Facts about the result"},"request":{"$ref":"#/components/schemas/AnalyticsRequestEcho","description":"The request as the server resolved it"},"cohorts":{"items":{"$ref":"#/components/schemas/CheckoutCohort"},"type":"array","title":"Cohorts"}},"type":"object","required":["meta","request","cohorts"],"title":"CheckoutCohortsResponse","description":"The cohorts of one window, in the order most-advanced first.\n\nA list rather than two named fields: customer-defined funnels evaluate\nlater with N steps, and their \"reached step k, never step k+1\" cohorts\nreuse this shape.\n\nThe cohorts are sized from the checkout events, so their visitor counts\nreconcile with the funnel's steps. What the site did for each group is\nmeasured over PAGEVIEWS, so a visitor with no pageview in the window counts\nin their cohort and adds nothing to `pageviews` or the vitals."},"CheckoutFunnelRequest":{"properties":{"time_range":{"$ref":"#/components/schemas/TimeRange","description":"Time range for the query"},"filters":{"$ref":"#/components/schemas/Filters","description":"Optional filters"},"identity":{"anyOf":[{"type":"string","enum":["stitch","session"]},{"type":"null"}],"title":"Identity","description":"Identifier to group the funnel by: 'stitch' or 'session'. Null → the application's default (stitch preferred), same resolution as /visitors. The funnel needs a stored identifier; without one there is nothing to follow from cart to success."},"granularity":{"$ref":"#/components/schemas/GranularityRequest","description":"Bucket size of the series: 'minute', 'five_minutes', 'fifteen_minutes', 'hour', 'six_hours', 'day', or 'auto' (default: the smallest width with at most 300 buckets over the window, and 'day' from 28 days). A width under an hour allows at most 1500 buckets.","default":"auto"},"timezone":{"anyOf":[{"type":"string","maxLength":64},{"type":"null"}],"title":"Timezone","description":"IANA time zone whose boundaries start the `six_hours`, `day`, `week` and `month` buckets, such as `Europe/Berlin`. A day is 23 or 25 hours long across a DST switch. Bucket timestamps stay UTC. In a zone whose offset is not whole hours a bucket starts at the UTC hour that holds the local boundary. Without it the buckets start at UTC boundaries"},"sparse_buckets":{"anyOf":[{"$ref":"#/components/schemas/SparseBuckets"},{"type":"null"}],"description":"The sparse threshold of the page, the number `POST /analytics/sparse-hours` derives. With `exclude` the rows of the thin hours are left out. Without it the route only echoes the number in `meta.sparse_buckets`"}},"additionalProperties":false,"type":"object","required":["time_range"],"title":"CheckoutFunnelRequest","description":"Request for the checkout funnel + its time series."},"CheckoutFunnelResponse":{"properties":{"meta":{"$ref":"#/components/schemas/AnalyticsMeta","description":"Facts about the result"},"request":{"$ref":"#/components/schemas/AnalyticsRequestEcho","description":"The request as the server resolved it"},"steps":{"items":{"$ref":"#/components/schemas/FunnelStep"},"type":"array","title":"Steps","description":"Funnel steps in funnel order"},"visitors_total":{"title":"Visitors Total","description":"Distinct visitors in the window, funnel or not - the denominator of conversion_rate. Counted over the same `identity` as the steps, so both halves of the rate describe one population. A visitor with a checkout event weighs one, every other visitor 1000 over the loosest sampling permille of their pageviews, so on a sampled application this is an estimate. Audience filters (site, country, device) narrow it. It holds the visitors of the pageviews and of the checkout events, so a visitor seen only in the checkout counts here too and conversion_rate stays at or below 1. ABSENT when this half of the query failed (per response_model_exclude_none): the steps are still reported, the rate is not.","type":"integer"},"conversion_rate":{"title":"Conversion Rate","description":"Visitors who reached the LAST step, over visitors_total. The classic e-commerce conversion rate: purchases over all traffic, the denominator GA4 ('session key event rate') and Shopify ('sessions converted') use, so a shop can hold it against the usual 1-3% benchmark. Buyers are counted exactly from events, visitors estimated from the sampled RUM data. Never exceeds 1.0; absent when visitors_total is. NOT a step rate: how the funnel narrows from one step to the next is FunnelStep.step_conversion_rate, and those stay unclamped.","type":"number"},"time_to_success_seconds":{"$ref":"#/components/schemas/MetricDistribution","description":"Seconds from funnel entry to the first success, over the visitors who reached it. Both ends are observed rows, so this is a measurement and not an estimate. `count` is the sample, so it equals the last step's `reached`. A p90 pulling away from the p50 is the checkout getting slow or getting in the way."},"cart_interactions":{"type":"integer","title":"Cart Interactions","description":"Visitors with at least one cart interaction (fetch/XHR cart mutation) over the window. A signal BESIDE the funnel steps: it only says an interaction happened, undercounts by design (fetch_xhr coverage), and is therefore not a conversion baseline.","default":0},"cart_interaction_rate":{"title":"Cart Interaction Rate","description":"cart_interactions over visitors_total - the add-to-cart rate, against a typical shop benchmark of 5-6%. Never exceeds 1.0; absent when visitors_total is. The underlying COUNT undercounts wherever the shop's cart calls are invisible to fetch/XHR collection (WooCommerce classic without the wc-ajax opt-in, OXID, anything posting the document) and never overcounts, so read the rate as a floor.","type":"number"},"cart_interaction_error_visitors":{"type":"integer","title":"Cart Interaction Error Visitors","description":"Visitors whose cart calls FAILED at least once over the window (transport error or an HTTP error status, including status 0). Read against cart_interactions: the share of shoppers who hit a broken cart. It moves before the conversion rate does, which is what makes it worth watching.","default":0},"cart_interaction_kinds":{"additionalProperties":{"type":"integer"},"type":"object","title":"Cart Interaction Kinds","description":"Kind -> visitors with >=1 interaction of that kind, where the shop system's endpoint reveals the kind: add | change | remove | other. 'change' includes Shopify's qty-0 removes; 'other' = the kind only lives in the POST body (never read). Only kinds that occurred appear."},"payment_submitted_visitors":{"title":"Payment Submitted Visitors","description":"Visitors who submitted payment in the checkout, from a Shopify Web Pixel event. A FACT BESIDE THE STEPS, not a fourth step: it is reported for the same run as the steps, and a visitor can carry it and a success at once. It can exceed the `checkout` step, because a visitor whose `begin_checkout` was lost still counts here. On Shopify a visitor with this and without a success most likely paid through a wallet (Shop Pay, Apple Pay) whose completion Shopify does not report, so the success step is a lower bound and the gap between the two numbers is where it is lost. ABSENT (per response_model_exclude_none) when no checkout event belongs to a run that ENTERED the funnel inside the requested window - an event of a buyer who entered before it counts for neither this field nor the steps. Also absent when none are collected (not a Shopify application, the events table is not installed, the identity is `session`, or a filter the event rows cannot honor such as URL, page type, campaign or a metric threshold), or when none occurred. 0 means events were read and nobody submitted payment.","type":"integer"},"timeseries":{"items":{"$ref":"#/components/schemas/FunnelBucket"},"type":"array","title":"Timeseries","description":"One point per bucket that had a funnel entry OR any traffic. Step counts are bucketed by funnel entry time, `visitors` by the pageview itself, so a bucket with traffic and no funnel activity appears with zero steps and a real denominator."}},"type":"object","required":["meta","request","steps","timeseries","time_to_success_seconds","cart_interactions","cart_interaction_error_visitors","cart_interaction_kinds"],"title":"CheckoutFunnelResponse","description":"Checkout funnel over the window plus its entry-day series."},"CheckoutInput":{"properties":{"tracking":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Tracking","description":"Mark cart, checkout and success pageviews."},"cart_paths":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Cart Paths","description":"URL patterns of the cart step, in the syntax of `page_type.url_rules`. Null uses the built-in set."},"paths":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Paths","description":"URL patterns of the checkout step, in the syntax of `page_type.url_rules`. Null uses the built-in set."},"success_paths":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Success Paths","description":"URL patterns of the completed-order step, in the syntax of `page_type.url_rules`. Null uses the built-in set."}},"additionalProperties":false,"type":"object","title":"CheckoutInput"},"CheckoutJourney":{"properties":{"visitor_id":{"type":"string","title":"Visitor Id","description":"Visitor identifier (stitch hex or session_id)"},"matched_at":{"type":"string","format":"date-time","title":"Matched At","description":"Time of their latest event of the stage in the window","examples":["2026-04-14T09:50:01Z"]},"pages":{"items":{"$ref":"#/components/schemas/CheckoutJourneyPageview"},"type":"array","title":"Pages","description":"Chronological pageviews"},"events":{"title":"Events","description":"Events of this visitor, oldest first, in the same +-24h window the pages are read on and not merged into `pages`: interleave the two by time. With `full_journey: false` only the events of the requested stage in the requested window come back, the events that picked the pages. `[]` means this visitor has none there. An event whose pageview the edge did not keep has no page beside it, so a journey can show a stage event without its page, or no page at all.","items":{"$ref":"#/components/schemas/VisitorEvent"},"type":"array"},"nel_reports":{"title":"Nel Reports","description":"NEL reports of this visitor, the Network Error Logging reports its browser sent, oldest first, in the same +-24h window the pages are read on and not merged into `pages`: interleave them by `timestamp`. Each is a row of POST /analytics/nel/reports without `visitor_id`. At most the latest 100 reports of the window per visitor. POST /analytics/nel/reports with `filters.stitch` pages through all of them. With `full_journey: false` only the reports of a returned page come back: those whose `page_url` or `request_url` equals the `url` of one of the journey's `pages`, so the failed load of the page itself stays. ABSENT (per response_model_exclude_none) when reports were not consulted: `identity` is session, a filter has no column on the nel_reports table, or the table is not installed. `[]` means they were consulted and this visitor has none. A report joins its visitor over the stitch, which has limits. Only sites with `store_stitch` carry one, and the zero stitch never joins. The edge rotates the stitch salt at 02:00 UTC, so a visitor's reports join within one day and the chain breaks at the boundary. A report may upload up to 48 hours after the failure and then carries the stitch of the upload, so a failure before a rotation that uploads after it belongs to no visitor. Only Chromium browsers report.","items":{"$ref":"#/components/schemas/NelReportRow"},"type":"array"},"csp_reports":{"title":"Csp Reports","description":"CSP reports of this visitor, the Content Security Policy violations its browser reported, oldest first, in the same +-24h window the pages are read on and not merged into `pages`: interleave them by `timestamp`. Each is a row of POST /analytics/csp/reports without `visitor_id` and `original_policy`, and one row stands for `report_count` identical reports. At most the latest 100 rows of the window per visitor. POST /analytics/csp/reports with `filters.stitch` pages through all of them. With `full_journey: false` only the reports whose `page_url` equals the `url` of one of the journey's `pages` come back. ABSENT (per response_model_exclude_none) when reports were not consulted: `identity` is session, a filter has no column on the csp_reports table, or the table is not installed. `[]` means they were consulted and this visitor has none. A CSP report joins its visitor over the stitch, as a NEL report does. Only sites with `store_stitch` carry one, and the zero stitch never joins. The edge rotates the stitch salt at 02:00 UTC, so a visitor's reports join within one day and the chain breaks at the boundary. A `report-to` report may upload up to 48 hours after the violation and then carries the stitch of the upload, while a `report-uri` report is sent at once. Practically every browser reports.","items":{"$ref":"#/components/schemas/CspReportRow"},"type":"array"}},"type":"object","required":["visitor_id","matched_at","pages"],"title":"CheckoutJourney","description":"One visitor's pageviews around their funnel hit."},"CheckoutJourneyPageview":{"properties":{"url":{"type":"string","title":"Url"},"started_at":{"type":"string","format":"date-time","title":"Started At","examples":["2026-04-14T09:50:01Z"],"description":"ISO 8601 in UTC with a `Z` suffix."},"ended_at":{"type":"string","format":"date-time","title":"Ended At","examples":["2026-04-14T09:50:01Z"],"description":"ISO 8601 in UTC with a `Z` suffix."},"checkout_stage":{"description":"Funnel stage of THIS pageview, absent outside the funnel","$ref":"#/components/schemas/CheckoutStage"},"cart_interactions":{"type":"integer","title":"Cart Interactions","description":"Cart interactions (fetch/XHR cart mutations) this pageview issued","default":0},"cart_interaction_errors":{"type":"integer","title":"Cart Interaction Errors","description":"Of those, failed ones (HTTP >= 400 or network failure) - the 'cart actions are failing' signal","default":0},"cart_interaction_kinds":{"additionalProperties":{"type":"integer"},"type":"object","title":"Cart Interaction Kinds","description":"Kind -> calls (add/change/remove/other), where the endpoint reveals it"},"page_type":{"title":"Page Type","type":"string"},"nav_type":{"title":"Nav Type","type":"string"},"lcp":{"title":"Lcp","type":"number"},"fcp":{"title":"Fcp","type":"number"},"cls":{"title":"Cls","type":"number"},"inp":{"title":"Inp","type":"number"},"ttfb":{"title":"Ttfb","type":"number"}},"type":"object","required":["url","started_at","ended_at","cart_interactions","cart_interaction_errors","cart_interaction_kinds"],"title":"CheckoutJourneyPageview","description":"One pageview inside a checkout journey.\n\nDeliberately narrower than `VisitorPageVisit`: a journey list projects many\nrows per visitor, so it carries the funnel hook, the URL and the four core\nvitals (which is what \"web vitals per funnel step\" needs) rather than the\nfull per-pageview record. `/visitors/detail` remains the full drill-in."},"CheckoutJourneysRequest":{"properties":{"time_range":{"$ref":"#/components/schemas/TimeRange","description":"Time range for the query"},"filters":{"$ref":"#/components/schemas/Filters","description":"Optional filters"},"timezone":{"anyOf":[{"type":"string","maxLength":64},{"type":"null"}],"title":"Timezone","description":"IANA time zone the local hours of `filters.hour_of_day` are read in, such as `Europe/Berlin`. The filter requires it. This route buckets nothing, so the zone changes nothing else"},"sparse_buckets":{"anyOf":[{"$ref":"#/components/schemas/SparseBuckets"},{"type":"null"}],"description":"The sparse threshold of the page, the number `POST /analytics/sparse-hours` derives. With `exclude` the rows of the thin hours are left out. Without it the route only echoes the number in `meta.sparse_buckets`"},"identity":{"anyOf":[{"type":"string","enum":["stitch","session"]},{"type":"null"}],"title":"Identity","description":"Identifier to group by; null → the application's default"},"stage":{"type":"string","enum":["cart","checkout","success"],"title":"Stage","description":"Which stage a visitor must have hit to be included","default":"success"},"full_journey":{"type":"boolean","title":"Full Journey","description":"True: every pageview of the matching visitors, in order - the whole journey around the hit. False: only the pageviews their events of the stage were sent from in the window.","default":true},"limit":{"type":"integer","maximum":200.0,"minimum":1.0,"title":"Limit","description":"Max visitors (not pageviews)","default":50}},"additionalProperties":false,"type":"object","required":["time_range"],"title":"CheckoutJourneysRequest","description":"Request for the journeys behind a funnel step."},"CheckoutJourneysResponse":{"properties":{"meta":{"$ref":"#/components/schemas/AnalyticsMeta","description":"Facts about the result"},"request":{"$ref":"#/components/schemas/AnalyticsRequestEcho","description":"The request as the server resolved it"},"stage":{"$ref":"#/components/schemas/CheckoutStage","description":"Stage the visitors were selected by"},"journeys":{"items":{"$ref":"#/components/schemas/CheckoutJourney"},"type":"array","title":"Journeys"}},"type":"object","required":["meta","request","stage","journeys"],"title":"CheckoutJourneysResponse"},"CheckoutResponse":{"properties":{"tracking":{"type":"boolean","title":"Tracking","description":"Mark cart, checkout and success pageviews so the funnel can be queried. Runs whether or not the application is a shop."},"cart_paths":{"title":"Cart Paths","description":"URL patterns of the cart step. Absent when the built-in set applies.","items":{"type":"string"},"type":"array"},"paths":{"title":"Paths","description":"URL patterns of the checkout step. Absent when the built-in set applies.","items":{"type":"string"},"type":"array"},"success_paths":{"title":"Success Paths","description":"URL patterns of the completed-order step. Absent when the built-in set applies.","items":{"type":"string"},"type":"array"}},"type":"object","required":["tracking"],"title":"CheckoutResponse"},"CheckoutStage":{"type":"string","enum":["cart","checkout","success"],"title":"CheckoutStage","description":"Where in the checkout funnel a pageview or a selection sits (§28).\n\nThe value set of `CHECKOUT_STAGES`, which the collector writes. A pageview\noutside the funnel carries no stage rather than a fourth value."},"CheckoutStagesBucket":{"properties":{"timestamp":{"type":"string","format":"date-time","title":"Timestamp","examples":["2026-04-14T09:50:01Z"],"description":"ISO 8601 in UTC with a `Z` suffix."},"reached_by_stage":{"additionalProperties":{"type":"integer"},"type":"object","title":"Reached By Stage","description":"Stage -> distinct visitors who reached it INSIDE this bucket, all three stages always present. A visitor who reached the same stage in three buckets counts in all three and once in `totals`, so the series does not sum to the totals."}},"type":"object","required":["timestamp","reached_by_stage"],"title":"CheckoutStagesBucket","description":"One bucket of the stage series."},"CheckoutStagesComparison":{"properties":{"time_range":{"$ref":"#/components/schemas/TimeRange","description":"The compared window"},"totals":{"additionalProperties":{"type":"integer"},"type":"object","title":"Totals","description":"Distinct visitors per stage over the compared window"},"series":{"items":{"$ref":"#/components/schemas/CheckoutStagesBucket"},"type":"array","title":"Series","description":"The compared window's own buckets, carrying their own timestamps. They are NOT shifted onto the current window: the client lines the two up by position or by clock, as /analytics/query does."}},"type":"object","required":["time_range","totals","series"],"title":"CheckoutStagesComparison","description":"The same numbers over the earlier window `compare_to` asked for."},"CheckoutStagesRequest":{"properties":{"time_range":{"$ref":"#/components/schemas/TimeRange","description":"Time range for the query"},"filters":{"$ref":"#/components/schemas/Filters","description":"Optional filters"},"identity":{"anyOf":[{"type":"string","enum":["stitch","session"]},{"type":"null"}],"title":"Identity","description":"Identifier to count distinct visitors by: 'stitch' or 'session'. Null -> the application's default (stitch preferred), same resolution as /visitors. 'session' answers from pageviews alone, because a pixel event carries no session id (see `events_read`)."},"granularity":{"$ref":"#/components/schemas/GranularityRequest","description":"Bucket size of the series: 'minute', 'five_minutes', 'fifteen_minutes', 'hour', 'six_hours', 'day', or 'auto' (default: the smallest width with at most 300 buckets over the window, and 'day' from 28 days). A width under an hour allows at most 1500 buckets. The comparison window is bucketed at the resolved size too, so both series sit on one grid.","default":"auto"},"timezone":{"anyOf":[{"type":"string","maxLength":64},{"type":"null"}],"title":"Timezone","description":"IANA time zone whose boundaries start the `six_hours`, `day`, `week` and `month` buckets, such as `Europe/Berlin`. A day is 23 or 25 hours long across a DST switch. Bucket timestamps stay UTC. In a zone whose offset is not whole hours a bucket starts at the UTC hour that holds the local boundary. Without it the buckets start at UTC boundaries"},"sparse_buckets":{"anyOf":[{"$ref":"#/components/schemas/SparseBuckets"},{"type":"null"}],"description":"The sparse threshold of the page, the number `POST /analytics/sparse-hours` derives. With `exclude` the rows of the thin hours are left out. Without it the route only echoes the number in `meta.sparse_buckets`"},"compare_to":{"anyOf":[{"$ref":"#/components/schemas/CompareMode","description":"A window derived from `time_range` by `TimeRange.get_comparison_range`."},{"$ref":"#/components/schemas/TimeRange","description":"Any window, validated like `time_range`. It may differ in length and may overlap the main window."},{"$ref":"#/components/schemas/CompareToRelease"},{"type":"null"}],"title":"Compare To","description":"Also report the same numbers for a second window: a mode, a `{from, to}` window or a `{release_id}`. It resolves as on /analytics/query, so a tile here and a tile there compare against the same days."}},"additionalProperties":false,"type":"object","required":["time_range"],"title":"CheckoutStagesRequest","description":"Request for the checkout stage series, bucketed by the hit itself."},"CheckoutStagesResponse":{"properties":{"meta":{"$ref":"#/components/schemas/AnalyticsMeta","description":"Facts about the result"},"request":{"$ref":"#/components/schemas/AnalyticsRequestEcho","description":"The request as the server resolved it"},"events_read":{"type":"boolean","title":"Events Read","description":"Always true, kept for the response shape: the stages are counted from `events` alone. A request the events table cannot answer is refused with a 422 instead."},"totals":{"additionalProperties":{"type":"integer"},"type":"object","title":"Totals","description":"Stage name -> distinct visitors who reached it anywhere in the window. NOT the column sum of `series`: a visitor who reached the checkout on three days is one visitor here and three bucket entries there. Exact, as events are never sampled."},"series":{"items":{"$ref":"#/components/schemas/CheckoutStagesBucket"},"type":"array","title":"Series","description":"One point per bucket that had at least one stage hit. A bucket with none is absent rather than zero-filled, as in /analytics/query."},"comparison":{"description":"Absent unless `compare_to` was set (per response_model_exclude_none). The compared window can predate the checkout events, which the collector derives and the pixel sends from the day each started. A stage then rises from 0, and that rise is the installation, not the shop.","$ref":"#/components/schemas/CheckoutStagesComparison"}},"type":"object","required":["meta","request","events_read","totals","series"],"title":"CheckoutStagesResponse","description":"Visitors per checkout stage per bucket, counted at the time of the hit.\n\nDeliberately not the funnel's `timeseries.reached`. That one buckets a\nvisitor by their funnel ENTRY over a window widened by 24h, so it answers\n\"what did the cohort that entered on Monday do\". This one applies the\nrequested range to the row's own time: a hit inside the window counts in the\nwindow, whatever the run's entry."},"ClientAnomaly":{"type":"string","enum":["automation","no_languages","no_window_chrome","no_plugins","vendor_mismatch","viewport_mismatch","version_mismatch"],"title":"ClientAnomaly","description":"One bit of the mask, by the name a `BeaconRow` answers it under."},"CohortCartCalls":{"properties":{"calls":{"type":"integer","title":"Calls","description":"Cart mutation calls the cohort issued","default":0},"avg_ms":{"title":"Avg Ms","description":"Mean duration over those calls; absent without any","type":"number"},"max_ms":{"title":"Max Ms","description":"Slowest single cart call in the cohort; absent without any","type":"integer"},"error_calls":{"type":"integer","title":"Error Calls","description":"Of `calls`, the ones that failed (HTTP >= 400 or network failure). Read from the per-endpoint telemetry, which the tracker caps at 24 endpoints per pageview, so on a very chatty page a cart call can fall out of it. A count of the stored calls, not weighted by the sampling rate, so it is not comparable with `CheckoutCohort.cart_interaction_errors` on a sampled application. Read it for the timing it comes with.","default":0}},"type":"object","title":"CohortCartCalls","description":"A cohort's cart fetch/XHR calls: the \"was the cart slow\" evidence.\n\nCovers only the calls whose endpoint is in the curated cart list AND whose\nsite collects fetch_xhr. Absent numbers therefore never mean \"the cart was\nfast\", they mean \"not observed\" - `calls` is what separates the two.","required":["calls","error_calls"]},"CohortStage":{"properties":{"stage":{"$ref":"#/components/schemas/CohortStageName","description":"The funnel stage, or `other` for the cohort's pageviews outside the funnel (product pages, category pages, everything else in the journey)."},"visitors":{"type":"integer","title":"Visitors","description":"Cohort visitors with a pageview at this stage, counted per stored sampling rate and scaled by it. An estimate beside a cohort size counted from events, so on a thin sampled cohort it can exceed CheckoutCohort.visitors. It is not clamped, because a clamp would bias every estimate below it."},"pageviews":{"type":"integer","title":"Pageviews","description":"Their pageviews at this stage, weighted like CheckoutCohort.pageviews"},"vitals":{"additionalProperties":{"$ref":"#/components/schemas/MetricDistribution"},"type":"object","title":"Vitals","description":"Metric name -> its distribution at this stage"}},"type":"object","required":["stage","visitors","pageviews","vitals"],"title":"CohortStage","description":"One cohort's numbers for the pageviews at one funnel stage."},"CohortStageName":{"type":"string","enum":["cart","checkout","success","other"],"title":"CohortStageName","description":"A cohort's stage, plus `other` for its pageviews outside the funnel.\n\nThe cohort rows cover every pageview of the cohort, so they need a name for\n\"no stage\" where the funnel rows simply have no row."},"CollectionInput":{"properties":{"sessions":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Sessions","description":"Collect a session id. Needs consent."},"session_consent":{"anyOf":[{"$ref":"#/components/schemas/SessionConsent"},{"type":"null"}],"description":"When the served bundle writes the session id."},"fetch_xhr":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Fetch Xhr","description":"Collect the fetch and XHR calls a page makes."},"error_messages":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Error Messages","description":"Keep the text of an error, not only its signature."},"error_frames":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Error Frames","description":"Keep the stack frames of an error."},"query_keys":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Query Keys","description":"Keep the query parameter names of a page URL."},"query_values_for":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Query Values For","description":"Query parameters whose value is kept as well. At most 20."},"data_layer":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Data Layer","description":"Turn every push on the page's `dataLayer` that carries an event name into a custom event with that name. Props only from `data_layer_prop_keys`. `gtm.*` is never read."},"ga4_ecommerce":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Ga4 Ecommerce","description":"Turn the seven GA4 ecommerce pushes on the page's `dataLayer` into custom events with their value, currency and items. Independent of `data_layer`."},"data_layer_prop_keys":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Data Layer Prop Keys","description":"Top-level keys of a push that become props of a `data_layer` event. Empty: the event carries its name only. The GA4 ecommerce events ignore it. At most 30, null for none."},"data_layer_mode":{"anyOf":[{"$ref":"#/components/schemas/DataLayerMode"},{"type":"null"}],"description":"What the collector does with the dataLayer events named in `data_layer_names`: `allow` keeps only those, `block` drops them."},"data_layer_names":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Data Layer Names","description":"Event names for `data_layer_mode`, lowercase as the tracker normalises them, an entry ending in `*` a prefix. Applied at ingest, so a change needs no new script. `fastmon.event()` calls are never filtered. At most 50, null for none."},"template_url_ids":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Template Url Ids","description":"Replace id-like segments of the stored page URL with `:id`."},"sampling_rate":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Sampling Rate","description":"Share of visitors whose beacons are stored, 1.0 for all of them. In `automatic` mode a changed rate is refused, unless the request sets `sampling_mode` to `manual` as well."},"sampling_mode":{"anyOf":[{"$ref":"#/components/schemas/SamplingMode"},{"type":"null"}],"description":"Who sets `sampling_rate`. `manual` keeps the rate written here, `automatic` lets fastmon set it from the booked pageviews. A switch leaves the rate where it is until the next change."},"fetch_xhr_sampling_rate":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Fetch Xhr Sampling Rate","description":"Share of visitors whose fetch and XHR calls are stored, 1.0 for all of them, 0.25 for a new application that leaves it out. Never above `sampling_rate` in effect."}},"additionalProperties":false,"type":"object","title":"CollectionInput"},"CollectionResponse":{"properties":{"sessions":{"type":"boolean","title":"Sessions","description":"Collect a session id. Needs consent."},"session_consent":{"$ref":"#/components/schemas/SessionConsent","description":"When the served bundle writes the session id."},"fetch_xhr":{"type":"boolean","title":"Fetch Xhr","description":"Collect the fetch and XHR calls a page makes."},"error_messages":{"type":"boolean","title":"Error Messages","description":"Keep the text of an error, not only its signature."},"error_frames":{"type":"boolean","title":"Error Frames","description":"Keep the stack frames of an error."},"query_keys":{"type":"boolean","title":"Query Keys","description":"Keep the query parameter names of a page URL."},"query_values_for":{"items":{"type":"string"},"type":"array","title":"Query Values For","description":"Query parameters whose value is kept as well."},"data_layer":{"type":"boolean","title":"Data Layer","description":"Turn every push on the page's `dataLayer` that carries an event name into a custom event with that name. Props only from `data_layer_prop_keys`. `gtm.*` is never read."},"ga4_ecommerce":{"type":"boolean","title":"Ga4 Ecommerce","description":"Turn the seven GA4 ecommerce pushes on the page's `dataLayer` into custom events with their value, currency and items. Independent of `data_layer`."},"data_layer_prop_keys":{"items":{"type":"string"},"type":"array","title":"Data Layer Prop Keys","description":"Top-level keys of a push that become props of a `data_layer` event. Empty: the event carries its name only. The GA4 ecommerce events ignore it."},"data_layer_mode":{"$ref":"#/components/schemas/DataLayerMode","description":"What the collector does with the dataLayer events named in `data_layer_names`: `allow` keeps only those, `block` drops them."},"data_layer_names":{"items":{"type":"string"},"type":"array","title":"Data Layer Names","description":"Event names for `data_layer_mode`, lowercase as the tracker normalises them, an entry ending in `*` a prefix. Applied at ingest, so a change needs no new script. `fastmon.event()` calls are never filtered."},"template_url_ids":{"type":"boolean","title":"Template Url Ids","description":"Replace id-like segments of the stored page URL with `:id`."},"sampling_rate":{"type":"number","title":"Sampling Rate","description":"Share of visitors whose beacons are stored, 1.0 for all of them. Traffic counts are scaled back up, percentiles and shares are not, so a lower rate costs confidence rather than traffic."},"sampling_mode":{"$ref":"#/components/schemas/SamplingMode","description":"Who sets `sampling_rate`: `manual` the customer, `automatic` fastmon from the booked pageviews."},"sampling_rate_changed_at":{"title":"Sampling Rate Changed At","description":"When fastmon last changed `sampling_rate` in `automatic` mode. Absent until it does, and again after a switch of the mode or a written rate.","examples":["2026-04-14T09:50:01Z"],"type":"string","format":"date-time"},"fetch_xhr_sampling_rate":{"type":"number","title":"Fetch Xhr Sampling Rate","description":"Share of visitors whose fetch and XHR calls are stored, 1.0 for all of them. Applied on top of `sampling_rate`, so the lower of the two binds."}},"type":"object","required":["sessions","session_consent","fetch_xhr","error_messages","error_frames","query_keys","query_values_for","data_layer","ga4_ecommerce","data_layer_prop_keys","data_layer_mode","data_layer_names","template_url_ids","sampling_rate","sampling_mode","fetch_xhr_sampling_rate"],"title":"CollectionResponse"},"CollectorInput":{"properties":{"mode":{"anyOf":[{"$ref":"#/components/schemas/CollectorMode"},{"type":"null"}],"description":"Where the served bundle posts its beacons. Set with `endpoint`."},"endpoint":{"anyOf":[{"type":"string","maxLength":255},{"type":"null"}],"title":"Endpoint","description":"The URL beacons are posted to. Only with `mode=custom`."}},"additionalProperties":false,"type":"object","title":"CollectorInput"},"CollectorMode":{"type":"string","enum":["default","custom","relative"],"title":"CollectorMode","description":"How the served tracker bundle is told where to POST beacons.\n\nDEFAULT  → fastmon's shared collector (`settings.COLLECTOR_URL`); third-party.\nCUSTOM   → an explicit absolute `collector_endpoint` URL. Covers both a\n           first-party setup on the customer's own domain AND a third-party\n           custom collector host - the browser decides 1P/3P at runtime by\n           comparing that host to the page origin; we don't store which.\nRELATIVE → a host-less relative `/c/<hash>`, resolved same-origin against\n           whatever domain the page runs on. First-party without pinning a\n           host - the natural fit for an org tracker embedded across N\n           domains. `collector_endpoint` is unused (must be empty)."},"CollectorResponse":{"properties":{"hash":{"type":"string","title":"Hash","description":"Path segment of the collector URL, `/c/{hash}`."},"mode":{"$ref":"#/components/schemas/CollectorMode","description":"Where the served bundle posts its beacons."},"endpoint":{"title":"Endpoint","description":"The URL beacons are posted to. Only with `mode=custom`.","type":"string"},"proxy_secret":{"$ref":"#/components/schemas/ProxySecretResponse","description":"Trust for a first-party beacon proxy."}},"type":"object","required":["hash","mode","proxy_secret"],"title":"CollectorResponse"},"CompareMode":{"type":"string","enum":["previous_period","previous_day","previous_week","previous_month"],"title":"CompareMode","description":"Comparison time range modes."},"CompareToRelease":{"properties":{"release_id":{"type":"string","format":"uuid","title":"Release Id","description":"A release of the organization. Its window starts at `released_at`, is as long as `time_range` and ends early at the next release of the same application or at now.","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]}},"additionalProperties":false,"type":"object","required":["release_id"],"title":"CompareToRelease","description":"The window of one release, from its `released_at` on."},"ComparisonData":{"properties":{"metrics":{"items":{"$ref":"#/components/schemas/MetricValue"},"type":"array","title":"Metrics","description":"Comparison metric values"},"sample_count":{"type":"integer","title":"Sample Count","description":"Pageviews behind the comparison values, unweighted under sampling"},"relative_change":{"title":"Relative Change","description":"(current - comparison) / comparison (negative = improvement for timing)","type":"number"},"is_sparse":{"type":"boolean","title":"Is Sparse","description":"The comparison row holds fewer page views than `meta.sparse_buckets.min_pageviews`, measured against the main window's threshold. Always false without `sparse_buckets`"},"beacons":{"type":"integer","title":"Beacons","description":"Deprecated, use `sample_count`. It always counted pageviews.","deprecated":true,"readOnly":true,"x-replaced-by":"sample_count"}},"type":"object","required":["metrics","sample_count","is_sparse","beacons"],"title":"ComparisonData","description":"Comparison data for a data point."},"ConditionType":{"type":"string","enum":["absolute","relative_change"],"title":"ConditionType"},"ConnectionInfo":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":"Identifier of the connection.","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"client_id":{"type":"string","title":"Client Id","description":"The app's client id."},"client_name":{"type":"string","title":"Client Name","description":"The name the app gave for itself at registration."},"is_verified":{"type":"boolean","title":"Is Verified","description":"Whether fastmon vouches for the app. Never true for a self-registered one.","default":false},"redirect_uris":{"items":{"type":"string"},"type":"array","title":"Redirect Uris","description":"Where this connection's codes were sent. For a shop plugin that is the shop's own domain, which is the part a merchant can judge.","default":[]},"scopes":{"items":{"type":"string"},"type":"array","title":"Scopes","description":"What the app was allowed to do.","default":[]},"approved_by_user_id":{"title":"Approved By User Id","description":"Who approved it. Absent once that account is gone, which does not stop the connection.","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"],"type":"string","format":"uuid"},"credential_owner":{"type":"string","title":"Credential Owner","description":"`organization` or `user`: whether the connection outlives the person who made it.","default":"organization"},"organization_id":{"type":"string","format":"uuid","title":"Organization Id","description":"The organization this connection acts in.","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"created_at":{"type":"string","format":"date-time","title":"Created At","description":"When it was approved.","examples":["2026-04-14T09:50:01Z"]},"revoked_at":{"title":"Revoked At","description":"When it was disconnected. Absent while it is live.","examples":["2026-04-14T09:50:01Z"],"type":"string","format":"date-time"},"via_partner_org_id":{"title":"Via Partner Org Id","description":"The partner organization whose member approved this org-owned connection. It keeps working after that partnership ends. Absent otherwise.","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"],"type":"string","format":"uuid"}},"type":"object","required":["id","client_id","client_name","organization_id","created_at","is_verified","redirect_uris","scopes","credential_owner"],"title":"ConnectionInfo","description":"One connected app, as the merchant should see it.\n\n`client_name` is self-declared at registration and `is_verified` says\nwhether we vouch for it, which for anything self-registered is never. The\nsignal the merchant can actually judge is `redirect_uris`: those are the\naddresses the connection's codes were sent to, and for a shop plugin that\nis their own domain."},"CorrelatedRequestItem":{"properties":{"method":{"type":"string","title":"Method","description":"HTTP method"},"host":{"type":"string","title":"Host","description":"Target host ('' = same-origin as the page)"},"path":{"type":"string","title":"Path","description":"Templated path (/api/users/:id)"},"pageviews_with_error":{"type":"integer","title":"Pageviews With Error","description":"Pageviews that carried the signature AND this failing endpoint"},"pageviews_cancelled":{"type":"integer","title":"Pageviews Cancelled","description":"Of `pageviews_with_error`, how many had the call cancelled rather than failing. Only the 'aborted' surface counts cancellations, and it counts them next to calls that never connected, because both answer 'the response was empty'. They mean opposite things: a visitor who left, or a broken connection. The remainder, `pageviews_with_error` minus this, never connected.","default":0},"pageviews_without_error":{"type":"integer","title":"Pageviews Without Error","description":"Pageviews without the signature where this endpoint failed too"},"with_error_share":{"type":"number","title":"With Error Share","description":"pageviews_with_error / summary.pageviews_with_error, 0..1"},"without_error_share":{"type":"number","title":"Without Error Share","description":"pageviews_without_error / summary.pageviews_without_error, 0..1"},"lift":{"type":"number","title":"Lift","description":"with_error_share / without_error_share. Above 1 the endpoint fails more often where the error is. An endpoint that never fails elsewhere would divide by zero, so the baseline is floored at what one stored row stands for, one pageview unless the application is sampled. That makes the lift of a rare endpoint a lower bound rather than infinity."},"baseline_floored":{"type":"boolean","title":"Baseline Floored","description":"True when the endpoint failed in no pageview without the error, so `lift` was divided by the floored baseline and is a lower bound rather than infinity. Both shares are rounded for display, so neither this flag nor the absence of it makes `with_error_share / without_error_share` a way to recompute `lift`: divide the pageview counts instead.","default":false}},"type":"object","required":["method","host","path","pageviews_with_error","pageviews_without_error","with_error_share","without_error_share","lift","pageviews_cancelled","baseline_floored"],"title":"CorrelatedRequestItem","description":"One fetch/XHR endpoint that fails together with the signature.\n\nBoth shares count pageviews, never calls: `beacons` is a\nReplacingMergeTree, so a sum over an un-merged pageview counts its snapshot\ntwice while a distinct count of pageview ids does not."},"CorrelatedRequestsRequest":{"properties":{"time_range":{"$ref":"#/components/schemas/TimeRange","description":"Time range for the query"},"filters":{"$ref":"#/components/schemas/Filters","description":"Optional filters"},"timezone":{"anyOf":[{"type":"string","maxLength":64},{"type":"null"}],"title":"Timezone","description":"IANA time zone the local hours of `filters.hour_of_day` are read in, such as `Europe/Berlin`. The filter requires it. This route buckets nothing, so the zone changes nothing else"},"sparse_buckets":{"anyOf":[{"$ref":"#/components/schemas/SparseBuckets"},{"type":"null"}],"description":"The sparse threshold of the page, the number `POST /analytics/sparse-hours` derives. With `exclude` the rows of the thin hours are left out. Without it the route only echoes the number in `meta.sparse_buckets`"},"fingerprint":{"type":"string","maxLength":16,"minLength":1,"title":"Fingerprint"},"limit":{"type":"integer","maximum":50.0,"minimum":1.0,"title":"Limit","description":"Max endpoints to return","default":10},"min_pageviews":{"type":"integer","maximum":10000.0,"minimum":1.0,"title":"Min Pageviews","description":"An endpoint is only reported once it failed in at least this many of the pageviews that carried the signature. Below it the share, and with it the lift, is noise.","default":20}},"additionalProperties":false,"type":"object","required":["time_range","fingerprint"],"title":"CorrelatedRequestsRequest","description":"Request for `/analytics/error-types/correlated-requests`."},"CorrelatedRequestsResponse":{"properties":{"meta":{"$ref":"#/components/schemas/AnalyticsMeta","description":"Facts about the result"},"request":{"$ref":"#/components/schemas/AnalyticsRequestEcho","description":"The request as the server resolved it"},"surface":{"type":"string","title":"Surface","description":"Which fetch/XHR failures were counted, chosen from the signature's `message_kind`: 'network' (status 0), 'aborted' (cancelled calls and status 0), 'http' (4xx and 5xx) or 'failures' (5xx and status 0, the default). 'aborted' answers 'the response was empty' and therefore covers two causes: a visitor who left and a call that never connected. Only the first is not a failure, and `pageviews_cancelled` on each row says how many of its pageviews were which."},"message_kind":{"$ref":"#/components/schemas/ErrorMessageKind","description":"The signature's recognised message shape, '' if unrecognised"},"summary":{"$ref":"#/components/schemas/CorrelatedRequestsSummary"},"endpoints":{"items":{"$ref":"#/components/schemas/CorrelatedRequestItem"},"type":"array","title":"Endpoints","description":"Ranked by lift, desc"},"fetch_xhr_collected":{"type":"boolean","title":"Fetch Xhr Collected","description":"False when an application in scope does not collect fetch/XHR. The query then covered only the sites that do, so the numbers are sound but partial, and an empty list is inconclusive rather than an answer: request telemetry is opt-in, and nothing reconstructs a failing request from the error alone."}},"type":"object","required":["meta","request","surface","message_kind","summary","endpoints","fetch_xhr_collected"],"title":"CorrelatedRequestsResponse","description":"Response for `/analytics/error-types/correlated-requests`.\n\nThe endpoints are ranked by lift, not by share: an endpoint that fails in\n85 percent of all pageviews correlates with every signature at about 85\npercent, and reading that as a cause is the mistake this endpoint exists to\nprevent. It reports co-occurrence, never causation."},"CorrelatedRequestsSummary":{"properties":{"pageviews_with_error":{"type":"integer","title":"Pageviews With Error","description":"Pageviews carrying the signature in scope"},"pageviews_without_error":{"type":"integer","title":"Pageviews Without Error","description":"The baseline population, same scope"}},"type":"object","required":["pageviews_with_error","pageviews_without_error"],"title":"CorrelatedRequestsSummary","description":"The two populations the shares are measured against."},"CredentialReach":{"properties":{"scope":{"type":"string","title":"Scope"},"partner_org_id":{"title":"Partner Org Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"],"description":"An ID, a UUID in lowercase with hyphens.","type":"string","format":"uuid"},"organization_ids":{"items":{"type":"string","format":"uuid","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"type":"array","title":"Organization Ids","default":[],"description":"IDs, each a UUID in lowercase with hyphens."},"organization_count":{"title":"Organization Count","type":"integer"}},"type":"object","required":["scope","organization_ids"],"title":"CredentialReach","description":"How far a credential reaches, in organizations.\n\nDeliberately not a `cross_tenant` boolean and deliberately not keyed on the\nowner being an admin - that would miss the ordinary case. A member of a\npartner organization reaches every client org it manages; anyone in several\norganizations reaches several. What matters is the reach itself.\n\nThe unbounded values are a promise about organizations that do not exist\nyet: the owner may be added to one tomorrow. That is the same unbounded\ngrant a wildcard scope would have been, one level up, which is why **no\nAPI key can report them**. They describe sessions only."},"CspBreakdownOrderBy":{"properties":{"field":{"$ref":"#/components/schemas/CspBreakdownSort","description":"`report_count`, the reports, or `last_seen_at`, the latest report of the row","default":"report_count"},"direction":{"$ref":"#/components/schemas/SortDirection","description":"Sort direction","default":"desc"}},"additionalProperties":false,"type":"object","title":"CspBreakdownOrderBy","description":"The order of the rows of a CSP breakdown, a tie always by `key`."},"CspBreakdownRequest":{"properties":{"time_range":{"$ref":"#/components/schemas/TimeRange","description":"Time range, on the time the browser saw the violation"},"filters":{"$ref":"#/components/schemas/Filters","description":"The filters of `POST /analytics/csp`, with its 422 for a filter the table cannot answer. A filter on the dimension itself narrows the rows"},"timezone":{"anyOf":[{"type":"string","maxLength":64},{"type":"null"}],"title":"Timezone","description":"IANA time zone the local hours of `filters.hour_of_day` are read in, such as `Europe/Berlin`. The filter requires it. This route buckets nothing, so the zone changes nothing else"},"sparse_buckets":{"anyOf":[{"$ref":"#/components/schemas/SparseBuckets"},{"type":"null"}],"description":"The sparse threshold of the page, the number `POST /analytics/sparse-hours` derives. With `exclude` the rows of the thin hours are left out. Without it the route only echoes the number in `meta.sparse_buckets`"},"dimension":{"$ref":"#/components/schemas/CspDimension","description":"The one dimension the rows group by. `page_url` is the page that broke the policy, `blocked_url` what the policy blocked, `source_url` the script that broke it, `effective_directive` and `disposition` the report's own, `bot_class` derived from the edge labels as the filter derives it, the rest the edge labels. `browser_version` keys mix browsers that share a version number, so pair it with `filters.browser`. Reports without a `source_url` or a `disposition` form one row with an empty `key`. `stitch` is the visitor, its key the `visitor_id` of the report list, and the reports without a stitch form one row with an empty `key`. `status_code_range` groups by the page's status code, its key the code as text, and the reports without one form one row with an empty `key`. `bot_name` is the edge label"},"order_by":{"$ref":"#/components/schemas/CspBreakdownOrderBy","description":"The order of the rows before `limit` cuts them, the most reports first by default. `last_seen_at` puts the newest group first"},"limit":{"type":"integer","maximum":100.0,"minimum":1.0,"title":"Limit","description":"Max rows, in the `order_by` order","default":50}},"additionalProperties":false,"type":"object","required":["time_range","dimension"],"title":"CspBreakdownRequest","description":"Request for the CSP reports grouped by one dimension."},"CspBreakdownResponse":{"properties":{"meta":{"$ref":"#/components/schemas/CspMeta","description":"Facts about the result. `total` is the number of values the dimension has in the window, `limit` the cap on `data`"},"request":{"$ref":"#/components/schemas/AnalyticsRequestEcho","description":"The request as the server resolved it"},"report_count":{"type":"integer","title":"Report Count","description":"Reports in the window, the rows the limit cut included, which every `share` is measured against"},"data":{"items":{"$ref":"#/components/schemas/CspBreakdownRow"},"type":"array","title":"Data","description":"At most `meta.limit` rows, in the `order_by` order"}},"type":"object","required":["meta","request","report_count","data"],"title":"CspBreakdownResponse","description":"CSP reports grouped by one dimension."},"CspBreakdownRow":{"properties":{"key":{"type":"string","title":"Key","description":"The value this row groups by, as stored. Where a filter of the same name exists, the key passed to it selects this row's reports. A `page_url`, `blocked_url` or `source_url` key holding `*` matches as a wildcard pattern. Their empty key goes back as `\"\"` and selects the reports without that URL. The empty `disposition` key is no filter value. A `stitch` key goes back as `filters.stitch: [key]` and a `status_code_range` key as `filters.status_code_range: {gte: key, lte: key}`. The empty key of these two is no filter value"},"report_count":{"type":"integer","title":"Report Count","description":"Reports with this value"},"affected_visitors":{"title":"Affected Visitors","description":"Distinct visitors behind the reports with this value. Counted over the non-zero `stitch`. Only sites with `store_stitch` carry a stitch, and a report that came without a valid stitch is left out. The stitch salt rotates daily and on every edge restart, so a report uploaded after a rotation loses its visitor. Absent when no site in scope stores a stitch","type":"integer"},"share":{"type":"number","title":"Share","description":"This row's reports over the reports of the whole answer, the rows the limit cut included, 0..1"},"isp":{"title":"Isp","description":"The name of the network on a row of the `asn` dimension, '' when unknown. Absent on every other dimension","type":"string"},"first_seen_at":{"type":"string","format":"date-time","title":"First Seen At","description":"The browser's time of the first report with this value in the window","examples":["2026-04-14T09:50:01Z"]},"last_seen_at":{"type":"string","format":"date-time","title":"Last Seen At","description":"The browser's time of the latest report with this value in the window","examples":["2026-04-14T09:50:01Z"]}},"type":"object","required":["key","report_count","share","first_seen_at","last_seen_at"],"title":"CspBreakdownRow","description":"One value of the breakdown dimension with the reports behind it."},"CspBreakdownSort":{"type":"string","enum":["report_count","last_seen_at"],"title":"CspBreakdownSort","description":"What the rows of a CSP breakdown are ordered by."},"CspBucket":{"properties":{"timestamp":{"type":"string","format":"date-time","title":"Timestamp","examples":["2026-04-14T09:50:01Z"],"description":"ISO 8601 in UTC with a `Z` suffix."},"report_count":{"type":"integer","title":"Report Count","description":"Reports in this bucket"},"reports_by_effective_directive":{"additionalProperties":{"type":"integer"},"type":"object","title":"Reports By Effective Directive","description":"The directive the violation broke, such as `script-src-elem` or `img-src`, to its reports in this bucket"},"reports_by_disposition":{"additionalProperties":{"type":"integer"},"type":"object","title":"Reports By Disposition","description":"`enforce` and `report` to their reports, and `''` for the reports whose browser did not say, in this bucket"},"affected_visitors":{"title":"Affected Visitors","description":"Distinct visitors behind the reports of this bucket. A visitor of two buckets counts in each. Counted over the non-zero `stitch`. Only sites with `store_stitch` carry a stitch, and a report that came without a valid stitch is left out. The stitch salt rotates daily and on every edge restart, so a report uploaded after a rotation loses its visitor. Absent when no site in scope stores a stitch","type":"integer"}},"type":"object","required":["timestamp","report_count","reports_by_effective_directive","reports_by_disposition"],"title":"CspBucket","description":"One bucket of the CSP report series."},"CspDimension":{"type":"string","enum":["site_id","page_url","blocked_url","source_url","effective_directive","disposition","device_type","browser","browser_version","os","country","asn","bot_class","stitch","status_code_range","bot_name"],"title":"CspDimension","description":"What a CSP breakdown groups the reports by."},"CspDisposition":{"type":"string","enum":["enforce","report"],"title":"CspDisposition","description":"What the policy behind a Content Security Policy report did with the violation."},"CspMeta":{"properties":{"execution_time_ms":{"type":"number","title":"Execution Time Ms","description":"How long the query took, in milliseconds"},"total":{"title":"Total","description":"Rows the query matched before paging, absent where the response is not a paged list.","type":"integer"},"limit":{"title":"Limit","description":"Rows per page the query applied, absent where the response is not paged","type":"integer"},"offset":{"title":"Offset","description":"Rows the query skipped, absent where the response is not paged","type":"integer"},"has_more":{"title":"Has More","description":"Whether a further page exists, absent where the response is not paged","type":"boolean"},"next_cursor":{"title":"Next Cursor","description":"Cursor for the next page, absent on the last page and where the response is not cursor-paged.","type":"string"},"sampling":{"description":"Sampling configured for the applications behind this result. Traffic counts are scaled by the weight each stored row carries, not by this rate. The beacon explorer's counts stay raw, as they count stored beacons, and so do the checkout funnel's stage counts.","$ref":"#/components/schemas/SamplingMeta"},"is_identity_mixed":{"title":"Is Identity Mixed","description":"Whether the applications in scope store different visitor identifiers and the count ran over `request.identity`, which some of them do not store. Their visitors are then left out, so the count is a lower bound for the scope. Absent where the response counts no visitors or the request named the identity.","type":"boolean"},"complete_until":{"title":"Complete Until","description":"The moment up to which the result holds every pageview. Data after it is still arriving, so the newest bucket is partial past this point. On a window of 6 hours or less it trails the request time by the ingest lag, on a longer one it is how far the finalizer has written the running hour. Absent where the route reads neither, or where that is unknown.","examples":["2026-04-14T09:50:01Z"],"type":"string","format":"date-time"},"sparse_buckets":{"description":"The sparse threshold this response applied, absent where the request sent no `sparse_buckets`. On `POST /analytics/query` always present","$ref":"#/components/schemas/SparseBucketsApplied"},"stitchless_site_ids":{"items":{"type":"string","format":"uuid","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"type":"array","title":"Stitchless Site Ids","description":"Active sites of the scope that store no stitch, so none of their reports counts in `affected_visitors`. Empty when every active site stores it"}},"type":"object","required":["execution_time_ms","stitchless_site_ids"],"title":"CspMeta","description":"The result facts of a CSP query."},"CspReportRow":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":"The report's own id, which ClickHouse gives it on insert. It orders reports of the same timestamp and says nothing about time","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"timestamp":{"type":"string","format":"date-time","title":"Timestamp","description":"When the browser saw the violation, millisecond precision","examples":["2026-04-14T09:50:01Z"]},"disposition":{"description":"`enforce` when the browser blocked the resource under a `Content-Security-Policy`, `report` when a `Content-Security-Policy-Report-Only` only reported it and nothing was blocked. Absent when the browser did not say","$ref":"#/components/schemas/CspDisposition"},"effective_directive":{"type":"string","title":"Effective Directive","description":"The directive the violation broke, lowercased: `script-src-elem`, `img-src`, `connect-src`, ..."},"blocked_url":{"type":"string","title":"Blocked Url","description":"What the policy blocked: a URL as scheme, host, port and path, with ids templated where the application templates them, or a keyword such as `inline`, `eval` or the scheme `data`. Empty when the browser sent nothing the collector could read"},"page_url":{"type":"string","title":"Page Url","description":"The page that broke the policy, the full URL with the query keys the application keeps"},"source_url":{"title":"Source Url","description":"The script that broke the policy, reduced as `blocked_url`. Absent when the browser named none","type":"string"},"line":{"type":"integer","title":"Line","description":"Line in `source_url` the violation came from, 0 where none was sent"},"column":{"type":"integer","title":"Column","description":"Column in that line, 0 where none was sent"},"status_code":{"type":"integer","title":"Status Code","description":"HTTP status code of the page, 0 where the browser sent none"},"referrer_url":{"title":"Referrer Url","description":"The page the visitor came from, reduced as `page_url`. Absent after a direct visit and whenever it was on another host","type":"string"},"original_policy":{"title":"Original Policy","description":"The policy the page broke, as the browser reported it: whitespace collapsed, every `'nonce-...'` blanked to `'nonce'`, the query cut from every URL in it, cut to 8192 characters. Absent when the browser sent none","type":"string"},"site_id":{"type":"string","format":"uuid","title":"Site Id","description":"The site the report was filed under","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"visitor_id":{"title":"Visitor Id","description":"The 32-hex edge pseudonym (`stitch`), the wire form /analytics/visitors uses, so a row links straight into the visitor detail. No `identity` sits beside it, so it is always the stitch. Absent where the report carries none: a site with `store_stitch` off, or an upload without a valid stitch","type":"string"},"report_count":{"type":"integer","title":"Report Count","description":"How many identical reports of one upload this row stands for, 1 or more. The counts of the aggregate route sum it"},"country":{"type":"string","title":"Country","description":"Edge-derived country code"},"asn":{"type":"integer","title":"Asn","description":"Edge-derived autonomous system number of the network, 0 when unknown"},"isp":{"type":"string","title":"Isp","description":"Name of that network, empty when unknown"},"device_type":{"description":"Edge-derived device class, absent where it could not be derived","$ref":"#/components/schemas/DeviceType"},"browser":{"type":"string","title":"Browser","description":"Edge-derived browser family"},"browser_version":{"type":"string","title":"Browser Version","description":"Edge-derived major browser version, empty where none was stored"},"os":{"type":"string","title":"Os","description":"Edge-derived operating system"},"bot_name":{"type":"string","title":"Bot Name","description":"Bot label, empty for human traffic"},"bot_type":{"type":"string","title":"Bot Type","description":"Bot category, empty for human traffic"},"datacenter":{"type":"string","title":"Datacenter","description":"Datacenter label, empty for a consumer network"},"ua_anomaly":{"type":"string","title":"Ua Anomaly","description":"User-agent anomaly label, empty when there is none"},"bot_class":{"$ref":"#/components/schemas/BotClass","description":"Derived from the edge labels as `filters.bot_class` derives it"}},"type":"object","required":["id","timestamp","effective_directive","blocked_url","page_url","line","column","status_code","site_id","report_count","country","asn","isp","browser","browser_version","os","bot_name","bot_type","datacenter","ua_anomaly","bot_class"],"title":"CspReportRow","description":"One Content Security Policy report as stored."},"CspReportsRequest":{"properties":{"time_range":{"$ref":"#/components/schemas/TimeRange","description":"Time range, on the time the browser saw the violation"},"filters":{"$ref":"#/components/schemas/Filters","description":"The filters of `POST /analytics/csp`, with its 422 for a filter the table cannot answer"},"timezone":{"anyOf":[{"type":"string","maxLength":64},{"type":"null"}],"title":"Timezone","description":"IANA time zone the local hours of `filters.hour_of_day` are read in, such as `Europe/Berlin`. The filter requires it. This route buckets nothing, so the zone changes nothing else"},"sparse_buckets":{"anyOf":[{"$ref":"#/components/schemas/SparseBuckets"},{"type":"null"}],"description":"The sparse threshold of the page, the number `POST /analytics/sparse-hours` derives. With `exclude` the rows of the thin hours are left out. Without it the route only echoes the number in `meta.sparse_buckets`"},"limit":{"type":"integer","maximum":100.0,"minimum":1.0,"title":"Limit","description":"Max rows per page","default":50},"cursor":{"anyOf":[{"type":"string","maxLength":1024},{"type":"null"}],"title":"Cursor","description":"Opaque resume point from `meta.next_cursor` of the previous page. It carries the last row's timestamp and id, so two reports of the same millisecond page without a gap or a repeat."}},"additionalProperties":false,"type":"object","required":["time_range"],"title":"CspReportsRequest","description":"Request for the single CSP reports, newest first."},"CspRequest":{"properties":{"time_range":{"$ref":"#/components/schemas/TimeRange","description":"Time range, on the time the browser saw the violation"},"filters":{"$ref":"#/components/schemas/Filters","description":"Optional filters. The site scope, `stitch`, the report's own fields and the edge-derived dimensions are accepted, because a report carries those and no pageview or metric. Anything else is a 422 naming it under its own path, since an empty answer would read as 'no violations'."},"granularity":{"$ref":"#/components/schemas/GranularityRequest","description":"Bucket size of the series: 'minute', 'five_minutes', 'fifteen_minutes', 'hour', 'six_hours', 'day', or 'auto' (default: the smallest width with at most 300 buckets over the window, and 'day' from 28 days). A width under an hour allows at most 1500 buckets.","default":"auto"},"timezone":{"anyOf":[{"type":"string","maxLength":64},{"type":"null"}],"title":"Timezone","description":"IANA time zone whose boundaries start the `six_hours`, `day`, `week` and `month` buckets, such as `Europe/Berlin`. A day is 23 or 25 hours long across a DST switch. Bucket timestamps stay UTC. In a zone whose offset is not whole hours a bucket starts at the UTC hour that holds the local boundary. Without it the buckets start at UTC boundaries"},"sparse_buckets":{"anyOf":[{"$ref":"#/components/schemas/SparseBuckets"},{"type":"null"}],"description":"The sparse threshold of the page, the number `POST /analytics/sparse-hours` derives. With `exclude` the rows of the thin hours are left out. Without it the route only echoes the number in `meta.sparse_buckets`"}},"additionalProperties":false,"type":"object","required":["time_range"],"title":"CspRequest","description":"Request for the Content Security Policy reports of the organization's sites."},"CspResponse":{"properties":{"meta":{"$ref":"#/components/schemas/CspMeta","description":"Facts about the result"},"request":{"$ref":"#/components/schemas/AnalyticsRequestEcho","description":"The request as the server resolved it"},"report_count":{"type":"integer","title":"Report Count","description":"Reports in the window"},"affected_visitors":{"title":"Affected Visitors","description":"Distinct visitors behind the reports of the window, each once however many buckets it appears in. Counted over the non-zero `stitch`. Only sites with `store_stitch` carry a stitch, and a report that came without a valid stitch is left out. The stitch salt rotates daily and on every edge restart, so a report uploaded after a rotation loses its visitor. Absent when no site in scope stores a stitch","type":"integer"},"reports_by_effective_directive":{"additionalProperties":{"type":"integer"},"type":"object","title":"Reports By Effective Directive","description":"The directive the violation broke to its reports in the window"},"reports_by_disposition":{"additionalProperties":{"type":"integer"},"type":"object","title":"Reports By Disposition","description":"`enforce` and `report` to their reports, and `''` for the reports whose browser did not say, in the window"},"series":{"items":{"$ref":"#/components/schemas/CspBucket"},"type":"array","title":"Series","description":"One point per bucket with at least one report. A bucket with none is absent rather than zero-filled, as in /analytics/query."}},"type":"object","required":["meta","request","report_count","reports_by_effective_directive","reports_by_disposition","series"],"title":"CspResponse","description":"The Content Security Policy reports of the organization's sites.\n\nEvery count is the number of reports the browsers sent. The edge does not\nsample them, so `meta.sampling` does not describe them."},"CursorPaginatedResponse_CspReportRow_":{"properties":{"data":{"items":{"$ref":"#/components/schemas/CspReportRow"},"type":"array","title":"Data"},"meta":{"$ref":"#/components/schemas/CursorPaginationMeta"}},"type":"object","required":["data","meta"],"title":"CursorPaginatedResponse[CspReportRow]"},"CursorPaginatedResponse_EventRow_":{"properties":{"data":{"items":{"$ref":"#/components/schemas/EventRow"},"type":"array","title":"Data"},"meta":{"$ref":"#/components/schemas/CursorPaginationMeta"}},"type":"object","required":["data","meta"],"title":"CursorPaginatedResponse[EventRow]"},"CursorPaginatedResponse_NelReportRow_":{"properties":{"data":{"items":{"$ref":"#/components/schemas/NelReportRow"},"type":"array","title":"Data"},"meta":{"$ref":"#/components/schemas/CursorPaginationMeta"}},"type":"object","required":["data","meta"],"title":"CursorPaginatedResponse[NelReportRow]"},"CursorPaginatedResponse_VisitorSummaryItem_":{"properties":{"data":{"items":{"$ref":"#/components/schemas/VisitorSummaryItem"},"type":"array","title":"Data"},"meta":{"$ref":"#/components/schemas/CursorPaginationMeta"}},"type":"object","required":["data","meta"],"title":"CursorPaginatedResponse[VisitorSummaryItem]"},"CursorPaginationMeta":{"properties":{"limit":{"type":"integer","title":"Limit"},"has_more":{"type":"boolean","title":"Has More"},"next_cursor":{"title":"Next Cursor","type":"string"}},"type":"object","required":["limit","has_more"],"title":"CursorPaginationMeta","description":"Meta for ClickHouse-backed cursor-paginated lists.\n\n`total` is intentionally absent: COUNT(*) over beacon tables is too\nexpensive. Clients rely on `has_more` + `next_cursor` instead."},"DataLayerMode":{"type":"string","enum":["allow","block"],"title":"DataLayerMode","description":"What the collector does with the dataLayer events named in `data_layer_names`."},"DeviceComparison":{"properties":{"device_type":{"$ref":"#/components/schemas/SyntheticDeviceType"},"lab_score":{"title":"Lab Score","type":"number"},"experience_score":{"title":"Experience Score","type":"number"},"experience_grade":{"title":"Experience Grade","type":"string"},"field_samples":{"type":"integer","title":"Field Samples"},"field_sufficient":{"type":"boolean","title":"Field Sufficient"},"metrics":{"items":{"$ref":"#/components/schemas/MetricComparison"},"type":"array","title":"Metrics"},"field_inp_p75_ms":{"title":"Field Inp P75 Ms","type":"number"},"lab_tbt_ms":{"title":"Lab Tbt Ms","type":"number"}},"type":"object","required":["device_type","field_samples","field_sufficient","metrics"],"title":"DeviceComparison"},"DeviceType":{"type":"string","enum":["desktop","mobile","tablet"],"title":"DeviceType","description":"The class of device a beacon came from (§28).\n\nThe value set the collector validates against (`_VALID_DEVICE_TYPES`). A\nbeacon whose class could not be derived stores `''`, which a row serves as\nabsence rather than as a fourth value."},"ElementTargetItem":{"properties":{"target":{"type":"string","title":"Target","description":"Bounded CSS selector path (e.g. '#hero>img.banner')"},"count":{"type":"integer","title":"Count","description":"Pageviews attributing this target (exact)"},"share":{"type":"number","title":"Share","description":"Share of the group's attributed pageviews, 0..1"},"avg_value":{"title":"Avg Value","description":"Mean metric value over those pageviews that report one, ms for lcp and inp, a score for cls","type":"number"},"distribution":{"$ref":"#/components/schemas/MetricDistribution","description":"Quantiles of the metric over those pageviews, with the method `/analytics/query` uses for it. Its `count` is the raw number of pageviews with a value, unweighted, beside the weighted `count` of the target"},"first_seen_at":{"title":"First Seen At","description":"Start of the earliest of those pageviews inside `time_range`, not the element's first appearance ever","examples":["2026-04-14T09:50:01Z"],"type":"string","format":"date-time"},"example_url":{"title":"Example Url","description":"One page the target is the element on: the URL carrying more than half of its stored rows, else any one of its URLs, which can differ between calls. One example, not a list. Equals the group `key` under group_by=url. Absent where no pageview of the target has a URL","type":"string"},"avg_lcp_ttfb":{"title":"Avg Lcp Ttfb","description":"`lcp` only: mean `lcp_ttfb` in ms over the pageviews that report all four LCP subparts. The four means sum to the mean LCP of exactly those pageviews, which can differ from `avg_value` over all of them. Absent where no pageview reports the subparts","type":"number"},"avg_lcp_load_delay":{"title":"Avg Lcp Load Delay","description":"`lcp` only: mean `lcp_load_delay` in ms, over the same pageviews","type":"number"},"avg_lcp_load_duration":{"title":"Avg Lcp Load Duration","description":"`lcp` only: mean `lcp_load_duration` in ms, over the same pageviews","type":"number"},"avg_lcp_render_delay":{"title":"Avg Lcp Render Delay","description":"`lcp` only: mean `lcp_render_delay` in ms, over the same pageviews","type":"number"},"lcp_discovered_via":{"description":"`lcp` only: the most frequent way the browser found the LCP resource. Absent where no pageview reports one","$ref":"#/components/schemas/LcpDiscoveredVia"},"image_rate":{"title":"Image Rate","description":"`lcp` only: the part of those pageviews whose LCP element is an image, 0..1, over the pageviews that report it. Absent where none does","type":"number"},"fetch_priority_high_rate":{"title":"Fetch Priority High Rate","description":"`lcp` only: the part of those pageviews whose LCP image, or the preload that fetched it, carries `fetchpriority=\"high\"`, 0..1, over the pageviews that report the attribute. Absent where none does","type":"number"},"lazy_rate":{"title":"Lazy Rate","description":"`lcp` only: the part of those pageviews whose LCP image carries `loading=\"lazy\"`, 0..1, over the pageviews that report the attribute. Absent where none does, as for a text element","type":"number"},"cache_rate":{"title":"Cache Rate","description":"`lcp` only: the part of those pageviews whose LCP resource came from the browser cache, 0..1, over the pageviews where the tracker could tell. A revalidation counts as network. Absent where none could, as for a text element or a cross-origin image without `Timing-Allow-Origin`","type":"number"},"resource_url":{"title":"Resource Url","description":"`lcp` with by='element' only: the LCP resource URL serving more than half of the target's pageviews with one, else one of its URLs. `resource_url_count` tells whether it is the only one. Absent for a text element and for by='resource_url', where `target` is the URL","type":"string"},"resource_url_count":{"title":"Resource Url Count","description":"`lcp` with by='element' only: the number of distinct LCP resource URLs among those pageviews, exact for a few and approximate for many, so 1 where `resource_url` is the element's only resource. Absent where `resource_url` is","type":"integer"}},"type":"object","required":["target","count","share","distribution"],"title":"ElementTargetItem","description":"One ranked element target within a group."},"ElementTargetMetric":{"type":"string","enum":["lcp","cls","inp"],"title":"ElementTargetMetric","description":"A vital whose element `/analytics/element-targets` ranks."},"ElementTargetsGroup":{"properties":{"key":{"title":"Key","description":"The group's URL, page type or device type, '' for pageviews without one, absent for group_by=none","type":"string"},"pageviews_with_target":{"type":"integer","title":"Pageviews With Target","description":"Pageviews in this group carrying a non-empty target"},"targets":{"items":{"$ref":"#/components/schemas/ElementTargetItem"},"type":"array","title":"Targets","description":"Ranked targets, most frequent first"}},"type":"object","required":["pageviews_with_target","targets"],"title":"ElementTargetsGroup","description":"Ranked targets for one group: a URL, a page type, a device type or the whole scope."},"ElementTargetsRequest":{"properties":{"time_range":{"$ref":"#/components/schemas/TimeRange","description":"Time range for the query (required)"},"filters":{"$ref":"#/components/schemas/Filters","description":"Optional filters"},"timezone":{"anyOf":[{"type":"string","maxLength":64},{"type":"null"}],"title":"Timezone","description":"IANA time zone the local hours of `filters.hour_of_day` are read in, such as `Europe/Berlin`. The filter requires it. This route buckets nothing, so the zone changes nothing else"},"sparse_buckets":{"anyOf":[{"$ref":"#/components/schemas/SparseBuckets"},{"type":"null"}],"description":"The sparse threshold of the page, the number `POST /analytics/sparse-hours` derives. With `exclude` the rows of the thin hours are left out. Without it the route only echoes the number in `meta.sparse_buckets`"},"metric":{"$ref":"#/components/schemas/ElementTargetMetric","description":"Which vital's element attribution to rank"},"by":{"type":"string","enum":["element","resource_url"],"title":"By","description":"'element' ranks the CSS selector path; 'resource_url' ranks the LCP resource URL (only valid for metric='lcp')","default":"element"},"group_by":{"type":"string","enum":["none","url","page_type","device_type"],"title":"Group By","description":"'url', 'page_type' or 'device_type' ranks targets per value of that column. 'none' ranks them over the whole scope","default":"none"},"target":{"anyOf":[{"type":"string","maxLength":100,"minLength":1},{"type":"null"}],"title":"Target","description":"Keep only the pageviews whose ranked column is exactly this value: the selector, or with by='resource_url' the LCP resource URL. Takes the `target` of an item. With a group_by the top groups are then those of this element"},"limit":{"type":"integer","maximum":25.0,"minimum":1.0,"title":"Limit","description":"Top-N targets per group","default":10},"groups_limit":{"type":"integer","maximum":50.0,"minimum":1.0,"title":"Groups Limit","description":"Top-N groups by attributed pageviews, for a group_by","default":20}},"additionalProperties":false,"type":"object","required":["time_range","metric"],"title":"ElementTargetsRequest","description":"Request for the element-targets breakdown (migration-053 selector paths).\n\nGeneric over the three attributed vitals: which ELEMENT is the LCP /\nthe largest layout shift / the reported INP interaction target. The\nselector columns are deliberately not query-builder dimensions\n(high-cardinality GROUP BY hazard); this endpoint ranks them via a\nbounded-state topK instead."},"ElementTargetsResponse":{"properties":{"meta":{"$ref":"#/components/schemas/AnalyticsMeta","description":"Facts about the result"},"request":{"$ref":"#/components/schemas/AnalyticsRequestEcho","description":"The request as the server resolved it"},"metric":{"$ref":"#/components/schemas/ElementTargetMetric","description":"The requested vital"},"groups":{"items":{"$ref":"#/components/schemas/ElementTargetsGroup"},"type":"array","title":"Groups","description":"group_by=none → exactly one group; any other group_by → the top groups"}},"type":"object","required":["meta","request","metric","groups"],"title":"ElementTargetsResponse","description":"Response for the element-targets breakdown."},"Environment":{"type":"string","enum":["prod","dev"],"title":"Environment","description":"Deployment environment of an application. Billing-relevant: PROD apps are\nbilled, DEV apps are not (see the billing module). Defaults to PROD - the\nrevenue-safe fallback, so a forgotten value is never silently unbilled."},"ErrorAcknowledgementCreate":{"properties":{"fingerprint":{"type":"string","maxLength":16,"minLength":1,"title":"Fingerprint","description":"The `fingerprint` of a row of `/analytics/error-types`. The server reads the signature's fault key from it."},"note":{"anyOf":[{"type":"string","maxLength":1000},{"type":"null"}],"title":"Note","description":"A free text to leave on the signature."}},"additionalProperties":false,"type":"object","required":["fingerprint"],"title":"ErrorAcknowledgementCreate"},"ErrorAcknowledgementResponse":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"],"description":"An ID, a UUID in lowercase with hyphens."},"organization_id":{"type":"string","format":"uuid","title":"Organization Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"],"description":"An ID, a UUID in lowercase with hyphens."},"fingerprint":{"type":"string","title":"Fingerprint","description":"The fingerprint that was acknowledged. The match only where the signature has no fault key, which an empty `frame_host` says."},"error_type":{"type":"string","title":"Error Type","description":"The fault key's error type, empty without a key, such as `TypeError` ..."},"message_kind":{"$ref":"#/components/schemas/ErrorMessageKind","description":"The fault key's message shape, empty without a key or a recognised shape."},"message_value":{"type":"string","title":"Message Value","description":"The identifier the message shape names, empty without one."},"frame_host":{"type":"string","title":"Frame Host","description":"The top frame's host, empty without a key."},"frame_path":{"type":"string","title":"Frame Path","description":"The top frame's file, empty where the frame carries none."},"frame_line":{"type":"integer","title":"Frame Line","description":"The top frame's line where it has no file, 0 otherwise and without a key."},"acknowledged_at":{"type":"string","format":"date-time","title":"Acknowledged At","description":"When a person acknowledged the signature.","examples":["2026-04-14T09:50:01Z"]},"acknowledged_by_user_id":{"title":"Acknowledged By User Id","description":"The user who acknowledged it. Absent when an organization's own key did, and once that account is deleted.","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"],"type":"string","format":"uuid"},"note":{"title":"Note","description":"The free text a person left on it. Absent without one.","type":"string"},"created_at":{"type":"string","format":"date-time","title":"Created At","examples":["2026-04-14T09:50:01Z"],"description":"ISO 8601 in UTC with a `Z` suffix."},"updated_at":{"type":"string","format":"date-time","title":"Updated At","description":"When the note last changed.","examples":["2026-04-14T09:50:01Z"]}},"type":"object","required":["id","organization_id","fingerprint","error_type","message_kind","message_value","frame_host","frame_path","frame_line","acknowledged_at","created_at","updated_at"],"title":"ErrorAcknowledgementResponse"},"ErrorAcknowledgementUpdate":{"properties":{"note":{"anyOf":[{"type":"string","maxLength":1000},{"type":"null"}],"title":"Note","description":"The free text. `null` removes it."}},"additionalProperties":false,"type":"object","title":"ErrorAcknowledgementUpdate","description":"A merge patch (API_STANDARDS §13): an absent field stays as it is."},"ErrorBody":{"properties":{"code":{"$ref":"#/components/schemas/ErrorCode"},"message":{"type":"string","title":"Message"},"request_id":{"title":"Request Id","type":"string"},"doc_url":{"title":"Doc Url","type":"string"},"details":{"title":"Details","additionalProperties":true,"type":"object"}},"type":"object","required":["code","message"],"title":"ErrorBody"},"ErrorBreakdown":{"properties":{"top":{"items":{"$ref":"#/components/schemas/ErrorBreakdownEntry"},"type":"array","title":"Top","description":"Top-N entries, desc by count"},"distinct_total":{"type":"integer","title":"Distinct Total","description":"Total distinct values across the dimension"}},"type":"object","required":["top","distinct_total"],"title":"ErrorBreakdown","description":"Top-N plus totals for one breakdown dimension."},"ErrorBreakdownDim":{"type":"string","enum":["url","browser","device","os","country"],"title":"ErrorBreakdownDim","description":"Dimensions available for error detail breakdowns."},"ErrorBreakdownEntry":{"properties":{"key":{"type":"string","title":"Key","description":"Dimension value (e.g. a URL, browser name)"},"count":{"type":"integer","title":"Count","description":"Error occurrences for this value"},"visitors":{"title":"Visitors","description":"Distinct affected visitors for this value, counted over the response's resolved `identity` (stitch or session). Absent if the site collects no visitor identifier.","type":"integer"}},"type":"object","required":["key","count"],"title":"ErrorBreakdownEntry","description":"One row in a breakdown histogram."},"ErrorCode":{"type":"string","title":"ErrorCode","x-extensible-enum":["unauthenticated","invalid_credentials","two_factor_required","invalid_two_factor_code","session_expired","invalid_token","credential_expired","webauthn_failed","forbidden","organization_access_denied","site_access_denied","admin_required","admin_two_factor_required","partner_required","permission_denied","last_owner","demo_session","organization_not_found","site_not_found","release_not_found","notification_rule_not_found","notification_channel_not_found","observation_subscription_not_found","observation_not_found","member_not_found","invite_not_found","partner_not_found","platform_not_found","user_not_found","resource_not_found","uptime_check_not_found","uptime_chain_not_found","demo_unavailable","email_already_registered","email_domain_not_allowed","site_already_exists","release_already_exists","organization_inactive","organization_not_approved","organization_review_locked","user_inactive","user_blocked","already_member","billing_partner_exists","circular_partner_forbidden","self_transfer_forbidden","demo_user_forbidden","conflict","validation_error","unsupported_operation","invalid_cursor","rate_limited","plan_insufficient","ai_disabled","synthetic_disabled","billing_required","trial_expired","app_limit_reached","billing_disabled","payment_provider_error","billing_profile_incomplete","billing_vat_id_required","billing_business_only","billing_payment_method_limit","billing_payment_declined","billing_payment_received","billing_country_not_supported","mcp_disabled","time_range_beyond_history","uptime_not_configured","beacon_buffer_full","clickhouse_unavailable","upstream_unavailable","oauth_error","feature_removed","internal_error","not_ready"]},"ErrorDetailRequest":{"properties":{"time_range":{"$ref":"#/components/schemas/TimeRange","description":"Time range for the query"},"filters":{"$ref":"#/components/schemas/Filters","description":"Optional filters"},"identity":{"anyOf":[{"type":"string","enum":["stitch","session"]},{"type":"null"}],"title":"Identity","description":"Identity backing `affected_visitors` / breakdown `visitors`: 'stitch' or 'session'. Null resolves to the application's default."},"fingerprint":{"type":"string","maxLength":16,"minLength":1,"title":"Fingerprint"},"breakdowns":{"items":{"$ref":"#/components/schemas/ErrorBreakdownDim"},"type":"array","title":"Breakdowns","description":"Dimensions to return as top-N breakdowns"},"limit":{"type":"integer","maximum":50.0,"minimum":1.0,"title":"Limit","description":"Max entries per breakdown dimension","default":10},"sample_size":{"type":"integer","maximum":100.0,"minimum":0.0,"title":"Sample Size","default":20},"granularity":{"$ref":"#/components/schemas/GranularityRequest","description":"Bucket size of the series: 'minute', 'five_minutes', 'fifteen_minutes', 'hour', 'six_hours', 'day', or 'auto' (default: the smallest width with at most 300 buckets over the window, and 'day' from 28 days). A width under an hour allows at most 1500 buckets.","default":"auto"},"timezone":{"anyOf":[{"type":"string","maxLength":64},{"type":"null"}],"title":"Timezone","description":"IANA time zone whose boundaries start the `six_hours`, `day`, `week` and `month` buckets, such as `Europe/Berlin`. A day is 23 or 25 hours long across a DST switch. Bucket timestamps stay UTC. In a zone whose offset is not whole hours a bucket starts at the UTC hour that holds the local boundary. Without it the buckets start at UTC boundaries"},"sparse_buckets":{"anyOf":[{"$ref":"#/components/schemas/SparseBuckets"},{"type":"null"}],"description":"The sparse threshold of the page, the number `POST /analytics/sparse-hours` derives. With `exclude` the rows of the thin hours are left out. Without it the route only echoes the number in `meta.sparse_buckets`"}},"additionalProperties":false,"type":"object","required":["time_range","fingerprint"],"title":"ErrorDetailRequest","description":"Request for drill-down on a single error signature.\n\nIdentified by `fingerprint` (server-computed canonical key), not the\nlegacy 4-tuple. Backfillable: if the fingerprint rule changes, an\nUPDATE rewrites every row deterministically; old request URLs become\ninvalid by design rather than silently matching the wrong bucket."},"ErrorDetailResponse":{"properties":{"meta":{"$ref":"#/components/schemas/AnalyticsMeta","description":"Facts about the result"},"request":{"$ref":"#/components/schemas/AnalyticsRequestEcho","description":"The request as the server resolved it"},"status":{"$ref":"#/components/schemas/ErrorSignatureStatus","description":"`acknowledged` while an `error_acknowledgement` of the organization holds the row's fault key, or its fingerprint where it has no key. Derived, never stored on the row. An acknowledged signature still counts in every total.","default":"open"},"acknowledged_at":{"title":"Acknowledged At","description":"When a person acknowledged the signature. Absent while `open`.","examples":["2026-04-14T09:50:01Z"],"type":"string","format":"date-time"},"note":{"title":"Note","description":"The free text left on the acknowledgement. Absent without one.","type":"string"},"acknowledgement_id":{"title":"Acknowledgement Id","description":"The acknowledgement the row matches, the address of `/error-acknowledgements/{acknowledgement_id}`. Absent while `open`.","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"],"type":"string","format":"uuid"},"summary":{"$ref":"#/components/schemas/ErrorDetailSummary"},"error_type":{"type":"string","title":"Error Type","description":"The group's error type, repeated here so the detail reads alone.","default":""},"message_kind":{"$ref":"#/components/schemas/ErrorMessageKind","description":"The group's message shape (`selector_invalid`, `not_defined`, ...), collected in every mode. '' when the message is one the customer wrote themselves. The field a diagnosis should be built on.","default":""},"message_value":{"type":"string","title":"Message Value","description":"The identifier that shape names, '' when it names none.","default":""},"sample_message":{"type":"string","title":"Sample Message","description":"One example message of the group, PII-stripped. Empty when the site does not collect messages, which is the default.","default":""},"messages_collected":{"type":"boolean","title":"Messages Collected","description":"Every application in scope stores error messages, so an empty `sample_message` means the error carried none. False means the message may simply not be collected.","default":false},"timeseries":{"items":{"$ref":"#/components/schemas/ErrorTimeseriesPoint"},"type":"array","title":"Timeseries"},"breakdowns":{"additionalProperties":{"$ref":"#/components/schemas/ErrorBreakdown"},"type":"object","title":"Breakdowns"},"samples":{"items":{"$ref":"#/components/schemas/ErrorSample"},"type":"array","title":"Samples"}},"type":"object","required":["meta","request","summary","timeseries","breakdowns","samples","status","error_type","message_kind","message_value","sample_message","messages_collected"],"title":"ErrorDetailResponse","description":"Response for `/analytics/error-types/detail`."},"ErrorDetailSummary":{"properties":{"count":{"type":"integer","title":"Count"},"affected_visitors":{"title":"Affected Visitors","description":"Distinct affected visitors, counted over the response's resolved `identity` (stitch or session). Absent if the site collects no visitor identifier.","type":"integer"},"first_seen_at":{"title":"First Seen At","examples":["2026-04-14T09:50:01Z"],"description":"ISO 8601 in UTC with a `Z` suffix.","type":"string","format":"date-time"},"last_seen_at":{"title":"Last Seen At","examples":["2026-04-14T09:50:01Z"],"description":"ISO 8601 in UTC with a `Z` suffix.","type":"string","format":"date-time"},"share":{"type":"number","title":"Share","description":"This signature's part of the errors in the request's scope, 0..1"}},"type":"object","required":["count","share"],"title":"ErrorDetailSummary","description":"Aggregate summary for the selected error."},"ErrorFingerprintKind":{"type":"string","enum":["error","failed_resource"],"title":"ErrorFingerprintKind","description":"Which half of the `errors` Nested a fingerprint scope means.\n\nBoth halves carry a fingerprint out of the same key space, so a caller that\nscopes to one says which list it took the key from rather than letting the\nserver guess: `/analytics/error-types` for `error`, `/analytics/failed-resources`\nfor `failed_resource`."},"ErrorFrameInfo":{"properties":{"host":{"type":"string","title":"Host","description":"Source-script hostname (no port/query)."},"path":{"type":"string","title":"Path","description":"Sanitized script path; '' on host-only frames.","default":""},"line":{"type":"integer","title":"Line","description":"Line number in the bundled file."},"column":{"type":"integer","title":"Column","description":"Column number in the bundled file."}},"type":"object","required":["host","line","column","path"],"title":"ErrorFrameInfo","description":"One stack frame surfaced to the dashboard.\n\nThe fields mirror the storage shape (`errors.frame_hosts/paths/lines/\ncols` per error): hostname + sanitized script path - never a query\nstring or token. `path` is \"\" wherever the wire carried a host-only\nframe: on the without-consent wire everything except first-party\nEXTERNAL script frames, plus rows predating migration 033. line/col are the raw positions; resolving\nthem to source-mapped locations is a future server-side concern, not\npart of this schema."},"ErrorMessageKind":{"type":"string","title":"ErrorMessageKind","description":"The shape a browser error message was recognised as.\n\nThe kinds of the message catalogue the tracker and the collector share,\nwhich grows with the wordings it learns. `''` is a message the catalogue\ndoes not know, mostly one the customer's own code wrote. It stays a value\nrather than absence because it is part of an error's fault key.","x-extensible-enum":["","fetch_failed","json_empty","json_invalid","not_a_function","not_defined","null_read","readonly_write","selector_invalid","stack_overflow","syntax_unexpected_token","undefined_read","undefined_write"]},"ErrorResponse":{"properties":{"error":{"$ref":"#/components/schemas/ErrorBody"}},"type":"object","required":["error"],"title":"ErrorResponse"},"ErrorSample":{"properties":{"started_at":{"type":"string","format":"date-time","title":"Started At","description":"Pageview start where the error occurred","examples":["2026-04-14T09:50:01Z"]},"url":{"type":"string","title":"Url"},"session_id":{"type":"string","title":"Session Id"},"browser":{"title":"Browser","type":"string"},"device_type":{"description":"The class of device the sample came from.","$ref":"#/components/schemas/DeviceType"},"os":{"title":"Os","type":"string"},"country":{"title":"Country","type":"string"},"asn":{"title":"Asn","description":"Autonomous system number of the visitor's network, absent when unknown","type":"integer"},"isp":{"title":"Isp","description":"Name of that network, absent when unknown","type":"string"}},"type":"object","required":["started_at","url","session_id"],"title":"ErrorSample","description":"Recent beacon exhibiting this error."},"ErrorSignatureStatus":{"type":"string","enum":["open","acknowledged"],"title":"ErrorSignatureStatus","description":"Whether a person acknowledged an error signature. Derived from `error_acknowledgements`."},"ErrorSymbolicationRequest":{"properties":{"time_range":{"$ref":"#/components/schemas/TimeRange","description":"Time range for the query"},"filters":{"$ref":"#/components/schemas/Filters","description":"Optional filters"},"timezone":{"anyOf":[{"type":"string","maxLength":64},{"type":"null"}],"title":"Timezone","description":"IANA time zone the local hours of `filters.hour_of_day` are read in, such as `Europe/Berlin`. The filter requires it. This route buckets nothing, so the zone changes nothing else"},"sparse_buckets":{"anyOf":[{"$ref":"#/components/schemas/SparseBuckets"},{"type":"null"}],"description":"The sparse threshold of the page, the number `POST /analytics/sparse-hours` derives. With `exclude` the rows of the thin hours are left out. Without it the route only echoes the number in `meta.sparse_buckets`"},"fingerprint":{"type":"string","maxLength":16,"minLength":1,"title":"Fingerprint"}},"additionalProperties":false,"type":"object","required":["time_range","fingerprint"],"title":"ErrorSymbolicationRequest","description":"Request for `/analytics/error-types/symbolicate`.\n\nCarries the same identity as the error detail. There is deliberately no URL\nparameter: the frames come from what we stored for this fingerprint, so a\ncaller cannot point our fetcher at a host of their choosing."},"ErrorSymbolicationResponse":{"properties":{"meta":{"$ref":"#/components/schemas/AnalyticsMeta","description":"Facts about the result"},"request":{"$ref":"#/components/schemas/AnalyticsRequestEcho","description":"The request as the server resolved it"},"frames":{"items":{"$ref":"#/components/schemas/SymbolicatedFrame"},"type":"array","title":"Frames"},"error_type":{"type":"string","title":"Error Type","description":"The group's error type, repeated here so the stack reads alone.","default":""},"message_kind":{"$ref":"#/components/schemas/ErrorMessageKind","description":"The group's message shape, repeated here for the same reason as `error_type`. Together with the top frame's `object` and `property` this is the sentence: `not_defined` plus `uc` plus `setServiceAlias` says what was called and what was missing.","default":""},"message_value":{"type":"string","title":"Message Value","description":"The identifier that shape names, '' when it names none.","default":""},"sample_message":{"type":"string","title":"Sample Message","description":"The group's message. Often the whole answer where the stack is not: a selector, a bad token, the value that failed to parse. Empty when the site does not collect messages.","default":""},"messages_collected":{"type":"boolean","title":"Messages Collected","description":"Every application in scope stores error messages, so an empty `sample_message` means the error carried none. False means the message may simply not be collected, which is the default.","default":false},"all_frames_in_libraries":{"type":"boolean","title":"All Frames In Libraries","description":"Every frame is a known library, so the mistake is in a call that is no longer on the stack. The stack was cut at five frames.","default":false}},"type":"object","required":["meta","request","frames","error_type","message_kind","message_value","sample_message","messages_collected","all_frames_in_libraries"],"title":"ErrorSymbolicationResponse","description":"Response for `/analytics/error-types/symbolicate`."},"ErrorTimeseriesPoint":{"properties":{"timestamp":{"type":"string","format":"date-time","title":"Timestamp","examples":["2026-04-14T09:50:01Z"],"description":"ISO 8601 in UTC with a `Z` suffix."},"count":{"type":"integer","title":"Count"}},"type":"object","required":["timestamp","count"],"title":"ErrorTimeseriesPoint","description":"One point in the error time series."},"ErrorTypeComparison":{"properties":{"count":{"type":"integer","title":"Count","description":"Occurrences of the row over the compared window, weighted like the row's `count`. With `group_variants` every occurrence that would have joined the row counts, a variant seen only in the compared window included, so a fault whose file moved by a few lines keeps its count. Without it, the row's fingerprint alone. 0 means the fault did not occur there."}},"type":"object","required":["count"],"title":"ErrorTypeComparison","description":"A signature's measures over the window `compare_to` picked."},"ErrorTypeItem":{"properties":{"status":{"$ref":"#/components/schemas/ErrorSignatureStatus","description":"`acknowledged` while an `error_acknowledgement` of the organization holds the row's fault key, or its fingerprint where it has no key. Derived, never stored on the row. An acknowledged signature still counts in every total.","default":"open"},"acknowledged_at":{"title":"Acknowledged At","description":"When a person acknowledged the signature. Absent while `open`.","examples":["2026-04-14T09:50:01Z"],"type":"string","format":"date-time"},"note":{"title":"Note","description":"The free text left on the acknowledgement. Absent without one.","type":"string"},"acknowledgement_id":{"title":"Acknowledgement Id","description":"The acknowledgement the row matches, the address of `/error-acknowledgements/{acknowledgement_id}`. Absent while `open`.","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"],"type":"string","format":"uuid"},"fingerprint":{"type":"string","title":"Fingerprint","description":"Stable group-by key for this error signature."},"error_type":{"type":"string","title":"Error Type","description":"Error type name (e.g., 'TypeError')"},"count":{"type":"integer","title":"Count","description":"Number of occurrences"},"share":{"type":"number","title":"Share","description":"This signature's part of the errors in scope, 0..1"},"sample_message":{"title":"Sample Message","description":"One example error message captured for this signature, PII-stripped and capped at 80 chars. Sourced from `errors.sample_message`. Empty on a site that does not collect messages, which is the default; `message_kind` is there in every mode and is what a reader should show.","type":"string"},"message_kind":{"$ref":"#/components/schemas/ErrorMessageKind","description":"What the browser's message says, as one of a closed list of shapes (`json_empty`, `not_defined`, `selector_invalid`, ...), or '' when the message is one the customer wrote themselves. Collected in every mode, so this is the field a diagnosis should be built on.","default":""},"message_value":{"type":"string","title":"Message Value","description":"The identifier that shape names: a property, a variable, a callee, a selector. '' when the shape names none, when the browser did not give one, or when what it gave did not look like code.","default":""},"ownership":{"$ref":"#/components/schemas/Ownership","description":"`first_party` if any captured frame's host sits on the page's own registrable domain or is a site of the application (server-derived), `mixed` where the occurrences of the row do not agree.","default":"mixed"},"frames":{"items":{"$ref":"#/components/schemas/ErrorFrameInfo"},"type":"array","title":"Frames","description":"Captured stack frames (max 5). frames[0] is the innermost throw site; frames[1+] expose the caller chain past framework/wrapper frames."},"last_seen_at":{"type":"string","format":"date-time","title":"Last Seen At","description":"End of the newest pageview that hit this row, over every variant. Read from raw beacons, so an error of the running hour is in it. Same value as `summary.last_seen_at` on /analytics/error-types/detail for one fingerprint.","examples":["2026-04-14T09:50:01Z"]},"variants":{"items":{"$ref":"#/components/schemas/ErrorVariant"},"type":"array","title":"Variants","description":"Every fingerprint this row counts, biggest first, the row's own `fingerprint` included. Empty unless the request set `group_variants`."},"comparison":{"description":"The same signature over the window of `compare_to`, counted for this row whatever its rank there was. Absent unless the request set `compare_to`.","$ref":"#/components/schemas/ErrorTypeComparison"}},"type":"object","required":["fingerprint","error_type","count","share","last_seen_at","status","message_kind","message_value","ownership","frames","variants"],"title":"ErrorTypeItem","description":"One error signature, keyed by `fingerprint`.\n\n`fingerprint` is the canonical group-by handle (server-computed djb2\nhash over type + frames + message shape). All other fields are display\nprojections of one row in that group."},"ErrorTypesRequest":{"properties":{"time_range":{"$ref":"#/components/schemas/TimeRange","description":"Time range for the query"},"filters":{"$ref":"#/components/schemas/Filters","description":"Optional filters"},"timezone":{"anyOf":[{"type":"string","maxLength":64},{"type":"null"}],"title":"Timezone","description":"IANA time zone the local hours of `filters.hour_of_day` are read in, such as `Europe/Berlin`. The filter requires it. This route buckets nothing, so the zone changes nothing else"},"sparse_buckets":{"anyOf":[{"$ref":"#/components/schemas/SparseBuckets"},{"type":"null"}],"description":"The sparse threshold of the page, the number `POST /analytics/sparse-hours` derives. With `exclude` the rows of the thin hours are left out. Without it the route only echoes the number in `meta.sparse_buckets`"},"error_type":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Error Type","description":"Restrict to specific error types (e.g. ['ResourceLoadError'])."},"exclude_error_type":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Exclude Error Type","description":"Drop these error types from the breakdown (e.g. ['ResourceLoadError'] to stop third-party resource-load noise from counting). Negative of error_type."},"exclude_hosts":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Exclude Hosts","description":"Exclude error signatures whose stack frames touch any of these hosts (e.g. ['bat.bing.com'] to drop a noisy 3rd-party)."},"ownership":{"anyOf":[{"$ref":"#/components/schemas/Ownership"},{"type":"null"}],"description":"Restrict to first_party or third_party error signatures. Matches per-signature `errors.is_first_party` (filter-then-rank: the Top-N reflects the chosen group). Unset = both, `mixed` is rejected. Signature-accurate, unlike the page-level `filters.error_origin`, which says whether the PAGEVIEW carried an own error."},"group_variants":{"type":"boolean","title":"Group Variants","description":"Merge the fingerprints of one fault into one row: the engines report the same throw site a few columns apart, and a second caller is a second stack. A row then counts all of them and lists them as `variants`. Off by default, because a client that compares rows across periods has to match them by their variants rather than by `fingerprint`.","default":false},"status":{"anyOf":[{"$ref":"#/components/schemas/ErrorSignatureStatus"},{"type":"null"}],"description":"Keep only the `open` or only the `acknowledged` rows. Absent keeps both. Applied after the query and before `limit`, over four times `limit` fingerprints at most 200, so a side can return fewer rows than `limit` when the other side filled that fetch."},"limit":{"type":"integer","maximum":50.0,"minimum":1.0,"title":"Limit","description":"Max error types to return","default":10},"compare_to":{"anyOf":[{"$ref":"#/components/schemas/CompareMode","description":"A window derived from `time_range` by `TimeRange.get_comparison_range`."},{"$ref":"#/components/schemas/TimeRange","description":"Any window, validated like `time_range`. It may differ in length and may overlap the main window."},{"$ref":"#/components/schemas/CompareToRelease"},{"type":"null"}],"title":"Compare To","description":"Also count each returned signature over a second window, as `comparison` on its row. A mode, a `{from, to}` window or a `{release_id}`, resolved as on /analytics/query. The counts are raw, so a window of another length needs no correction here but does in the reader."}},"additionalProperties":false,"type":"object","required":["time_range"],"title":"ErrorTypesRequest","description":"Request for error types breakdown."},"ErrorTypesResponse":{"properties":{"meta":{"$ref":"#/components/schemas/AnalyticsMeta","description":"Facts about the result"},"request":{"$ref":"#/components/schemas/AnalyticsRequestEcho","description":"The request as the server resolved it"},"data":{"items":{"$ref":"#/components/schemas/ErrorTypeItem"},"type":"array","title":"Data","description":"Error types with counts"},"error_count":{"type":"integer","title":"Error Count","description":"Total JavaScript error count. Failed resource loads are a separate signal, see /analytics/failed-resources."},"blocked_count":{"type":"integer","title":"Blocked Count","description":"Ad-blocked tracker requests in the same filter scope - surface as 'N excluded as ad-blocked', not as a failure. A subset of the blocked bucket on /analytics/failed-resources.","default":0},"own_subdomain_hosts":{"items":{"type":"string"},"type":"array","title":"Own Subdomain Hosts","description":"Hosts on the site's own registrable domain, other than the page host, that served scripts or slow resources in this scope. Filled only when a `ScriptError` row is present: a masked error cannot be attributed, but the fix (`crossorigin=\"anonymous\"` plus CORS on the host) needs a host name, and these are the ones the site owner controls. A hint, not a verdict: the beacon carries no exhaustive script-host list."}},"type":"object","required":["meta","request","data","error_count","blocked_count","own_subdomain_hosts"],"title":"ErrorTypesResponse","description":"Response for error types breakdown."},"ErrorVariant":{"properties":{"fingerprint":{"type":"string","title":"Fingerprint","description":"The variant's own group-by key."},"count":{"type":"integer","title":"Count","description":"Occurrences of this variant alone."},"frames":{"items":{"$ref":"#/components/schemas/ErrorFrameInfo"},"type":"array","title":"Frames","description":"This variant's stack, which is what tells it from its siblings."}},"type":"object","required":["fingerprint","count","frames"],"title":"ErrorVariant","description":"One fingerprint inside a grouped list row."},"EventBreakdownRequest":{"properties":{"time_range":{"$ref":"#/components/schemas/TimeRange","description":"Time range, on the event's own timestamp"},"filters":{"$ref":"#/components/schemas/Filters","description":"Optional filters. Only the ones with a column on the events table are accepted: the site scope, `stitch`, the edge-derived dimensions, `tracker_version` and `hour_of_day` on the event's own time. Anything else is a 422 naming it under its own path, because an empty answer would read as 'no events arrived'. They narrow the events of `name`, never the next event of `next_event`."},"name":{"type":"string","maxLength":64,"title":"Name","description":"The event name, lowercased first. One the collector would refuse is a 422. The stage events the collector derives are never read here"},"dimension":{"$ref":"#/components/schemas/EventDimension","description":"The one dimension the rows group by. `page_type` and `page_url` are the page the event was sent from, the `page_type` and `page_url` of its event row. `device_type` is the edge label. `next_event` is the name of the next sent event of the same visit, the stitch's next event in time on any page, read up to 24 hours past the window. Its rows count only the events of `name` that carry a stitch"},"timezone":{"anyOf":[{"type":"string","maxLength":64},{"type":"null"}],"title":"Timezone","description":"IANA time zone the local hours of `filters.hour_of_day` are read in, such as `Europe/Berlin`. The filter requires it. This route buckets nothing, so the zone changes nothing else"},"sparse_buckets":{"anyOf":[{"$ref":"#/components/schemas/SparseBuckets"},{"type":"null"}],"description":"The sparse threshold of the page, the number `POST /analytics/sparse-hours` derives. With `exclude` the rows of the thin hours are left out. Without it the route only echoes the number in `meta.sparse_buckets`"},"limit":{"type":"integer","maximum":100.0,"minimum":1.0,"title":"Limit","description":"Max rows, the most events first, a tie by `key`","default":10}},"additionalProperties":false,"type":"object","required":["time_range","name","dimension"],"title":"EventBreakdownRequest","description":"Request for the events of one name grouped by one dimension."},"EventBreakdownResponse":{"properties":{"meta":{"$ref":"#/components/schemas/AnalyticsMeta","description":"Facts about the result. `total` is the number of values the dimension has in the window, `limit` the cap on `data`"},"request":{"$ref":"#/components/schemas/AnalyticsRequestEcho","description":"The request as the server resolved it"},"event_count":{"type":"integer","title":"Event Count","description":"Events of `name` in the window, the rows the limit cut included, which every `share` is measured against. For `next_event` only the events that carry a stitch, 0 where none does"},"data":{"items":{"$ref":"#/components/schemas/EventBreakdownRow"},"type":"array","title":"Data","description":"At most `meta.limit` rows, the most events first, a tie by `key`"}},"type":"object","required":["meta","request","event_count","data"],"title":"EventBreakdownResponse","description":"The events of one name grouped by one dimension.\n\nEvery number is a count or a quotient of counts, as events are never sampled."},"EventBreakdownRow":{"properties":{"key":{"type":"string","title":"Key","description":"The value this row groups by, as stored. A `page_type` or `device_type` key goes back as a one-value list of the filter of the same name, `\"\"` included. A `page_url` key goes back as `filters.url`, which reads `*` as a wildcard. A `next_event` key is an event name and goes back as `name`. The empty key holds the events without a value: no page, no device label, or no event after them in the visit. `filters.url` and `name` take no empty value"},"event_count":{"type":"integer","title":"Event Count","description":"Events of `name` with this value"},"share":{"type":"number","title":"Share","description":"This row's events over the `event_count` of the response, the rows the limit cut included, 0..1"}},"type":"object","required":["key","event_count","share"],"title":"EventBreakdownRow","description":"One value of the breakdown dimension with the events behind it."},"EventDimension":{"type":"string","enum":["page_type","page_url","device_type","next_event"],"title":"EventDimension","description":"What the breakdown of one event name groups its events by."},"EventNameComparison":{"properties":{"event_count":{"type":"integer","title":"Event Count","description":"Events of this name in the compared window, 0 where it had none"},"visitors":{"title":"Visitors","description":"`visitors` of the row over the compared window, 0 where the name had no event there. Absent where no event of that window carries a stitch","type":"integer"},"visitor_share":{"title":"Visitor Share","description":"`visitors` over all visitors of the compared window, as on the row. Absent where either is not measured, and on a window without events","type":"number"},"events_per_pageview":{"title":"Events Per Pageview","description":"`event_count` over the weighted page views of the compared window, as on the row. Absent where they are not measured, and on a window without events","type":"number"}},"type":"object","required":["event_count"],"title":"EventNameComparison","description":"One event name over the window `compare_to` asked for."},"EventNameRow":{"properties":{"name":{"type":"string","title":"Name","description":"The event name"},"stage":{"description":"The funnel stage this name reaches. Absent for a name that reaches none","$ref":"#/components/schemas/EventStage"},"event_count":{"type":"integer","title":"Event Count","description":"Events of this name in the window. On a row of `derived_names` the page views the collector derived the event from, each once"},"visitors":{"title":"Visitors","description":"Distinct visitors with at least one of these events, by the stitch. A count, never weighted: events are not sampled. Absent where no event of the window carries a stitch, as on a site that stores none","type":"integer"},"visitor_share":{"title":"Visitor Share","description":"`visitors` over all visitors of the window under the same filters, the denominator of the checkout funnel's conversion rate, capped at 1. Absent where either is not measured, and on a sampled application an estimate, as the visitors are","type":"number"},"events_per_pageview":{"title":"Events Per Pageview","description":"`event_count` over the page views of the same window or bucket under the same filters, unbounded: 0.25 is 25 events per 100 page views. Absent where the page views are not measured or are 0, and on a sampled application an estimate, as the page views are","type":"number"},"first_seen_at":{"type":"string","format":"date-time","title":"First Seen At","description":"The first event of this name ever on the sites in scope, not only in the window. The other filters do not apply","examples":["2026-04-14T09:50:01Z"]},"last_seen_at":{"type":"string","format":"date-time","title":"Last Seen At","description":"The last event of this name in the window","examples":["2026-04-14T09:50:01Z"]},"comparison":{"description":"Absent unless `compare_to` was set","$ref":"#/components/schemas/EventNameComparison"}},"type":"object","required":["name","event_count","first_seen_at","last_seen_at"],"title":"EventNameRow","description":"One event name of the window with its counts and its first and last event."},"EventOrderRevenue":{"properties":{"currency":{"type":"string","title":"Currency","description":"The `currency` prop as sent, not validated and never converted. Empty for the orders whose `value` came without a `currency`"},"value":{"type":"number","title":"Value","description":"Sum of the order values, each order counted once"},"order_count":{"type":"integer","title":"Order Count","description":"Orders whose `value` prop reads as a number"},"average_order_value":{"title":"Average Order Value","description":"`value` over `order_count`, the mean value of one order in this currency. Absent where `order_count` is 0","type":"number"}},"type":"object","required":["currency","value","order_count"],"title":"EventOrderRevenue","description":"The money the orders of a window or a bucket reported in one currency."},"EventPropKey":{"properties":{"key":{"type":"string","title":"Key","description":"The prop key, flattened to dot notation with the array positions left out: `items.0.price` and `items.1.price` are `items.price`"},"event_count":{"type":"integer","title":"Event Count","description":"Events that carry this key, at any array position, each once"},"distinct_value_count":{"type":"integer","title":"Distinct Value Count","description":"Distinct values of this key in the window, independent of `limit`"},"events_by_value":{"additionalProperties":{"type":"integer"},"type":"object","title":"Events By Value","description":"The `limit` most frequent values of this key to the events that carry them at any array position, each event once per value, most first"}},"type":"object","required":["key","event_count","distinct_value_count","events_by_value"],"title":"EventPropKey","description":"One prop key of the window's events and its most frequent values."},"EventRow":{"properties":{"event_id":{"type":"string","format":"uuid","title":"Event Id","description":"Opaque id of this event within its site. Pass it with `site_id` to PATCH or DELETE /sites/{site_id}/events/{event_id}. An edit keeps it","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"timestamp":{"type":"string","format":"date-time","title":"Timestamp","description":"When the event happened, millisecond precision","examples":["2026-04-14T09:50:01Z"]},"name":{"type":"string","title":"Name","description":"The event's name as the sender chose it, lowercased, matching `^[a-z0-9_.-]{1,48}$`. `view_cart`, `begin_checkout`, `add_payment_info` and `order_placed` are the checkout vocabulary and reach their stage whoever sent them. `purchase`, GA4's name, reaches `success` as well. Any other name is the shop's own, ..."},"stage":{"description":"The funnel stage this event's name reaches. Absent for a name outside the checkout vocabulary and for `add_payment_info`, which is no stage: a visitor who submitted payment and shows no `order_placed` most likely paid through a wallet whose completion Shopify does not report.","$ref":"#/components/schemas/EventStage"},"source":{"type":"string","title":"Source","description":"Who sent the event: `shopify_pixel` for the Shopify checkout pixel, `collector` for the stage event derived from a checkout pageview, `tracker` for an event a page sent on purpose, through the tracker or a direct `POST /c/e/{collector_hash}`. The set grows with each way in, ..."},"props":{"additionalProperties":{"type":"string"},"type":"object","title":"Props","description":"The event's properties, flattened to dot notation, every value a string. An array is its JSON text, a number or a boolean its text. Empty when the sender sent none, and always empty on a `collector` event"},"site_id":{"type":"string","format":"uuid","title":"Site Id","description":"The site the event was sent from","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"visitor_id":{"title":"Visitor Id","description":"The 32-hex edge pseudonym (`stitch`), the wire form /analytics/visitors uses, so a row links straight into the visitor detail. No `identity` sits beside it, so it is always the stitch. Absent where the site has `store_stitch` off: the 16 zero bytes join nothing, and 32 zeros would look like an id that does.","type":"string"},"pvid":{"type":"string","title":"Pvid","description":"The decimal string of the script-load id, as in `BeaconRow.pvid`. On a pixel event it groups the events of ONE checkout load and matches no pageview, because the checkout runs where no theme script does. On a `collector` event it is the pvid of the pageview it was derived from, on a `tracker` event the pvid of the pageview that sent it."},"country":{"type":"string","title":"Country","description":"Edge-derived country code"},"asn":{"type":"integer","title":"Asn","description":"Edge-derived autonomous system number of the network, 0 when unknown"},"isp":{"type":"string","title":"Isp","description":"Name of that network, empty when unknown"},"device_type":{"description":"Edge-derived device class, absent where it could not be derived","$ref":"#/components/schemas/DeviceType"},"browser":{"type":"string","title":"Browser","description":"Edge-derived browser family"},"os":{"type":"string","title":"Os","description":"Edge-derived operating system"},"bot_name":{"type":"string","title":"Bot Name","description":"Bot label, empty for human traffic"},"bot_type":{"type":"string","title":"Bot Type","description":"Bot category, empty for human traffic"},"datacenter":{"type":"string","title":"Datacenter","description":"Datacenter label, empty for a consumer network"},"ua_anomaly":{"type":"string","title":"Ua Anomaly","description":"User-agent anomaly label, empty when there is none"},"tracker_version":{"type":"string","title":"Tracker Version","description":"Build that sent the event, `YYMMDD-<sha>`"},"page_url":{"title":"Page Url","description":"URL of the page the event was sent from, sanitized as the pageview's `url` is. Filtered by `filters.url`. Absent where the event carries none, as on a row written before the events table had the column","type":"string"},"page_type":{"title":"Page Type","description":"Page type of the page the event was sent from. Absent where unknown, as on a `/c/e/` event, which has no pageview, other than the pixel's","type":"string"}},"type":"object","required":["event_id","timestamp","name","source","props","site_id","pvid","country","asn","isp","browser","os","bot_name","bot_type","datacenter","ua_anomaly","tracker_version"],"title":"EventRow","description":"One event row, in the wire shapes `/analytics/beacons` already uses."},"EventStage":{"type":"string","enum":["cart","checkout","success"],"title":"EventStage","description":"The stage a checkout EVENT reaches.\n\n`cart` is reached by the event the collector derives from a cart pageview.\nThe pixel's events reach `checkout` and `success` only."},"EventUpdate":{"properties":{"name":{"anyOf":[{"type":"string","maxLength":64},{"type":"null"}],"title":"Name","description":"The new name, lowercased and checked as the collector checks it"},"props":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Props","description":"The new props, replacing the old ones whole. Flattened, capped and checked as the collector does: a key the collector would drop, such as `email`, is a 422 here. `{}` removes every prop"}},"additionalProperties":false,"type":"object","title":"EventUpdate","description":"What an edit of one event changes. A field left out stays as it is."},"EventValueSum":{"properties":{"name":{"type":"string","title":"Name","description":"The event name"},"stage":{"description":"The funnel stage this name reaches. Absent for a name that reaches none, `add_payment_info` included, so a `view_item` sum, the price of an item looked at, is never mistaken for money taken","$ref":"#/components/schemas/EventStage"},"currency":{"type":"string","title":"Currency","description":"The event's `currency` prop as sent, not validated and never converted. Empty for the events that carry a `value` and no `currency`"},"value":{"type":"number","title":"Value","description":"Sum of the `value` prop of these events, read as a number"},"event_count":{"type":"integer","title":"Event Count","description":"Events whose `value` prop reads as a number"}},"type":"object","required":["name","currency","value","event_count"],"title":"EventValueSum","description":"The summed `value` prop of one event name in one currency."},"EventsBucket":{"properties":{"timestamp":{"type":"string","format":"date-time","title":"Timestamp","examples":["2026-04-14T09:50:01Z"],"description":"ISO 8601 in UTC with a `Z` suffix."},"event_count":{"type":"integer","title":"Event Count","description":"Events in this bucket"},"visitors":{"title":"Visitors","description":"Distinct visitors with at least one of these events, by the stitch. A count, never weighted: events are not sampled. Absent where no event of the window carries a stitch, as on a site that stores none","type":"integer"},"events_per_pageview":{"title":"Events Per Pageview","description":"`event_count` over the page views of the same window or bucket under the same filters, unbounded: 0.25 is 25 events per 100 page views. Absent where the page views are not measured or are 0, and on a sampled application an estimate, as the page views are","type":"number"},"names":{"items":{"$ref":"#/components/schemas/EventsBucketName"},"type":"array","title":"Names","description":"Every name of the window's `names` with an event in this bucket, most events first. A name outside them counts in `event_count` only"},"order_revenue":{"items":{"$ref":"#/components/schemas/OverviewOrderRevenue"},"type":"array","title":"Order Revenue","description":"The window's `order_revenue` for the orders of this bucket, empty where none carried a value. An order counts in the bucket of its newest event with a numeric `value`, so the buckets add up to the window's `order_revenue` per currency"},"events_by_name":{"additionalProperties":{"type":"integer"},"type":"object","title":"Events By Name","description":"Deprecated, use `names`. Event name to its events in this bucket","deprecated":true,"readOnly":true,"x-replaced-by":"names"}},"type":"object","required":["timestamp","event_count","names","order_revenue","events_by_name"],"title":"EventsBucket","description":"One bucket of the event series."},"EventsBucketName":{"properties":{"name":{"type":"string","title":"Name","description":"The event name"},"event_count":{"type":"integer","title":"Event Count","description":"Events of this name in the bucket"},"visitors":{"title":"Visitors","description":"Distinct visitors with at least one of these events, by the stitch. A count, never weighted: events are not sampled. Absent where no event of the window carries a stitch, as on a site that stores none","type":"integer"},"events_per_pageview":{"title":"Events Per Pageview","description":"`event_count` over the page views of the same window or bucket under the same filters, unbounded: 0.25 is 25 events per 100 page views. Absent where the page views are not measured or are 0, and on a sampled application an estimate, as the page views are","type":"number"}},"type":"object","required":["name","event_count"],"title":"EventsBucketName","description":"One event name in one bucket of the event series."},"EventsOverviewComparison":{"properties":{"time_range":{"$ref":"#/components/schemas/TimeRange","description":"The compared window"},"event_count":{"type":"integer","title":"Event Count","description":"Events in the compared window"},"name_count":{"type":"integer","title":"Name Count","description":"Distinct event names of the compared window, as on the response"},"visitors":{"title":"Visitors","description":"Distinct visitors with any event of the compared window, as on the response. Absent where no event of that window carries a stitch","type":"integer"},"visitor_share":{"title":"Visitor Share","description":"`visitors` over all visitors of the compared window, as on the response","type":"number"},"order_revenue":{"items":{"$ref":"#/components/schemas/OverviewOrderRevenue"},"type":"array","title":"Order Revenue","description":"The window's `order_revenue` over the compared window"},"series":{"items":{"$ref":"#/components/schemas/EventsBucket"},"type":"array","title":"Series","description":"The compared window's own buckets at the resolved size, carrying their own timestamps and the most frequent names of the compared window. NOT shifted onto the current window: the client lines the two up by position or by clock, as /analytics/query does"}},"type":"object","required":["time_range","event_count","name_count","order_revenue","series"],"title":"EventsOverviewComparison","description":"The counts, the visitors, the orders and the series over the window `compare_to` asked for."},"EventsOverviewRequest":{"properties":{"time_range":{"$ref":"#/components/schemas/TimeRange","description":"Time range, on the event's own timestamp"},"filters":{"$ref":"#/components/schemas/Filters","description":"Optional filters. Only the ones with a column on the events table are accepted: the site scope, `stitch`, the edge-derived dimensions, `tracker_version` and `hour_of_day` on the event's own time. Anything else is a 422 naming it under its own path, because an empty answer would read as 'no events arrived'."},"names":{"anyOf":[{"items":{"type":"string"},"type":"array","maxItems":50,"minItems":1},{"type":"null"}],"title":"Names","description":"Restrict to these event names, lowercased first. Null or omitted counts every name. Name one event to read the values of its own props."},"granularity":{"$ref":"#/components/schemas/GranularityRequest","description":"Bucket size of the series: 'minute', 'five_minutes', 'fifteen_minutes', 'hour', 'six_hours', 'day', or 'auto' (default: the smallest width with at most 300 buckets over the window, and 'day' from 28 days). A width under an hour allows at most 1500 buckets.","default":"auto"},"timezone":{"anyOf":[{"type":"string","maxLength":64},{"type":"null"}],"title":"Timezone","description":"IANA time zone whose boundaries start the `six_hours`, `day`, `week` and `month` buckets, such as `Europe/Berlin`. A day is 23 or 25 hours long across a DST switch. Bucket timestamps stay UTC. In a zone whose offset is not whole hours a bucket starts at the UTC hour that holds the local boundary. Without it the buckets start at UTC boundaries"},"sparse_buckets":{"anyOf":[{"$ref":"#/components/schemas/SparseBuckets"},{"type":"null"}],"description":"The sparse threshold of the page, the number `POST /analytics/sparse-hours` derives. With `exclude` the rows of the thin hours are left out. Without it the route only echoes the number in `meta.sparse_buckets`"},"limit":{"type":"integer","maximum":100.0,"minimum":1.0,"title":"Limit","description":"Max names in `names`, max keys in `prop_keys` and max values per key","default":20},"compare_to":{"anyOf":[{"$ref":"#/components/schemas/CompareMode","description":"A window derived from `time_range` by `TimeRange.get_comparison_range`."},{"$ref":"#/components/schemas/TimeRange","description":"Any window, validated like `time_range`. It may differ in length and may overlap the main window."},{"$ref":"#/components/schemas/CompareToRelease"},{"type":"null"}],"title":"Compare To","description":"Also report the counts, the orders and the series for a second window: a mode, a `{from, to}` window or a `{release_id}`, resolved as on /analytics/query"}},"additionalProperties":false,"type":"object","required":["time_range"],"title":"EventsOverviewRequest","description":"Request for the counts of the events of a window."},"EventsOverviewResponse":{"properties":{"meta":{"$ref":"#/components/schemas/AnalyticsMeta","description":"Facts about the result"},"request":{"$ref":"#/components/schemas/AnalyticsRequestEcho","description":"The request as the server resolved it"},"event_count":{"type":"integer","title":"Event Count","description":"Events in the window, the derived ones of `derived_names` left out"},"name_count":{"type":"integer","title":"Name Count","description":"Distinct event names of the window, independent of `limit`, the derived ones left out"},"visitors":{"title":"Visitors","description":"Distinct visitors with any event of the window, the derived ones left out. A count, never weighted. Absent where no event of the window carries a stitch","type":"integer"},"visitor_share":{"title":"Visitor Share","description":"`visitors` over all visitors of the window, as on a row of `names`","type":"number"},"names":{"items":{"$ref":"#/components/schemas/EventNameRow"},"type":"array","title":"Names","description":"The `limit` most frequent event names of the window, most events first. The stage events the collector derives from checkout page views are in `derived_names` instead"},"derived_names":{"items":{"$ref":"#/components/schemas/EventNameRow"},"type":"array","title":"Derived Names","description":"The stage events the collector derives from checkout page views, `view_cart`, `begin_checkout` and `order_placed`, one per page view. Kept apart because they are page views counted again, not events a site sent: `event_count` and `series` leave them out. A name can stand in both lists when a site also sends it"},"series":{"items":{"$ref":"#/components/schemas/EventsBucket"},"type":"array","title":"Series","description":"One point per bucket with at least one event. A bucket with none is absent rather than zero-filled, as in /analytics/query."},"value_sums":{"items":{"$ref":"#/components/schemas/EventValueSum"},"type":"array","title":"Value Sums","description":"Per event name and `currency` prop, the sum of the `value` prop over the events where it reads as a number, whatever the name means: a `view_item` sums item prices, not revenue. A convention, not a schema: nothing converts between currencies, and a name whose events carry no numeric `value` has no entry. Most events first"},"order_revenue":{"items":{"$ref":"#/components/schemas/OverviewOrderRevenue"},"type":"array","title":"Order Revenue","description":"Per `currency` prop, the money of the orders. An order is one pageview with a success-stage event, `order_placed` or `purchase`, and its value is the largest numeric `value` among them, so a pageview that sends both counts once. An event without a pageview is an order of its own, and a reloaded thank-you page is a second order. The collector's derived events and the Shopify pixel's carry no `value` and add nothing. `names` narrows it like every other figure. No conversion between currencies, most orders first. The `order_revenue` of the `series` buckets add up to it"},"prop_keys":{"items":{"$ref":"#/components/schemas/EventPropKey"},"type":"array","title":"Prop Keys","description":"The `limit` prop keys carried by the most events, most first"},"events_by_hour_of_day":{"additionalProperties":{"type":"integer"},"type":"object","title":"Events By Hour Of Day","description":"Local hour of the day, 0 to 23, to the events of the window in it, read on the event's own time in `timezone`, UTC where it is absent. Every name or the ones of `names`, the derived ones left out. An hour without an event has no key"},"comparison":{"description":"Absent unless `compare_to` was set","$ref":"#/components/schemas/EventsOverviewComparison"},"events_by_name":{"additionalProperties":{"type":"integer"},"type":"object","title":"Events By Name","description":"Deprecated, use `names`. The `limit` most frequent event names to their events","deprecated":true,"readOnly":true,"x-replaced-by":"names"},"revenue":{"items":{"$ref":"#/components/schemas/EventValueSum"},"type":"array","title":"Revenue","description":"Deprecated, use `value_sums`. It sums the `value` prop of every name, so it is no revenue: `order_revenue` is","deprecated":true,"readOnly":true,"x-replaced-by":"value_sums"}},"type":"object","required":["meta","request","event_count","name_count","names","derived_names","series","value_sums","order_revenue","prop_keys","events_by_hour_of_day","events_by_name","revenue"],"title":"EventsOverviewResponse","description":"The events of a window counted: per name, over time, as sums, as orders and per prop value.\n\nEvents are never sampled, so every number is a count, except the revenue\nper visitor, whose visitors are weighted."},"EventsRequest":{"properties":{"time_range":{"$ref":"#/components/schemas/TimeRange","description":"Time range, on the event's own timestamp"},"filters":{"$ref":"#/components/schemas/Filters","description":"Optional filters. Only the ones with a column on the events table are accepted: the site scope, `stitch`, the edge-derived dimensions, `tracker_version` and `hour_of_day` on the event's own time. Anything else is a 422 naming it under its own path, because an empty answer would read as 'no events arrived'."},"timezone":{"anyOf":[{"type":"string","maxLength":64},{"type":"null"}],"title":"Timezone","description":"IANA time zone the local hours of `filters.hour_of_day` are read in, such as `Europe/Berlin`. The filter requires it. This route buckets nothing, so the zone changes nothing else"},"sparse_buckets":{"anyOf":[{"$ref":"#/components/schemas/SparseBuckets"},{"type":"null"}],"description":"The sparse threshold of the page, the number `POST /analytics/sparse-hours` derives. With `exclude` the rows of the thin hours are left out. Without it the route only echoes the number in `meta.sparse_buckets`"},"names":{"anyOf":[{"items":{"type":"string"},"type":"array","maxItems":50,"minItems":1},{"type":"null"}],"title":"Names","description":"Restrict to these event names. Null or omitted lists every name. A name is lowercased first, and one the collector would refuse is a 422. A stage is not a filter here: `stage` is derived from the name, so a caller who wants one stage names its events. A name selects the rows of every source, and `source` on each row tells them apart."},"limit":{"type":"integer","maximum":100.0,"minimum":1.0,"title":"Limit","description":"Max rows per page","default":50},"cursor":{"anyOf":[{"type":"string","maxLength":1024},{"type":"null"}],"title":"Cursor","description":"Opaque resume point from `meta.next_cursor` of the previous page. It carries the last row's timestamp, pvid and seq, so two events in the same millisecond page without a gap or a repeat."}},"additionalProperties":false,"type":"object","required":["time_range"],"title":"EventsRequest","description":"Request for the row-level list of events."},"ExcludeColumn":{"type":"string","enum":["browser","device_type","os","country","connection_type","nav_type","protocol","viewport_class","dominant_third_party_category","error_origin","cdn_cache_status","origin_cache_status","page_type","origin_host","logged_in","tracker_version","datacenter","bot_name","bot_type","ua_anomaly","checkout_stage","error_type","path","page_url","host","browser_version","nel_class","server_ip","disposition","effective_directive","blocked_url","source_url","domain","referrer_source","referrer_medium","utm_source","utm_medium","utm_campaign","utm_term","utm_content","click_id_param"],"title":"ExcludeColumn","description":"Columns allowed as Filters.exclude keys (NOT IN)."},"ExperienceScoreMetric":{"properties":{"metric":{"type":"string","title":"Metric","description":"A metric catalog id: lcp, inp, cls, fcp, ttfb or first_party_error_rate, which are scored, and `error_rate`, every JavaScript error, with `score` absent. The `error_rate` entry is deprecated and goes once the dashboard reads the first-party one."},"value":{"title":"Value","description":"The p75 of a vital, the share 0 to 1 of first_party_error_rate","type":"number"},"score":{"title":"Score","description":"Metric score 0.0-10.0","type":"number"}},"type":"object","required":["metric"],"title":"ExperienceScoreMetric","description":"Score for a single metric within a segment."},"ExperienceScoreRequest":{"properties":{"time_range":{"$ref":"#/components/schemas/TimeRange","description":"Time range for the query (required)"},"filters":{"$ref":"#/components/schemas/Filters","description":"Optional filters"},"timezone":{"anyOf":[{"type":"string","maxLength":64},{"type":"null"}],"title":"Timezone","description":"IANA time zone the local hours of `filters.hour_of_day` are read in, such as `Europe/Berlin`. The filter requires it. This route buckets nothing, so the zone changes nothing else"},"sparse_buckets":{"anyOf":[{"$ref":"#/components/schemas/SparseBuckets"},{"type":"null"}],"description":"The sparse threshold of the page, the number `POST /analytics/sparse-hours` derives. With `exclude` the rows of the thin hours are left out. Without it the route only echoes the number in `meta.sparse_buckets`"}},"additionalProperties":false,"type":"object","required":["time_range"],"title":"ExperienceScoreRequest","description":"Request schema for experience score query."},"ExperienceScoreResponse":{"properties":{"meta":{"$ref":"#/components/schemas/AnalyticsMeta","description":"Facts about the result"},"request":{"$ref":"#/components/schemas/AnalyticsRequestEcho","description":"The request as the server resolved it"},"segments":{"items":{"$ref":"#/components/schemas/ExperienceScoreSegment"},"type":"array","title":"Segments","description":"Scores per visitor segment"}},"type":"object","required":["meta","request","segments"],"title":"ExperienceScoreResponse","description":"Response for experience score query."},"ExperienceScoreSegment":{"properties":{"segment":{"type":"string","title":"Segment","description":"Segment key (all, desktop, mobile, slow)"},"label":{"type":"string","title":"Label","description":"Human-readable segment name"},"score":{"title":"Score","description":"Overall score 0.0-10.0","type":"number"},"grade":{"title":"Grade","description":"Letter grade (A+, A, B, C, D, F)","type":"string"},"beacon_count":{"type":"integer","title":"Beacon Count","description":"Number of beacons in segment"},"metrics":{"items":{"$ref":"#/components/schemas/ExperienceScoreMetric"},"type":"array","title":"Metrics","description":"Per-metric breakdown"}},"type":"object","required":["segment","label","beacon_count","metrics"],"title":"ExperienceScoreSegment","description":"Experience score for one visitor segment."},"FailedResourceDetailRequest":{"properties":{"time_range":{"$ref":"#/components/schemas/TimeRange","description":"Time range for the query"},"filters":{"$ref":"#/components/schemas/Filters","description":"Optional filters"},"identity":{"anyOf":[{"type":"string","enum":["stitch","session"]},{"type":"null"}],"title":"Identity","description":"Identity backing `affected_visitors` / breakdown `visitors`: 'stitch' or 'session'. Null resolves to the application's default."},"fingerprint":{"type":"string","maxLength":16,"minLength":1,"title":"Fingerprint"},"breakdowns":{"items":{"$ref":"#/components/schemas/ErrorBreakdownDim"},"type":"array","title":"Breakdowns","description":"Dimensions to return as top-N breakdowns. `url` is the PAGE the resource failed on, not the resource itself - that one is in the summary."},"limit":{"type":"integer","maximum":50.0,"minimum":1.0,"title":"Limit","description":"Max entries per breakdown dimension","default":10},"sample_size":{"type":"integer","maximum":100.0,"minimum":0.0,"title":"Sample Size","default":20},"granularity":{"$ref":"#/components/schemas/GranularityRequest","description":"Bucket size of the series: 'minute', 'five_minutes', 'fifteen_minutes', 'hour', 'six_hours', 'day', or 'auto' (default: the smallest width with at most 300 buckets over the window, and 'day' from 28 days). A width under an hour allows at most 1500 buckets.","default":"auto"},"timezone":{"anyOf":[{"type":"string","maxLength":64},{"type":"null"}],"title":"Timezone","description":"IANA time zone whose boundaries start the `six_hours`, `day`, `week` and `month` buckets, such as `Europe/Berlin`. A day is 23 or 25 hours long across a DST switch. Bucket timestamps stay UTC. In a zone whose offset is not whole hours a bucket starts at the UTC hour that holds the local boundary. Without it the buckets start at UTC boundaries"},"sparse_buckets":{"anyOf":[{"$ref":"#/components/schemas/SparseBuckets"},{"type":"null"}],"description":"The sparse threshold of the page, the number `POST /analytics/sparse-hours` derives. With `exclude` the rows of the thin hours are left out. Without it the route only echoes the number in `meta.sparse_buckets`"}},"additionalProperties":false,"type":"object","required":["time_range","fingerprint"],"title":"FailedResourceDetailRequest","description":"Request for drill-down on a single failed-resource signature.\n\nKeyed by the `fingerprint` that `/analytics/failed-resources` returns.\n`/analytics/error-types/detail` deliberately refuses that key (its\npercentage divides by the JavaScript-only `error_count`), so the two\npopulations keep separate routes rather than one route with a mode flag."},"FailedResourceDetailResponse":{"properties":{"meta":{"$ref":"#/components/schemas/AnalyticsMeta","description":"Facts about the result"},"request":{"$ref":"#/components/schemas/AnalyticsRequestEcho","description":"The request as the server resolved it"},"summary":{"$ref":"#/components/schemas/FailedResourceDetailSummary"},"timeseries":{"items":{"$ref":"#/components/schemas/ErrorTimeseriesPoint"},"type":"array","title":"Timeseries"},"breakdowns":{"additionalProperties":{"$ref":"#/components/schemas/ErrorBreakdown"},"type":"object","title":"Breakdowns"},"samples":{"items":{"$ref":"#/components/schemas/ErrorSample"},"type":"array","title":"Samples"}},"type":"object","required":["meta","request","summary","timeseries","breakdowns","samples"],"title":"FailedResourceDetailResponse","description":"Response for `/analytics/failed-resources/detail`."},"FailedResourceDetailSummary":{"properties":{"host":{"type":"string","title":"Host","description":"Host that should have served the resource. Empty only when the signature had no occurrences in this scope.","default":""},"path":{"type":"string","title":"Path","description":"Path of the resource, often empty - stack frames are opt-in per site (features.collect_error_frames) and without them only a resource on the exact page host keeps its path.","default":""},"ownership":{"description":"Whose host served the resource, absent when the signature had no occurrences. One value even where the scope has two: ownership is a per-site fact and the fingerprint does not carry it, so the same CDN host can be first_party for one site of a multi-site scope and third_party for another. Reported as the conservative third_party then, never `mixed`. The list endpoint groups by ownership and shows the split.","$ref":"#/components/schemas/Ownership"},"count":{"type":"integer","title":"Count","description":"Failed load events for this resource."},"pageviews":{"type":"integer","title":"Pageviews","description":"Distinct pageviews the resource failed on. Duplicate-invariant, so unlike `count` it is unaffected by a pageview that sent several beacons."},"affected_visitors":{"title":"Affected Visitors","description":"Distinct affected visitors, counted over the response's resolved `identity` (stitch or session). Absent if the site collects no visitor identifier.","type":"integer"},"first_seen_at":{"title":"First Seen At","examples":["2026-04-14T09:50:01Z"],"description":"ISO 8601 in UTC with a `Z` suffix.","type":"string","format":"date-time"},"last_seen_at":{"title":"Last Seen At","examples":["2026-04-14T09:50:01Z"],"description":"ISO 8601 in UTC with a `Z` suffix.","type":"string","format":"date-time"},"share":{"type":"number","title":"Share","description":"Part of every failed resource load in THIS request's time range and filter scope, both halves included, 0..1. Never a part of the JavaScript `error_count`: the two populations are disjoint and a share across them would mean nothing. It equals a part of the list endpoint's `failed_count` only where that call set no `host`/`exclude_hosts` - those narrow its total, and this request has no way to say it wants the same denominator."}},"type":"object","required":["count","pageviews","share","host","path"],"title":"FailedResourceDetailSummary","description":"Aggregate summary for the selected failed resource."},"FailedResourceItem":{"properties":{"ownership":{"$ref":"#/components/schemas/Ownership","description":"Whose host served the resource. Never `mixed`: a row is one host."},"host":{"type":"string","title":"Host","description":"Host of the resource that failed to load."},"path":{"type":"string","title":"Path","description":"Path of the resource, query and hash removed. Often empty: stack frames are opt-in per site (features.collect_error_frames, off by default) and without them only a resource on the EXACT page host keeps its path. Ownership uses the registrable domain, so a resource on your own CDN subdomain is first_party and still arrives host-only. Also empty when the URL was not parseable at all.","default":""},"fingerprint":{"type":"string","title":"Fingerprint","description":"Group key for the drill-down: pass it to `/analytics/beacons` as `error_fingerprint` with `error_fingerprint_kind: failed_resource`.","default":""},"count":{"type":"integer","title":"Count","description":"Failed load events."},"pageviews":{"type":"integer","title":"Pageviews","description":"Pageviews on which this resource failed."}},"type":"object","required":["ownership","host","count","pageviews","path","fingerprint"],"title":"FailedResourceItem","description":"One failing resource, keyed by host + path."},"FailedResourcesRequest":{"properties":{"time_range":{"$ref":"#/components/schemas/TimeRange","description":"Time range for the query"},"filters":{"$ref":"#/components/schemas/Filters","description":"Optional filters"},"timezone":{"anyOf":[{"type":"string","maxLength":64},{"type":"null"}],"title":"Timezone","description":"IANA time zone the local hours of `filters.hour_of_day` are read in, such as `Europe/Berlin`. The filter requires it. This route buckets nothing, so the zone changes nothing else"},"sparse_buckets":{"anyOf":[{"$ref":"#/components/schemas/SparseBuckets"},{"type":"null"}],"description":"The sparse threshold of the page, the number `POST /analytics/sparse-hours` derives. With `exclude` the rows of the thin hours are left out. Without it the route only echoes the number in `meta.sparse_buckets`"},"ownership":{"anyOf":[{"items":{"$ref":"#/components/schemas/Ownership"},"type":"array"},{"type":"null"}],"title":"Ownership","description":"Restrict to these ownerships. Default: both. `mixed` is rejected."},"host":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Host","description":"Restrict to these resource hosts (exact match on the host that should have served the file). Narrows the totals too, unlike `ownership`."},"exclude_hosts":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Exclude Hosts","description":"Drop these resource hosts (e.g. a tracker every ad blocker kills). Host is the dimension that decides this list, so without it the top rows are whatever the blockers hit most and the site's own broken files sit below them. Narrows the totals too, so the numbers agree with the rows."},"limit":{"type":"integer","maximum":100.0,"minimum":1.0,"title":"Limit","description":"Max rows to return","default":20}},"additionalProperties":false,"type":"object","required":["time_range"],"title":"FailedResourcesRequest","description":"Request for the failed-resources breakdown."},"FailedResourcesResponse":{"properties":{"meta":{"$ref":"#/components/schemas/AnalyticsMeta","description":"Facts about the result"},"request":{"$ref":"#/components/schemas/AnalyticsRequestEcho","description":"The request as the server resolved it"},"data":{"items":{"$ref":"#/components/schemas/FailedResourceItem"},"type":"array","title":"Data","description":"Failing resources, most frequent first. A top-N, so the rows do not sum to the totals below. Narrowed by the request's `ownership`, if it set one."},"failed_count":{"type":"integer","title":"Failed Count","description":"Every failed load in the time range and filter scope, both halves included. Deliberately NOT narrowed by the request's `ownership`: the point of the number is that the reader sees how the two compare."},"failed_by_ownership":{"additionalProperties":{"type":"integer"},"type":"object","title":"Failed By Ownership","description":"Failed loads per ownership (first_party / third_party), over the same unnarrowed scope as `failed_count`."}},"type":"object","required":["meta","request","data","failed_count","failed_by_ownership"],"title":"FailedResourcesResponse","description":"Response for the failed-resources breakdown.\n\nDeliberately NOT part of the error rate: a failed resource load is\ndominated by the visitor's ad blocker, which is not a defect of the site.\nThe `first_party` half is the one a site operator can act on."},"Feature":{"type":"string","enum":["checkout","nel","csp","uptime","synthetic","ai","watchdog","weekly_overview","mcp","history"],"title":"Feature","description":"A product feature that partner coverage, grants and plans switch.\n\nOnly what one switch locks completely, its API, its jobs and its collection,\nis in the catalog. Core RUM is never a feature. `history` is the retention\nhorizon, 395 days with it and 90 without."},"FeatureStatus":{"type":"string","enum":["covered","granted","included","locked"],"title":"FeatureStatus","description":"What makes a feature available to an organization, or `locked`."},"FetchXhrDetailRequest":{"properties":{"time_range":{"$ref":"#/components/schemas/TimeRange","description":"Time range for the query"},"filters":{"$ref":"#/components/schemas/Filters","description":"Optional filters"},"timezone":{"anyOf":[{"type":"string","maxLength":64},{"type":"null"}],"title":"Timezone","description":"IANA time zone the local hours of `filters.hour_of_day` are read in, such as `Europe/Berlin`. The filter requires it. This route buckets nothing, so the zone changes nothing else"},"sparse_buckets":{"anyOf":[{"$ref":"#/components/schemas/SparseBuckets"},{"type":"null"}],"description":"The sparse threshold of the page, the number `POST /analytics/sparse-hours` derives. With `exclude` the rows of the thin hours are left out. Without it the route only echoes the number in `meta.sparse_buckets`"},"host":{"type":"string","maxLength":1024,"title":"Host","description":"Target host ('' = same-origin) - the drill-down key"},"method":{"anyOf":[{"type":"string","maxLength":1024},{"type":"null"}],"title":"Method","description":"Optional HTTP-method refinement"},"path":{"anyOf":[{"type":"string","maxLength":8192},{"type":"null"}],"title":"Path","description":"Optional path refinement (one endpoint)"},"limit":{"type":"integer","maximum":100.0,"minimum":1.0,"title":"Limit","description":"Max rows per block (pages/endpoints/outliers)","default":20},"order_by":{"$ref":"#/components/schemas/FetchXhrPagesOrderBy","description":"Sort for the `pages` block, a {field, direction} object (§11)."},"outliers":{"type":"string","enum":["slowest","failed"],"title":"Outliers","description":"Trace sample: 'slowest' (default) or 'failed' (only status >= 400)","default":"slowest"}},"additionalProperties":false,"type":"object","required":["time_range","host"],"title":"FetchXhrDetailRequest","description":"Drill-down keyed by `host` (the fetch_xhr analogue of the error-fingerprint\ndetail). `method`/`path` are optional refinements: omit them for a HOST-level\nview (all endpoints of that host), give `path` to scope to one endpoint.\nAnswers \"where do this host's calls run, and which fail (status + page)?\"."},"FetchXhrDetailResponse":{"properties":{"meta":{"$ref":"#/components/schemas/AnalyticsMeta","description":"Facts about the result"},"request":{"$ref":"#/components/schemas/AnalyticsRequestEcho","description":"The request as the server resolved it"},"host":{"type":"string","title":"Host","description":"Echoed host"},"method":{"title":"Method","description":"Echoed method refinement (None = all)","type":"string"},"path":{"title":"Path","description":"Echoed path refinement (None = all)","type":"string"},"calls":{"type":"integer","title":"Calls","description":"Total calls in scope"},"error_count":{"type":"integer","title":"Error Count","description":"Total errored calls in scope"},"error_rate":{"type":"number","title":"Error Rate","description":"error_count / calls"},"avg_ms":{"type":"number","title":"Avg Ms","description":"sum_ms / calls"},"max_ms":{"type":"integer","title":"Max Ms","description":"Slowest single call in scope"},"impact_ms":{"type":"integer","title":"Impact Ms","description":"sum_ms - total wall time in scope"},"endpoints":{"items":{"$ref":"#/components/schemas/FetchXhrEndpointItem"},"type":"array","title":"Endpoints","description":"Per (method, path) within the host, by impact"},"pages":{"items":{"$ref":"#/components/schemas/FetchXhrPageItem"},"type":"array","title":"Pages","description":"Per page (url) in scope, by impact"},"outliers":{"items":{"$ref":"#/components/schemas/FetchXhrOutlierItem"},"type":"array","title":"Outliers","description":"Individual trace calls (slow/failed) in scope - status + page"}},"type":"object","required":["meta","request","host","calls","error_count","error_rate","avg_ms","max_ms","impact_ms","endpoints","pages","outliers"],"title":"FetchXhrDetailResponse","description":"Host (or endpoint) drill-down: overall stats + per-endpoint, per-page and\nthe individual trace calls (slow/failed, with status + page)."},"FetchXhrEndpointItem":{"properties":{"method":{"type":"string","title":"Method","description":"HTTP method (GET/POST/... or 'other')"},"host":{"type":"string","title":"Host","description":"Target host ('' = same-origin as the page)"},"path":{"type":"string","title":"Path","description":"Templated path (/api/users/:id)"},"calls":{"type":"integer","title":"Calls","description":"Calls to this endpoint"},"avg_ms":{"type":"number","title":"Avg Ms","description":"sum_ms / calls"},"max_ms":{"type":"integer","title":"Max Ms","description":"Slowest single call to this endpoint"},"error_count":{"type":"integer","title":"Error Count","description":"Errored calls"},"error_rate":{"type":"number","title":"Error Rate","description":"error_count / calls"},"impact_ms":{"type":"integer","title":"Impact Ms","description":"Σ per-call duration (sum_ms) - frequency × latency, the impact sort key. NOT wall-clock: fetch/XHR run concurrently, so this overcounts vs elapsed time."},"errors_by_status_code":{"additionalProperties":{"type":"integer"},"type":"object","title":"Errors By Status Code","description":"Error-status distribution over ALL calls: HTTP code → count (0 = network failure). Complete, unlike the outlier trace sample."},"p75_ms":{"title":"P75 Ms","description":"Approx p75 latency from the histogram","type":"integer"},"p95_ms":{"title":"P95 Ms","description":"Approx p95 latency from the histogram","type":"integer"},"avg_offset_ms":{"title":"Avg Offset Ms","description":"Mean start offset from the beginning of the pageview (sum_offset_ms/calls), the bar position in the aggregated waterfall. Absent when it was not recorded.","type":"integer"},"sync_calls":{"type":"integer","title":"Sync Calls","description":"Synchronous XHR (main-thread-blocking) calls","default":0},"aborts":{"type":"integer","title":"Aborts","description":"Aborted calls (user/navigation cancellation)","default":0},"blocked":{"type":"integer","title":"Blocked","description":"Status-0 calls to known ad/analytics/tracker hosts, classified server-side as ad-blocked (not real failures) and excluded from `errors`.","default":0},"avg_bytes":{"title":"Avg Bytes","description":"sum_bytes / calls, averaged over ALL calls (cache hits and cross-origin-masked calls count as 0 bytes, so this under-reports for cache-heavy endpoints); absent only when every call reported 0 bytes.","type":"integer"},"max_bytes":{"title":"Max Bytes","description":"Largest single response (bytes); absent when masked","type":"integer"}},"type":"object","required":["method","host","path","calls","avg_ms","max_ms","error_count","error_rate","impact_ms","errors_by_status_code","sync_calls","aborts","blocked"],"title":"FetchXhrEndpointItem","description":"One endpoint template, aggregated over all pageviews (the `other` rollup\nbucket is excluded - it's only reflected in totals)."},"FetchXhrOutlierItem":{"properties":{"method":{"type":"string","title":"Method","description":"HTTP method"},"host":{"type":"string","title":"Host","description":"Target host ('' = same-origin)"},"path":{"type":"string","title":"Path","description":"Templated path"},"duration_ms":{"type":"integer","title":"Duration Ms","description":"Call duration (ms)"},"status_code":{"type":"integer","title":"Status Code","description":"HTTP status (0 = network error / unknown)"},"ttfb_ms":{"title":"Ttfb Ms","description":"TTFB (ms); absent = cross-origin masked","type":"integer"},"page_url":{"title":"Page Url","description":"Page URL the call ran on (the beacon's `url`)","type":"string"},"server_timing_phases":{"additionalProperties":{"type":"number"},"type":"object","title":"Server Timing Phases","description":"The call's own backend phases (name → ms) from Server-Timing - the mini-waterfall; same-origin/TAO only (empty cross-origin)."}},"type":"object","required":["method","host","path","duration_ms","status_code","server_timing_phases"],"title":"FetchXhrOutlierItem","description":"One slow individual call (>500 ms) for debug context."},"FetchXhrPageItem":{"properties":{"url":{"type":"string","title":"Url","description":"Page URL"},"calls":{"type":"integer","title":"Calls","description":"Calls to the endpoint from this page"},"avg_ms":{"type":"number","title":"Avg Ms","description":"sum_ms / calls"},"max_ms":{"type":"integer","title":"Max Ms","description":"Slowest single call from this page"},"error_count":{"type":"integer","title":"Error Count","description":"Errored calls"},"error_rate":{"type":"number","title":"Error Rate","description":"error_count / calls"},"impact_ms":{"type":"integer","title":"Impact Ms","description":"sum_ms - total wall time, the impact sort key"},"errors_by_status_code":{"additionalProperties":{"type":"integer"},"type":"object","title":"Errors By Status Code","description":"Error-status distribution on this page: HTTP code → count (0 = network)."}},"type":"object","required":["url","calls","avg_ms","max_ms","error_count","error_rate","impact_ms","errors_by_status_code"],"title":"FetchXhrPageItem","description":"One page an endpoint runs on, aggregated over all pageviews of that page."},"FetchXhrPagesOrderBy":{"properties":{"field":{"$ref":"#/components/schemas/FetchXhrPagesSort","description":"Which of the four derived sort keys","default":"impact"},"direction":{"$ref":"#/components/schemas/SortDirection","description":"Sort direction","default":"desc"}},"additionalProperties":false,"type":"object","title":"FetchXhrPagesOrderBy","description":"Sort configuration for the `pages` block of the fetch/XHR drill-down."},"FetchXhrPagesSort":{"type":"string","enum":["impact","errors","error_rate","calls"],"title":"FetchXhrPagesSort","description":"What the `pages` block of the fetch/XHR drill-down sorts by."},"FetchXhrRequest":{"properties":{"time_range":{"$ref":"#/components/schemas/TimeRange","description":"Time range for the query"},"filters":{"$ref":"#/components/schemas/Filters","description":"Optional filters"},"timezone":{"anyOf":[{"type":"string","maxLength":64},{"type":"null"}],"title":"Timezone","description":"IANA time zone the local hours of `filters.hour_of_day` are read in, such as `Europe/Berlin`. The filter requires it. This route buckets nothing, so the zone changes nothing else"},"sparse_buckets":{"anyOf":[{"$ref":"#/components/schemas/SparseBuckets"},{"type":"null"}],"description":"The sparse threshold of the page, the number `POST /analytics/sparse-hours` derives. With `exclude` the rows of the thin hours are left out. Without it the route only echoes the number in `meta.sparse_buckets`"},"limit":{"type":"integer","maximum":100.0,"minimum":1.0,"title":"Limit","description":"Max endpoints (endpoints block)","default":20},"outlier_limit":{"type":"integer","maximum":100.0,"minimum":1.0,"title":"Outlier Limit","description":"Max outliers","default":20}},"additionalProperties":false,"type":"object","required":["time_range"],"title":"FetchXhrRequest","description":"Request for the fetch_xhr (fetch/XHR) dashboard panel."},"FetchXhrResponse":{"properties":{"meta":{"$ref":"#/components/schemas/AnalyticsMeta","description":"Facts about the result"},"request":{"$ref":"#/components/schemas/AnalyticsRequestEcho","description":"The request as the server resolved it"},"totals":{"$ref":"#/components/schemas/FetchXhrTotals","description":"Aggregate counters"},"endpoints":{"items":{"$ref":"#/components/schemas/FetchXhrEndpointItem"},"type":"array","title":"Endpoints","description":"Per-endpoint aggregates"},"outliers":{"items":{"$ref":"#/components/schemas/FetchXhrOutlierItem"},"type":"array","title":"Outliers","description":"Slowest individual calls"}},"type":"object","required":["meta","request","totals","endpoints","outliers"],"title":"FetchXhrResponse","description":"Response for the fetch_xhr dashboard panel: three blocks."},"FetchXhrTotals":{"properties":{"calls":{"type":"integer","title":"Calls","description":"Total fetch_xhr calls"},"error_count":{"type":"integer","title":"Error Count","description":"All fetch_xhr errors (status >= 400 or 0), both halves. Kept unchanged so nothing reading it shifts meaning."},"first_party_errors":{"type":"integer","title":"First Party Errors","description":"Errors on the site's own hosts, same-origin or a subdomain of the same registrable domain. The actionable half. Rows written before migration 073 have no split and count their whole error total here, the meaning they were collected under.","default":0},"third_party_errors":{"type":"integer","title":"Third Party Errors","description":"Errors on foreign hosts. Dominated by ad blockers and tracking protection, so not a defect of the site. 0 on rows written before migration 073.","default":0},"error_rate":{"type":"number","title":"Error Rate","description":"first_party_errors / calls (0 when no calls). Deliberately NOT the all-origin errors: a blocked tracker would otherwise read as the site failing."},"worst_ms":{"title":"Worst Ms","description":"Slowest single observed call (ms)","type":"integer"}},"type":"object","required":["calls","error_count","error_rate","first_party_errors","third_party_errors"],"title":"FetchXhrTotals","description":"Aggregate fetch_xhr counters across the queried scope.\n\nSplit by ownership since migration 073. A failure on a foreign host is not\nthe customer's bug in either direction: they cannot fix a vendor's outage\nand they cannot unblock a visitor's ad blocker. So `error_rate` counts the\nfirst-party half only, and the third-party half is reported beside it\nrather than folded in."},"FieldPoint":{"properties":{"timestamp":{"type":"string","format":"date-time","title":"Timestamp","examples":["2026-04-14T09:50:01Z"],"description":"ISO 8601 in UTC with a `Z` suffix."},"sample_count":{"type":"integer","title":"Sample Count"},"lcp":{"title":"Lcp","type":"number"},"fcp":{"title":"Fcp","type":"number"},"cls":{"title":"Cls","type":"number"},"inp":{"title":"Inp","type":"number"},"ttfb":{"title":"Ttfb","type":"number"}},"type":"object","required":["timestamp","sample_count"],"title":"FieldPoint","description":"One RUM bucket (regular). p75 per metric (ms; cls unitless)."},"Filters":{"properties":{"site_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Site Id","description":"Filter by specific site","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"site_ids":{"anyOf":[{"items":{"type":"string","format":"uuid","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"type":"array","minItems":1},{"type":"null"}],"title":"Site Ids","description":"Filter by multiple sites (OR). Must be non-empty when present - an empty list is rejected with 422. Ignored when `site_id` is also set (precedence: site_id > site_ids > application_id > tags)."},"application_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Application Id","description":"Filter to every domain (site) of one application - the aggregated per-application scope. Resolved to the app's site_ids. Ignored when a higher-precedence site filter is set (precedence: site_id > site_ids > application_id > tags).","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"tags":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Tags","description":"Filter by site tags (AND semantics)"},"browser":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Browser","description":"Filter by browsers"},"device_type":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Device Type","description":"Filter by device types"},"os":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Os","description":"Filter by OS"},"country":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Country","description":"Filter by countries (ISO codes)"},"connection_type":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Connection Type","description":"Filter by connection types"},"url":{"anyOf":[{"type":"string","maxLength":8192},{"type":"null"}],"title":"Url","description":"Filter by URL (supports * wildcards). Every pageview has one, so `\"\"` matches none."},"url_path":{"anyOf":[{"type":"string","maxLength":8192},{"type":"null"}],"title":"Url Path","description":"Filter by the URL without its query string, matched like `url`: `*` is a wildcard and a value starting with `/` is compared with the path"},"url_key":{"anyOf":[{"type":"string","maxLength":1024},{"type":"null"}],"title":"Url Key","description":"Keep the page views whose URL query carries this key, compared exactly"},"url_key_set":{"anyOf":[{"type":"string","maxLength":8192},{"type":"null"}],"title":"Url Key Set","description":"Keep the page views whose URL query carries exactly these keys, joined by `&` in the order the `url_key_set` dimension answers them. An empty string keeps the page views without a query"},"domain":{"anyOf":[{"type":"string","maxLength":1024},{"type":"null"}],"title":"Domain","description":"Filter by domain. Every pageview carries the domain of its site, so `\"\"` matches none."},"referrer_source":{"anyOf":[{"type":"string","maxLength":1024},{"type":"null"}],"title":"Referrer Source","description":"Filter by referrer source bucket (e.g. Google, Direct). `\"\"` selects the pageviews without a known source: direct visits, navigation within the site and referrers the catalog does not know. `exclude: {referrer_source: [\"\"]}` keeps the others."},"referrer_medium":{"anyOf":[{"type":"string","maxLength":1024},{"type":"null"}],"title":"Referrer Medium","description":"Filter by Snowplow referer-parser medium (search/social/email/paid/internal/unknown). `\"\"` selects the direct visits, the pageviews without a referrer. `exclude: {referrer_medium: [\"\"]}` keeps the others."},"utm_source":{"anyOf":[{"type":"string","maxLength":1024},{"type":"null"}],"title":"Utm Source","description":"Filter by UTM source bucket (marketer-set, e.g. google, newsletter). `\"\"` selects the pageviews whose URL carried none. `exclude: {utm_source: [\"\"]}` keeps the others."},"utm_medium":{"anyOf":[{"type":"string","maxLength":1024},{"type":"null"}],"title":"Utm Medium","description":"Filter by UTM medium (marketer-set, e.g. cpc, email, social). `\"\"` selects the pageviews whose URL carried none. `exclude: {utm_medium: [\"\"]}` keeps the others."},"utm_campaign":{"anyOf":[{"type":"string","maxLength":1024},{"type":"null"}],"title":"Utm Campaign","description":"Filter by UTM campaign identifier. `\"\"` selects the pageviews whose URL carried none. `exclude: {utm_campaign: [\"\"]}` keeps the others."},"utm_term":{"anyOf":[{"type":"string","maxLength":1024},{"type":"null"}],"title":"Utm Term","description":"Filter by UTM term (PPC keyword). High cardinality: useful for scoping a query, less so as a group-by dimension. `\"\"` selects the pageviews whose URL carried none. `exclude: {utm_term: [\"\"]}` keeps the others."},"utm_content":{"anyOf":[{"type":"string","maxLength":1024},{"type":"null"}],"title":"Utm Content","description":"Filter by UTM content (A/B variant / ad creative ID). High cardinality: useful for A/B comparisons, less so as a group-by dimension. `\"\"` selects the pageviews whose URL carried none. `exclude: {utm_content: [\"\"]}` keeps the others."},"click_id_param":{"anyOf":[{"type":"string","maxLength":1024},{"type":"null"}],"title":"Click Id Param","description":"Filter by ad-platform or affiliate click-ID label (gclid/fbclid/msclkid/.../awc/cjevent/tduid). `\"\"` selects the pageviews whose URL carried no click ID. `exclude: {click_id_param: [\"\"]}` keeps the others."},"nav_type":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Nav Type","description":"Filter by navigation type (navigate/reload/back_forward/prerender/softnav)"},"protocol":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Protocol","description":"Filter by protocol (h2/h3/http1.1)"},"viewport_class":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Viewport Class","description":"Filter by viewport class (mobile/tablet/desktop/large)"},"dominant_third_party_category":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Dominant Third Party Category","description":"Filter by dominant third-party category (analytics/ads/tag-manager/...)"},"error_origin":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Error Origin","description":"Filter by error origin. Stored values: 'first' (the pageview carried an error on one of your own hosts), 'third' (it carried errors and every host seen was foreign), '' (no errors, or none whose origin could be determined - a frameless error such as a masked `Script error.` lands here)."},"cdn_cache_status":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Cdn Cache Status","description":"Filter by CDN cache status (HIT/MISS/EXPIRED/...). The empty string '' is a valid value and matches pageviews that reported no CDN cache status at all."},"origin_cache_status":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Origin Cache Status","description":"Filter by origin/FPC cache status (HIT/MISS/...). The empty string '' is a valid value and matches pageviews that reported no origin cache status at all."},"page_type":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Page Type","description":"Filter by page type (product/category/cart/...)"},"origin_host":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Origin Host","description":"Filter by the origin node that served the pageview (from the `fm-host` Server-Timing key). The empty string '' is a valid value and matches pageviews that reported no host at all."},"logged_in":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Logged In","description":"Filter by authenticated-render state (from the `fm-loggedin` Server-Timing key): 'yes' / 'no', or '' for pageviews that reported nothing. Use it to separate the personalized traffic that bypasses the full-page cache from the cacheable anonymous traffic."},"checkout_stage":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Checkout Stage","description":"Filter by checkout-funnel stage of the pageview itself (cart/checkout/success). The empty string '' is a valid value and matches every pageview outside the funnel. Requires checkout_tracking on the application; deliberately NOT a slicing dimension, so a query filtering on it reads the pageview source rather than an aggregate tier."},"datacenter":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Datacenter","description":"Filter by datacenter/crawler network label (aws/hetzner/googlebot/...). The empty string '' is a valid value and matches normal (non-datacenter) traffic - e.g. exclude={'datacenter': ['']} keeps ONLY datacenter traffic, while datacenter=[''] keeps only residential traffic."},"bot_name":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Bot Name","description":"Filter by detected bot slug (googlebot/gptbot/...; the reserved 'unknown' = generic bot heuristics matched without a named entry). The empty string '' matches traffic with no bot signal - bot_name=[''] is the 'humans only' filter."},"bot_type":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Bot Type","description":"Filter by bot category tag (ai-crawler/search-engine/seo/monitoring/...). '' matches traffic with no bot signal."},"ua_anomaly":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Ua Anomaly","description":"Filter by client signal (headless/spoofed/non-browser/hyperactive/unnamed from the edge, webdriver/automation from the tracker). '' matches unremarkable traffic."},"asn":{"anyOf":[{"items":{"type":"integer","maximum":4294967295.0,"minimum":0.0},"type":"array"},{"type":"null"}],"title":"Asn","description":"Filter by the visitor's network, autonomous system numbers. 0 matches the traffic whose network is unknown."},"bot_class":{"anyOf":[{"items":{"$ref":"#/components/schemas/BotClass"},"type":"array"},{"type":"null"}],"title":"Bot Class","description":"Derived traffic verdict filter - a three-way PARTITION (values always sum to all traffic): 'bot' = declared/verified bots (bot UA, published crawler IP range or navigator.webdriver), 'suspect' = indications without declaration (UA/client-hints contradiction or hosting-datacenter IP), 'none' = no signal (humans). ['none'] is the 'real visitors' filter; multiple values are ORed."},"is_bot":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Bot","description":"Derived boolean filter: true = only detected bots (any bot_name incl. 'unknown'), false = humans only (no bot signal). Shorthand for bot_name != '' / = ''."},"is_datacenter":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Datacenter","description":"Derived boolean filter: true = only traffic from known hosting/crawler networks, false = residential networks only. Shorthand for datacenter != '' / = ''."},"pvid":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Pvid","description":"Filter by pageview ID(s) - e.g. to share / deep-link a specific beacon (all beacons of that pageview). Exact match (IN)."},"stitch":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Stitch","description":"Filter by stitch visitor ID(s) - the 32-hex edge-computed identity (`lower(hex(stitch))` as surfaced by /analytics/beacons). Exact match (IN). Values that aren't 32 lowercase-hex chars are dropped; an all-invalid filter matches nothing."},"tracker_version":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Tracker Version","description":"Filter by tracker bundle version (e.g. rollout debugging)"},"error_fingerprint":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Error Fingerprint","description":"Filter by error signature(s) - the `fingerprint` key returned by /analytics/error-types and /analytics/failed-resources. Narrows the traffic to the pageviews that carried one of these signatures, so any panel can be read over 'the pages where this breaks': LCP, browsers, countries, funnel. Say which population the key came from with `error_fingerprint_kind`. Reads the `errors` Nested column, which no rollup carries, so a query using it always reads source `beacons` and costs accordingly. Rejected by the endpoints that group BY fingerprint themselves (/analytics/error-types, /analytics/failed-resources and their /detail routes) - those name the signature in their own field."},"error_fingerprint_kind":{"anyOf":[{"$ref":"#/components/schemas/ErrorFingerprintKind"},{"type":"null"}],"description":"Which population `error_fingerprint` belongs to; unset means `error`, as on /analytics/beacons. Both halves of the `errors` column carry fingerprints out of one key space, so a resource signature scoped as an error matches nothing at all. Nullable rather than defaulted because it is a modifier of the field above: a default would put it in every `applied_filters` echo of every query that filters on nothing of the sort."},"error_type":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Error Type","description":"Filter Network Error Logging reports by the type the browser reported, as `errors_by_error_type` returns it: `http.error`, `abandoned`, `tcp.timed_out`, ... Exact match (IN). Nothing is left out by default, so `abandoned`, a visitor leaving while a request loads, counts unless `exclude` drops it. Only /analytics/nel has the column, every other route answers 422. A value the collector could never store is a 422."},"nel_class":{"anyOf":[{"items":{"$ref":"#/components/schemas/NelClass"},"type":"array"},{"type":"null"}],"title":"Nel Class","description":"Filter Network Error Logging reports by their class, derived from `error_type` as the report field `nel_class` is. Multiple values are ORed. Nothing is left out by default, so every class counts unless `exclude` drops it. Applies together with `error_type`, and a pair that excludes each other matches nothing. Only /analytics/nel has it, every other route answers 422."},"status_code_range":{"anyOf":[{"$ref":"#/components/schemas/StatusCodeRange"},{"type":"null"}],"description":"Filter Network Error Logging reports by the HTTP status code of the failed request, as `errors_by_status_code` returns it: {gte: 500, lte: 599} keeps the server errors. A report without an HTTP response has status 0 and is outside every range. On /analytics/csp it is the status of the page that broke the policy, 0 where the browser sent none. Only /analytics/nel and /analytics/csp have the column, every other route answers 422. The pageview's own document status is `metric_ranges: [{metric: 'status_code', ...}]` instead."},"path":{"anyOf":[{"type":"string","maxLength":8192},{"type":"null"}],"title":"Path","description":"Filter Network Error Logging reports by the path of the failed request, without host and query, as `paths` lists it. `*` is a wildcard, so `/media/*` keeps everything under /media, and without one the match is exact. `exclude: {path: [...]}` takes the same patterns. Only /analytics/nel has the column, every other route answers 422. `\"\"` selects the reports of a request URL without a path. `exclude: {path: [\"\"]}` keeps the others."},"host":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Host","description":"Filter Network Error Logging reports by the host of the failed request, as `paths` lists it: `www.shop.example` and `shop.example` are two hosts of one site. Exact match (IN), case-insensitive, no wildcard. With `path` it selects one entry of `paths`. `exclude: {host: [...]}` drops hosts. Only /analytics/nel has the column, every other route answers 422."},"browser_version":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Browser Version","description":"Filter Network Error Logging and Content Security Policy reports by the browser's major version, as the edge reports it: `140`. Exact match (IN). Chrome and Edge share version numbers, so pair it with `browser`. Reports stored before the column existed hold '' and match only ''. `exclude: {browser_version: [...]}` drops versions. Only /analytics/nel and /analytics/csp take it, every other route answers 422. The pageview routes read the version as `metric_ranges: [{metric: 'browser_version', ...}]` instead."},"server_ip":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Server Ip","description":"Filter Network Error Logging reports by the address of the shop's server the failed request went to: `203.0.113.7` or `2001:db8::1`. Exact match (IN) on the address, so `2001:DB8::0:1` selects the same reports. A value that is no IP address is a 422. '' selects the reports without a stored address: the browser sent none, it was not a public address, or the report is older than the column. `exclude: {server_ip: [...]}` drops addresses. Only /analytics/nel takes it, every other route answers 422."},"page_url":{"anyOf":[{"type":"string","maxLength":8192},{"type":"null"}],"title":"Page Url","description":"Filter Network Error Logging reports by the page the failed request was made from, matched like `url`: a value starting with `/` is compared with the page's path and query, anything else with the whole URL, and `*` is a wildcard. `exclude: {page_url: [...]}` takes the same patterns. It is the browser's referrer, so for a failed navigation it is the page the visitor came from, and empty after a direct visit. It is also empty whenever the referrer was on another host. A pattern never matches an empty page, and an empty page always survives a pattern in `exclude`. On /analytics/csp it is the page that broke the policy, as the report names it. Only /analytics/nel and /analytics/csp have the column, every other route answers 422. `\"\"` selects the reports without a page. `exclude: {page_url: [\"\"]}` keeps the others."},"report_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Report Id","description":"Select one NEL or CSP report by its `id`, the field of a row of /analytics/nel/reports or /analytics/csp/reports, for a link to a single report. Exact match on the UUID. An id that matches no report of the scope answers empty, not 404. Only the /analytics/nel and /analytics/csp routes take it, every other route answers 422.","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"disposition":{"anyOf":[{"items":{"$ref":"#/components/schemas/CspDisposition"},"type":"array"},{"type":"null"}],"title":"Disposition","description":"Filter Content Security Policy reports by what the policy did: `enforce` keeps the violations the browser blocked, `report` the ones a report-only policy merely reported. Multiple values are ORed. A report whose browser did not say matches neither. `exclude: {disposition: [...]}` drops values. Only /analytics/csp takes it, every other route answers 422."},"effective_directive":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Effective Directive","description":"Filter Content Security Policy reports by the directive the violation broke, as `reports_by_effective_directive` returns it: `script-src-elem`, `img-src`, `connect-src`, ... Exact match (IN), lowercased. A value the collector could never store is a 422. `exclude: {effective_directive: [...]}` drops directives. Only /analytics/csp takes it, every other route answers 422."},"blocked_url":{"anyOf":[{"type":"string","maxLength":8192},{"type":"null"}],"title":"Blocked Url","description":"Filter Content Security Policy reports by what the policy blocked, matched like `url`: a value starting with `/` is compared with the path, anything else with the whole stored value, and `*` is a wildcard. The stored value is a URL without its query, or a keyword such as `inline`, `eval` or `data`. `exclude: {blocked_url: [...]}` takes the same patterns. Only /analytics/csp takes it, every other route answers 422. `\"\"` selects the reports that named nothing blocked. `exclude: {blocked_url: [\"\"]}` keeps the others."},"source_url":{"anyOf":[{"type":"string","maxLength":8192},{"type":"null"}],"title":"Source Url","description":"Filter Content Security Policy reports by the script that broke the policy, matched like `blocked_url`. A pattern never matches a report without one, which always survives a pattern in `exclude: {source_url: [...]}`. Only /analytics/csp takes it, every other route answers 422. `\"\"` selects the reports without a script. `exclude: {source_url: [\"\"]}` keeps the others."},"hour_of_day":{"anyOf":[{"$ref":"#/components/schemas/HourOfDayRange"},{"type":"null"}],"description":"Keep the rows of these local hours, both inclusive: `{from: 6, to: 23}`. A page view counts by its start, an event or a report by its own time. A `from` above `to` wraps across midnight, so `{from: 22, to: 6}` keeps the night. The hours are read in the request's `timezone`, which it requires. In a zone whose offset is not whole hours a row counts by the local hour its UTC hour ends in, as the buckets do. The comparison window keeps the same hours. A route that does not take it answers 422."},"metric_ranges":{"anyOf":[{"items":{"$ref":"#/components/schemas/MetricRange"},"type":"array"},{"type":"null"}],"title":"Metric Ranges","description":"Numeric threshold filters (gte/lte) on beacon metrics - e.g. {metric:'lcp', gte:2500} for slow-LCP pageviews, or {metric:'error_count', gte:1} for pageviews with errors. Also carries the browser MAJOR version: {metric:'browser_version', gte:150} = 'browser >= 150' (pair with a `browser` family filter for 'Chrome >= 150'). Multiple are ANDed."},"exclude":{"anyOf":[{"additionalProperties":{"items":{"type":"string"},"type":"array"},"propertyNames":{"$ref":"#/components/schemas/ExcludeColumn"},"type":"object"},{"type":"null"}],"title":"Exclude","description":"Negative filters: column → values to EXCLUDE (NOT IN). Keys are the allowlisted categorical columns (see the ExcludeColumn enum in the schema). e.g. {'country': ['DE','NL']} drops DE+NL; multiple columns are ANDed. Complements the positive (IN) filters above. `path`, `page_url`, `blocked_url` and `source_url` take `*` patterns like their filters and drop every row one pattern matches.","examples":[{"country":["DE","NL"]}]}},"additionalProperties":false,"type":"object","title":"Filters","description":"Query filters for narrowing down results."},"FunnelBucket":{"properties":{"timestamp":{"type":"string","format":"date-time","title":"Timestamp","examples":["2026-04-14T09:50:01Z"],"description":"ISO 8601 in UTC with a `Z` suffix."},"visitors":{"title":"Visitors","description":"Visitors ACTIVE in this bucket - anyone with a pageview in it, funnel or not. The denominator of this bucket's conversion_rate. Deliberately not summable to CheckoutFunnelResponse.visitors_total: a visitor active on three days counts in all three buckets and once in the window total. Daily rates in GA4 and Shopify behave the same way. ABSENT when the denominator could not be measured, same as CheckoutFunnelResponse.visitors_total.","type":"integer"},"reached_by_stage":{"additionalProperties":{"type":"integer"},"type":"object","title":"Reached By Stage","description":"Stage -> visitors who entered in this bucket and reached it"},"cart_interactions":{"type":"integer","title":"Cart Interactions","description":"Visitors who entered in this bucket and whose session issued at least one cart interaction (fetch/XHR cart mutation). Reported beside the steps, not as one: its coverage depends on collect_fetch_xhr and the shop system, so it would be a misleading conversion baseline.","default":0},"cart_interaction_rate":{"title":"Cart Interaction Rate","description":"cart_interactions over this bucket's `visitors` - the add-to-cart rate, around 5-6% on a typical shop. Never exceeds 1.0; absent when `visitors` is. The underlying COUNT undercounts where fetch/XHR cart calls are not visible (see cart_interactions) and never overcounts, so read the rate as a floor.","type":"number"},"cart_interaction_kinds":{"additionalProperties":{"type":"integer"},"type":"object","title":"Cart Interaction Kinds","description":"Kind -> visitors of this bucket with >=1 interaction of that kind: add | change | remove | other. The per-bucket twin of CheckoutFunnelResponse.cart_interaction_kinds, including its rule that a kind which did not occur is OMITTED rather than reported as 0."},"cart_interaction_error_visitors":{"type":"integer","title":"Cart Interaction Error Visitors","description":"Visitors of this bucket whose cart calls FAILED at least once (transport error or an HTTP error status, including status 0). Read against cart_interactions in the same object: a jump here precedes the conversion drop it causes.","default":0},"time_to_success_seconds":{"$ref":"#/components/schemas/MetricDistribution","description":"Seconds from funnel entry to the first success, over the visitors of this bucket who reached it. `count` is that sample, so it equals reached['success']. Always present: a bucket nobody bought in reports count 0 and no quantiles, whether or not anyone entered the funnel in it."},"conversion_rate":{"title":"Conversion Rate","description":"Visitors who entered in this bucket and reached the LAST step, over this bucket's `visitors`. Same definition as CheckoutFunnelResponse.conversion_rate, applied to one bucket, so the headline and the trend cannot mean two things. Never exceeds 1.0; 0.0 when the bucket had no visitors, absent when `visitors` is.","type":"number"},"step_conversion_rates":{"additionalProperties":{"type":"number"},"type":"object","title":"Step Conversion Rates","description":"Step name -> share of the PREVIOUS step's visitors that reached it, within this bucket. The per-bucket twin of FunnelStep.step_conversion_rate."}},"type":"object","required":["timestamp","reached_by_stage","cart_interactions","cart_interaction_kinds","cart_interaction_error_visitors","time_to_success_seconds","step_conversion_rates"],"title":"FunnelBucket","description":"One time bucket of the funnel series.\n\nA visitor is counted in the bucket of their funnel ENTRY (their first\npageview at any step), never in the bucket of their success. That makes a\nday finally computable once the day plus the 24h stitch window plus the\nfinalizer lag have passed, instead of shifting as late successes arrive.\n\n`visitors` is the one field that does NOT work that way: it counts everyone\nactive in the bucket, which is why a bucket exists as soon as it had\ntraffic, even with nothing in `reached`. A day when the checkout was broken\nhas to show 0%, not go missing from the trend."},"FunnelStep":{"properties":{"stage":{"$ref":"#/components/schemas/CheckoutStage","description":"Which step of the funnel this row is"},"reached":{"type":"integer","title":"Reached","description":"Visitors who reached this step at least once"},"reach_rate":{"type":"number","title":"Reach Rate","description":"Share of the FIRST step's visitors that reached this step. 1.0 on the first step; 0.0 when the first step has no visitors. Describes the funnel's SHAPE, not its success: the conversion rate is CheckoutFunnelResponse.conversion_rate, which counts against all visitors. Can exceed 1.0: a visitor can enter a later step without the first one being observed (deep link into the checkout, drawer cart with no URL, express checkout), which is real behaviour and not normalized away - render accordingly."},"step_conversion_rate":{"type":"number","title":"Step Conversion Rate","description":"Share of the PREVIOUS step's visitors that reached this step. A ratio, not a bounded fraction: it exceeds 1 whenever a step is reached by visitors the previous one never saw (deep link into the checkout, cart page never loaded), which is real behaviour and not normalized away. A Shopify shop reads above 1 on cart -> checkout routinely: the checkout step comes from a pixel event, and a buyer who went straight to the checkout never loaded a cart URL."}},"type":"object","required":["stage","reached","reach_rate","step_conversion_rate"],"title":"FunnelStep","description":"One step of a funnel over the whole reported window."},"GoalEventStep":{"properties":{"step_type":{"type":"string","const":"event","title":"Step Type","description":"The form, `event`"},"name":{"type":"string","maxLength":64,"title":"Name","description":"The event's name, lowercased first. One the collector would refuse is a 422. It is checked as the collector checks a name, never against a list of known ones"}},"additionalProperties":false,"type":"object","required":["step_type","name"],"title":"GoalEventStep","description":"A visitor with an event of this name."},"GoalFactor":{"properties":{"dimension":{"$ref":"#/components/schemas/GoalFactorDimension","description":"The dimension"},"key":{"type":"string","title":"Key","description":"The value as stored, `''` where the visit carried none. A boolean fact such as `js_error` has the one key `true`."},"category":{"$ref":"#/components/schemas/GoalFactorCategory","description":"The group of the dimension"},"visitors":{"type":"integer","title":"Visitors","description":"Visitors of the base with this key"},"reached":{"type":"integer","title":"Reached","description":"Of them, the visitors who reached the goal"},"conversion_rate":{"type":"number","title":"Conversion Rate","description":"`reached` over `visitors`"},"rest_conversion_rate":{"type":"number","title":"Rest Conversion Rate","description":"The same over every other visitor of the base"},"lift":{"title":"Lift","description":"`conversion_rate` over `rest_conversion_rate`, unbounded, 1.0 for no difference. Absent where either rate is 0.","type":"number"},"share":{"type":"number","title":"Share","description":"`visitors` over the visitors of the base"},"reached_delta":{"type":"number","title":"Reached Delta","description":"`reached` minus what `rest_conversion_rate` predicts for `visitors`: the goal visitors this group has above the rest's rate, negative below it"},"confident_reached_delta":{"type":"number","title":"Confident Reached Delta","description":"The end of the 95 % confidence interval of `reached_delta` nearest to 0, and 0 where the interval holds 0. A small group's chance result stays at 0, so this is the default rank"},"is_significant":{"type":"boolean","title":"Is Significant","description":"Whether the rate differs from the rest's at a false discovery rate of 5 % over every factor of the answer above `min_visitors`"}},"type":"object","required":["dimension","key","category","visitors","reached","conversion_rate","rest_conversion_rate","share","reached_delta","confident_reached_delta","is_significant"],"title":"GoalFactor","description":"One value of one dimension, against every other visitor of the base."},"GoalFactorCategory":{"type":"string","title":"GoalFactorCategory","description":"The group a dimension of the factors route belongs to (section 28).","x-extensible-enum":["origin","device","performance","behaviour","place"]},"GoalFactorDimension":{"type":"string","title":"GoalFactorDimension","description":"One dimension of a visit the factors route compares (section 28).\n\nThe entry dimensions read the visitor's first pageview, the device and\nplace dimensions any pageview, since they do not change within a visit.","x-extensible-enum":["referrer_source","referrer_medium","utm_source","utm_medium","utm_campaign","utm_term","utm_content","click_id_param","entry_page_type","country","device_type","viewport_class","browser","browser_version","os","connection_type","asn","protocol","tracker_version","logged_in","pages_per_visit","pages_outside_checkout","page_type_seen","js_error","cart_error","event_name","entry_lcp_rating","entry_inp_rating","entry_cls_rating","entry_ttfb_rating","entry_fcp_rating","product_lcp_rating","product_inp_rating","product_cls_rating","product_ttfb_rating","product_fcp_rating"]},"GoalFactorDimensionRequest":{"type":"string","enum":["referrer_source","referrer_medium","utm_source","utm_medium","utm_campaign","utm_term","utm_content","click_id_param","entry_page_type","country","device_type","viewport_class","browser","browser_version","os","connection_type","asn","protocol","tracker_version","logged_in","pages_per_visit","pages_outside_checkout","page_type_seen","js_error","cart_error","event_name","entry_lcp_rating","entry_inp_rating","entry_cls_rating","entry_ttfb_rating","entry_fcp_rating","product_lcp_rating","product_inp_rating","product_cls_rating","product_ttfb_rating","product_fcp_rating"],"title":"GoalFactorDimensionRequest","description":"A dimension the factors route can compare (section 28)."},"GoalFactorSort":{"type":"string","enum":["confident_reached_delta","lift","visitors"],"title":"GoalFactorSort","description":"What the factors are ordered by."},"GoalFactorsOrderBy":{"properties":{"field":{"$ref":"#/components/schemas/GoalFactorSort","description":"`confident_reached_delta` orders by the signed value, so descending puts the groups with surely more goal visitors first and those with surely fewer last. `lift` orders by the absolute of its logarithm, so a lift of 0.5 and one of 2.0 weigh the same. A row without a lift sorts last.","default":"confident_reached_delta"},"direction":{"$ref":"#/components/schemas/SortDirection","description":"Sort direction","default":"desc"}},"additionalProperties":false,"type":"object","title":"GoalFactorsOrderBy","description":"The order of the factors, a {field, direction} object (section 11)."},"GoalFactorsRequest":{"properties":{"time_range":{"$ref":"#/components/schemas/TimeRange","description":"The window, at most 31 days. A visitor belongs to it by their first pageview, as in the checkout funnel."},"filters":{"$ref":"#/components/schemas/Filters","description":"Optional filters, with the rules of the checkout funnel"},"identity":{"anyOf":[{"$ref":"#/components/schemas/VisitorIdentity"},{"type":"null"}],"description":"Identifier to group by. The goal is counted from events, which only carry the stitch, so anything resolving to `session` is a 422."},"goal":{"oneOf":[{"$ref":"#/components/schemas/GoalStageStep"},{"$ref":"#/components/schemas/GoalEventStep"}],"title":"Goal","description":"What counts as reaching the goal: an event of a checkout stage or an event by name. Absent is the stage `success`, an order","default":{"step_type":"stage","stage":"success"},"discriminator":{"propertyName":"step_type","mapping":{"event":"#/components/schemas/GoalEventStep","stage":"#/components/schemas/GoalStageStep"}}},"base":{"anyOf":[{"oneOf":[{"$ref":"#/components/schemas/GoalStageStep"},{"$ref":"#/components/schemas/GoalEventStep"}],"discriminator":{"propertyName":"step_type","mapping":{"event":"#/components/schemas/GoalEventStep","stage":"#/components/schemas/GoalStageStep"}}},{"type":"null"}],"title":"Base","description":"Compare only the visitors who did this, in the same forms as `goal`. Absent compares every visitor. Equal to `goal` is a 422"},"dimensions":{"anyOf":[{"items":{"$ref":"#/components/schemas/GoalFactorDimensionRequest"},"type":"array","minItems":1},{"type":"null"}],"title":"Dimensions","description":"The dimensions to compare. Absent compares every one the backend offers."},"min_visitors":{"anyOf":[{"type":"integer","minimum":1.0},{"type":"null"}],"title":"Min Visitors","description":"The fewest visitors a factor and the rest of the base must each have. Absent lets the backend decide from the traffic, and the response echoes the value used."},"limit":{"type":"integer","maximum":500.0,"minimum":1.0,"title":"Limit","description":"Max factors returned","default":50},"order_by":{"$ref":"#/components/schemas/GoalFactorsOrderBy","description":"Sort order, a {field, direction} object (section 11)"}},"additionalProperties":false,"type":"object","required":["time_range"],"title":"GoalFactorsRequest","description":"Which visitors to compare and how to order the answer."},"GoalFactorsResponse":{"properties":{"meta":{"$ref":"#/components/schemas/AnalyticsMeta","description":"Facts about the result"},"request":{"$ref":"#/components/schemas/AnalyticsRequestEcho","description":"The request as the server resolved it"},"goal":{"$ref":"#/components/schemas/ResolvedGoalStep","description":"The goal applied, `success` where the request named none"},"base":{"description":"The base applied. Absent where every visitor is compared","$ref":"#/components/schemas/ResolvedGoalStep"},"factors":{"items":{"$ref":"#/components/schemas/GoalFactor"},"type":"array","title":"Factors","description":"The factors above the minimum, ordered, at most `limit`. No step is one. `meta.total` and `meta.limit` describe this list only"},"steps":{"items":{"$ref":"#/components/schemas/GoalStep"},"type":"array","title":"Steps","description":"The steps on the way to the goal, by `visitors` descending, which is the funnel's shape. Not cut by `min_visitors` or `limit`: a step is a page type or one of the at most 100 event names a visitor carries"},"step_source":{"description":"Where `steps` come from. Absent where too few goal visitors were sampled to derive steps and the goal is not `success`, so `steps` is empty","$ref":"#/components/schemas/GoalStepSource"},"visitors":{"type":"integer","title":"Visitors","description":"Visitors of the base"},"reached":{"type":"integer","title":"Reached","description":"Of them, the visitors who reached the goal"},"conversion_rate":{"type":"number","title":"Conversion Rate","description":"`reached` over `visitors`, 0.0 without visitors"},"min_visitors":{"type":"integer","title":"Min Visitors","description":"The minimum applied, the request's or the backend's"},"skipped_count":{"type":"integer","title":"Skipped Count","description":"Factors left out because they or the rest of the base had fewer than `min_visitors` visitors"}},"type":"object","required":["meta","request","goal","factors","steps","visitors","reached","conversion_rate","min_visitors","skipped_count"],"title":"GoalFactorsResponse","description":"The factors of the window, ordered, with the base they are measured against."},"GoalStageStep":{"properties":{"step_type":{"type":"string","const":"stage","title":"Step Type","description":"The form, `stage`"},"stage":{"$ref":"#/components/schemas/CheckoutStage","description":"The checkout stage. `success` is an `order_placed` or `purchase` event, whoever sent it"}},"additionalProperties":false,"type":"object","required":["step_type","stage"],"title":"GoalStageStep","description":"A visitor with an event of this checkout stage."},"GoalStep":{"properties":{"dimension":{"$ref":"#/components/schemas/GoalFactorDimension","description":"The dimension, `page_type_seen` or `event_name`"},"key":{"type":"string","title":"Key","description":"The page type or the event name"},"visitors":{"type":"integer","title":"Visitors","description":"Visitors of the base with this key"},"reached":{"type":"integer","title":"Reached","description":"Of them, the visitors who reached the goal"},"share":{"type":"number","title":"Share","description":"`visitors` over the visitors of the base"},"reached_share":{"type":"number","title":"Reached Share","description":"`reached` over the goal visitors of the base"},"conversion_rate":{"type":"number","title":"Conversion Rate","description":"`reached` over `visitors`"}},"type":"object","required":["dimension","key","visitors","reached","share","reached_share","conversion_rate"],"title":"GoalStep","description":"One step on the way to the goal, a value nearly every goal visitor has."},"GoalStepSource":{"type":"string","title":"GoalStepSource","description":"Where the steps of the goal come from (section 28).\n\n`derived` reads them off the goal visitors. `checkout` is the known\ncheckout steps, taken where too few goal visitors were sampled to derive any.","x-extensible-enum":["derived","checkout"]},"GoalStepType":{"type":"string","title":"GoalStepType","description":"Which form a goal step takes (section 28).","x-extensible-enum":["stage","event"]},"GranularityRequest":{"type":"string","enum":["auto","minute","five_minutes","fifteen_minutes","hour","six_hours","day"],"title":"GranularityRequest","description":"The bucket width a caller asks a series endpoint for (§28)."},"GroupBy":{"properties":{"granularity":{"$ref":"#/components/schemas/QueryGranularityRequest","description":"Bucket width of the series, 'none' for no time grouping. 'auto' picks the smallest width with at most 300 buckets over the window, and 'day' from 28 days. `request.granularity` reports the width it resolved to. A width under an hour allows at most 1500 buckets.","default":"none"},"dimensions":{"items":{"anyOf":[{"type":"string"},{"$ref":"#/components/schemas/MapDimension"}]},"type":"array","maxItems":2,"title":"Dimensions","description":"Dimensions to group by (max 2). Strings for flat or Nested (errors.*) columns; objects for Map columns."},"top_n":{"anyOf":[{"type":"integer","maximum":100.0,"minimum":1.0},{"type":"null"}],"title":"Top N","description":"Keep only the N dimension values with the most pageviews in the window, ranked over the whole window before bucketing. Needed for a time series with a dimension: without it the response is cut at `limit` rows in time order, which drops the END OF THE TIME AXIS rather than the smallest series. Requires at least one dimension."}},"type":"object","title":"GroupBy","description":"Grouping configuration for queries."},"HistogramBucket":{"properties":{"label":{"type":"string","title":"Label","description":"Bucket label (e.g., '0-500ms')"},"min_value":{"type":"number","title":"Min Value","description":"Minimum value for this bucket (inclusive)"},"max_value":{"title":"Max Value","description":"Maximum value for this bucket (exclusive, absent for the last bucket)","type":"number"},"count":{"type":"integer","title":"Count","description":"Number of samples in this bucket"},"share":{"type":"number","title":"Share","description":"This bucket's part of the samples, 0..1"}},"type":"object","required":["label","min_value","count","share"],"title":"HistogramBucket","description":"Single bucket in a histogram."},"HistogramMeta":{"properties":{"execution_time_ms":{"type":"number","title":"Execution Time Ms","description":"How long the query took, in milliseconds"},"total":{"title":"Total","description":"Rows the query matched before paging, absent where the response is not a paged list.","type":"integer"},"limit":{"title":"Limit","description":"Rows per page the query applied, absent where the response is not paged","type":"integer"},"offset":{"title":"Offset","description":"Rows the query skipped, absent where the response is not paged","type":"integer"},"has_more":{"title":"Has More","description":"Whether a further page exists, absent where the response is not paged","type":"boolean"},"next_cursor":{"title":"Next Cursor","description":"Cursor for the next page, absent on the last page and where the response is not cursor-paged.","type":"string"},"sampling":{"description":"Sampling configured for the applications behind this result. Traffic counts are scaled by the weight each stored row carries, not by this rate. The beacon explorer's counts stay raw, as they count stored beacons, and so do the checkout funnel's stage counts.","$ref":"#/components/schemas/SamplingMeta"},"is_identity_mixed":{"title":"Is Identity Mixed","description":"Whether the applications in scope store different visitor identifiers and the count ran over `request.identity`, which some of them do not store. Their visitors are then left out, so the count is a lower bound for the scope. Absent where the response counts no visitors or the request named the identity.","type":"boolean"},"complete_until":{"title":"Complete Until","description":"The moment up to which the result holds every pageview. Data after it is still arriving, so the newest bucket is partial past this point. On a window of 6 hours or less it trails the request time by the ingest lag, on a longer one it is how far the finalizer has written the running hour. Absent where the route reads neither, or where that is unknown.","examples":["2026-04-14T09:50:01Z"],"type":"string","format":"date-time"},"sparse_buckets":{"description":"The sparse threshold this response applied, absent where the request sent no `sparse_buckets`. On `POST /analytics/query` always present","$ref":"#/components/schemas/SparseBucketsApplied"},"sample_count":{"type":"integer","title":"Sample Count","description":"Samples behind the histogram"},"metric":{"type":"string","title":"Metric","description":"Metric used for histogram"}},"type":"object","required":["execution_time_ms","sample_count","metric"],"title":"HistogramMeta","description":"Metadata about histogram query execution."},"HistogramRequest":{"properties":{"time_range":{"$ref":"#/components/schemas/TimeRange","description":"Time range for the query (required)"},"metric":{"type":"string","maxLength":64,"title":"Metric","description":"Metric to create histogram for (e.g., lcp, ttfb)"},"buckets":{"items":{"type":"number"},"type":"array","maxItems":20,"minItems":2,"title":"Buckets","description":"Bucket boundaries (e.g., [0, 500, 1000, 2500, 4000] creates 5 buckets)"},"filters":{"$ref":"#/components/schemas/Filters","description":"Optional filters"},"timezone":{"anyOf":[{"type":"string","maxLength":64},{"type":"null"}],"title":"Timezone","description":"IANA time zone the local hours of `filters.hour_of_day` are read in, such as `Europe/Berlin`. The filter requires it. This route buckets nothing, so the zone changes nothing else"},"sparse_buckets":{"anyOf":[{"$ref":"#/components/schemas/SparseBuckets"},{"type":"null"}],"description":"The sparse threshold of the page, the number `POST /analytics/sparse-hours` derives. With `exclude` the rows of the thin hours are left out. Without it the route only echoes the number in `meta.sparse_buckets`"},"compare_to":{"anyOf":[{"$ref":"#/components/schemas/CompareMode","description":"A window derived from `time_range` by `TimeRange.get_comparison_range`."},{"$ref":"#/components/schemas/TimeRange","description":"Any window, validated like `time_range`. It may differ in length and may overlap the main window."},{"$ref":"#/components/schemas/CompareToRelease"},{"type":"null"}],"title":"Compare To","description":"Also count the same buckets over a second window, as `comparison`. A mode, a `{from, to}` window or a `{release_id}`, resolved as on /analytics/query."}},"additionalProperties":false,"type":"object","required":["time_range","metric","buckets"],"title":"HistogramRequest","description":"Request schema for histogram queries."},"HistogramResponse":{"properties":{"buckets":{"items":{"$ref":"#/components/schemas/HistogramBucket"},"type":"array","title":"Buckets","description":"Histogram buckets with counts"},"comparison":{"title":"Comparison","description":"The same buckets over the `compare_to` window, absent unless it was set. Each `share` is of that window's own samples, so a window of another length draws to the same scale. `meta.sample_count` stays the main window's","items":{"$ref":"#/components/schemas/HistogramBucket"},"type":"array"},"meta":{"$ref":"#/components/schemas/HistogramMeta","description":"Query metadata"},"request":{"$ref":"#/components/schemas/AnalyticsRequestEcho","description":"The request as the server resolved it"}},"type":"object","required":["buckets","meta","request"],"title":"HistogramResponse","description":"Response for histogram queries."},"HourOfDayRange":{"properties":{"from":{"type":"integer","maximum":23.0,"minimum":0.0,"title":"From","description":"First local hour kept, 0 to 23"},"to":{"type":"integer","maximum":23.0,"minimum":0.0,"title":"To","description":"Last local hour kept, 0 to 23. Below `from` the range wraps across midnight"}},"additionalProperties":false,"type":"object","required":["from","to"],"title":"HourOfDayRange","description":"Inclusive local hours of the day a filter keeps."},"InviteCreate":{"properties":{"email":{"type":"string","format":"email","title":"Email","description":"Address to invite."},"role":{"$ref":"#/components/schemas/Role","description":"Role the invitation grants once accepted.","default":"member"}},"type":"object","required":["email"],"title":"InviteCreate"},"InviteResponse":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":"Identifier of the invitation.","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"email":{"type":"string","title":"Email","description":"Address it was sent to."},"role":{"$ref":"#/components/schemas/Role","description":"Role it grants."},"invited_by_id":{"type":"string","format":"uuid","title":"Invited By Id","description":"Who sent it.","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"created_at":{"type":"string","format":"date-time","title":"Created At","description":"When it was sent.","examples":["2026-04-14T09:50:01Z"]},"expires_at":{"type":"string","format":"date-time","title":"Expires At","description":"When it stops working.","examples":["2026-04-14T09:50:01Z"]}},"type":"object","required":["id","email","role","invited_by_id","created_at","expires_at"],"title":"InviteResponse"},"LabPoint":{"properties":{"timestamp":{"title":"Timestamp","examples":["2026-04-14T09:50:01Z"],"description":"ISO 8601 in UTC with a `Z` suffix.","type":"string","format":"date-time"},"score":{"title":"Score","type":"number"},"lcp":{"title":"Lcp","type":"number"},"fcp":{"title":"Fcp","type":"number"},"cls":{"title":"Cls","type":"number"},"inp":{"title":"Inp","type":"number"},"ttfb":{"title":"Ttfb","type":"number"}},"type":"object","title":"LabPoint","description":"One CS analysis run (sparse). Score is the CS sum; CWV are ms (cls unitless),\nparsed from that run's scores[]."},"LabVsFieldResponse":{"properties":{"page_id":{"type":"string","format":"uuid","title":"Page Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"],"description":"An ID, a UUID in lowercase with hyphens."},"url":{"type":"string","title":"Url"},"window_days":{"type":"integer","title":"Window Days"},"devices":{"items":{"$ref":"#/components/schemas/DeviceComparison"},"type":"array","title":"Devices"}},"type":"object","required":["page_id","url","window_days","devices"],"title":"LabVsFieldResponse"},"LcpDiscoveredVia":{"type":"string","enum":["preload","early-hints","css-background","img-tag","video-poster","data-uri","text","video-frame","other"],"title":"LcpDiscoveredVia","description":"How the browser found the LCP resource, as the collector stores it.\n\nThe values keep their hyphens: they are the stored values that the\n`lcp_discovered_via` filter and dimension take, and a second spelling\nwould make the two disagree."},"LighthouseOpportunity":{"properties":{"id":{"type":"string","title":"Id"},"title":{"title":"Title","type":"string"},"score":{"title":"Score","type":"number"},"savings_ms":{"title":"Savings Ms","type":"number"}},"type":"object","required":["id"],"title":"LighthouseOpportunity"},"LighthouseReportResponse":{"properties":{"page_id":{"type":"string","format":"uuid","title":"Page Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"],"description":"An ID, a UUID in lowercase with hyphens."},"device_type":{"$ref":"#/components/schemas/SyntheticDeviceType"},"lighthouse_version":{"title":"Lighthouse Version","type":"string"},"fetched_url":{"title":"Fetched Url","type":"string"},"categories":{"additionalProperties":{"anyOf":[{"type":"number"},{"type":"null"}]},"type":"object","title":"Categories"},"values_by_metric":{"additionalProperties":{"anyOf":[{"type":"number"},{"type":"null"}]},"type":"object","title":"Values By Metric","description":"One measurement per Lighthouse metric id, in the metric's own unit."},"opportunities":{"items":{"$ref":"#/components/schemas/LighthouseOpportunity"},"type":"array","title":"Opportunities"},"audits":{"additionalProperties":true,"type":"object","title":"Audits"}},"type":"object","required":["page_id","device_type","categories","values_by_metric","opportunities","audits"],"title":"LighthouseReportResponse","description":"Curated Lighthouse report: category scores, metrics (ms), opportunities, and\na whitelist of native Lighthouse audit objects (waterfall / third-party /\nresource-summary / filmstrip / main-thread) for the frontend to render."},"LighthouseSummaryResponse":{"properties":{"page_id":{"type":"string","format":"uuid","title":"Page Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"],"description":"An ID, a UUID in lowercase with hyphens."},"commerce_score_analysis_id":{"type":"string","title":"Commerce Score Analysis Id","description":"The run this summary is of."},"device_type":{"$ref":"#/components/schemas/SyntheticDeviceType"},"language":{"type":"string","title":"Language"},"summary":{"type":"string","title":"Summary"},"cached":{"type":"boolean","title":"Cached"}},"type":"object","required":["page_id","commerce_score_analysis_id","device_type","language","summary","cached"],"title":"LighthouseSummaryResponse","description":"AI-generated summary of a Lighthouse run (one device + language). Persisted and\nreused - `cached=false` means it was generated on this request."},"LiveDayCounts":{"properties":{"visitors":{"type":"integer","title":"Visitors","description":"Distinct visitors in the window, bots left out"},"purchases":{"type":"integer","title":"Purchases","description":"Distinct visitors in the window with a success-stage event, bots left out, as `purchases` of the traffic block counts them"},"order_revenue":{"items":{"$ref":"#/components/schemas/EventOrderRevenue"},"type":"array","title":"Order Revenue","description":"Per `currency` prop as sent, never converted, the money of the orders in the window, bots left out, most orders first. Empty when no order carried a `value`. `order_count` can be below `purchases`: purchases count buyers, this counts the orders with a value"},"time_range":{"$ref":"#/components/schemas/TimeRange","description":"The window the counts cover, in UTC"}},"type":"object","required":["visitors","purchases","order_revenue","time_range"],"title":"LiveDayCounts","description":"Visitors and buyers over one window of a day, counted as `today` counts them."},"LiveFilters":{"properties":{"site_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Site Id","description":"One site","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"site_ids":{"anyOf":[{"items":{"type":"string","format":"uuid","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"type":"array","minItems":1},{"type":"null"}],"title":"Site Ids","description":"Several sites. Ignored when `site_id` is set"},"application_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Application Id","description":"Every site of one application. Ignored when a site filter is set","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"tags":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Tags","description":"Sites carrying all of these tags. Ignored when any of the above is set"},"country":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Country","description":"Countries, ISO codes"},"asn":{"anyOf":[{"items":{"type":"integer","maximum":4294967295.0,"minimum":0.0},"type":"array"},{"type":"null"}],"title":"Asn","description":"Networks, autonomous system numbers. 0 is an unknown network"},"device_type":{"anyOf":[{"items":{"$ref":"#/components/schemas/DeviceType"},"type":"array"},{"type":"null"}],"title":"Device Type","description":"Device classes"},"page_type":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Page Type","description":"Page types as stored"},"bot_class":{"anyOf":[{"items":{"$ref":"#/components/schemas/BotClass"},"type":"array"},{"type":"null"}],"title":"Bot Class","description":"Traffic classes. Without it every class is served"}},"additionalProperties":false,"type":"object","title":"LiveFilters","description":"The site scope and the five dimensions the live floor filters on."},"LiveMeta":{"properties":{"execution_time_ms":{"type":"number","title":"Execution Time Ms","description":"How long the query took, in milliseconds"},"total":{"title":"Total","description":"Rows the query matched before paging, absent where the response is not a paged list.","type":"integer"},"limit":{"title":"Limit","description":"Rows per page the query applied, absent where the response is not paged","type":"integer"},"offset":{"title":"Offset","description":"Rows the query skipped, absent where the response is not paged","type":"integer"},"has_more":{"title":"Has More","description":"Whether a further page exists, absent where the response is not paged","type":"boolean"},"next_cursor":{"title":"Next Cursor","description":"Cursor for the next page, absent on the last page and where the response is not cursor-paged.","type":"string"},"sampling":{"description":"Sampling configured for the applications behind this result. Traffic counts are scaled by the weight each stored row carries, not by this rate. The beacon explorer's counts stay raw, as they count stored beacons, and so do the checkout funnel's stage counts.","$ref":"#/components/schemas/SamplingMeta"},"is_identity_mixed":{"title":"Is Identity Mixed","description":"Whether the applications in scope store different visitor identifiers and the count ran over `request.identity`, which some of them do not store. Their visitors are then left out, so the count is a lower bound for the scope. Absent where the response counts no visitors or the request named the identity.","type":"boolean"},"complete_until":{"title":"Complete Until","description":"The moment up to which the result holds every pageview. Data after it is still arriving, so the newest bucket is partial past this point. On a window of 6 hours or less it trails the request time by the ingest lag, on a longer one it is how far the finalizer has written the running hour. Absent where the route reads neither, or where that is unknown.","examples":["2026-04-14T09:50:01Z"],"type":"string","format":"date-time"},"sparse_buckets":{"description":"The sparse threshold this response applied, absent where the request sent no `sparse_buckets`. On `POST /analytics/query` always present","$ref":"#/components/schemas/SparseBucketsApplied"},"next_poll_ms":{"type":"integer","title":"Next Poll Ms","description":"How long the client waits before it polls again"}},"type":"object","required":["execution_time_ms","next_poll_ms"],"title":"LiveMeta","description":"The result facts of a live poll."},"LivePerformanceRow":{"properties":{"page_type":{"title":"Page Type","description":"Page type as stored, absent for pageviews without one","type":"string"},"p75_lcp_ms":{"type":"integer","title":"P75 Lcp Ms","description":"75th percentile of the pageviews' LCP, bots left out"},"sample_count":{"type":"integer","title":"Sample Count","description":"Pageviews that reported an LCP, bots left out. On a sampled application only the kept visitors report one"}},"type":"object","required":["p75_lcp_ms","sample_count"],"title":"LivePerformanceRow","description":"LCP of one page type over the last 30 minutes."},"LivePreviousWeekDay":{"properties":{"visitors":{"type":"integer","title":"Visitors","description":"Distinct visitors in the window, bots left out"},"purchases":{"type":"integer","title":"Purchases","description":"Distinct visitors in the window with a success-stage event, bots left out, as `purchases` of the traffic block counts them"},"order_revenue":{"items":{"$ref":"#/components/schemas/EventOrderRevenue"},"type":"array","title":"Order Revenue","description":"Per `currency` prop as sent, never converted, the money of the orders in the window, bots left out, most orders first. Empty when no order carried a `value`. `order_count` can be below `purchases`: purchases count buyers, this counts the orders with a value"},"time_range":{"$ref":"#/components/schemas/TimeRange","description":"The window the counts cover, in UTC"},"whole_day":{"$ref":"#/components/schemas/LiveDayCounts","description":"That day complete, from its midnight in `timezone` to the next. 23 or 25 hours long across a DST switch"}},"type":"object","required":["visitors","purchases","order_revenue","time_range","whole_day"],"title":"LivePreviousWeekDay","description":"The same weekday 7 days earlier, up to now's wall-clock time and complete."},"LiveRequest":{"properties":{"filters":{"$ref":"#/components/schemas/LiveFilters","description":"Optional filters"},"window_seconds":{"$ref":"#/components/schemas/LiveWindow","description":"Length of the window, which ends now","default":300},"limit":{"type":"integer","maximum":2000.0,"minimum":1.0,"title":"Limit","description":"Most visitors returned, the ones seen last are kept","default":500}},"additionalProperties":false,"type":"object","title":"LiveRequest","description":"The scope and the window of the live view."},"LiveResponse":{"properties":{"meta":{"$ref":"#/components/schemas/LiveVisitorsMeta","description":"Facts about the result"},"request":{"$ref":"#/components/schemas/AnalyticsRequestEcho","description":"The request as the server resolved it"},"data":{"items":{"$ref":"#/components/schemas/LiveVisitor"},"type":"array","title":"Data","description":"One row per visitor, by `last_seen_at` descending, at most `meta.limit`"},"visitor_count":{"type":"integer","title":"Visitor Count","description":"Distinct visitors in the window, every one counted at any sampling rate. The same number as `meta.total`, and above `meta.limit` the list is cut"}},"type":"object","required":["meta","request","data","visitor_count"],"title":"LiveResponse","description":"The visitors on the floor, newest first, with the count behind them."},"LiveShareRow":{"properties":{"page_type":{"title":"Page Type","description":"Page type as stored, absent for pageviews without one","type":"string"},"pageviews":{"type":"integer","title":"Pageviews","description":"Pageviews started in the window, bots left out"},"share":{"type":"number","title":"Share","description":"Its pageviews over all pageviews in the window, 0..1"}},"type":"object","required":["pageviews","share"],"title":"LiveShareRow","description":"One page type's part of the last 60 minutes, for the floor layout."},"LiveSource":{"properties":{"referrer_source":{"type":"string","title":"Referrer Source","description":"Referrer source as stored"},"visitors":{"type":"integer","title":"Visitors","description":"Distinct visitors today from this source"},"share":{"type":"number","title":"Share","description":"Its visitors over all of today's visitors, 0..1"}},"type":"object","required":["referrer_source","visitors","share"],"title":"LiveSource","description":"One referrer source of today's visitors."},"LiveSummaryRequest":{"properties":{"filters":{"$ref":"#/components/schemas/LiveFilters","description":"Optional filters"},"window_seconds":{"$ref":"#/components/schemas/LiveWindow","description":"Length of the window `traffic` and `traffic_total` count, which ends now. `performance` and `shares` keep their own","default":300},"timezone":{"anyOf":[{"type":"string","maxLength":64},{"type":"null"}],"title":"Timezone","description":"IANA time zone whose midnight starts `today`, such as `Europe/Berlin`. Without it the day starts at 00:00 UTC"}},"additionalProperties":false,"type":"object","title":"LiveSummaryRequest","description":"The scope of the live summary and the window of its traffic blocks."},"LiveSummaryResponse":{"properties":{"meta":{"$ref":"#/components/schemas/LiveMeta","description":"Facts about the result"},"request":{"$ref":"#/components/schemas/AnalyticsRequestEcho","description":"The request as the server resolved it"},"traffic":{"items":{"$ref":"#/components/schemas/LiveTrafficRow"},"type":"array","title":"Traffic","description":"Per page type over the window, busiest first"},"traffic_total":{"$ref":"#/components/schemas/LiveTrafficTotal","description":"The same counts over every page type of the window. A visitor seen on several page types counts once, so the rows do not sum to it"},"today":{"$ref":"#/components/schemas/LiveToday","description":"Since 00:00 in the request's `timezone`, in UTC without it"},"performance":{"items":{"$ref":"#/components/schemas/LivePerformanceRow"},"type":"array","title":"Performance","description":"LCP per page type over the last 30 minutes"},"shares":{"items":{"$ref":"#/components/schemas/LiveShareRow"},"type":"array","title":"Shares","description":"Pageviews per page type over the last 60 minutes, busiest first"}},"type":"object","required":["meta","request","traffic","traffic_total","today","performance","shares"],"title":"LiveSummaryResponse","description":"The figures around the live floor, each block at its own window and cache."},"LiveToday":{"properties":{"visitors":{"type":"integer","title":"Visitors","description":"Distinct visitors today, bots left out"},"purchases":{"type":"integer","title":"Purchases","description":"Distinct visitors today with a success-stage event, bots left out, as `purchases` of the traffic block counts them"},"order_revenue":{"items":{"$ref":"#/components/schemas/EventOrderRevenue"},"type":"array","title":"Order Revenue","description":"Per `currency` prop as sent, never converted, the money of the orders in the window, bots left out, most orders first. Empty when no order carried a `value`. `order_count` can be below `purchases`: purchases count buyers, this counts the orders with a value"},"bot_visitors":{"type":"integer","title":"Bot Visitors","description":"Distinct visitors of class `bot` today"},"sources":{"items":{"$ref":"#/components/schemas/LiveSource"},"type":"array","title":"Sources","description":"The five busiest referrer sources, busiest first, bots left out"},"time_range":{"$ref":"#/components/schemas/TimeRange","description":"The day the block counts, in UTC: from 00:00 in `timezone` to now, cut to 10 s. `purchases` count up to `to`, the other figures up to the start of its minute. In a zone whose offset is not whole hours it starts at the UTC hour holding that midnight"},"previous_week":{"$ref":"#/components/schemas/LivePreviousWeekDay","description":"The same weekday 7 days ago, from its midnight in `timezone` to the same wall-clock time as now, with the midnight rounded as in `time_range`"}},"type":"object","required":["visitors","purchases","order_revenue","bot_visitors","sources","time_range","previous_week"],"title":"LiveToday","description":"The day behind the live figures, since 00:00 in the request's `timezone`."},"LiveTrafficCounts":{"properties":{"pageviews":{"type":"integer","title":"Pageviews","description":"Pageviews started in the window, bots left out"},"visitors":{"type":"integer","title":"Visitors","description":"Distinct visitors with a pageview or checkout event in the window, bots left out"},"purchases":{"type":"integer","title":"Purchases","description":"Distinct visitors with a success-stage event in the window, bots left out. Exact, as events are never sampled"},"bot_visitors":{"type":"integer","title":"Bot Visitors","description":"Distinct visitors of class `bot` in the window, not in `visitors`"}},"type":"object","required":["pageviews","visitors","purchases","bot_visitors"],"title":"LiveTrafficCounts","description":"The traffic of one page type over a window compared with, scaled by the sampling weight.\n\nThe week, and the window before at 3600, come from the finalized pageviews,\nwhich hold the kept visitors only."},"LiveTrafficRow":{"properties":{"pageviews":{"type":"integer","title":"Pageviews","description":"Pageviews started in the window, bots left out"},"visitors":{"type":"integer","title":"Visitors","description":"Distinct visitors with a pageview or checkout event in the window, bots left out"},"purchases":{"type":"integer","title":"Purchases","description":"Distinct visitors with a success-stage event in the window, bots left out"},"bot_visitors":{"type":"integer","title":"Bot Visitors","description":"Distinct visitors of class `bot` in the window, not in `visitors`"},"page_type":{"title":"Page Type","description":"Page type as stored, absent for pageviews without one","type":"string"},"previous_period":{"$ref":"#/components/schemas/LiveTrafficCounts","description":"The same length before the window. Counted like the window up to 1800, weighted from the finalized pageviews at 3600"},"previous_week":{"$ref":"#/components/schemas/LiveTrafficCounts","description":"The same window seven days earlier, weighted from the finalized pageviews"}},"type":"object","required":["pageviews","visitors","purchases","bot_visitors","previous_period","previous_week"],"title":"LiveTrafficRow","description":"One page type over the window, next to the two windows it is compared with."},"LiveTrafficTotal":{"properties":{"pageviews":{"type":"integer","title":"Pageviews","description":"Pageviews started in the window, bots left out"},"visitors":{"type":"integer","title":"Visitors","description":"Distinct visitors with a pageview or checkout event in the window, bots left out"},"purchases":{"type":"integer","title":"Purchases","description":"Distinct visitors with a success-stage event in the window, bots left out"},"bot_visitors":{"type":"integer","title":"Bot Visitors","description":"Distinct visitors of class `bot` in the window, not in `visitors`"},"order_revenue":{"items":{"$ref":"#/components/schemas/EventOrderRevenue"},"type":"array","title":"Order Revenue","description":"Per `currency` prop as sent, never converted, the money of the orders in the window, bots left out, most orders first. Empty when no order carried a `value`. `order_count` can be below `purchases`: purchases count buyers, this counts the orders with a value"},"previous_period":{"$ref":"#/components/schemas/LiveTrafficTotalCounts","description":"The same length before the window. Counted like the window up to 1800, weighted from the finalized pageviews at 3600"},"previous_week":{"$ref":"#/components/schemas/LiveTrafficTotalCounts","description":"The same window seven days earlier, weighted from the finalized pageviews"}},"type":"object","required":["pageviews","visitors","purchases","bot_visitors","order_revenue","previous_period","previous_week"],"title":"LiveTrafficTotal","description":"Every page type of the window together, each visitor counted once."},"LiveTrafficTotalCounts":{"properties":{"pageviews":{"type":"integer","title":"Pageviews","description":"Pageviews started in the window, bots left out"},"visitors":{"type":"integer","title":"Visitors","description":"Distinct visitors with a pageview or checkout event in the window, bots left out"},"purchases":{"type":"integer","title":"Purchases","description":"Distinct visitors with a success-stage event in the window, bots left out. Exact, as events are never sampled"},"bot_visitors":{"type":"integer","title":"Bot Visitors","description":"Distinct visitors of class `bot` in the window, not in `visitors`"},"order_revenue":{"items":{"$ref":"#/components/schemas/EventOrderRevenue"},"type":"array","title":"Order Revenue","description":"Per `currency` prop as sent, never converted, the money of the orders in the window, bots left out, most orders first. Empty when no order carried a `value`. `order_count` can be below `purchases`: purchases count buyers, this counts the orders with a value"}},"type":"object","required":["pageviews","visitors","purchases","bot_visitors","order_revenue"],"title":"LiveTrafficTotalCounts","description":"Every page type of a window compared with, the order revenue included."},"LiveVisitor":{"properties":{"visitor_id":{"type":"string","title":"Visitor Id","description":"The stitch as 32 hex characters"},"page_type":{"title":"Page Type","description":"Page type of the newest pageview as stored, `checkout` after a newer checkout event, absent when unset","type":"string"},"checkout_stage":{"description":"Checkout stage of the newest pageview or checkout event, absent outside the funnel","$ref":"#/components/schemas/CheckoutStage"},"device_type":{"description":"Device class, absent where it could not be derived","$ref":"#/components/schemas/DeviceType"},"country":{"title":"Country","description":"ISO country code, absent when unknown","type":"string"},"asn":{"title":"Asn","description":"Autonomous system number of the network, absent when unknown","type":"integer"},"isp":{"title":"Isp","description":"Name of that network, absent when unknown","type":"string"},"started_at":{"type":"string","format":"date-time","title":"Started At","description":"Start of the visitor's first pageview or checkout event in the window","examples":["2026-04-14T09:50:01Z"]},"last_seen_at":{"type":"string","format":"date-time","title":"Last Seen At","description":"Receive time of the visitor's newest beacon, or time of a newer checkout event","examples":["2026-04-14T09:50:01Z"]},"status":{"$ref":"#/components/schemas/LiveVisitorStatus","description":"`hidden` once the newest pageview reported hidden, frozen or terminated"},"bot_class":{"$ref":"#/components/schemas/BotClass","description":"Traffic class of the newest pageview, or of the event without a pageview"},"lcp":{"title":"Lcp","description":"LCP of the newest pageview in ms, absent until it is measured, in the checkout and where sampling did not keep the visitor","type":"integer"},"referrer_source":{"title":"Referrer Source","description":"Referrer source of the visitor's first pageview in the window, absent when it has none or the visitor has checkout events only","type":"string"},"purchase":{"description":"The value of the visitor's order, absent when no success event in the window carried a finite `value`. A buyer without a value has none, so a sale is read from `checkout_stage`","$ref":"#/components/schemas/LiveVisitorPurchase"}},"type":"object","required":["visitor_id","started_at","last_seen_at","status","bot_class"],"title":"LiveVisitor","description":"One visitor seen in the window, described by their newest pageview."},"LiveVisitorPurchase":{"properties":{"value":{"type":"number","title":"Value","description":"The largest finite `value` among the visitor's success events in the window, as sent, never converted"},"currency":{"type":"string","title":"Currency","description":"The `currency` prop of that event as sent, empty when it came without one"}},"type":"object","required":["value","currency"],"title":"LiveVisitorPurchase","description":"The value a visitor's order reported."},"LiveVisitorStatus":{"type":"string","enum":["active","hidden"],"title":"LiveVisitorStatus","description":"Whether a visitor's newest page is in front of them."},"LiveVisitorsMeta":{"properties":{"execution_time_ms":{"type":"number","title":"Execution Time Ms","description":"How long the query took, in milliseconds"},"total":{"title":"Total","description":"Rows the query matched before paging, absent where the response is not a paged list.","type":"integer"},"limit":{"title":"Limit","description":"Rows per page the query applied, absent where the response is not paged","type":"integer"},"offset":{"title":"Offset","description":"Rows the query skipped, absent where the response is not paged","type":"integer"},"has_more":{"title":"Has More","description":"Whether a further page exists, absent where the response is not paged","type":"boolean"},"next_cursor":{"title":"Next Cursor","description":"Cursor for the next page, absent on the last page and where the response is not cursor-paged.","type":"string"},"sampling":{"description":"Sampling configured for the applications behind this result. Traffic counts are scaled by the weight each stored row carries, not by this rate. The beacon explorer's counts stay raw, as they count stored beacons, and so do the checkout funnel's stage counts.","$ref":"#/components/schemas/SamplingMeta"},"is_identity_mixed":{"title":"Is Identity Mixed","description":"Whether the applications in scope store different visitor identifiers and the count ran over `request.identity`, which some of them do not store. Their visitors are then left out, so the count is a lower bound for the scope. Absent where the response counts no visitors or the request named the identity.","type":"boolean"},"complete_until":{"title":"Complete Until","description":"The moment up to which the result holds every pageview. Data after it is still arriving, so the newest bucket is partial past this point. On a window of 6 hours or less it trails the request time by the ingest lag, on a longer one it is how far the finalizer has written the running hour. Absent where the route reads neither, or where that is unknown.","examples":["2026-04-14T09:50:01Z"],"type":"string","format":"date-time"},"sparse_buckets":{"description":"The sparse threshold this response applied, absent where the request sent no `sparse_buckets`. On `POST /analytics/query` always present","$ref":"#/components/schemas/SparseBucketsApplied"},"next_poll_ms":{"type":"integer","title":"Next Poll Ms","description":"How long the client waits before it polls again"},"bot_visitors":{"type":"integer","title":"Bot Visitors","description":"Of `meta.total`, the visitors of class `bot`, unscaled like it"},"stitchless_site_ids":{"items":{"type":"string","format":"uuid","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"type":"array","title":"Stitchless Site Ids","description":"Active sites of the scope that store no stitch, so none of their visitors can appear. Empty when every active site stores it"}},"type":"object","required":["execution_time_ms","next_poll_ms","bot_visitors","stitchless_site_ids"],"title":"LiveVisitorsMeta","description":"The result facts of a visitor poll."},"LiveWindow":{"type":"integer","enum":[300,900,1800,3600],"title":"LiveWindow","description":"The windows the live routes read, in seconds, each ending now."},"LoAFItem":{"properties":{"duration_ms":{"type":"number","title":"Duration Ms","description":"Frame duration in ms"},"script_url":{"type":"string","title":"Script Url","description":"Primary script URL"},"count":{"type":"integer","title":"Count","description":"Number of occurrences"}},"type":"object","required":["duration_ms","script_url","count"],"title":"LoAFItem","description":"Single long animation frame."},"LoAFRequest":{"properties":{"time_range":{"$ref":"#/components/schemas/TimeRange","description":"Time range for the query"},"filters":{"$ref":"#/components/schemas/Filters","description":"Optional filters"},"timezone":{"anyOf":[{"type":"string","maxLength":64},{"type":"null"}],"title":"Timezone","description":"IANA time zone the local hours of `filters.hour_of_day` are read in, such as `Europe/Berlin`. The filter requires it. This route buckets nothing, so the zone changes nothing else"},"sparse_buckets":{"anyOf":[{"$ref":"#/components/schemas/SparseBuckets"},{"type":"null"}],"description":"The sparse threshold of the page, the number `POST /analytics/sparse-hours` derives. With `exclude` the rows of the thin hours are left out. Without it the route only echoes the number in `meta.sparse_buckets`"},"limit":{"type":"integer","maximum":50.0,"minimum":1.0,"title":"Limit","description":"Max LoAF entries to return","default":10}},"additionalProperties":false,"type":"object","required":["time_range"],"title":"LoAFRequest","description":"Request for Long Animation Frames data."},"LoAFResponse":{"properties":{"meta":{"$ref":"#/components/schemas/AnalyticsMeta","description":"Facts about the result"},"request":{"$ref":"#/components/schemas/AnalyticsRequestEcho","description":"The request as the server resolved it"},"data":{"items":{"$ref":"#/components/schemas/LoAFItem"},"type":"array","title":"Data","description":"Long animation frames"},"frame_count":{"type":"integer","title":"Frame Count","description":"Long animation frames over all scripts"},"avg_ms":{"type":"number","title":"Avg Ms","description":"Average frame duration in ms"}},"type":"object","required":["meta","request","data","frame_count","avg_ms"],"title":"LoAFResponse","description":"Response for Long Animation Frames data."},"MapDimension":{"properties":{"map":{"type":"string","maxLength":64,"title":"Map","description":"Map column name (e.g. 'third_parties')"}},"additionalProperties":false,"type":"object","required":["map"],"title":"MapDimension","description":"Group by the keys of a Map column (ARRAY JOIN mapKeys / mapValues).\n\nExample: `{\"map\": \"third_parties\"}` produces one row per (beacon, domain)\nwith `third_parties_key` (the domain) as the dimension and an\nauto-emitted `<map>_total` metric (sum of map values across the group)."},"MapMetric":{"properties":{"map":{"type":"string","maxLength":64,"title":"Map","description":"Map column name (e.g. 'resource_sizes')"},"key":{"type":"string","maxLength":128,"minLength":1,"pattern":"^[a-zA-Z0-9._-]+$","title":"Key","description":"Map key to extract. Restricted to [a-zA-Z0-9._-] to keep the bracket expression SQL-safe; covers resource types, category names, and sanitized hostnames."}},"additionalProperties":false,"type":"object","required":["map","key"],"title":"MapMetric","description":"Aggregate a single key from a Map column. Behaves like a flat metric:\nthe request's `aggregations` list (sum / avg / p75 / …) is applied to\n`<map>['<key>']` directly, no ARRAY JOIN required.\n\nExample: `{\"map\": \"resource_sizes\", \"key\": \"script\"}` aggregates the\nper-beacon `resource_sizes['script']` value."},"MeasurementState":{"type":"string","title":"MeasurementState","description":"Whether a pageview carries a metric, and if not, why not.","x-extensible-enum":["measured","unsupported","not_applicable","absent"]},"MemberAdd":{"properties":{"email":{"type":"string","format":"email","title":"Email","description":"Address of the person to add."},"role":{"$ref":"#/components/schemas/Role","description":"Role they get.","default":"member"}},"type":"object","required":["email"],"title":"MemberAdd"},"MemberResponse":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":"Identifier of the membership, not of the user.","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"user_id":{"type":"string","format":"uuid","title":"User Id","description":"The account behind this membership.","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"email":{"type":"string","title":"Email","description":"The member's email address."},"full_name":{"title":"Full Name","description":"The member's name, when they gave one.","type":"string"},"role":{"$ref":"#/components/schemas/Role","description":"What the member may do here."},"totp_enabled":{"type":"boolean","title":"Totp Enabled","description":"Whether the account has two-factor authentication.","default":false},"created_at":{"type":"string","format":"date-time","title":"Created At","description":"When the member joined.","examples":["2026-04-14T09:50:01Z"]}},"type":"object","required":["id","user_id","email","role","created_at","totp_enabled"],"title":"MemberResponse"},"MemberRoleUpdate":{"properties":{"role":{"$ref":"#/components/schemas/Role","description":"The new role."}},"type":"object","required":["role"],"title":"MemberRoleUpdate"},"Message":{"properties":{"message":{"type":"string","title":"Message"}},"type":"object","required":["message"],"title":"Message"},"MetadataResponse":{"properties":{"metrics":{"items":{"$ref":"#/components/schemas/MetricMeta"},"type":"array","title":"Metrics"},"aggregations":{"items":{"$ref":"#/components/schemas/RuleAggregation"},"type":"array","title":"Aggregations"},"dimensions":{"items":{"type":"string"},"type":"array","title":"Dimensions","description":"The dimensions `filters` takes."},"window_options_seconds":{"items":{"$ref":"#/components/schemas/RuleWindow"},"type":"array","title":"Window Options Seconds"}},"type":"object","required":["metrics","aggregations","dimensions","window_options_seconds"],"title":"MetadataResponse"},"MetricComparison":{"properties":{"metric":{"type":"string","title":"Metric"},"lab_value":{"title":"Lab Value","type":"number"},"field_p75":{"title":"Field P75","type":"number"},"verdict":{"type":"string","title":"Verdict"}},"type":"object","required":["metric","verdict"],"title":"MetricComparison","description":"One CWV metric, lab (CS) vs field (RUM p75), in canonical ms (cls unitless)."},"MetricDistribution":{"properties":{"p50":{"title":"P50","type":"number"},"p75":{"title":"P75","type":"number"},"p90":{"title":"P90","type":"number"},"p95":{"title":"P95","type":"number"},"count":{"type":"integer","title":"Count","description":"Rows that carried a value for this measurement. Always check it before reading the quantiles: loading vitals (lcp, fcp, ttfb) are absent on soft navigations by design, and a handful of rows makes a p90 noise rather than a measurement.","default":0}},"type":"object","title":"MetricDistribution","description":"Quantiles of one measurement over a set of rows.\n\nWeb vitals over pageviews, funnel timings over visitors: one shape, so the\nfrontend renders every distribution this API returns the same way.","required":["count"]},"MetricMeta":{"properties":{"metric":{"type":"string","title":"Metric","description":"The metric catalog id a rule names."},"label":{"type":"string","title":"Label","description":"The English name the editor shows."},"unit":{"description":"What the metric is measured in.","$ref":"#/components/schemas/MetricUnit"},"supported_aggregations":{"items":{"$ref":"#/components/schemas/RuleAggregation"},"type":"array","title":"Supported Aggregations","description":"The aggregations that make sense for the metric."}},"type":"object","required":["metric","label","supported_aggregations"],"title":"MetricMeta"},"MetricRange":{"properties":{"metric":{"type":"string","maxLength":64,"title":"Metric","description":"Metric column - allowlisted (lcp/inp/cls/error_count/…)"},"gte":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Gte","description":"Keep rows with metric >= this"},"lte":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Lte","description":"Keep rows with metric <= this"}},"additionalProperties":false,"type":"object","required":["metric"],"title":"MetricRange","description":"A numeric threshold filter on ONE beacon metric (e.g. `{metric:'lcp', gte:2500}`\nfor slow-LCP pageviews, or `{metric:'error_count', gte:1}` = \"has errors\").\nAt least one bound required. NULL metric values don't match (a softnav with no\nLCP isn't a \"slow-LCP\" pageview) - true for the Nullable columns. Note:\n`fetch_xhr_total_calls`/`_total_errors` are non-nullable (0-default), so an\n`lte` on those matches genuine-zero rows."},"MetricState":{"properties":{"state":{"$ref":"#/components/schemas/MeasurementState","description":"`measured`: the pageview carries a value. `unsupported`: the visitor's browser cannot observe the metric. `not_applicable`: the pageview has no such moment, as a soft navigation or BFCache restore has no navigation timing. `absent`: the browser supports it and the pageview has none"},"reason":{"description":"Why an `absent` metric is missing, absent where unknown","$ref":"#/components/schemas/AbsenceReason"}},"type":"object","required":["state"],"title":"MetricState","description":"The state of one metric on one pageview."},"MetricSummaryComparison":{"properties":{"value":{"title":"Value","description":"The percentile over the `compare_to` window, absent without data there","type":"number"}},"type":"object","title":"MetricSummaryComparison","description":"The measures of the window `compare_to` names, `previous_period` when unset."},"MetricSummaryFacts":{"properties":{"value":{"title":"Value","description":"The requested percentile of the metric, absent without data","type":"number"},"unit":{"$ref":"#/components/schemas/MetricUnit","description":"What `value` and `comparison.value` are measured in: `ms`, or `score` for the unitless CLS"},"comparison":{"description":"The same measures over the window `compare_to` names, `previous_period` when it is unset, whatever form `compare_to` takes","$ref":"#/components/schemas/MetricSummaryComparison"},"direction":{"description":"How `value` moved against `comparison`. A change below the metric's flat delta is `neutral`, never `worse`. Absent without both values","$ref":"#/components/schemas/ObservationDirection"},"rating":{"description":"The rating of `value`, absent without data or without cutoffs for the metric","$ref":"#/components/schemas/VitalRating"},"good_share":{"title":"Good Share","description":"The part of the pageviews reporting the metric that rate good, 0..1","type":"number"},"poor_share":{"title":"Poor Share","description":"The part of the pageviews reporting the metric that rate poor, 0..1","type":"number"},"lead_phase":{"title":"Lead Phase","description":"The metric id of the phase that takes the most time, such as `lcp_ttfb`. On TTFB `ttfb_phase_server` stands for edge, origin and backend together. Absent where a phase was not measured","type":"string"},"coverage":{"title":"Coverage","description":"The part of all pageviews that reported the metric, 0..1","type":"number"}},"type":"object","required":["unit"],"title":"MetricSummaryFacts","description":"The numbers the sentences rest on, for the tiles to read too."},"MetricSummaryPart":{"properties":{"text":{"type":"string","title":"Text","description":"Plain text, no markup"},"section":{"description":"The page section this part links to, absent on plain text","$ref":"#/components/schemas/SummarySection"}},"type":"object","required":["text"],"title":"MetricSummaryPart","description":"A stretch of plain text, linked to a page section where it names one."},"MetricSummaryRequest":{"properties":{"metric":{"$ref":"#/components/schemas/SummaryMetric","description":"The metric page to summarize"},"time_range":{"$ref":"#/components/schemas/TimeRange","description":"The window, as `/analytics/query` takes it"},"filters":{"$ref":"#/components/schemas/Filters","description":"Optional filters, as `/analytics/query` takes them"},"timezone":{"anyOf":[{"type":"string","maxLength":64},{"type":"null"}],"title":"Timezone","description":"IANA time zone the local hours of `filters.hour_of_day` are read in, such as `Europe/Berlin`. The filter requires it. This route buckets nothing, so the zone changes nothing else"},"sparse_buckets":{"anyOf":[{"$ref":"#/components/schemas/SparseBuckets"},{"type":"null"}],"description":"The sparse threshold of the page, the number `POST /analytics/sparse-hours` derives. With `exclude` the rows of the thin hours are left out. Without it the route only echoes the number in `meta.sparse_buckets`"},"aggregation":{"$ref":"#/components/schemas/AggregationType","description":"The percentile the page shows: p50, p75, p90 or p95","default":"p75"},"compare_to":{"anyOf":[{"$ref":"#/components/schemas/CompareMode","description":"A window derived from `time_range` by `TimeRange.get_comparison_range`."},{"$ref":"#/components/schemas/TimeRange","description":"Any window, validated like `time_range`. It may differ in length and may overlap the main window."},{"$ref":"#/components/schemas/CompareToRelease"},{"type":"null"}],"title":"Compare To","description":"The window `facts.comparison` is read over: a mode, a `{from, to}` window or a `{release_id}`, resolved as on /analytics/query. Set in any form, the sentences say what changed against it instead of how the metric stands. Unset, it is `previous_period` for the facts only"},"language":{"type":"string","maxLength":16,"title":"Language","description":"The language of the sentences. A tag such as `de-AT` counts by its first two letters, and a language the summary does not speak falls back to `en`","default":"en"}},"additionalProperties":false,"type":"object","required":["metric","time_range"],"title":"MetricSummaryRequest","description":"The metric page, its scope and the language to write in."},"MetricSummaryResponse":{"properties":{"meta":{"$ref":"#/components/schemas/AnalyticsMeta","description":"Facts about the result"},"request":{"$ref":"#/components/schemas/AnalyticsRequestEcho","description":"The request as the server resolved it"},"language":{"type":"string","enum":["en","de"],"title":"Language","description":"The language the sentences are in"},"sentences":{"items":{"$ref":"#/components/schemas/MetricSummarySentence"},"type":"array","title":"Sentences","description":"In reading order, empty without data"},"facts":{"$ref":"#/components/schemas/MetricSummaryFacts","description":"The numbers the sentences rest on"}},"type":"object","required":["meta","request","language","sentences","facts"],"title":"MetricSummaryResponse","description":"The sentences of a metric page's summary box and the facts behind them."},"MetricSummarySentence":{"properties":{"sentence_type":{"$ref":"#/components/schemas/SummarySentenceType","description":"What the sentence says"},"severity":{"$ref":"#/components/schemas/SummarySeverity","description":"How the sentence reads"},"parts":{"items":{"$ref":"#/components/schemas/MetricSummaryPart"},"type":"array","title":"Parts","description":"The sentence in order, joined without a separator"}},"type":"object","required":["sentence_type","severity","parts"],"title":"MetricSummarySentence","description":"One sentence of the summary, in parts so a part can link to its section."},"MetricThreshold":{"properties":{"metric":{"type":"string","title":"Metric","description":"The metric catalog id, as `POST /analytics/query` and a notification rule name it."},"good":{"type":"number","title":"Good","description":"The good cutoff, in `unit`. Where lower is better a value at or below it is good, where higher is better a value at or above it."},"poor":{"type":"number","title":"Poor","description":"The poor cutoff, in `unit`. Where lower is better a value strictly above it is poor, where higher is better a value strictly below it. A value between the two cutoffs, or equal to `poor`, needs improvement."},"unit":{"$ref":"#/components/schemas/MetricUnit","description":"What `good` and `poor` are measured in."},"better":{"$ref":"#/components/schemas/ThresholdBetter","description":"`lower` where a smaller value is better, `higher` where a larger one is."},"basis":{"$ref":"#/components/schemas/ThresholdBasis","description":"Where the cutoffs come from: `web_vitals`, `lighthouse_mobile`, or `fastmon` for fastmon's own cut with no external source."},"basis_url":{"title":"Basis Url","description":"The page that states the cutoffs. Absent where `basis` is `fastmon`.","type":"string"}},"type":"object","required":["metric","good","poor","unit","better","basis"],"title":"MetricThreshold","description":"The good and poor cutoff of one metric, with where they come from."},"MetricThresholdsResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/MetricThreshold"},"type":"array","title":"Data","description":"One entry per rated metric."}},"type":"object","required":["data"],"title":"MetricThresholdsResponse","description":"Every metric fastmon rates, with its cutoffs."},"MetricUnit":{"type":"string","enum":["ms","s","score","count","bytes","rate","percent"],"title":"MetricUnit","description":"What a metric's numbers are measured in.\n\n\"s\" (migration 072) is the cache-age pair and the only non-millisecond\nduration in the catalog. It is a widening of the vocabulary, so a form that\nswitches on this needs the case: reporting those two as \"ms\" instead would\nput a threshold off by a factor of 1000."},"MetricValue":{"properties":{"metric":{"type":"string","title":"Metric","description":"Metric name"},"aggregation":{"$ref":"#/components/schemas/AggregationType","description":"Aggregation type"},"value":{"anyOf":[{"type":"number"},{"type":"integer"}],"title":"Value","description":"Aggregated value"}},"type":"object","required":["metric","aggregation"],"title":"MetricValue","description":"Single metric with its aggregation result."},"NelBreakdownOrderBy":{"properties":{"field":{"$ref":"#/components/schemas/NelBreakdownSort","description":"`error_count`, the weighted reports, or `last_seen_at`, the latest report of the row","default":"error_count"},"direction":{"$ref":"#/components/schemas/SortDirection","description":"Sort direction","default":"desc"}},"additionalProperties":false,"type":"object","title":"NelBreakdownOrderBy","description":"The order of the rows of a NEL breakdown, a tie always by `key`."},"NelBreakdownRequest":{"properties":{"time_range":{"$ref":"#/components/schemas/TimeRange","description":"Time range, on the time the browser saw the error"},"filters":{"$ref":"#/components/schemas/Filters","description":"The filters of `POST /analytics/nel`, with its 422 for a filter the table cannot answer. A filter on the dimension itself narrows the rows"},"timezone":{"anyOf":[{"type":"string","maxLength":64},{"type":"null"}],"title":"Timezone","description":"IANA time zone the local hours of `filters.hour_of_day` are read in, such as `Europe/Berlin`. The filter requires it. This route buckets nothing, so the zone changes nothing else"},"sparse_buckets":{"anyOf":[{"$ref":"#/components/schemas/SparseBuckets"},{"type":"null"}],"description":"The sparse threshold of the page, the number `POST /analytics/sparse-hours` derives. With `exclude` the rows of the thin hours are left out. Without it the route only echoes the number in `meta.sparse_buckets`"},"dimension":{"$ref":"#/components/schemas/NelDimension","description":"The one dimension the rows group by. `host` is the failed request's host in lowercase, `page_url` the page it was sent from, `phase`, `method` and `protocol` the report's own, `bot_class` derived from the edge labels as the filter derives it, `nel_class` derived from `error_type` as the filter derives it, the rest the edge labels. `browser_version` keys mix browsers that share a version number, so pair it with `filters.browser`, and reports stored before the column existed form one row with an empty `key`. `server_ip` is the address of the shop's server the request went to, and the reports without a stored address form one row with an empty `key`. `stitch` is the visitor, its key the `visitor_id` of the report list, and the reports without a stitch form one row with an empty `key`. `status_code_range` groups by the status code, its key the code as text, and the reports without an HTTP response form one row with an empty `key`. `bot_name`, `error_type` and `path` are the report's columns the filters of the same name compare. `request_url` is the failed request's host and path in one key, `shop.example/checkout`"},"order_by":{"$ref":"#/components/schemas/NelBreakdownOrderBy","description":"The order of the rows before `limit` cuts them, most weighted reports first by default. `last_seen_at` puts the newest group first"},"limit":{"type":"integer","maximum":100.0,"minimum":1.0,"title":"Limit","description":"Max rows, in the `order_by` order","default":50}},"additionalProperties":false,"type":"object","required":["time_range","dimension"],"title":"NelBreakdownRequest","description":"Request for the NEL reports grouped by one dimension."},"NelBreakdownResponse":{"properties":{"meta":{"$ref":"#/components/schemas/NelMeta","description":"Facts about the result. `total` is the number of values the dimension has in the window, `limit` the cap on `data`"},"request":{"$ref":"#/components/schemas/AnalyticsRequestEcho","description":"The request as the server resolved it"},"error_count":{"type":"integer","title":"Error Count","description":"Weighted reports in the window, the rows the limit cut included, which every `share` is measured against"},"data":{"items":{"$ref":"#/components/schemas/NelBreakdownRow"},"type":"array","title":"Data","description":"At most `meta.limit` rows, in the `order_by` order"}},"type":"object","required":["meta","request","error_count","data"],"title":"NelBreakdownResponse","description":"NEL reports grouped by one dimension."},"NelBreakdownRow":{"properties":{"key":{"type":"string","title":"Key","description":"The value this row groups by, as stored. Where a filter of the same name exists, the key passed to it selects this row's reports. For `page_url` it is the full page URL with the query keys the application keeps, and a key holding `*` matches as a wildcard pattern. Reports without a page, a direct visit or a page on another host, form one row with an empty key, which `filters.page_url` selects as `\"\"`. The same holds for the empty `path` key. A `stitch` key goes back as `filters.stitch: [key]`, a `status_code_range` key as `filters.status_code_range: {gte: key, lte: key}`, and a `request_url` key splits at its first `/` into `filters.host: [host]` and `filters.path: path`, a key without `/` into the host and `filters.path: \"\"`. The empty key of these three is no filter value"},"error_count":{"type":"integer","title":"Error Count","description":"Weighted reports with this value"},"affected_visitors":{"title":"Affected Visitors","description":"Distinct visitors behind the reports with this value. Counted unweighted over the non-zero `stitch`, so it is exact with a `failure_fraction` of 1 in the site's `NEL` header and a lower bound below it. Only sites with `store_stitch` carry a stitch, and a report that came without a valid stitch is left out. The stitch salt rotates daily and on every edge restart, so a report uploaded after a rotation loses its visitor. Only Chromium browsers report. Absent when no site in scope stores a stitch","type":"integer"},"share":{"type":"number","title":"Share","description":"This row's weighted reports over the weighted reports of the whole answer, the rows the limit cut included, 0..1"},"isp":{"title":"Isp","description":"The name of the network on a row of the `asn` dimension, '' when unknown. Absent on every other dimension","type":"string"},"first_seen_at":{"type":"string","format":"date-time","title":"First Seen At","description":"The browser's time of the first report with this value in the window","examples":["2026-04-14T09:50:01Z"]},"last_seen_at":{"type":"string","format":"date-time","title":"Last Seen At","description":"The browser's time of the latest report with this value in the window","examples":["2026-04-14T09:50:01Z"]}},"type":"object","required":["key","error_count","share","first_seen_at","last_seen_at"],"title":"NelBreakdownRow","description":"One value of the breakdown dimension with the reports behind it."},"NelBreakdownSort":{"type":"string","enum":["error_count","last_seen_at"],"title":"NelBreakdownSort","description":"What the rows of a NEL breakdown are ordered by."},"NelBucket":{"properties":{"timestamp":{"type":"string","format":"date-time","title":"Timestamp","examples":["2026-04-14T09:50:01Z"],"description":"ISO 8601 in UTC with a `Z` suffix."},"error_count":{"type":"integer","title":"Error Count","description":"Weighted reports in this bucket"},"errors_by_error_type":{"additionalProperties":{"type":"integer"},"type":"object","title":"Errors By Error Type","description":"The browser's error type, such as `http.error` or `tcp.timed_out`, to its weighted reports in this bucket"},"errors_by_status_code":{"additionalProperties":{"type":"integer"},"type":"object","title":"Errors By Status Code","description":"HTTP status code to weighted reports in this bucket, 0 for a request that got no HTTP response"},"affected_visitors":{"title":"Affected Visitors","description":"Distinct visitors behind the reports of this bucket. A visitor of two buckets counts in each. Counted unweighted over the non-zero `stitch`, so it is exact with a `failure_fraction` of 1 in the site's `NEL` header and a lower bound below it. Only sites with `store_stitch` carry a stitch, and a report that came without a valid stitch is left out. The stitch salt rotates daily and on every edge restart, so a report uploaded after a rotation loses its visitor. Only Chromium browsers report. Absent when no site in scope stores a stitch","type":"integer"}},"type":"object","required":["timestamp","error_count","errors_by_error_type","errors_by_status_code"],"title":"NelBucket","description":"One bucket of the NEL report series."},"NelClass":{"type":"string","enum":["http_error","connection","abandoned","downgraded","other"],"title":"NelClass","description":"What a Network Error Logging report says happened, derived from its `error_type`."},"NelDimension":{"type":"string","enum":["site_id","host","page_url","device_type","browser","os","country","asn","phase","method","protocol","bot_class","browser_version","nel_class","server_ip","stitch","status_code_range","bot_name","request_url","error_type","path"],"title":"NelDimension","description":"What a NEL breakdown groups the reports by."},"NelElapsed":{"properties":{"p50_ms":{"type":"integer","title":"P50 Ms","description":"Median elapsed time in ms"},"p75_ms":{"type":"integer","title":"P75 Ms","description":"75th percentile of the elapsed time in ms"},"p95_ms":{"type":"integer","title":"P95 Ms","description":"95th percentile of the elapsed time in ms"}},"type":"object","required":["p50_ms","p75_ms","p95_ms"],"title":"NelElapsed","description":"Percentiles of the time from the request's start to its failure."},"NelMeta":{"properties":{"execution_time_ms":{"type":"number","title":"Execution Time Ms","description":"How long the query took, in milliseconds"},"total":{"title":"Total","description":"Rows the query matched before paging, absent where the response is not a paged list.","type":"integer"},"limit":{"title":"Limit","description":"Rows per page the query applied, absent where the response is not paged","type":"integer"},"offset":{"title":"Offset","description":"Rows the query skipped, absent where the response is not paged","type":"integer"},"has_more":{"title":"Has More","description":"Whether a further page exists, absent where the response is not paged","type":"boolean"},"next_cursor":{"title":"Next Cursor","description":"Cursor for the next page, absent on the last page and where the response is not cursor-paged.","type":"string"},"sampling":{"description":"Sampling configured for the applications behind this result. Traffic counts are scaled by the weight each stored row carries, not by this rate. The beacon explorer's counts stay raw, as they count stored beacons, and so do the checkout funnel's stage counts.","$ref":"#/components/schemas/SamplingMeta"},"is_identity_mixed":{"title":"Is Identity Mixed","description":"Whether the applications in scope store different visitor identifiers and the count ran over `request.identity`, which some of them do not store. Their visitors are then left out, so the count is a lower bound for the scope. Absent where the response counts no visitors or the request named the identity.","type":"boolean"},"complete_until":{"title":"Complete Until","description":"The moment up to which the result holds every pageview. Data after it is still arriving, so the newest bucket is partial past this point. On a window of 6 hours or less it trails the request time by the ingest lag, on a longer one it is how far the finalizer has written the running hour. Absent where the route reads neither, or where that is unknown.","examples":["2026-04-14T09:50:01Z"],"type":"string","format":"date-time"},"sparse_buckets":{"description":"The sparse threshold this response applied, absent where the request sent no `sparse_buckets`. On `POST /analytics/query` always present","$ref":"#/components/schemas/SparseBucketsApplied"},"stitchless_site_ids":{"items":{"type":"string","format":"uuid","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"type":"array","title":"Stitchless Site Ids","description":"Active sites of the scope that store no stitch, so none of their reports counts in `affected_visitors`. Empty when every active site stores it"}},"type":"object","required":["execution_time_ms","stitchless_site_ids"],"title":"NelMeta","description":"The result facts of a NEL query."},"NelPathItem":{"properties":{"host":{"type":"string","title":"Host","description":"Host of the failed request URL. A site's subdomains are hosts of their own, so `www.shop.example` and `shop.example` are two entries"},"path":{"type":"string","title":"Path","description":"Path of the failed request URL, reduced as the application stores URLs, so ids may be templated"},"error_count":{"type":"integer","title":"Error Count","description":"Weighted reports for this host and path in the window"},"errors_by_status_code":{"additionalProperties":{"type":"integer"},"type":"object","title":"Errors By Status Code","description":"HTTP status code to weighted reports. 0 means the request got no HTTP response, as for a DNS or connection failure."},"affected_visitors":{"title":"Affected Visitors","description":"Distinct visitors behind the reports of this host and path. Counted unweighted over the non-zero `stitch`, so it is exact with a `failure_fraction` of 1 in the site's `NEL` header and a lower bound below it. Only sites with `store_stitch` carry a stitch, and a report that came without a valid stitch is left out. The stitch salt rotates daily and on every edge restart, so a report uploaded after a rotation loses its visitor. Only Chromium browsers report. Absent when no site in scope stores a stitch","type":"integer"}},"type":"object","required":["host","path","error_count","errors_by_status_code"],"title":"NelPathItem","description":"One request host and path among the most reported ones of the window."},"NelReportRow":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":"The report's own id, which ClickHouse gives it on insert. It orders reports of the same timestamp and says nothing about time","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"timestamp":{"type":"string","format":"date-time","title":"Timestamp","description":"When the browser saw the failure, millisecond precision","examples":["2026-04-14T09:50:01Z"]},"host":{"type":"string","title":"Host","description":"Host of the failed request URL, lowercased"},"path":{"type":"string","title":"Path","description":"Path of the failed request URL, reduced as the application stores URLs, so ids may be templated"},"server_ip":{"title":"Server Ip","description":"The address of the shop's server the failed request went to, as the browser reported it. A downgraded report names the address the request went to, not the one the policy came from. Absent when the browser sent none or it was not a public address, and on reports stored before the column existed","type":"string"},"page_url":{"title":"Page Url","description":"The page the failed request was sent from, the full URL with the query keys the application keeps. Absent when the browser sent none, as for a direct visit or a page on another host","type":"string"},"request_url":{"type":"string","title":"Request Url","description":"The failed request's URL, with the query keys the application keeps"},"error_type":{"type":"string","title":"Error Type","description":"The browser's error type, such as `http.error` or `tcp.timed_out`"},"nel_class":{"$ref":"#/components/schemas/NelClass","description":"The class of a Network Error Logging report, derived from `error_type` at read time. It says what happened, not who is at fault. `http_error` is `http.error`, the server answered with a 4xx or 5xx status. `connection` is every other `dns.*`, `tcp.*`, `tls.*`, `h2.*`, `h3.*` and `http.*` type and `unknown`: no usable answer came back. `abandoned` is the visitor or the browser cancelling the request. `downgraded` is `dns.address_changed`, a failure whose type the browser hid because the request went to another address than the one the policy came from. A downgraded `http.error` never arrives, since the browser samples it as a success and `success_fraction` 0 drops it. On a site behind several addresses a rise of `downgraded` means one address fails. `other` is a type no rule matches, one a browser added since"},"phase":{"type":"string","title":"Phase","description":"The phase of the request the failure happened in, as the NEL spec names it"},"status_code":{"type":"integer","title":"Status Code","description":"HTTP status code, 0 for a request that got no HTTP response"},"elapsed_ms":{"type":"integer","title":"Elapsed Ms","description":"Time from the start of the request to its failure. 0 stands for both an invalid and a zero time"},"method":{"type":"string","title":"Method","description":"HTTP method of the failed request, `other` outside the standard ones"},"protocol":{"type":"string","title":"Protocol","description":"Network protocol, such as `http/1.1` or `h2`, empty when the browser sent none and `other` when it sent one the collector cannot read"},"site_id":{"type":"string","format":"uuid","title":"Site Id","description":"The site the report was filed under","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"visitor_id":{"title":"Visitor Id","description":"The 32-hex edge pseudonym (`stitch`), the wire form /analytics/visitors uses, so a row links straight into the visitor detail. No `identity` sits beside it, so it is always the stitch. Absent where the report carries none: a site with `store_stitch` off, or an upload without a valid stitch","type":"string"},"failure_sampling_rate":{"type":"number","title":"Failure Sampling Rate","description":"The share of failures the site's `NEL` header asks the browser to report, 0..1. Rows are listed unweighted, and each one stands for `1 / failure_sampling_rate` failures in the counts of the aggregate route"},"country":{"type":"string","title":"Country","description":"Edge-derived country code"},"asn":{"type":"integer","title":"Asn","description":"Edge-derived autonomous system number of the network, 0 when unknown"},"isp":{"type":"string","title":"Isp","description":"Name of that network, empty when unknown"},"device_type":{"description":"Edge-derived device class, absent where it could not be derived","$ref":"#/components/schemas/DeviceType"},"browser":{"type":"string","title":"Browser","description":"Edge-derived browser family"},"browser_version":{"type":"string","title":"Browser Version","description":"Edge-derived major browser version, empty where none was stored"},"os":{"type":"string","title":"Os","description":"Edge-derived operating system"},"bot_name":{"type":"string","title":"Bot Name","description":"Bot label, empty for human traffic"},"bot_type":{"type":"string","title":"Bot Type","description":"Bot category, empty for human traffic"},"datacenter":{"type":"string","title":"Datacenter","description":"Datacenter label, empty for a consumer network"},"ua_anomaly":{"type":"string","title":"Ua Anomaly","description":"User-agent anomaly label, empty when there is none"},"bot_class":{"$ref":"#/components/schemas/BotClass","description":"Derived from the edge labels as `filters.bot_class` derives it"}},"type":"object","required":["id","timestamp","host","path","request_url","error_type","nel_class","phase","status_code","elapsed_ms","method","protocol","site_id","failure_sampling_rate","country","asn","isp","browser","browser_version","os","bot_name","bot_type","datacenter","ua_anomaly","bot_class"],"title":"NelReportRow","description":"One Network Error Logging report as stored, unweighted."},"NelReportsRequest":{"properties":{"time_range":{"$ref":"#/components/schemas/TimeRange","description":"Time range, on the time the browser saw the error"},"filters":{"$ref":"#/components/schemas/Filters","description":"The filters of `POST /analytics/nel`, with its 422 for a filter the table cannot answer"},"timezone":{"anyOf":[{"type":"string","maxLength":64},{"type":"null"}],"title":"Timezone","description":"IANA time zone the local hours of `filters.hour_of_day` are read in, such as `Europe/Berlin`. The filter requires it. This route buckets nothing, so the zone changes nothing else"},"sparse_buckets":{"anyOf":[{"$ref":"#/components/schemas/SparseBuckets"},{"type":"null"}],"description":"The sparse threshold of the page, the number `POST /analytics/sparse-hours` derives. With `exclude` the rows of the thin hours are left out. Without it the route only echoes the number in `meta.sparse_buckets`"},"limit":{"type":"integer","maximum":100.0,"minimum":1.0,"title":"Limit","description":"Max rows per page","default":50},"cursor":{"anyOf":[{"type":"string","maxLength":1024},{"type":"null"}],"title":"Cursor","description":"Opaque resume point from `meta.next_cursor` of the previous page. It carries the last row's timestamp and id, so two reports of the same millisecond page without a gap or a repeat."}},"additionalProperties":false,"type":"object","required":["time_range"],"title":"NelReportsRequest","description":"Request for the single NEL reports, newest first."},"NelRequest":{"properties":{"time_range":{"$ref":"#/components/schemas/TimeRange","description":"Time range, on the time the browser saw the error"},"filters":{"$ref":"#/components/schemas/Filters","description":"Optional filters. The site scope, `stitch` and the edge-derived dimensions are accepted, because a report carries those and no page or metric. Anything else is a 422 naming it under its own path, since an empty answer would read as 'no errors'."},"granularity":{"$ref":"#/components/schemas/GranularityRequest","description":"Bucket size of the series: 'minute', 'five_minutes', 'fifteen_minutes', 'hour', 'six_hours', 'day', or 'auto' (default: the smallest width with at most 300 buckets over the window, and 'day' from 28 days). A width under an hour allows at most 1500 buckets.","default":"auto"},"timezone":{"anyOf":[{"type":"string","maxLength":64},{"type":"null"}],"title":"Timezone","description":"IANA time zone whose boundaries start the `six_hours`, `day`, `week` and `month` buckets, such as `Europe/Berlin`. A day is 23 or 25 hours long across a DST switch. Bucket timestamps stay UTC. In a zone whose offset is not whole hours a bucket starts at the UTC hour that holds the local boundary. Without it the buckets start at UTC boundaries"},"sparse_buckets":{"anyOf":[{"$ref":"#/components/schemas/SparseBuckets"},{"type":"null"}],"description":"The sparse threshold of the page, the number `POST /analytics/sparse-hours` derives. With `exclude` the rows of the thin hours are left out. Without it the route only echoes the number in `meta.sparse_buckets`"},"limit":{"type":"integer","maximum":200.0,"minimum":1.0,"title":"Limit","description":"Max entries in `paths`","default":50}},"additionalProperties":false,"type":"object","required":["time_range"],"title":"NelRequest","description":"Request for the Network Error Logging reports of the organization's sites."},"NelResponse":{"properties":{"meta":{"$ref":"#/components/schemas/NelMeta","description":"Facts about the result"},"request":{"$ref":"#/components/schemas/AnalyticsRequestEcho","description":"The request as the server resolved it"},"error_count":{"type":"integer","title":"Error Count","description":"Weighted reports in the window"},"affected_visitors":{"title":"Affected Visitors","description":"Distinct visitors behind the reports of the window, each once however many buckets it appears in. Counted unweighted over the non-zero `stitch`, so it is exact with a `failure_fraction` of 1 in the site's `NEL` header and a lower bound below it. Only sites with `store_stitch` carry a stitch, and a report that came without a valid stitch is left out. The stitch salt rotates daily and on every edge restart, so a report uploaded after a rotation loses its visitor. Only Chromium browsers report. Absent when no site in scope stores a stitch","type":"integer"},"errors_by_error_type":{"additionalProperties":{"type":"integer"},"type":"object","title":"Errors By Error Type","description":"The browser's error type to weighted reports in the window"},"elapsed_by_error_type":{"additionalProperties":{"$ref":"#/components/schemas/NelElapsed"},"type":"object","title":"Elapsed By Error Type","description":"The browser's error type to the percentiles of its elapsed time in the window, unweighted as every percentile is. A report with an elapsed time of 0 is left out, since 0 stands for both an invalid and a zero time, and a type without a report above 0 has no entry"},"errors_by_status_code":{"additionalProperties":{"type":"integer"},"type":"object","title":"Errors By Status Code","description":"HTTP status code to weighted reports in the window, 0 for a request that got no HTTP response"},"series":{"items":{"$ref":"#/components/schemas/NelBucket"},"type":"array","title":"Series","description":"One point per bucket with at least one report. A bucket with none is absent rather than zero-filled, as in /analytics/query."},"paths":{"items":{"$ref":"#/components/schemas/NelPathItem"},"type":"array","title":"Paths","description":"The `limit` pairs of host and path with the most weighted reports, most first. The same path on two hosts is two entries"}},"type":"object","required":["meta","request","error_count","errors_by_error_type","elapsed_by_error_type","errors_by_status_code","series","paths"],"title":"NelResponse","description":"The NEL reports of the organization's sites, as browsers sent them.\n\nEvery count is weighted by the report's `sampling_fraction`, the share of\nfailures the site's `NEL` header asks the browser to report. `meta.sampling`\ndescribes that failure sampling, not the application's rate."},"NotificationChannelType":{"type":"string","enum":["slack","discord","webhook"],"title":"NotificationChannelType"},"ObservationDirection":{"type":"string","enum":["worse","better","neutral"],"title":"ObservationDirection","description":"Worse is a problem, better a highlight, neutral information that is neither."},"ObservationKind":{"type":"string","enum":["shift","trend"],"title":"ObservationKind","description":"A shift is a level change within a quarter hour, a trend a change over weeks."},"ObservationMetric":{"type":"string","enum":["traffic","ttfb","lcp","inp","cls","error","bot","availability","response_time","certificate","stability","broken_page"],"title":"ObservationMetric","description":"What a lane measures. Traffic, bots and the five uptime metrics are\nshifts only, INP and CLS trends only. Availability, response time,\ncertificate, stability and broken pages come from the uptime probe."},"ObservationOccurrence":{"properties":{"started_at":{"type":"string","format":"date-time","title":"Started At","description":"The first quarter hour of the occurrence.","examples":["2026-04-14T09:50:01Z"]},"ended_at":{"title":"Ended At","description":"When the occurrence ended. Absent while it lasts.","examples":["2026-04-14T09:50:01Z"],"type":"string","format":"date-time"},"reference":{"type":"number","title":"Reference","description":"The reference this occurrence opened against, in the unit `reference_unit` names."},"reference_unit":{"description":"What `reference` is measured in: `share` 0..1, `page_views` per quarter hour for `traffic` and `bot`, `milliseconds` for a TTFB or LCP p75 and for `response_time`, `days` before expiry for `certificate`. A TTFB or LCP row written before the p75 holds a `share`.","$ref":"#/components/schemas/ReferenceUnit"},"peak_factor":{"title":"Peak Factor","description":"The largest factor against the reference, in the direction of the observation. Absent where the reference was zero.","type":"number"},"affected_pageviews":{"title":"Affected Pageviews","description":"The page views behind the change, weighted: the slow, failed or missing ones, or the bot page views. Absent for the uptime metrics `availability`, `response_time`, `certificate`, `stability` and `broken_page`, which measure no page views.","type":"number"},"bot_change":{"description":"Which way the bot page views went in this occurrence. On every occurrence of a `bot` observation, whose rows hold both ways. Absent for every other metric.","$ref":"#/components/schemas/BotChange"}},"type":"object","required":["started_at","reference"],"title":"ObservationOccurrence","description":"One occurrence of a shift. A recurring shift has several."},"ObservationOccurrenceWebhook":{"properties":{"type":{"type":"string","const":"observation.occurrence","title":"Type"},"timestamp":{"type":"string","format":"date-time","title":"Timestamp","description":"When the event happened: the start of the observation, for a trend midnight UTC of its first day, or of the occurrence, the evaluation of a rule, and the moment of sending for a test. The same on every attempt of one delivery.","examples":["2026-04-14T09:50:01Z"]},"data":{"$ref":"#/components/schemas/ObservationOccurrenceWebhookData"}},"type":"object","required":["type","timestamp","data"],"title":"ObservationOccurrenceWebhook","description":"A shift that had settled began again, the first recurrence only."},"ObservationOccurrenceWebhookData":{"properties":{"organization":{"$ref":"#/components/schemas/OrganizationRef","description":"The organization the event is about. For a partner's channel that is the client, not the partner that owns the channel."},"application":{"$ref":"#/components/schemas/ApplicationRef","description":"The application the Watchdog watched."},"site":{"description":"The site the observation hangs on. Absent where it watches the application.","$ref":"#/components/schemas/SiteRef"},"channel":{"$ref":"#/components/schemas/ChannelRef","description":"The channel the event was posted to."},"observation":{"$ref":"#/components/schemas/WebhookObservation"},"occurrence":{"$ref":"#/components/schemas/WebhookOccurrence","description":"The occurrence that began."},"message":{"$ref":"#/components/schemas/WebhookMessage"}},"type":"object","required":["organization","application","channel","observation","occurrence","message"],"title":"ObservationOccurrenceWebhookData"},"ObservationOpenedWebhook":{"properties":{"type":{"type":"string","const":"observation.opened","title":"Type"},"timestamp":{"type":"string","format":"date-time","title":"Timestamp","description":"When the event happened: the start of the observation, for a trend midnight UTC of its first day, or of the occurrence, the evaluation of a rule, and the moment of sending for a test. The same on every attempt of one delivery.","examples":["2026-04-14T09:50:01Z"]},"data":{"$ref":"#/components/schemas/ObservationWebhookData"}},"type":"object","required":["type","timestamp","data"],"title":"ObservationOpenedWebhook","description":"The Watchdog opened an observation the channel's subscription admits."},"ObservationResponse":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":"Identifier of the observation.","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"organization_id":{"type":"string","format":"uuid","title":"Organization Id","description":"The organization the observation belongs to.","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"application_id":{"type":"string","format":"uuid","title":"Application Id","description":"The application the Watchdog watched.","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"site_id":{"title":"Site Id","description":"The site an `availability`, `response_time`, `certificate`, `stability` or `broken_page` observation hangs on. Absent on an outage or a slow answer of a whole application and on every other metric, which watches the application as a whole.","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"],"type":"string","format":"uuid"},"kind":{"$ref":"#/components/schemas/ObservationKind","description":"`shift` for a level change within a quarter hour, `trend` for a change over weeks."},"metric":{"$ref":"#/components/schemas/ObservationMetric","description":"What changed."},"direction":{"$ref":"#/components/schemas/ObservationDirection","description":"`worse` is a problem, `better` a highlight, `neutral` information that is neither. A traffic rise is `neutral` and a drop `worse`. A change of bot traffic is `neutral` either way."},"status":{"$ref":"#/components/schemas/ObservationStatus","description":"`open` while the change lasts, `acknowledged` while it lasts and a person acknowledged it, `ended` once the lane saw it end."},"started_at":{"type":"string","format":"date-time","title":"Started At","description":"The start of the first occurrence, or the day a trend opened.","examples":["2026-04-14T09:50:01Z"]},"ended_at":{"title":"Ended At","description":"When the observation ended. Absent while it is open.","examples":["2026-04-14T09:50:01Z"],"type":"string","format":"date-time"},"reference":{"type":"number","title":"Reference","description":"The reference the newest occurrence opened against, in `reference_unit`: a share 0..1, page views per quarter hour for `traffic` and `bot`, the usual p75 in milliseconds for `ttfb` and `lcp`, milliseconds for `response_time`, days before expiry for `certificate`, the failed share 0..1 of recent checks for `stability`. 0 for `availability` and `broken_page`, which have no baseline."},"reference_unit":{"description":"What `reference` is measured in: `share` 0..1, `page_views` per quarter hour for `traffic` and `bot`, `milliseconds` for a TTFB or LCP p75 and for `response_time`, `days` before expiry for `certificate`. A TTFB or LCP row written before the p75 holds a `share`.","$ref":"#/components/schemas/ReferenceUnit"},"occurrences":{"items":{"$ref":"#/components/schemas/ObservationOccurrence"},"type":"array","title":"Occurrences","description":"The occurrences of a shift, oldest first: the first one and the newest 199. Empty for a trend."},"occurrence_count":{"type":"integer","title":"Occurrence Count","description":"Every occurrence, also those the list leaves out. 1 for a trend."},"evidence":{"additionalProperties":true,"type":"object","title":"Evidence","description":"The numbers the text is built from. A shift carries the releases around its start under `diagnosis`, and one that opened worse or a traffic or bot shift either way also the drill-down per dimension. A traffic shift carries the bot page views of its opening quarter hours against their usual count as `opening_bot_pageviews_delta`. The delivery record `notifications` is left out for access through a partner."},"title":{"type":"string","title":"Title","description":"One line naming the change."},"summary":{"type":"string","title":"Summary","description":"A few sentences on what was measured."},"acknowledged_at":{"title":"Acknowledged At","description":"When a person acknowledged the observation. Absent while nobody did. It holds for the life of the row, also across new occurrences.","examples":["2026-04-14T09:50:01Z"],"type":"string","format":"date-time"},"acknowledged_by_user_id":{"title":"Acknowledged By User Id","description":"The user who acknowledged it. Absent while nobody did, when an organization's own key did, and once that account is deleted.","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"],"type":"string","format":"uuid"},"note":{"title":"Note","description":"The free text a person left on the observation. Absent without one.","type":"string"},"created_at":{"type":"string","format":"date-time","title":"Created At","description":"When the lane wrote the row.","examples":["2026-04-14T09:50:01Z"]},"updated_at":{"type":"string","format":"date-time","title":"Updated At","description":"When the lane last changed it.","examples":["2026-04-14T09:50:01Z"]}},"type":"object","required":["id","organization_id","application_id","kind","metric","direction","status","started_at","reference","occurrences","occurrence_count","evidence","title","summary","created_at","updated_at"],"title":"ObservationResponse"},"ObservationStatus":{"type":"string","enum":["open","acknowledged","ended"],"title":"ObservationStatus","description":"Open or acknowledged while the change lasts, ended once the lane saw it end."},"ObservationSubscriptionCreate":{"properties":{"channel_id":{"type":"string","format":"uuid","title":"Channel Id","description":"The channel the observations are posted to.","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"application_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Application Id","description":"The application whose observations are posted, of the organization or of `client_organization`. Absent for every application, including ones created later.","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"client_organization_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Client Organization Id","description":"The partner client whose observations are posted to the organization's channel. Absent for the organization's own observations or with `all_clients`.","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"all_clients":{"type":"boolean","title":"All Clients","description":"Whether every partner client's observations are posted, including clients linked later. Never together with a client or an application.","default":false},"directions":{"items":{"$ref":"#/components/schemas/ObservationDirection"},"type":"array","minItems":1,"title":"Directions","description":"The directions of the observations posted: `worse` for problems, `better` for highlights, `neutral` for information. Never empty, `[\"worse\"]` by default, which is what the Watchdog mail sends."},"metrics":{"anyOf":[{"items":{"$ref":"#/components/schemas/ObservationMetric"},"type":"array","minItems":1},{"type":"null"}],"title":"Metrics","description":"The metrics of the observations posted. Absent for every metric a channel can get: `traffic`, `ttfb`, `lcp`, `error` and `bot` of a shift, `ttfb`, `lcp`, `inp`, `cls` and `error` of a trend. The uptime metrics are not posted yet and are refused."}},"additionalProperties":false,"type":"object","required":["channel_id"],"title":"ObservationSubscriptionCreate"},"ObservationSubscriptionResponse":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"],"description":"An ID, a UUID in lowercase with hyphens."},"organization":{"$ref":"#/components/schemas/OrganizationRef","description":"The organization that owns the subscription and the channel. Its own observations are posted unless `client_organization` or `all_clients` says otherwise."},"channel":{"$ref":"#/components/schemas/ChannelRef","description":"The channel the observations are posted to."},"application":{"description":"The application whose observations are posted, of the organization or of `client_organization`. Absent for every application, including ones created later.","$ref":"#/components/schemas/ApplicationRef"},"client_organization":{"description":"The partner client whose observations are posted to the organization's channel. Absent for the organization's own observations or with `all_clients`.","$ref":"#/components/schemas/OrganizationRef"},"all_clients":{"type":"boolean","title":"All Clients","description":"Whether every partner client's observations are posted, including clients linked later. Never together with a client or an application."},"directions":{"items":{"$ref":"#/components/schemas/ObservationDirection"},"type":"array","title":"Directions","description":"The directions of the observations posted: `worse` for problems, `better` for highlights, `neutral` for information. Never empty, `[\"worse\"]` by default, which is what the Watchdog mail sends."},"metrics":{"title":"Metrics","description":"The metrics of the observations posted. Absent for every metric a channel can get: `traffic`, `ttfb`, `lcp`, `error` and `bot` of a shift, `ttfb`, `lcp`, `inp`, `cls` and `error` of a trend. The uptime metrics are not posted yet and are refused.","items":{"$ref":"#/components/schemas/ObservationMetric"},"type":"array"},"created_at":{"type":"string","format":"date-time","title":"Created At","examples":["2026-04-14T09:50:01Z"],"description":"ISO 8601 in UTC with a `Z` suffix."}},"type":"object","required":["id","organization","channel","all_clients","directions","created_at"],"title":"ObservationSubscriptionResponse","description":"One channel that receives the observations of one application, or of all, as filtered."},"ObservationSubscriptionUpdate":{"properties":{"directions":{"anyOf":[{"items":{"$ref":"#/components/schemas/ObservationDirection"},"type":"array","minItems":1},{"type":"null"}],"title":"Directions","description":"The directions of the observations posted: `worse` for problems, `better` for highlights, `neutral` for information. Never empty, `[\"worse\"]` by default, which is what the Watchdog mail sends."},"metrics":{"anyOf":[{"items":{"$ref":"#/components/schemas/ObservationMetric"},"type":"array","minItems":1},{"type":"null"}],"title":"Metrics","description":"The metrics of the observations posted. Absent for every metric a channel can get: `traffic`, `ttfb`, `lcp`, `error` and `bot` of a shift, `ttfb`, `lcp`, `inp`, `cls` and `error` of a trend. The uptime metrics are not posted yet and are refused."}},"additionalProperties":false,"type":"object","title":"ObservationSubscriptionUpdate","description":"Merge-patch of a subscription's filters. Channel and application stay fixed.\nOnly `metrics` can be cleared with null, which means every metric."},"ObservationUpdate":{"properties":{"status":{"anyOf":[{"$ref":"#/components/schemas/ObservationStatus"},{"type":"null"}],"description":"`acknowledged` acknowledges the observation as the caller, `open` takes the acknowledgement back. `ended` is refused, as the lane ends an observation, and so is any status on an ended one."},"note":{"anyOf":[{"type":"string","maxLength":1000},{"type":"null"}],"title":"Note","description":"The free text to leave on the observation. `null`, an empty or a blank string removes it."}},"additionalProperties":false,"type":"object","title":"ObservationUpdate","description":"A merge patch, API_STANDARDS §13, so an absent field stays as it is."},"ObservationWebhookData":{"properties":{"organization":{"$ref":"#/components/schemas/OrganizationRef","description":"The organization the event is about. For a partner's channel that is the client, not the partner that owns the channel."},"application":{"$ref":"#/components/schemas/ApplicationRef","description":"The application the Watchdog watched."},"site":{"description":"The site the observation hangs on. Absent where it watches the application.","$ref":"#/components/schemas/SiteRef"},"channel":{"$ref":"#/components/schemas/ChannelRef","description":"The channel the event was posted to."},"observation":{"$ref":"#/components/schemas/WebhookObservation"},"occurrence":{"description":"The first occurrence of a shift. Absent on a trend.","$ref":"#/components/schemas/WebhookOccurrence"},"message":{"$ref":"#/components/schemas/WebhookMessage"}},"type":"object","required":["organization","application","channel","observation","message"],"title":"ObservationWebhookData"},"Operator":{"type":"string","enum":["gt","gte","lt","lte"],"title":"Operator"},"OrderBy":{"properties":{"field":{"type":"string","maxLength":1024,"title":"Field","description":"Field to sort by (metric name or dimension)"},"direction":{"$ref":"#/components/schemas/SortDirection","description":"Sort direction","default":"desc"}},"type":"object","required":["field"],"title":"OrderBy","description":"Sort configuration for results."},"OrgKeyCreate":{"properties":{"current_password":{"anyOf":[{"type":"string","maxLength":1024},{"type":"null"}],"title":"Current Password","description":"The account's password, when it has neither a passkey nor 2FA."},"totp_code":{"anyOf":[{"type":"string","maxLength":6},{"type":"null"}],"title":"Totp Code","description":"Code from the authenticator app, when 2FA is on and there is no passkey."},"passkey_challenge_id":{"anyOf":[{"type":"string","maxLength":64},{"type":"null"}],"title":"Passkey Challenge Id","description":"Challenge from `POST /auth/session/webauthn/options`, required together with `passkey_assertion` whenever the account has a passkey."},"passkey_assertion":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Passkey Assertion","description":"The WebAuthn assertion answering that challenge."},"name":{"type":"string","maxLength":100,"minLength":1,"title":"Name","description":"Label the key is recognised by in the dashboard."},"audience":{"type":"string","enum":["own","clients"],"title":"Audience","description":"Where the key acts. `own`: in this organization. `clients`: in the organizations this one is a partner of, resolved at request time, and not in this organization itself.","default":"own"},"scopes":{"items":{"type":"string"},"type":"array","minItems":1,"title":"Scopes","description":"Permissions the key carries, `analytics:read` and the like. Capped at what the caller holds in this organization, and `org_key:manage` is never grantable."},"expires_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Expires At","description":"When the key stops working. Required, and `null` means it never expires.","examples":["2026-04-14T09:50:01Z"]}},"type":"object","required":["name","scopes","expires_at"],"title":"OrgKeyCreate","description":"Mint an org key. The step-up fields re-authenticate the acting human -\nthe key itself belongs to nobody and never authenticates interactively."},"OrgKeyUpdate":{"properties":{"current_password":{"anyOf":[{"type":"string","maxLength":1024},{"type":"null"}],"title":"Current Password","description":"The account's password, when it has neither a passkey nor 2FA."},"totp_code":{"anyOf":[{"type":"string","maxLength":6},{"type":"null"}],"title":"Totp Code","description":"Code from the authenticator app, when 2FA is on and there is no passkey."},"passkey_challenge_id":{"anyOf":[{"type":"string","maxLength":64},{"type":"null"}],"title":"Passkey Challenge Id","description":"Challenge from `POST /auth/session/webauthn/options`, required together with `passkey_assertion` whenever the account has a passkey."},"passkey_assertion":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Passkey Assertion","description":"The WebAuthn assertion answering that challenge."},"name":{"anyOf":[{"type":"string","maxLength":100,"minLength":1},{"type":"null"}],"title":"Name","description":"New label, or omitted to keep the current one."},"scopes":{"anyOf":[{"items":{"type":"string"},"type":"array","minItems":1},{"type":"null"}],"title":"Scopes","description":"The key's new permissions, replacing the old set. Omitted keeps them. Adding one takes step-up and is capped at what the caller holds today."},"expires_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Expires At","description":"Omitted leaves the expiry alone, `null` means it never expires. Moving it further out takes step-up.","examples":["2026-04-14T09:50:01Z"]}},"type":"object","title":"OrgKeyUpdate","description":"Rename an org key, change what it may do, or both. Every field is\noptional and what is left out stays as it is. There is no reach to edit:\nan org key names one organization by construction."},"OrgSiteStatusItem":{"properties":{"beacons_today":{"type":"integer","title":"Beacons Today","description":"Beacons received for this domain since midnight in the request's `timezone`, UTC without one."},"beacons_per_minute":{"type":"number","title":"Beacons Per Minute"},"last_beacon_at":{"title":"Last Beacon At","examples":["2026-04-14T09:50:01Z"],"description":"ISO 8601 in UTC with a `Z` suffix.","type":"string","format":"date-time"},"events_today":{"type":"integer","title":"Events Today","description":"Checkout events received for this domain since midnight in the request's `timezone`, UTC without one. 0 also whenever `events_available` is false.","default":0},"last_event_at":{"title":"Last Event At","description":"When the newest checkout event of the last 31 days arrived, absent when the domain has none in that window. A value proves the pixel reports. Its absence does not prove that it never did.","examples":["2026-04-14T09:50:01Z"],"type":"string","format":"date-time"},"events_available":{"type":"boolean","title":"Events Available","description":"Whether the checkout events could be read at all. False when the events table is absent or the probe for it failed, and then the two fields above say nothing about the pixel.","default":true},"site_id":{"type":"string","format":"uuid","title":"Site Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"],"description":"An ID, a UUID in lowercase with hyphens."}},"type":"object","required":["beacons_today","beacons_per_minute","site_id","events_today","events_available"],"title":"OrgSiteStatusItem","description":"One site's beacon status within the org-wide status listing.\n\nSame fields as `SiteStatusResponse` plus the `site_id` the row belongs to,\nso a single call can back the dashboard header widget across every site."},"OrganizationCreate":{"properties":{"name":{"type":"string","maxLength":128,"minLength":1,"title":"Name","description":"Display name."},"intended_domain":{"type":"string","maxLength":8192,"title":"Intended Domain","description":"The domain that will be monitored. Used for the review. A pasted URL keeps its host."}},"type":"object","required":["name","intended_domain"],"title":"OrganizationCreate"},"OrganizationFeature":{"properties":{"feature":{"$ref":"#/components/schemas/Feature","description":"A catalog feature."},"status":{"$ref":"#/components/schemas/FeatureStatus","description":"What makes it available: `covered` by a partner, `granted` by fastmon, `included` in the own plan, or `locked`. With several sources the first of that order wins."}},"type":"object","required":["feature","status"],"title":"OrganizationFeature"},"OrganizationHit":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"],"description":"An ID, a UUID in lowercase with hyphens."},"name":{"type":"string","title":"Name"},"role":{"$ref":"#/components/schemas/Role"},"access":{"title":"Access","type":"string","enum":["member","partner","admin"]},"is_partner":{"type":"boolean","title":"Is Partner"}},"type":"object","required":["id","name","is_partner"],"title":"OrganizationHit","description":"An organization as a hit in its own right.\n\nInherits the reference shape so the \"both omitted for an ownerless\ncredential\" rule is stated once and cannot drift between the two places an\norganization appears in a response."},"OrganizationRef":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"],"description":"An ID, a UUID in lowercase with hyphens."},"name":{"type":"string","title":"Name"}},"type":"object","required":["id","name"],"title":"OrganizationRef","description":"An organization another resource belongs to or points at."},"OrganizationResponse":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":"Identifier of the organization.","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"name":{"type":"string","title":"Name","description":"Display name."},"is_active":{"type":"boolean","title":"Is Active","description":"Whether the organization is enabled."},"review_status":{"$ref":"#/components/schemas/ReviewStatus","description":"Where the organization stands in the anti-abuse review. Applications and sites, and with them ingestion, wait for approval."},"intended_domain":{"title":"Intended Domain","description":"The domain the organization said it wants to monitor, from sign-up.","type":"string"},"storage":{"$ref":"#/components/schemas/Storage","description":"Which ClickHouse storage tier holds this organization's beacons."},"clickhouse_table":{"type":"string","title":"Clickhouse Table","description":"The table its beacons are read from."},"plan":{"$ref":"#/components/schemas/Plan","description":"Subscription plan."},"is_partner":{"type":"boolean","title":"Is Partner","description":"Whether this organization manages client organizations as an agency."},"ai_enabled":{"type":"boolean","title":"Ai Enabled","description":"Whether AI features are switched on for it."},"synthetic_enabled":{"type":"boolean","title":"Synthetic Enabled","description":"Whether synthetic monitoring is switched on for it."},"mcp_enabled":{"type":"boolean","title":"Mcp Enabled","description":"Whether the MCP server is switched on for it."},"features":{"items":{"$ref":"#/components/schemas/OrganizationFeature"},"type":"array","title":"Features","description":"Every catalog feature with what makes it available to this organization. A locked one is shown with its upsell, not hidden.","default":[]},"history_days":{"type":"integer","title":"History Days","description":"The retention horizon an analytics window may reach back, in days: 395 with the `history` feature, 90 without. A longer window answers 422 `time_range_beyond_history`."},"data_starts_at":{"title":"Data Starts At","description":"The UTC midnight a complete analytics window of this organization starts at: the day of the first pageview over all its sites, but never before `history_days` ago. Absent until the first pageview is 3 hours old.","examples":["2026-04-14T09:50:01Z"],"type":"string","format":"date-time"},"role":{"description":"The caller's role here.","$ref":"#/components/schemas/Role"},"permissions":{"items":{"type":"string"},"type":"array","title":"Permissions","description":"What that role currently means for the caller. Gate a UI on this rather than on the role, so a re-cut role bundle needs no client change.","default":[]},"access":{"title":"Access","description":"How the caller reaches this organization: through a membership, through a partner link, or through the platform-admin bypass.","type":"string","enum":["member","partner","admin"]}},"type":"object","required":["id","name","is_active","review_status","storage","clickhouse_table","plan","is_partner","ai_enabled","synthetic_enabled","mcp_enabled","history_days","features","permissions"],"title":"OrganizationResponse"},"OrganizationUpdate":{"properties":{"name":{"anyOf":[{"type":"string","maxLength":128,"minLength":1},{"type":"null"}],"title":"Name","description":"New display name."},"ai_enabled":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Ai Enabled","description":"Switch AI features on or off."},"synthetic_enabled":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Synthetic Enabled","description":"Switch synthetic monitoring on or off."},"mcp_enabled":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Mcp Enabled","description":"Switch the MCP server on or off."}},"type":"object","title":"OrganizationUpdate"},"OrganizationUptimeAvailabilityResponse":{"properties":{"availability":{"type":"number","title":"Availability","description":"Share 0..1 of the window in which no active site of any listed application had an open outage, rounded to 4 decimals. The outages of all those sites are merged in time, so an overlap counts once. 1 without an outage in the window or without a listed application."},"downtime_seconds":{"type":"integer","title":"Downtime Seconds","description":"Seconds of the window in which at least one active site of a listed application had an open outage, an open one up to now. Wall-clock time, not the sum over the applications. 0 without an outage."},"applications":{"items":{"$ref":"#/components/schemas/ApplicationUptimeAvailability"},"type":"array","title":"Applications","description":"One row per active production application with the probe switched on and at least one active site, in the order of `GET /organizations/{org_id}/uptime`. Empty without such an application."},"time_range":{"$ref":"#/components/schemas/TimeRange","description":"The window the availability covers, as the server resolved it."}},"type":"object","required":["availability","downtime_seconds","applications","time_range"],"title":"OrganizationUptimeAvailabilityResponse","description":"The availability of an organization's monitored production applications over a window."},"OverviewOrderRevenue":{"properties":{"currency":{"type":"string","title":"Currency","description":"The `currency` prop as sent, not validated and never converted. Empty for the orders whose `value` came without a `currency`"},"value":{"type":"number","title":"Value","description":"Sum of the order values, each order counted once"},"order_count":{"type":"integer","title":"Order Count","description":"Orders whose `value` prop reads as a number"},"average_order_value":{"title":"Average Order Value","description":"`value` over `order_count`, the mean value of one order in this currency. Absent where `order_count` is 0","type":"number"},"revenue_per_visitor":{"title":"Revenue Per Visitor","description":"`value` over the visitors of the same window or bucket, the `visitors_total` of `POST /analytics/funnels/checkout` and the `visitors` of its buckets: the conversion rate's denominator. Absent where that denominator is not measured or is 0, and on a sampled application an estimate, as the visitors are","type":"number"}},"type":"object","required":["currency","value","order_count"],"title":"OverviewOrderRevenue","description":"The orders of one currency on the events overview, with the revenue per visitor."},"Ownership":{"type":"string","enum":["first_party","third_party","mixed"],"title":"Ownership","description":"Whose host something was on, by the one registrable-domain rule (§28).\n\nThe same axis as the stored `errors.is_first_party`, `error_origin` and\n`first_party_only`. Whether a third-party failure was blocked or is simply\nbroken is deliberately NOT a value here: a host denylist answers \"is this a\nknown tracker\" when the question is \"was this the visitor's browser\", which\nis a property of a population."},"OwnershipTransferRequest":{"properties":{"new_owner_user_id":{"type":"string","format":"uuid","title":"New Owner User Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"],"description":"An ID, a UUID in lowercase with hyphens."}},"type":"object","required":["new_owner_user_id"],"title":"OwnershipTransferRequest"},"PageSparkline":{"properties":{"page_id":{"type":"string","format":"uuid","title":"Page Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"],"description":"An ID, a UUID in lowercase with hyphens."},"url":{"type":"string","title":"Url"},"run_count":{"type":"integer","title":"Run Count"},"latest_desktop_score":{"title":"Latest Desktop Score","type":"number"},"latest_mobile_score":{"title":"Latest Mobile Score","type":"number"},"series":{"items":{"$ref":"#/components/schemas/SparklinePoint"},"type":"array","title":"Series"}},"type":"object","required":["page_id","url","run_count","series"],"title":"PageSparkline","description":"A page's overview: total run count + recent per-run scores for a mini graph,\nplus its latest score per device. Built live from the 1h-cached series."},"PageTypeCatalog":{"properties":{"platform":{"$ref":"#/components/schemas/PageTypeCatalogPlatform"},"groups":{"items":{"$ref":"#/components/schemas/PageTypeCatalogGroup"},"type":"array","title":"Groups","description":"Every group, in display order, including the empty ones."}},"type":"object","required":["platform","groups"],"title":"PageTypeCatalog","description":"What page types a platform produces, grouped for a layout."},"PageTypeCatalogEntry":{"properties":{"key":{"type":"string","title":"Key","description":"The page type as stored and filtered on, byte for byte what the collector writes."},"label":{"type":"string","title":"Label","description":"The platform's own word for the page type: on Shopify the template name, equal to `key`, elsewhere in English."}},"type":"object","required":["key","label"],"title":"PageTypeCatalogEntry","description":"One page type a platform produces."},"PageTypeCatalogGroup":{"properties":{"key":{"$ref":"#/components/schemas/PageTypeGroup","description":"The layout group. A stored page type that is not in the platform's catalog belongs to `other`."},"label":{"type":"string","title":"Label","description":"Display name of the group, in English."},"page_types":{"items":{"$ref":"#/components/schemas/PageTypeCatalogEntry"},"type":"array","title":"Page Types","description":"The platform's page types in this group, in display order. May be empty."}},"type":"object","required":["key","label","page_types"],"title":"PageTypeCatalogGroup","description":"One group of the layout, with the platform's page types that belong to it."},"PageTypeCatalogPlatform":{"properties":{"key":{"type":"string","title":"Key","description":"Key from the platform list, as `platform.key` of an application."},"label":{"type":"string","title":"Label","description":"The platform's product name."}},"type":"object","required":["key","label"],"title":"PageTypeCatalogPlatform","description":"The platform a catalog belongs to."},"PageTypeDetectionResponse":{"properties":{"url":{"type":"string","title":"Url","description":"The page that was probed."},"final_url":{"type":"string","title":"Final Url","description":"Where it ended up after redirects.","default":""},"status_code":{"type":"integer","title":"Status Code","description":"HTTP status the probe saw.","default":0},"detected_ruleset":{"type":"string","title":"Detected Ruleset","description":"Inferred shop system, '' when nothing was recognised. May name a system that is not a selectable ruleset, e.g. 'shopify'.","default":""},"ruleset_supported":{"type":"boolean","title":"Ruleset Supported","description":"Whether `detected_ruleset` is a valid `pagetype_ruleset` value.","default":false},"matched_via":{"type":"string","title":"Matched Via","description":"Evidence: 'header:x-shopid', 'body_class:is-ctl-navigation', 'generator:…'.","default":""},"page_type":{"type":"string","title":"Page Type","description":"page_type of the probed page under the detected ruleset. The home page, so 'home' is the expected answer and anything else is a hint that the theme renames classes.","default":""},"body_classes":{"items":{"type":"string"},"type":"array","title":"Body Classes","description":"Classes found on the page's `<body>`."},"generators":{"items":{"type":"string"},"type":"array","title":"Generators","description":"`<meta name=\"generator\">` values."}},"type":"object","required":["url","final_url","status_code","detected_ruleset","ruleset_supported","matched_via","page_type","body_classes","generators"],"title":"PageTypeDetectionResponse","description":"What a shop-system probe found on the application's own home page.\n\nDetection only. Nothing is written: the caller decides whether to PATCH\n`pagetype_ruleset` with `detected_ruleset`, and may only do so when\n`ruleset_supported` is true."},"PageTypeDiscoverCandidate":{"properties":{"page_type":{"type":"string","title":"Page Type"},"body_classes":{"items":{"type":"string"},"type":"array","title":"Body Classes","description":"Classes on every page of this type and on no other page read."}},"type":"object","required":["page_type","body_classes"],"title":"PageTypeDiscoverCandidate","description":"The classes that would identify one page type, and how sure that is."},"PageTypeDiscoverPage":{"properties":{"url":{"type":"string","maxLength":2048,"title":"Url","description":"Absolute https URL on one of the application's own domains."},"page_type":{"type":"string","maxLength":64,"title":"Page Type","description":"What this page is, from the fixed page-type enum."}},"type":"object","required":["url","page_type"],"title":"PageTypeDiscoverPage","description":"One page the customer labelled: where it is and what kind of page it is."},"PageTypeDiscoverPageResult":{"properties":{"url":{"type":"string","title":"Url"},"page_type":{"type":"string","title":"Page Type","description":"Empty on the baseline page, which carries no label.","default":""},"read":{"type":"boolean","title":"Read","description":"False when the page could not be fetched in time."},"status_code":{"type":"integer","title":"Status Code","description":"HTTP status of the fetch, 0 when it never happened.","default":0},"body_classes":{"items":{"type":"string"},"type":"array","title":"Body Classes"}},"type":"object","required":["url","read","page_type","status_code","body_classes"],"title":"PageTypeDiscoverPageResult","description":"What reading one page produced."},"PageTypeDiscoverRequest":{"properties":{"pages":{"items":{"$ref":"#/components/schemas/PageTypeDiscoverPage"},"type":"array","maxItems":4,"minItems":1,"title":"Pages"}},"additionalProperties":false,"type":"object","required":["pages"],"title":"PageTypeDiscoverRequest","description":"Ask for rule proposals from a handful of labelled pages.\n\nEvery URL has to sit on a domain of this application. The endpoint makes the\nserver fetch what it is given, so the customer's own domains are the whole\ntarget set; only the path is theirs to choose."},"PageTypeDiscoverResponse":{"properties":{"rules":{"items":{"$ref":"#/components/schemas/PageTypeRule"},"type":"array","title":"Rules","description":"The confident subset, ready to PATCH as `pagetype_rules`: one page type, exactly one class. A type with several candidates or none is left out and appears under `candidates` instead."},"candidates":{"items":{"$ref":"#/components/schemas/PageTypeDiscoverCandidate"},"type":"array","title":"Candidates","description":"Every labelled page type and what was found for it."},"pages":{"items":{"$ref":"#/components/schemas/PageTypeDiscoverPageResult"},"type":"array","title":"Pages","description":"Every page read, the baseline included."}},"type":"object","title":"PageTypeDiscoverResponse","description":"Proposals only. Writing them is a separate PATCH the customer confirms.","required":["rules","candidates","pages"]},"PageTypeGroup":{"type":"string","enum":["entry","browse","search","product","funnel","account","content","other"],"title":"PageTypeGroup","description":"The layer across platforms that a layout draws, in display order."},"PageTypeInput":{"properties":{"body_class":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Body Class","description":"Read the page type from the body classes, with the platform's ruleset."},"rules":{"anyOf":[{"items":{"$ref":"#/components/schemas/PageTypeRule"},"type":"array"},{"type":"null"}],"title":"Rules","description":"Own body classes and the page type each one stands for, applied in front of the ruleset. Replaces the whole list."},"url_rules":{"anyOf":[{"items":{"$ref":"#/components/schemas/PageTypeUrlRule"},"type":"array"},{"type":"null"}],"title":"Url Rules","description":"Own URL patterns and the page type each one stands for, the first match wins. Applied after the own body classes and before the ruleset. At most 10. Replaces the whole list."}},"additionalProperties":false,"type":"object","title":"PageTypeInput"},"PageTypeResponse":{"properties":{"body_class":{"type":"boolean","title":"Body Class","description":"Read the page type from the body classes, with the platform's ruleset."},"ruleset":{"type":"string","title":"Ruleset","description":"The platform when `body_class` is on and the platform has a ruleset, else an empty string. Derived."},"rules":{"title":"Rules","description":"Own body classes, applied in front of the ruleset. Absent when none.","items":{"$ref":"#/components/schemas/PageTypeRule"},"type":"array"},"url_rules":{"title":"Url Rules","description":"Own URL patterns in match order, applied after the own body classes and before the ruleset. Absent when none.","items":{"$ref":"#/components/schemas/PageTypeUrlRule"},"type":"array"}},"type":"object","required":["body_class","ruleset"],"title":"PageTypeResponse"},"PageTypeRule":{"properties":{"body_class":{"type":"string","maxLength":64,"title":"Body Class","description":"The class on the page's `<body>`."},"page_type":{"type":"string","maxLength":64,"title":"Page Type","description":"The page type that class stands for."}},"type":"object","required":["body_class","page_type"],"title":"PageTypeRule","description":"One customer-defined body class and the page type it stands for."},"PageTypeSource":{"properties":{"key":{"$ref":"#/components/schemas/PageTypeSourceKey"},"label":{"type":"string","title":"Label","description":"Display name of the source, in English."},"entries":{"items":{"$ref":"#/components/schemas/PageTypeSourceEntry"},"type":"array","title":"Entries","description":"What the source matches on, in the order the collector tries it."}},"type":"object","required":["key","label","entries"],"title":"PageTypeSource","description":"One source of the page type with everything it matches on."},"PageTypeSourceEntry":{"properties":{"key":{"title":"Key","description":"`server_timing`: a Server-Timing key whose `desc` is the page type, lowercase. `meta_tag`: the `name` of a meta tag whose `content` is the page type.","type":"string"},"body_class":{"title":"Body Class","description":"`rules` and `ruleset`: the body-class token that matches exactly.","type":"string"},"body_class_prefix":{"title":"Body Class Prefix","description":"`ruleset`: every body-class token starting with this matches.","type":"string"},"pattern":{"title":"Pattern","description":"`url_rules` and `checkout_paths`: the URL pattern, in the syntax of the checkout paths.","type":"string"},"route":{"title":"Route","description":"`platform_routes`: the path the platform fixes, `{handle}` standing for one segment. A locale prefix such as `/de` or `/en-de` may come first and a trailing `/` may follow. A platform that names the page in a query key lists `?key=value` instead, as OXID's `?cl=thankyou`, on any path.","type":"string"},"checkout_stage":{"description":"`checkout_paths`: the stage the pattern marks. `platform_routes`: the stage the route marks when no checkout path matched, while checkout tracking is on and that stage has no own path list.","$ref":"#/components/schemas/CheckoutStage"},"page_type":{"title":"Page Type","description":"The page type a match stores. Absent on `server_timing` and `meta_tag`, where the value is stored as sent.","type":"string"}},"type":"object","title":"PageTypeSourceEntry","description":"One thing a source matches on. Only the fields that source uses are present."},"PageTypeSourceKey":{"type":"string","enum":["server_timing","meta_tag","rules","url_rules","ruleset","platform_routes","checkout_paths"],"title":"PageTypeSourceKey","description":"One source of the page type, named after the setting that feeds it (§28)."},"PageTypeSources":{"properties":{"sources":{"items":{"$ref":"#/components/schemas/PageTypeSource"},"type":"array","title":"Sources","description":"The sources this application has, in precedence order: the first one that yields a page type wins. A source without configuration is left out."}},"type":"object","required":["sources"],"title":"PageTypeSources","description":"What the collector reads a page type from for this application right now."},"PageTypeUrlRule":{"properties":{"pattern":{"type":"string","maxLength":200,"title":"Pattern","description":"URL pattern matched against the whole lowercased path, in a subset of the URLPattern pathname syntax. `*` matches any characters including `/`, `:name` one path segment, `(a|b)` one of the listed words and `{...}?` an optional part, as in `{/}?` for an optional trailing slash. Everything else is literal, a `?` after a plain character or `*` included, and regex is not supported. A pattern with such a `?` matches path and kept query together, one without it ignores the query. At most one part can match in more than one way."},"page_type":{"type":"string","maxLength":64,"title":"Page Type","description":"The page type a matching URL stands for."}},"type":"object","required":["pattern","page_type"],"title":"PageTypeUrlRule","description":"One customer-defined URL pattern and the page type it stands for."},"PaginatedResponse_ApiKeyInfo_":{"properties":{"data":{"items":{"$ref":"#/components/schemas/ApiKeyInfo"},"type":"array","title":"Data"},"meta":{"$ref":"#/components/schemas/PaginationMeta"}},"type":"object","required":["data","meta"],"title":"PaginatedResponse[ApiKeyInfo]"},"PaginatedResponse_ApplicationResponse_":{"properties":{"data":{"items":{"$ref":"#/components/schemas/ApplicationResponse"},"type":"array","title":"Data"},"meta":{"$ref":"#/components/schemas/PaginationMeta"}},"type":"object","required":["data","meta"],"title":"PaginatedResponse[ApplicationResponse]"},"PaginatedResponse_AuditLogEntry_":{"properties":{"data":{"items":{"$ref":"#/components/schemas/AuditLogEntry"},"type":"array","title":"Data"},"meta":{"$ref":"#/components/schemas/PaginationMeta"}},"type":"object","required":["data","meta"],"title":"PaginatedResponse[AuditLogEntry]"},"PaginatedResponse_ChannelResponse_":{"properties":{"data":{"items":{"$ref":"#/components/schemas/ChannelResponse"},"type":"array","title":"Data"},"meta":{"$ref":"#/components/schemas/PaginationMeta"}},"type":"object","required":["data","meta"],"title":"PaginatedResponse[ChannelResponse]"},"PaginatedResponse_ConnectionInfo_":{"properties":{"data":{"items":{"$ref":"#/components/schemas/ConnectionInfo"},"type":"array","title":"Data"},"meta":{"$ref":"#/components/schemas/PaginationMeta"}},"type":"object","required":["data","meta"],"title":"PaginatedResponse[ConnectionInfo]"},"PaginatedResponse_ErrorAcknowledgementResponse_":{"properties":{"data":{"items":{"$ref":"#/components/schemas/ErrorAcknowledgementResponse"},"type":"array","title":"Data"},"meta":{"$ref":"#/components/schemas/PaginationMeta"}},"type":"object","required":["data","meta"],"title":"PaginatedResponse[ErrorAcknowledgementResponse]"},"PaginatedResponse_InviteResponse_":{"properties":{"data":{"items":{"$ref":"#/components/schemas/InviteResponse"},"type":"array","title":"Data"},"meta":{"$ref":"#/components/schemas/PaginationMeta"}},"type":"object","required":["data","meta"],"title":"PaginatedResponse[InviteResponse]"},"PaginatedResponse_MemberResponse_":{"properties":{"data":{"items":{"$ref":"#/components/schemas/MemberResponse"},"type":"array","title":"Data"},"meta":{"$ref":"#/components/schemas/PaginationMeta"}},"type":"object","required":["data","meta"],"title":"PaginatedResponse[MemberResponse]"},"PaginatedResponse_ObservationResponse_":{"properties":{"data":{"items":{"$ref":"#/components/schemas/ObservationResponse"},"type":"array","title":"Data"},"meta":{"$ref":"#/components/schemas/PaginationMeta"}},"type":"object","required":["data","meta"],"title":"PaginatedResponse[ObservationResponse]"},"PaginatedResponse_ObservationSubscriptionResponse_":{"properties":{"data":{"items":{"$ref":"#/components/schemas/ObservationSubscriptionResponse"},"type":"array","title":"Data"},"meta":{"$ref":"#/components/schemas/PaginationMeta"}},"type":"object","required":["data","meta"],"title":"PaginatedResponse[ObservationSubscriptionResponse]"},"PaginatedResponse_OrganizationResponse_":{"properties":{"data":{"items":{"$ref":"#/components/schemas/OrganizationResponse"},"type":"array","title":"Data"},"meta":{"$ref":"#/components/schemas/PaginationMeta"}},"type":"object","required":["data","meta"],"title":"PaginatedResponse[OrganizationResponse]"},"PaginatedResponse_PartnerAccessResponse_":{"properties":{"data":{"items":{"$ref":"#/components/schemas/PartnerAccessResponse"},"type":"array","title":"Data"},"meta":{"$ref":"#/components/schemas/PaginationMeta"}},"type":"object","required":["data","meta"],"title":"PaginatedResponse[PartnerAccessResponse]"},"PaginatedResponse_PartnerClientResponse_":{"properties":{"data":{"items":{"$ref":"#/components/schemas/PartnerClientResponse"},"type":"array","title":"Data"},"meta":{"$ref":"#/components/schemas/PaginationMeta"}},"type":"object","required":["data","meta"],"title":"PaginatedResponse[PartnerClientResponse]"},"PaginatedResponse_ReleaseResponse_":{"properties":{"data":{"items":{"$ref":"#/components/schemas/ReleaseResponse"},"type":"array","title":"Data"},"meta":{"$ref":"#/components/schemas/PaginationMeta"}},"type":"object","required":["data","meta"],"title":"PaginatedResponse[ReleaseResponse]"},"PaginatedResponse_RuleResponse_":{"properties":{"data":{"items":{"$ref":"#/components/schemas/RuleResponse"},"type":"array","title":"Data"},"meta":{"$ref":"#/components/schemas/PaginationMeta"}},"type":"object","required":["data","meta"],"title":"PaginatedResponse[RuleResponse]"},"PaginatedResponse_RuleSendResponse_":{"properties":{"data":{"items":{"$ref":"#/components/schemas/RuleSendResponse"},"type":"array","title":"Data"},"meta":{"$ref":"#/components/schemas/PaginationMeta"}},"type":"object","required":["data","meta"],"title":"PaginatedResponse[RuleSendResponse]"},"PaginatedResponse_SiteResponse_":{"properties":{"data":{"items":{"$ref":"#/components/schemas/SiteResponse"},"type":"array","title":"Data"},"meta":{"$ref":"#/components/schemas/PaginationMeta"}},"type":"object","required":["data","meta"],"title":"PaginatedResponse[SiteResponse]"},"PaginatedResponse_SyntheticPageListItem_":{"properties":{"data":{"items":{"$ref":"#/components/schemas/SyntheticPageListItem"},"type":"array","title":"Data"},"meta":{"$ref":"#/components/schemas/PaginationMeta"}},"type":"object","required":["data","meta"],"title":"PaginatedResponse[SyntheticPageListItem]"},"PaginationMeta":{"properties":{"total":{"type":"integer","title":"Total"},"limit":{"type":"integer","title":"Limit"},"offset":{"type":"integer","title":"Offset"},"has_more":{"type":"boolean","title":"Has More"}},"type":"object","required":["total","limit","offset","has_more"],"title":"PaginationMeta"},"PartnerAccessResponse":{"properties":{"partner_org_id":{"type":"string","format":"uuid","title":"Partner Org Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"],"description":"An ID, a UUID in lowercase with hyphens."},"partner_org_name":{"type":"string","title":"Partner Org Name"},"billing":{"type":"boolean","title":"Billing","description":"Whether this partner pays for this organization: it covers a feature or pageviews."},"covered_features":{"items":{"$ref":"#/components/schemas/Feature"},"type":"array","title":"Covered Features","description":"The features this partner covers for this organization."},"included_pageviews":{"title":"Included Pageviews","description":"The pageviews per month this partner covers for this organization. Absent where unlimited.","type":"integer"},"created_at":{"type":"string","format":"date-time","title":"Created At","examples":["2026-04-14T09:50:01Z"],"description":"ISO 8601 in UTC with a `Z` suffix."}},"type":"object","required":["partner_org_id","partner_org_name","billing","covered_features","created_at"],"title":"PartnerAccessResponse","description":"A partner organization that has access to this (client) org.\n\nThe client-side view of the `partners` relationship - \"who manages us\" -\nas opposed to PartnerClientResponse, which is the partner's view of \"our\nclients\". Lets a client org see, and decide to revoke, the partner access\ngranted over it."},"PartnerClientCreate":{"properties":{"name":{"type":"string","maxLength":128,"minLength":1,"title":"Name","description":"Name of the new client organization"},"billing":{"type":"boolean","title":"Billing","description":"Whether this partner pays for the client. Without `covered_features` and `included_pageviews` true covers what the contract allows and false covers nothing. Each of the two given replaces that default.","default":false},"covered_features":{"anyOf":[{"items":{"$ref":"#/components/schemas/Feature"},"type":"array"},{"type":"null"}],"title":"Covered Features","description":"The features this partner covers for the client, within its contract."},"included_pageviews":{"anyOf":[{"type":"integer","minimum":0.0},{"type":"null"}],"title":"Included Pageviews","description":"The pageviews per month this partner covers for the client, within its contract. `null` for unlimited, allowed only while the contract is unlimited."},"owner_email":{"anyOf":[{"type":"string","format":"email"},{"type":"null"}],"title":"Owner Email","description":"Optional: invite this email as OWNER of the new client org. Sends an invite email; on accept the customer takes ownership. Omit to keep the org partner-managed (headless)."}},"additionalProperties":false,"type":"object","required":["name"],"title":"PartnerClientCreate","description":"Create a new organization and link it to this partner as a client.\n\nSelf-service counterpart to the admin-only link endpoint\n(`POST /admin/partners`, which attaches an *existing* org)."},"PartnerClientResponse":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"],"description":"An ID, a UUID in lowercase with hyphens."},"partner_org_id":{"type":"string","format":"uuid","title":"Partner Org Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"],"description":"An ID, a UUID in lowercase with hyphens."},"client_org_id":{"type":"string","format":"uuid","title":"Client Org Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"],"description":"An ID, a UUID in lowercase with hyphens."},"client_org_name":{"type":"string","title":"Client Org Name"},"billing":{"type":"boolean","title":"Billing","description":"Whether this partner pays for the client: it covers a feature or pageviews."},"covered_features":{"items":{"$ref":"#/components/schemas/Feature"},"type":"array","title":"Covered Features","description":"The features this partner covers for the client, capped by its contract."},"included_pageviews":{"title":"Included Pageviews","description":"The pageviews per month this partner covers for the client, capped by its contract. Absent where unlimited.","type":"integer"},"created_at":{"type":"string","format":"date-time","title":"Created At","examples":["2026-04-14T09:50:01Z"],"description":"ISO 8601 in UTC with a `Z` suffix."}},"type":"object","required":["id","partner_org_id","client_org_id","client_org_name","billing","covered_features","created_at"],"title":"PartnerClientResponse","description":"A partner-client relationship."},"PartnerClientUpdate":{"properties":{"covered_features":{"anyOf":[{"items":{"$ref":"#/components/schemas/Feature"},"type":"array"},{"type":"null"}],"title":"Covered Features","description":"The features this partner covers for the client, within its contract."},"included_pageviews":{"anyOf":[{"type":"integer","minimum":0.0},{"type":"null"}],"title":"Included Pageviews","description":"The pageviews per month this partner covers for the client, within its contract. `null` for unlimited, allowed only while the contract is unlimited."}},"additionalProperties":false,"type":"object","title":"PartnerClientUpdate","description":"Change what a partner covers for one client. A field left out keeps its value."},"PartnerClientUsage":{"properties":{"organization_id":{"type":"string","format":"uuid","title":"Organization Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"],"description":"An ID, a UUID in lowercase with hyphens."},"organization_name":{"type":"string","title":"Organization Name"},"pageview_count":{"type":"integer","title":"Pageview Count","description":"Pageviews of the client over the window"}},"type":"object","required":["organization_id","organization_name","pageview_count"],"title":"PartnerClientUsage","description":"Usage for a single client org."},"PartnerContractResponse":{"properties":{"covered_features":{"items":{"$ref":"#/components/schemas/Feature"},"type":"array","title":"Covered Features","description":"The features it may cover."},"included_pageviews":{"title":"Included Pageviews","description":"The pageviews per client and month it may cover. Absent where unlimited.","type":"integer"}},"type":"object","required":["covered_features"],"title":"PartnerContractResponse","description":"The most a partner may cover per client, as fastmon sold it."},"PartnerLiveClient":{"properties":{"pageviews":{"type":"integer","title":"Pageviews","description":"Pageviews started in the window, bots left out"},"visitors":{"type":"integer","title":"Visitors","description":"Distinct visitors with a pageview or checkout event in the window, bots left out"},"purchases":{"type":"integer","title":"Purchases","description":"Distinct visitors with a success-stage event in the window, bots left out. Counted from the events alone, so a client without stage events shows 0. The same rows `recent_purchases` lists"},"bot_visitors":{"type":"integer","title":"Bot Visitors","description":"Distinct visitors of class `bot` in the window, not in `visitors`"},"order_revenue":{"items":{"$ref":"#/components/schemas/EventOrderRevenue"},"type":"array","title":"Order Revenue","description":"Per `currency` prop as sent, never converted, the money of the orders in the window, bots left out, most orders first. Empty when no order carried a `value`. `order_count` can be below `purchases`: purchases count buyers, this counts the orders with a value"},"cart_visitors":{"type":"integer","title":"Cart Visitors","description":"Visitors whose newest pageview in the window is in the cart, bots left out, as the floor places them"},"checkout_visitors":{"type":"integer","title":"Checkout Visitors","description":"Visitors whose newest pageview or checkout event in the window is in the checkout, bots left out, as the floor places them"},"previous_period":{"$ref":"#/components/schemas/PartnerLiveTrafficCounts","description":"The same length before the window. Counted like the window up to 1800, weighted from the finalized pageviews at 3600"},"previous_week":{"$ref":"#/components/schemas/PartnerLiveTrafficCounts","description":"The same window seven days earlier, weighted from the finalized pageviews"},"today":{"$ref":"#/components/schemas/PartnerLiveDay","description":"Since 00:00 in the request's `timezone`, in UTC without it"},"organization_id":{"type":"string","format":"uuid","title":"Organization Id","description":"The client organization","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"organization_name":{"type":"string","title":"Organization Name","description":"Its name"},"platform":{"description":"The platform of the client's active applications, absent where they name different ones or none","$ref":"#/components/schemas/PageTypeCatalogPlatform"},"pageviews_per_second":{"type":"number","title":"Pageviews Per Second","description":"`pageviews` over the length of the window"},"p75_lcp_ms":{"title":"P75 Lcp Ms","description":"75th percentile of the pageviews' LCP over the last 30 minutes, bots left out, absent without a sample","type":"integer"},"sample_count":{"type":"integer","title":"Sample Count","description":"Pageviews of the last 30 minutes that reported an LCP, bots left out. On a sampled application only the kept visitors report one"},"share":{"type":"number","title":"Share","description":"The client's pageviews of the last 60 minutes over the partner's, 0..1, bots left out"},"site_count":{"type":"integer","title":"Site Count","description":"Live sites of the client: active, activated and on an active production application. At least 1, since a client without one is not on the floor"},"is_stitchless":{"type":"boolean","title":"Is Stitchless","description":"True when the client has active sites and none of them stores the stitch, so it has no visitors by construction"},"last_seen_at":{"title":"Last Seen At","description":"Receive time of the client's newest beacon in the last three hours, absent without one. Bot beacons count only where `filters.bot_class` asks for `bot`","examples":["2026-04-14T09:50:01Z"],"type":"string","format":"date-time"},"sampling":{"$ref":"#/components/schemas/SamplingMeta","description":"Sampling configured for the client's applications. `estimated_metrics` names the estimates of this row, relative to the row"}},"type":"object","required":["pageviews","visitors","purchases","bot_visitors","order_revenue","cart_visitors","checkout_visitors","previous_period","previous_week","today","organization_id","organization_name","pageviews_per_second","sample_count","share","site_count","is_stitchless","sampling"],"title":"PartnerLiveClient","description":"One client organization of the partner on the floor."},"PartnerLiveDay":{"properties":{"visitors":{"type":"integer","title":"Visitors","description":"Distinct visitors in the window, bots left out"},"purchases":{"type":"integer","title":"Purchases","description":"Distinct visitors with a success-stage event in the window, bots left out. Counted from the events alone, so a client without stage events shows 0"},"order_revenue":{"items":{"$ref":"#/components/schemas/EventOrderRevenue"},"type":"array","title":"Order Revenue","description":"Per `currency` prop as sent, never converted, the money of the orders in the window, bots left out, most orders first. Empty when no order carried a `value`. `order_count` can be below `purchases`: purchases count buyers, this counts the orders with a value"},"time_range":{"$ref":"#/components/schemas/TimeRange","description":"The window the counts cover, in UTC"},"previous_week":{"$ref":"#/components/schemas/PartnerLivePreviousWeekDay","description":"The same weekday 7 days ago, from its midnight in `timezone` to the same wall-clock time as now, and complete"}},"type":"object","required":["visitors","purchases","order_revenue","time_range","previous_week"],"title":"PartnerLiveDay","description":"Visitors and buyers since 00:00 in the request's `timezone`, next to last week."},"PartnerLiveDayCounts":{"properties":{"visitors":{"type":"integer","title":"Visitors","description":"Distinct visitors in the window, bots left out"},"purchases":{"type":"integer","title":"Purchases","description":"Distinct visitors with a success-stage event in the window, bots left out. Counted from the events alone, so a client without stage events shows 0"},"order_revenue":{"items":{"$ref":"#/components/schemas/EventOrderRevenue"},"type":"array","title":"Order Revenue","description":"Per `currency` prop as sent, never converted, the money of the orders in the window, bots left out, most orders first. Empty when no order carried a `value`. `order_count` can be below `purchases`: purchases count buyers, this counts the orders with a value"},"time_range":{"$ref":"#/components/schemas/TimeRange","description":"The window the counts cover, in UTC"}},"type":"object","required":["visitors","purchases","order_revenue","time_range"],"title":"PartnerLiveDayCounts","description":"Visitors and buyers over one window of a day, its purchases from the events alone."},"PartnerLiveFilters":{"properties":{"bot_class":{"anyOf":[{"items":{"$ref":"#/components/schemas/BotClass"},"type":"array"},{"type":"null"}],"title":"Bot Class","description":"Traffic classes. Without it every class is served"}},"additionalProperties":false,"type":"object","title":"PartnerLiveFilters","description":"The one live filter that means the same in every client's shop."},"PartnerLivePreviousWeekDay":{"properties":{"visitors":{"type":"integer","title":"Visitors","description":"Distinct visitors in the window, bots left out"},"purchases":{"type":"integer","title":"Purchases","description":"Distinct visitors with a success-stage event in the window, bots left out. Counted from the events alone, so a client without stage events shows 0"},"order_revenue":{"items":{"$ref":"#/components/schemas/EventOrderRevenue"},"type":"array","title":"Order Revenue","description":"Per `currency` prop as sent, never converted, the money of the orders in the window, bots left out, most orders first. Empty when no order carried a `value`. `order_count` can be below `purchases`: purchases count buyers, this counts the orders with a value"},"time_range":{"$ref":"#/components/schemas/TimeRange","description":"The window the counts cover, in UTC"},"whole_day":{"$ref":"#/components/schemas/PartnerLiveDayCounts","description":"That day complete, from its midnight in `timezone` to the next. 23 or 25 hours long across a DST switch"}},"type":"object","required":["visitors","purchases","order_revenue","time_range","whole_day"],"title":"PartnerLivePreviousWeekDay","description":"The same weekday 7 days earlier, up to now's wall-clock time and complete."},"PartnerLivePurchase":{"properties":{"organization_id":{"type":"string","format":"uuid","title":"Organization Id","description":"The client organization","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"received_at":{"type":"string","format":"date-time","title":"Received At","description":"When the event reached the collector","examples":["2026-04-14T09:50:01Z"]},"device_type":{"description":"Device class, absent where it could not be derived","$ref":"#/components/schemas/DeviceType"},"country":{"title":"Country","description":"ISO country code, absent when unknown","type":"string"},"value":{"title":"Value","description":"The order's value: the largest finite `value` among the success events of its pageview, as `order_revenue` counts it. Absent when none carried one","type":"number"},"currency":{"title":"Currency","description":"The `currency` prop of that value as sent, never converted, absent with `value`. Empty when the value came without a currency","type":"string"}},"type":"object","required":["organization_id","received_at"],"title":"PartnerLivePurchase","description":"One order of a client, as its success event arrived."},"PartnerLiveRequest":{"properties":{"filters":{"$ref":"#/components/schemas/PartnerLiveFilters","description":"Optional filters. Country, device and page type mean different things across shops and are refused"},"window_seconds":{"$ref":"#/components/schemas/LiveWindow","description":"Length of the window the traffic counts, which ends now. `p75_lcp_ms` and `share` keep their own","default":300},"timezone":{"anyOf":[{"type":"string","maxLength":64},{"type":"null"}],"title":"Timezone","description":"IANA time zone whose midnight starts `today`, such as `Europe/Berlin`. Without it the day starts at 00:00 UTC"}},"additionalProperties":false,"type":"object","title":"PartnerLiveRequest","description":"The window and the day of the partner floor."},"PartnerLiveResponse":{"properties":{"meta":{"$ref":"#/components/schemas/LiveMeta","description":"Facts about the result"},"request":{"$ref":"#/components/schemas/AnalyticsRequestEcho","description":"The request as the server resolved it"},"data":{"items":{"$ref":"#/components/schemas/PartnerLiveClient"},"type":"array","title":"Data","description":"One row per live client organization, by `organization_name` and then `organization_id`, so a row keeps its place between polls"},"data_total":{"$ref":"#/components/schemas/PartnerLiveTotal","description":"The counts over the listed clients, the windows compared with included. The stitch is per site, so a visitor on two sites counts twice"},"recent_purchases":{"items":{"$ref":"#/components/schemas/PartnerLivePurchase"},"type":"array","title":"Recent Purchases","description":"The newest order of each buyer of all clients in the window, newest first, at most 20, bots left out"}},"type":"object","required":["meta","request","data","data_total","recent_purchases"],"title":"PartnerLiveResponse","description":"Every client of a partner on one floor, each with its own figures."},"PartnerLiveTotal":{"properties":{"pageviews":{"type":"integer","title":"Pageviews","description":"Pageviews started in the window, bots left out"},"visitors":{"type":"integer","title":"Visitors","description":"Distinct visitors with a pageview or checkout event in the window, bots left out"},"purchases":{"type":"integer","title":"Purchases","description":"Distinct visitors with a success-stage event in the window, bots left out. Counted from the events alone, so a client without stage events shows 0. The same rows `recent_purchases` lists"},"bot_visitors":{"type":"integer","title":"Bot Visitors","description":"Distinct visitors of class `bot` in the window, not in `visitors`"},"order_revenue":{"items":{"$ref":"#/components/schemas/EventOrderRevenue"},"type":"array","title":"Order Revenue","description":"Per `currency` prop as sent, never converted, the money of the orders in the window, bots left out, most orders first. Empty when no order carried a `value`. `order_count` can be below `purchases`: purchases count buyers, this counts the orders with a value"},"cart_visitors":{"type":"integer","title":"Cart Visitors","description":"Visitors whose newest pageview in the window is in the cart, bots left out, as the floor places them"},"checkout_visitors":{"type":"integer","title":"Checkout Visitors","description":"Visitors whose newest pageview or checkout event in the window is in the checkout, bots left out, as the floor places them"},"previous_period":{"$ref":"#/components/schemas/PartnerLiveTrafficCounts","description":"The same length before the window. Counted like the window up to 1800, weighted from the finalized pageviews at 3600"},"previous_week":{"$ref":"#/components/schemas/PartnerLiveTrafficCounts","description":"The same window seven days earlier, weighted from the finalized pageviews"},"today":{"$ref":"#/components/schemas/PartnerLiveDay","description":"Since 00:00 in the request's `timezone`, in UTC without it"},"client_count":{"type":"integer","title":"Client Count","description":"Client organizations on the floor"}},"type":"object","required":["pageviews","visitors","purchases","bot_visitors","order_revenue","cart_visitors","checkout_visitors","previous_period","previous_week","today","client_count"],"title":"PartnerLiveTotal","description":"Every client of the partner together."},"PartnerLiveTrafficCounts":{"properties":{"pageviews":{"type":"integer","title":"Pageviews","description":"Pageviews started in the window, bots left out"},"visitors":{"type":"integer","title":"Visitors","description":"Distinct visitors with a pageview or checkout event in the window, bots left out"},"purchases":{"type":"integer","title":"Purchases","description":"Distinct visitors with a success-stage event in the window, bots left out. Counted from the events alone, so a client without stage events shows 0"},"bot_visitors":{"type":"integer","title":"Bot Visitors","description":"Distinct visitors of class `bot` in the window, not in `visitors`"},"order_revenue":{"items":{"$ref":"#/components/schemas/EventOrderRevenue"},"type":"array","title":"Order Revenue","description":"Per `currency` prop as sent, never converted, the money of the orders in the window, bots left out, most orders first. Empty when no order carried a `value`. `order_count` can be below `purchases`: purchases count buyers, this counts the orders with a value"}},"type":"object","required":["pageviews","visitors","purchases","bot_visitors","order_revenue"],"title":"PartnerLiveTrafficCounts","description":"One window the partner floor compares with, its purchases from the events alone."},"PartnerUsageResponse":{"properties":{"pageview_count":{"type":"integer","title":"Pageview Count","description":"Pageviews counted over the window, all clients, unweighted, bots included"},"time_range":{"$ref":"#/components/schemas/TimeRange","description":"The window counted: the start of the calendar month to now"},"clients":{"items":{"$ref":"#/components/schemas/PartnerClientUsage"},"type":"array","title":"Clients"}},"type":"object","required":["pageview_count","time_range","clients"],"title":"PartnerUsageResponse","description":"Aggregated usage across all partner clients."},"Plan":{"type":"string","enum":["none","free","one","partner","enterprise"],"title":"Plan","description":"Subscription plan for organization.\n\nNONE is the starting state and means exactly what it says: nobody has chosen\nanything yet. It deliberately is not the paid plan: defaulting to a tariff\nshowed a brand-new organization something it never picked and conflated two\ndifferent questions, \"what did the customer buy\" and \"what feature level\napplies\". An org leaves NONE by exactly three routes: an approval starts its\ntrial, a checkout buys a plan, or a partner provisions it.\n\nONE is the only plan a customer can buy, sold as \"fastmon One\". The value\nmatches the product name deliberately: one word in the database, the API and\nthe invoice beats a mapping everyone has to remember. The cost is that the\nnext product rename is a migration and an API break, which is the trade that\nwas chosen when `standard` was retired here."},"PlatformInput":{"properties":{"key":{"type":"string","maxLength":24,"title":"Key","description":"Key from the platform list, empty string for unknown. A value set here is never replaced by detection."}},"additionalProperties":false,"type":"object","required":["key"],"title":"PlatformInput"},"PlatformResponse":{"properties":{"key":{"type":"string","title":"Key","description":"Key from the platform list, empty when unknown.","default":""},"source":{"$ref":"#/components/schemas/PlatformSource","description":"`manual` when a user or an integration set it. Detection never replaces that.","default":"detected"},"detected_via":{"type":"string","title":"Detected Via","description":"Evidence of the last detection, e.g. `header:x-shopid`.","default":""},"detected_at":{"title":"Detected At","description":"When detection last recognised the platform.","examples":["2026-04-14T09:50:01Z"],"type":"string","format":"date-time"}},"type":"object","title":"PlatformResponse","required":["key","source","detected_via"]},"PlatformSource":{"type":"string","enum":["detected","manual"],"title":"PlatformSource","description":"Who set `Application.platform`. A MANUAL value is never overwritten by\ndetection, a DETECTED one is replaced by the next positive finding."},"PresetResponse":{"properties":{"preset":{"$ref":"#/components/schemas/RulePreset"},"name":{"type":"string","title":"Name"},"description":{"type":"string","title":"Description"},"rule":{"$ref":"#/components/schemas/PresetRule"}},"type":"object","required":["preset","name","description","rule"],"title":"PresetResponse"},"PresetRule":{"properties":{"name":{"type":"string","title":"Name"},"metric":{"type":"string","title":"Metric"},"aggregation":{"$ref":"#/components/schemas/RuleAggregation"},"operator":{"$ref":"#/components/schemas/Operator"},"condition_type":{"$ref":"#/components/schemas/ConditionType"},"threshold":{"type":"number","title":"Threshold"},"window_seconds":{"$ref":"#/components/schemas/RuleWindow"},"baseline_window_seconds":{"$ref":"#/components/schemas/RuleWindow"}},"type":"object","required":["name","metric","aggregation","operator","condition_type","threshold","window_seconds"],"title":"PresetRule","description":"The part of a create body a preset fills in. Scope and targets are the user's."},"ProxySecretResponse":{"properties":{"secret":{"title":"Secret","description":"Secret a first-party beacon proxy presents in `FM-Proxy-Key`. Only for a caller who may change the application, absent when the feature is off.","type":"string"},"redacted":{"type":"boolean","title":"Redacted","description":"True when a secret exists but the caller may not read it."},"previous_set":{"type":"boolean","title":"Previous Set","description":"True while the secret from before the last rotation is still accepted."}},"type":"object","required":["redacted","previous_set"],"title":"ProxySecretResponse"},"QueryGranularityRequest":{"type":"string","enum":["auto","none","minute","five_minutes","fifteen_minutes","hour","six_hours","day","week","month"],"title":"QueryGranularityRequest","description":"The bucket width a caller asks `/analytics/query` for (§28)."},"RedirectKind":{"type":"string","title":"RedirectKind","description":"Which redirects a pageview went through before its document was fetched.","x-extensible-enum":["same_origin","cross_origin","none","not_applicable","unknown"]},"ReferenceUnit":{"type":"string","enum":["share","page_views","milliseconds","days"],"title":"ReferenceUnit","description":"What `reference` is measured in."},"ReleaseCreate":{"properties":{"version":{"type":"string","maxLength":255,"title":"Version"},"released_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Released At","examples":["2026-04-14T09:50:01Z"],"description":"ISO 8601. Send `Z` or an offset."}},"additionalProperties":false,"type":"object","required":["version"],"title":"ReleaseCreate"},"ReleaseResponse":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"],"description":"An ID, a UUID in lowercase with hyphens."},"application_id":{"type":"string","format":"uuid","title":"Application Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"],"description":"An ID, a UUID in lowercase with hyphens."},"organization_id":{"type":"string","format":"uuid","title":"Organization Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"],"description":"An ID, a UUID in lowercase with hyphens."},"version":{"type":"string","title":"Version"},"released_at":{"type":"string","format":"date-time","title":"Released At","examples":["2026-04-14T09:50:01Z"],"description":"ISO 8601 in UTC with a `Z` suffix."},"created_at":{"type":"string","format":"date-time","title":"Created At","examples":["2026-04-14T09:50:01Z"],"description":"ISO 8601 in UTC with a `Z` suffix."},"window":{"description":"The window this release is measured over: from `released_at` to the next release of the application, at most 14 days and never past now. Send it as `time_range` and the previous release as `compare_to` to compare two releases. Absent while the release lies at or after now, or where the next release shares its instant.","$ref":"#/components/schemas/TimeRange"}},"type":"object","required":["id","application_id","organization_id","version","released_at","created_at"],"title":"ReleaseResponse"},"ReleaseUpdate":{"properties":{"version":{"anyOf":[{"type":"string","maxLength":255},{"type":"null"}],"title":"Version"},"released_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Released At","examples":["2026-04-14T09:50:01Z"],"description":"ISO 8601. Send `Z` or an offset."}},"additionalProperties":false,"type":"object","title":"ReleaseUpdate"},"ResolvedGoalStep":{"properties":{"step_type":{"$ref":"#/components/schemas/GoalStepType","description":"The form. `stage` carries `stage`, `event` carries `name`"},"stage":{"description":"The checkout stage. Absent unless `step_type` is `stage`","$ref":"#/components/schemas/CheckoutStage"},"name":{"title":"Name","description":"The event name. Absent unless `step_type` is `event`","type":"string"}},"type":"object","required":["step_type"],"title":"ResolvedGoalStep","description":"A goal step as the server applied it."},"ResourceBreakdownRequest":{"properties":{"time_range":{"$ref":"#/components/schemas/TimeRange","description":"Time range for the query"},"filters":{"$ref":"#/components/schemas/Filters","description":"Optional filters"},"timezone":{"anyOf":[{"type":"string","maxLength":64},{"type":"null"}],"title":"Timezone","description":"IANA time zone the local hours of `filters.hour_of_day` are read in, such as `Europe/Berlin`. The filter requires it. This route buckets nothing, so the zone changes nothing else"},"sparse_buckets":{"anyOf":[{"$ref":"#/components/schemas/SparseBuckets"},{"type":"null"}],"description":"The sparse threshold of the page, the number `POST /analytics/sparse-hours` derives. With `exclude` the rows of the thin hours are left out. Without it the route only echoes the number in `meta.sparse_buckets`"}},"additionalProperties":false,"type":"object","required":["time_range"],"title":"ResourceBreakdownRequest","description":"Request for resource breakdown by type."},"ResourceBreakdownResponse":{"properties":{"meta":{"$ref":"#/components/schemas/AnalyticsMeta","description":"Facts about the result"},"request":{"$ref":"#/components/schemas/AnalyticsRequestEcho","description":"The request as the server resolved it"},"data":{"items":{"$ref":"#/components/schemas/ResourceTypeItem"},"type":"array","title":"Data","description":"Resource types with data"},"size_bytes":{"type":"integer","title":"Size Bytes","description":"Transfer size across all types, in bytes"}},"type":"object","required":["meta","request","data","size_bytes"],"title":"ResourceBreakdownResponse","description":"Response for resource breakdown."},"ResourceTypeItem":{"properties":{"resource_type":{"type":"string","title":"Resource Type","description":"Resource type (script, css, img, font, other)"},"size_bytes":{"type":"integer","title":"Size Bytes","description":"Transfer size of this type's resources, in bytes"},"resource_count":{"type":"integer","title":"Resource Count","description":"Resources of this type"},"avg_ms":{"type":"number","title":"Avg Ms","description":"Average duration in ms"},"share":{"type":"number","title":"Share","description":"This type's part of the total size, 0..1"}},"type":"object","required":["resource_type","size_bytes","resource_count","avg_ms","share"],"title":"ResourceTypeItem","description":"Single resource type with aggregated data."},"ResultDevice":{"properties":{"average":{"title":"Average","type":"number"},"has_error":{"title":"Has Error","description":"Whether the run errored on this device.","type":"boolean"},"has_vitals":{"title":"Has Vitals","description":"Whether the run captured web vitals on this device.","type":"boolean"},"pages_by_url":{"additionalProperties":{"$ref":"#/components/schemas/ResultPage"},"type":"object","title":"Pages By Url","description":"One result per measured page, keyed by the page URL commerce-score used."}},"type":"object","title":"ResultDevice","required":["pages_by_url"]},"ResultPage":{"properties":{"page_url":{"title":"Page Url","type":"string"},"has_error":{"title":"Has Error","description":"Whether commerce-score failed to measure this page.","type":"boolean"},"score":{"title":"Score","type":"number"},"scores":{"items":{"$ref":"#/components/schemas/ScoreEntry"},"type":"array","title":"Scores"}},"type":"object","title":"ResultPage","description":"One page's result. Asset URLs (screenshot / lighthouse) are intentionally\nomitted - reach the screenshot only via the access-controlled proxy.","required":["scores"]},"ResultTtfbPhase":{"properties":{"dns_ms":{"title":"Dns Ms","type":"number"},"connection_ms":{"title":"Connection Ms","type":"number"},"tls_ms":{"title":"Tls Ms","type":"number"},"server_ms":{"title":"Server Ms","type":"number"},"transfer_ms":{"title":"Transfer Ms","type":"number"},"total_ms":{"title":"Total Ms","type":"number"}},"type":"object","title":"ResultTtfbPhase"},"ReviewStatus":{"type":"string","enum":["pending","approved","blocked"],"title":"ReviewStatus","description":"Where an organization stands in the anti-abuse review.\n\nTHE single source of truth for the ingestion gate: an org may create\napplications and sites (and therefore obtain an embed) AND ingest beacons if\nand only if this is `APPROVED`. There is deliberately no mirrored boolean -\nregistration and org creation are open to everyone, what is gated is data\ningestion.\n\nThree states, mirroring the account model: an admin approves an org or turns\nit OFF (`BLOCKED` - declines it, stopping ingestion), with an optional owner\nnotification as a flag on the action rather than a separate status. `PENDING`\nis the queue an org lands in on creation."},"Role":{"type":"string","enum":["owner","member","viewer"],"title":"Role","description":"Role for organization members.\n\nA named bundle of permissions, not a capability in itself. Ordered weakest\nto strongest:\n\n- `VIEWER` reads everything the dashboards show and changes nothing. It is\n  the seat for the public demo login, for read-only guests, and the floor a\n  scoped API token can be cut down to.\n- `MEMBER` is everyday work: sites, applications, releases, synthetic pages,\n  issue triage, inviting other members.\n- `OWNER` additionally owns the org itself: settings, billing-relevant\n  consent, members, partners, notification rules, deletion."},"RuleAggregation":{"type":"string","enum":["count","avg","sum","min","max","p50","p75","p90","p95","p99"],"title":"RuleAggregation","description":"How a rule reduces its metric over the window."},"RuleBaseline":{"properties":{"value":{"type":"number","title":"Value","description":"The baseline window's value in the metric's unit."},"window_seconds":{"description":"How many seconds before the window the baseline covers. Absent on a past send, which stored the value alone.","$ref":"#/components/schemas/RuleWindow"}},"type":"object","required":["value"],"title":"RuleBaseline","description":"The baseline window a `relative_change` rule compares the window with."},"RuleCreate":{"properties":{"application_id":{"type":"string","format":"uuid","title":"Application Id","description":"The production application the rule watches, its active sites pooled into one value. Fixed once created.","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"site_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Site Id","description":"One site of the application the rule watches alone. Absent pools every active site. Fixed once created.","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"metric":{"type":"string","maxLength":64,"title":"Metric","description":"Which measurement is compared, a metric catalog id such as `lcp` or `error_count`. Fixed once created."},"aggregation":{"$ref":"#/components/schemas/RuleAggregation","description":"How the measurement is reduced over the window. Fixed once created."},"identity":{"anyOf":[{"$ref":"#/components/schemas/VisitorIdentity"},{"type":"null"}],"description":"Which identifier counts a visitor, for the `visitors` metric only. Absent counts by `stitch`. Fixed once created."},"operator":{"$ref":"#/components/schemas/Operator","description":"How the compared number stands to the threshold for the condition to hold."},"condition_type":{"$ref":"#/components/schemas/ConditionType","description":"`absolute` compares the window's value, `relative_change` compares `(value - baseline) / baseline` against the baseline window. Fixed once created."},"threshold":{"type":"number","title":"Threshold","description":"The number compared with. In the metric's unit for `absolute`, a ratio for `relative_change`: -0.5 is a drop by half."},"window_seconds":{"$ref":"#/components/schemas/RuleWindow","description":"How many seconds of data ending now one evaluation reduces."},"baseline_window_seconds":{"anyOf":[{"$ref":"#/components/schemas/RuleWindow"},{"type":"null"}],"description":"How many seconds before the window the baseline covers. Required for `relative_change`, absent otherwise."},"filters":{"anyOf":[{"additionalProperties":{"anyOf":[{"type":"string"},{"type":"integer"},{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array"}]},"type":"object"},{"type":"null"}],"title":"Filters","description":"Narrow what is measured: a dimension mapped to one value or a list of values, for example `country`."},"re_notify_after_seconds":{"anyOf":[{"type":"integer","maximum":2592000.0,"minimum":3600.0},{"type":"null"}],"title":"Re Notify After Seconds","description":"How long to stay quiet before notifying again while the condition holds. At least an hour. Absent notifies once per episode."},"name":{"type":"string","maxLength":100,"minLength":1,"title":"Name","description":"What the rule is called in the list and in the messages it sends."},"is_active":{"type":"boolean","title":"Is Active","description":"Whether the rule is evaluated at all. Switching it on starts from a clear state.","default":true},"channel_ids":{"items":{"type":"string","format":"uuid","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"type":"array","maxItems":10,"title":"Channel Ids","description":"The channels of the organization the rule posts to."},"member_user_ids":{"items":{"type":"string","format":"uuid","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"type":"array","maxItems":20,"title":"Member User Ids","description":"The members of the organization the rule mails, by user id."}},"additionalProperties":false,"type":"object","required":["application_id","metric","aggregation","operator","condition_type","threshold","window_seconds","name"],"title":"RuleCreate"},"RuleDeliveryResult":{"properties":{"target_type":{"$ref":"#/components/schemas/RuleTargetType","description":"Whether the target is a channel or a member."},"channel":{"description":"The channel, on a `channel` target. Absent once the channel is deleted.","$ref":"#/components/schemas/ChannelRef"},"member":{"description":"The member mailed, on a `member` target.","$ref":"#/components/schemas/UserRef"},"status":{"$ref":"#/components/schemas/ChannelDeliveryStatus","description":"Whether the target accepted the message."},"delivery_error":{"title":"Delivery Error","description":"Why the target did not accept it. Absent when delivered.","type":"string"}},"type":"object","required":["target_type","status"],"title":"RuleDeliveryResult","description":"What one target made of a rule's message."},"RuleEvaluationReason":{"type":"string","enum":["no_data","no_baseline"],"title":"RuleEvaluationReason","description":"Why an evaluation could not compare the value with the threshold."},"RuleEvaluationResponse":{"properties":{"rule":{"$ref":"#/components/schemas/RuleRef","description":"The rule evaluated."},"evaluated_at":{"type":"string","format":"date-time","title":"Evaluated At","description":"The end of the window evaluated.","examples":["2026-04-14T09:50:01Z"]},"value":{"title":"Value","description":"The window's value in the metric's unit. Absent without data.","type":"number"},"baseline":{"description":"What a `relative_change` rule compared against. Absent for `absolute` and without baseline data.","$ref":"#/components/schemas/RuleBaseline"},"relative_change":{"title":"Relative Change","description":"`(value - baseline.value) / baseline.value`, the number a `relative_change` rule compares. Absent for `absolute` and without both values.","type":"number"},"is_condition_met":{"type":"boolean","title":"Is Condition Met","description":"Whether the condition holds now."},"reason":{"description":"Why nothing could be compared: `no_data` in the window, `no_baseline` when the baseline is empty or zero. Absent when compared.","$ref":"#/components/schemas/RuleEvaluationReason"}},"type":"object","required":["rule","evaluated_at","is_condition_met"],"title":"RuleEvaluationResponse","description":"What the rule would decide now, over its application's sites pooled."},"RuleFiringWebhook":{"properties":{"type":{"type":"string","const":"rule.firing","title":"Type"},"timestamp":{"type":"string","format":"date-time","title":"Timestamp","description":"When the event happened: the start of the observation, for a trend midnight UTC of its first day, or of the occurrence, the evaluation of a rule, and the moment of sending for a test. The same on every attempt of one delivery.","examples":["2026-04-14T09:50:01Z"]},"data":{"$ref":"#/components/schemas/RuleWebhookData"}},"type":"object","required":["type","timestamp","data"],"title":"RuleFiringWebhook","description":"The condition of a rule started to hold, or still holds at a re-notify."},"RulePreset":{"type":"string","enum":["lcp_regression","cls_regression","inp_regression","traffic_drop","error_rate_high","page_weight_bloat"],"title":"RulePreset","description":"A ready-made rule of the presets catalog."},"RulePreviewBucket":{"properties":{"timestamp":{"type":"string","format":"date-time","title":"Timestamp","description":"The start of the bucket, which is one rule window wide.","examples":["2026-04-14T09:50:01Z"]},"value":{"title":"Value","description":"The window's value in the metric's unit. Absent without data.","type":"number"},"baseline":{"description":"What a `relative_change` rule compared against. Absent for `absolute` and without baseline data.","$ref":"#/components/schemas/RuleBaseline"},"relative_change":{"title":"Relative Change","description":"`(value - baseline.value) / baseline.value`, the number a `relative_change` rule compares. Absent for `absolute` and without both values.","type":"number"},"is_breach":{"type":"boolean","title":"Is Breach","description":"Whether the condition held at this evaluation."},"is_fire":{"type":"boolean","title":"Is Fire","description":"Whether a firing message would have been sent."}},"type":"object","required":["timestamp","is_breach","is_fire"],"title":"RulePreviewBucket","description":"One evaluation the worker would have made, at the end of the bucket."},"RulePreviewRequest":{"properties":{"application_id":{"type":"string","format":"uuid","title":"Application Id","description":"The production application the rule watches, its active sites pooled into one value. Fixed once created.","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"site_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Site Id","description":"One site of the application the rule watches alone. Absent pools every active site. Fixed once created.","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"metric":{"type":"string","maxLength":64,"title":"Metric","description":"Which measurement is compared, a metric catalog id such as `lcp` or `error_count`. Fixed once created."},"aggregation":{"$ref":"#/components/schemas/RuleAggregation","description":"How the measurement is reduced over the window. Fixed once created."},"identity":{"anyOf":[{"$ref":"#/components/schemas/VisitorIdentity"},{"type":"null"}],"description":"Which identifier counts a visitor, for the `visitors` metric only. Absent counts by `stitch`. Fixed once created."},"operator":{"$ref":"#/components/schemas/Operator","description":"How the compared number stands to the threshold for the condition to hold."},"condition_type":{"$ref":"#/components/schemas/ConditionType","description":"`absolute` compares the window's value, `relative_change` compares `(value - baseline) / baseline` against the baseline window. Fixed once created."},"threshold":{"type":"number","title":"Threshold","description":"The number compared with. In the metric's unit for `absolute`, a ratio for `relative_change`: -0.5 is a drop by half."},"window_seconds":{"$ref":"#/components/schemas/RuleWindow","description":"How many seconds of data ending now one evaluation reduces."},"baseline_window_seconds":{"anyOf":[{"$ref":"#/components/schemas/RuleWindow"},{"type":"null"}],"description":"How many seconds before the window the baseline covers. Required for `relative_change`, absent otherwise."},"filters":{"anyOf":[{"additionalProperties":{"anyOf":[{"type":"string"},{"type":"integer"},{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array"}]},"type":"object"},{"type":"null"}],"title":"Filters","description":"Narrow what is measured: a dimension mapped to one value or a list of values, for example `country`."},"re_notify_after_seconds":{"anyOf":[{"type":"integer","maximum":2592000.0,"minimum":3600.0},{"type":"null"}],"title":"Re Notify After Seconds","description":"How long to stay quiet before notifying again while the condition holds. At least an hour. Absent notifies once per episode."},"window_days":{"anyOf":[{"type":"integer","maximum":365.0,"minimum":1.0},{"type":"null"}],"title":"Window Days","description":"How many days back the preview reaches. Absent picks one by the window, from 7 days for an hour to 180 days for 30 days."}},"additionalProperties":false,"type":"object","required":["application_id","metric","aggregation","operator","condition_type","threshold","window_seconds"],"title":"RulePreviewRequest","description":"A rule shape, saved or not, to replay over past data."},"RulePreviewResponse":{"properties":{"buckets":{"items":{"$ref":"#/components/schemas/RulePreviewBucket"},"type":"array","title":"Buckets","description":"Oldest first, the last ends now."},"breach_count":{"type":"integer","title":"Breach Count","description":"The buckets where the condition held."},"fire_count":{"type":"integer","title":"Fire Count","description":"The firing messages the rule would have sent, after re-notify."},"unit":{"description":"What `value` and `baseline.value` are measured in.","$ref":"#/components/schemas/MetricUnit"},"time_range":{"$ref":"#/components/schemas/TimeRange","description":"From the first bucket's start to now."}},"type":"object","required":["buckets","breach_count","fire_count","time_range"],"title":"RulePreviewResponse"},"RuleRef":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"],"description":"An ID, a UUID in lowercase with hyphens."},"name":{"type":"string","title":"Name"}},"type":"object","required":["id","name"],"title":"RuleRef","description":"A notification rule another resource was sent by or evaluated for."},"RuleResolvedWebhook":{"properties":{"type":{"type":"string","const":"rule.resolved","title":"Type"},"timestamp":{"type":"string","format":"date-time","title":"Timestamp","description":"When the event happened: the start of the observation, for a trend midnight UTC of its first day, or of the occurrence, the evaluation of a rule, and the moment of sending for a test. The same on every attempt of one delivery.","examples":["2026-04-14T09:50:01Z"]},"data":{"$ref":"#/components/schemas/RuleWebhookData"}},"type":"object","required":["type","timestamp","data"],"title":"RuleResolvedWebhook","description":"The condition of a rule stopped holding."},"RuleResponse":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":"Identifier of the rule.","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"organization":{"$ref":"#/components/schemas/OrganizationRef","description":"The organization the rule belongs to."},"name":{"type":"string","title":"Name","description":"What the rule is called in the list and in the messages it sends."},"is_active":{"type":"boolean","title":"Is Active","description":"Whether the rule is evaluated at all. Switching it on starts from a clear state."},"application":{"$ref":"#/components/schemas/ApplicationRef","description":"The production application the rule watches, its active sites pooled into one value. Fixed once created."},"site":{"description":"One site of the application the rule watches alone. Absent pools every active site. Fixed once created.","$ref":"#/components/schemas/SiteRef"},"metric":{"type":"string","title":"Metric","description":"Which measurement is compared, a metric catalog id such as `lcp` or `error_count`. Fixed once created."},"aggregation":{"$ref":"#/components/schemas/RuleAggregation","description":"How the measurement is reduced over the window. Fixed once created."},"identity":{"description":"Which identifier counts a visitor, for the `visitors` metric only. Absent counts by `stitch`. Fixed once created.","$ref":"#/components/schemas/VisitorIdentity"},"operator":{"$ref":"#/components/schemas/Operator","description":"How the compared number stands to the threshold for the condition to hold."},"condition_type":{"$ref":"#/components/schemas/ConditionType","description":"`absolute` compares the window's value, `relative_change` compares `(value - baseline) / baseline` against the baseline window. Fixed once created."},"threshold":{"type":"number","title":"Threshold","description":"The number compared with. In the metric's unit for `absolute`, a ratio for `relative_change`: -0.5 is a drop by half."},"window_seconds":{"$ref":"#/components/schemas/RuleWindow","description":"How many seconds of data ending now one evaluation reduces."},"baseline_window_seconds":{"description":"How many seconds before the window the baseline covers. Required for `relative_change`, absent otherwise.","$ref":"#/components/schemas/RuleWindow"},"filters":{"title":"Filters","description":"Narrow what is measured: a dimension mapped to one value or a list of values, for example `country`.","additionalProperties":{"anyOf":[{"type":"string"},{"type":"integer"},{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array"}]},"type":"object"},"re_notify_after_seconds":{"title":"Re Notify After Seconds","description":"How long to stay quiet before notifying again while the condition holds. At least an hour. Absent notifies once per episode.","type":"integer"},"channels":{"items":{"$ref":"#/components/schemas/ChannelRef"},"type":"array","title":"Channels","description":"The channels of the organization the rule posts to."},"members":{"items":{"$ref":"#/components/schemas/UserRef"},"type":"array","title":"Members","description":"The members of the organization the rule mails."},"created_by":{"description":"Who created the rule. Absent once the account is deleted.","$ref":"#/components/schemas/UserRef"},"last_evaluated_at":{"title":"Last Evaluated At","description":"When it was last evaluated. Absent until the first run.","examples":["2026-04-14T09:50:01Z"],"type":"string","format":"date-time"},"created_at":{"type":"string","format":"date-time","title":"Created At","description":"When it was created.","examples":["2026-04-14T09:50:01Z"]},"updated_at":{"type":"string","format":"date-time","title":"Updated At","description":"When it last changed.","examples":["2026-04-14T09:50:01Z"]}},"type":"object","required":["id","organization","name","is_active","application","metric","aggregation","operator","condition_type","threshold","window_seconds","channels","members","created_at","updated_at"],"title":"RuleResponse"},"RuleSendResponse":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"],"description":"An ID, a UUID in lowercase with hyphens."},"rule":{"$ref":"#/components/schemas/RuleRef","description":"The rule that sent the event."},"sent_at":{"type":"string","format":"date-time","title":"Sent At","description":"When the event was sent.","examples":["2026-04-14T09:50:01Z"]},"state":{"$ref":"#/components/schemas/RuleState","description":"`firing` when the condition started or still holds, `resolved` when it stopped."},"value":{"type":"number","title":"Value","description":"The window's value in the metric's unit."},"baseline":{"description":"What a `relative_change` rule compared against. Absent for `absolute` and without baseline data.","$ref":"#/components/schemas/RuleBaseline"},"relative_change":{"title":"Relative Change","description":"`(value - baseline.value) / baseline.value`, the number a `relative_change` rule compares. Absent for `absolute` and without both values.","type":"number"},"threshold":{"type":"number","title":"Threshold","description":"The rule's threshold at the time of the event."},"deliveries":{"items":{"$ref":"#/components/schemas/RuleDeliveryResult"},"type":"array","title":"Deliveries","description":"One entry per target."}},"type":"object","required":["id","rule","sent_at","state","value","threshold","deliveries"],"title":"RuleSendResponse","description":"One firing or resolved event of a rule."},"RuleState":{"type":"string","enum":["firing","resolved","test"],"title":"RuleState","description":"What a rule event says: the condition started or kept holding, stopped holding, or a test."},"RuleTargetType":{"type":"string","enum":["channel","member"],"title":"RuleTargetType","description":"Where a rule's message went: a channel of the organization or a member's mailbox."},"RuleTestResponse":{"properties":{"rule":{"$ref":"#/components/schemas/RuleRef","description":"The rule whose test was sent."},"deliveries":{"items":{"$ref":"#/components/schemas/RuleDeliveryResult"},"type":"array","title":"Deliveries","description":"One entry per channel and member of the rule, in that order."}},"type":"object","required":["rule","deliveries"],"title":"RuleTestResponse"},"RuleTestWebhook":{"properties":{"type":{"type":"string","const":"rule.test","title":"Type"},"timestamp":{"type":"string","format":"date-time","title":"Timestamp","description":"When the event happened: the start of the observation, for a trend midnight UTC of its first day, or of the occurrence, the evaluation of a rule, and the moment of sending for a test. The same on every attempt of one delivery.","examples":["2026-04-14T09:50:01Z"]},"data":{"$ref":"#/components/schemas/RuleWebhookData"}},"type":"object","required":["type","timestamp","data"],"title":"RuleTestWebhook","description":"Someone sent a test of a rule, with made-up numbers."},"RuleUpdate":{"properties":{"name":{"anyOf":[{"type":"string","maxLength":100,"minLength":1},{"type":"null"}],"title":"Name","description":"What the rule is called in the list and in the messages it sends."},"is_active":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Active","description":"Whether the rule is evaluated at all. Switching it on starts from a clear state."},"operator":{"anyOf":[{"$ref":"#/components/schemas/Operator"},{"type":"null"}],"description":"How the compared number stands to the threshold for the condition to hold."},"threshold":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Threshold","description":"The number compared with. In the metric's unit for `absolute`, a ratio for `relative_change`: -0.5 is a drop by half."},"window_seconds":{"anyOf":[{"$ref":"#/components/schemas/RuleWindow"},{"type":"null"}],"description":"How many seconds of data ending now one evaluation reduces."},"baseline_window_seconds":{"anyOf":[{"$ref":"#/components/schemas/RuleWindow"},{"type":"null"}],"description":"How many seconds before the window the baseline covers. Required for `relative_change`, absent otherwise."},"filters":{"anyOf":[{"additionalProperties":{"anyOf":[{"type":"string"},{"type":"integer"},{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array"}]},"type":"object"},{"type":"null"}],"title":"Filters","description":"Narrow what is measured: a dimension mapped to one value or a list of values, for example `country`."},"re_notify_after_seconds":{"anyOf":[{"type":"integer","maximum":2592000.0,"minimum":3600.0},{"type":"null"}],"title":"Re Notify After Seconds","description":"How long to stay quiet before notifying again while the condition holds. At least an hour. Absent notifies once per episode."},"channel_ids":{"anyOf":[{"items":{"type":"string","format":"uuid","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"type":"array","maxItems":10},{"type":"null"}],"title":"Channel Ids","description":"The channels of the organization the rule posts to. Replaces the whole list."},"member_user_ids":{"anyOf":[{"items":{"type":"string","format":"uuid","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"type":"array","maxItems":20},{"type":"null"}],"title":"Member User Ids","description":"The members of the organization the rule mails, by user id. Replaces the whole list."}},"additionalProperties":false,"type":"object","title":"RuleUpdate","description":"Merge-patch of a rule. Only `baseline_window_seconds`, `filters` and\n`re_notify_after_seconds` can be cleared with null."},"RuleWebhookData":{"properties":{"organization":{"$ref":"#/components/schemas/OrganizationRef","description":"The organization of the rule."},"application":{"$ref":"#/components/schemas/ApplicationRef","description":"The application the rule watches."},"site":{"description":"The site the rule watches. Absent pools every active site.","$ref":"#/components/schemas/SiteRef"},"channel":{"$ref":"#/components/schemas/ChannelRef","description":"The channel the event was posted to."},"rule":{"$ref":"#/components/schemas/WebhookRule"},"evaluation":{"$ref":"#/components/schemas/RuleWebhookEvaluation"},"message":{"$ref":"#/components/schemas/WebhookMessage"}},"type":"object","required":["organization","application","channel","rule","evaluation","message"],"title":"RuleWebhookData"},"RuleWebhookEvaluation":{"properties":{"state":{"$ref":"#/components/schemas/RuleState","description":"`firing` while the condition holds, `resolved` once it stopped, `test`."},"value":{"type":"number","title":"Value","description":"The window's value in the metric's unit."},"baseline":{"description":"What a `relative_change` rule compared against.","$ref":"#/components/schemas/RuleBaseline"},"relative_change":{"title":"Relative Change","description":"`(value - baseline.value) / baseline.value`, the number a `relative_change` rule compares with `threshold`. Absent otherwise.","type":"number"},"operator":{"$ref":"#/components/schemas/Operator","description":"How the compared number stood to the threshold."},"threshold":{"type":"number","title":"Threshold","description":"The rule's threshold when it was evaluated."},"condition_type":{"$ref":"#/components/schemas/ConditionType","description":"`absolute` compares `value` with `threshold` in the metric's unit, `relative_change` compares `relative_change`, a ratio."},"window_seconds":{"$ref":"#/components/schemas/RuleWindow","description":"How many seconds `value` covers."},"unit":{"description":"What `value` is measured in.","$ref":"#/components/schemas/MetricUnit"},"occurred_at":{"type":"string","format":"date-time","title":"Occurred At","description":"When the rule was evaluated.","examples":["2026-04-14T09:50:01Z"]}},"type":"object","required":["state","value","operator","threshold","condition_type","window_seconds","occurred_at"],"title":"RuleWebhookEvaluation","description":"What the evaluation that caused a rule event measured."},"RuleWindow":{"type":"integer","enum":[3600,21600,86400,604800,2592000],"title":"RuleWindow","description":"The lengths a rule window and its baseline can take, in seconds."},"SamplingMeta":{"properties":{"sampling_rate":{"type":"number","title":"Sampling Rate","description":"Lowest sampling rate currently configured for an application in scope, 0.0 to 1.0. A configured rate, not the share of rows that arrived: rows stored before a rate change carry the rate of their time. On the NEL routes it is instead the lowest failure sampling rate a report of the answer carries, 1.0 when there is none, since that rate weighs the counts."},"is_sampled":{"type":"boolean","title":"Is Sampled","description":"True when `sampling_rate` is below 1.0"},"estimated_metrics":{"title":"Estimated Metrics","description":"Names of the fields in this response that are estimates, scaled up from the sampled rows. Empty while `is_sampled` is false, since every number is then a count. Absent on a route that does not name its estimates yet.","items":{"type":"string"},"type":"array"}},"type":"object","required":["sampling_rate","is_sampled"],"title":"SamplingMeta","description":"The sampling configured for the applications behind a result."},"SamplingMode":{"type":"string","enum":["manual","automatic"],"title":"SamplingMode","description":"Who sets an application's `sampling_rate`: `manual` is the rate as\nwritten through the API, `automatic` hands it to the sampling controller,\nwhich sets it from the organization's booked pageviews."},"SamplingRecommendation":{"properties":{"recommended_sampling_rate":{"type":"number","title":"Recommended Sampling Rate","description":"20 000 over `inputs.pageviews_per_day`, rounded up to the next 0.05, at least 0.2 or the operator's floor where that is higher, at most 1.0. 1.0 when the window holds no traffic."},"sampling_rate":{"type":"number","title":"Sampling Rate","description":"The rate the application has configured, as `collection.sampling_rate`."},"inputs":{"$ref":"#/components/schemas/SamplingRecommendationInputs"},"time_range":{"$ref":"#/components/schemas/TimeRange","description":"The last seven full UTC days."}},"type":"object","required":["recommended_sampling_rate","sampling_rate","inputs","time_range"],"title":"SamplingRecommendation","description":"The sampling rate the application's traffic allows. Nothing is applied."},"SamplingRecommendationInputs":{"properties":{"pageviews_per_day":{"type":"integer","title":"Pageviews Per Day","description":"Weighted pageviews per day over the window, every bot class included."},"pageviews_per_month":{"type":"integer","title":"Pageviews Per Month","description":"`pageviews_per_day` times 30."}},"type":"object","required":["pageviews_per_day","pageviews_per_month"],"title":"SamplingRecommendationInputs","description":"The weighted traffic of the window the recommendation rests on."},"ScoreEntry":{"properties":{"name":{"type":"string","title":"Name"},"display_value":{"title":"Display Value","description":"The measurement as commerce-score rendered it, `2.1 s`.","type":"string"},"score":{"title":"Score","type":"number"}},"type":"object","required":["name"],"title":"ScoreEntry"},"ScriptInput":{"properties":{"version":{"anyOf":[{"type":"string","maxLength":20},{"type":"null"}],"title":"Version","description":"Tracker bundle version to serve."}},"additionalProperties":false,"type":"object","title":"ScriptInput"},"ScriptResponse":{"properties":{"hash":{"type":"string","title":"Hash","description":"Path segment of the script URL, `/s/{hash}.js`."},"version":{"type":"string","title":"Version","description":"Tracker bundle version that is served."}},"type":"object","required":["hash","version"],"title":"ScriptResponse"},"SearchApplicationRef":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"],"description":"An ID, a UUID in lowercase with hyphens."},"name":{"type":"string","title":"Name"},"environment":{"$ref":"#/components/schemas/Environment"}},"type":"object","required":["id","name","environment"],"title":"SearchApplicationRef"},"SearchOrganizationRef":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"],"description":"An ID, a UUID in lowercase with hyphens."},"name":{"type":"string","title":"Name"},"role":{"$ref":"#/components/schemas/Role"},"access":{"title":"Access","type":"string","enum":["member","partner","admin"]}},"type":"object","required":["id","name"],"title":"SearchOrganizationRef","description":"The organization a hit lives in, with the caller's standing there.\n\n`role` and `access` are both None for a credential the organization owns:\nthere is no person and no membership, the same way `GET /organizations`\nreports it. Being None, they are omitted from the serialized response\nrather than sent as `null` (`StandardAPIRoute`, API_STANDARDS §7)."},"SearchResponse":{"properties":{"query":{"type":"string","title":"Query"},"limit":{"type":"integer","title":"Limit"},"organizations":{"items":{"$ref":"#/components/schemas/OrganizationHit"},"type":"array","title":"Organizations"},"applications":{"items":{"$ref":"#/components/schemas/ApplicationHit"},"type":"array","title":"Applications"},"sites":{"items":{"$ref":"#/components/schemas/SiteHit"},"type":"array","title":"Sites"}},"type":"object","required":["query","limit","organizations","applications","sites"],"title":"SearchResponse","description":"One object holding three bounded lists, deliberately without `{data,\nmeta}`.\n\nRegistered as an exemption in API_STANDARDS §9 rather than left looking\nlike an oversight: there is no resume point for a cursor or an offset to\nname, and a per-kind `total` would be three numbers a palette cannot act\non."},"ServerTimingCacheAgeItem":{"properties":{"layer":{"$ref":"#/components/schemas/CacheAgeLayer","description":"Which tier the age belongs to. `content` is cdn + origin over the pageviews where the CDN served a HIT: the age of what the visitor actually saw, because the origin header froze inside the CDN object. It cannot be derived from the other two rows (the p75 of a sum is not the sum of the p75s), which is why it is computed here."},"count":{"type":"integer","title":"Count","description":"Pageviews reporting this age (the n behind the percentiles). RAW, for the same reason as `phases[].count`, and not comparable with the scaled `count` on `cache` or `top_keys`."},"p50_s":{"title":"P50 S","type":"integer"},"p75_s":{"title":"P75 S","type":"integer"},"p95_s":{"title":"P95 S","type":"integer"}},"type":"object","required":["layer","count"],"title":"ServerTimingCacheAgeItem","description":"Cache-age percentiles for one layer, in SECONDS.\n\nDeliberately not part of `phases`: those are milliseconds, these are\nseconds, and one block mixing both units is a bug waiting to be written.\nThe `_s` suffix follows `ServerTimingKeyItem.p75_ms` for the same reason."},"ServerTimingCacheItem":{"properties":{"layer":{"$ref":"#/components/schemas/CacheLayer","description":"Which tier reported the status"},"cache_status":{"type":"string","title":"Cache Status","description":"Normalized cache status, as the tier spells it: HIT | MISS | ..."},"count":{"type":"integer","title":"Count","description":"Pageviews with this status, TRAFFIC: scaled by the sampling weight. Not comparable with the `count` on `phases`, `cache_age` or `cache_ttl`, which is a raw sample size."}},"type":"object","required":["layer","cache_status","count"],"title":"ServerTimingCacheItem","description":"Cache-status distribution for one layer."},"ServerTimingCacheTtlItem":{"properties":{"layer":{"$ref":"#/components/schemas/CacheLayer","description":"Which tier reported the ttl"},"count":{"type":"integer","title":"Count","description":"Pageviews reporting this ttl (the n behind the percentiles). RAW, for the same reason as `phases[].count`, and not comparable with the scaled `count` on `cache` or `top_keys`."},"p50_s":{"title":"P50 S","type":"integer"},"p75_s":{"title":"P75 S","type":"integer"},"p95_s":{"title":"P95 S","type":"integer"}},"type":"object","required":["layer","count"],"title":"ServerTimingCacheTtlItem","description":"Remaining-cache-lifetime percentiles for one layer, in SECONDS.\n\nThe shape of `ServerTimingCacheAgeItem` without its `content` layer: two\nremaining lifetimes do not add up across tiers the way two ages do."},"ServerTimingKeyItem":{"properties":{"key":{"type":"string","title":"Key","description":"Server-Timing key (catalog or custom)"},"count":{"type":"integer","title":"Count","description":"Pageviews carrying this key, TRAFFIC: scaled by the sampling weight. `p75_ms` next to it is raw, so the two measure different populations on a sampled application."},"p75_ms":{"title":"P75 Ms","description":"p75 of the key's duration (None = no duration ever reported)","type":"number"},"values":{"items":{"$ref":"#/components/schemas/ServerTimingKeyValue"},"type":"array","title":"Values","description":"Most frequent desc values of this key (empty = no desc ever reported)"}},"type":"object","required":["key","count","values"],"title":"ServerTimingKeyItem","description":"One Tier-2/3 custom key from server_timing_dur and/or server_timing_desc.\n\nA key can be timed (`dur`), categorical (`desc`) or both, so both halves are\noptional: `p75_ms` is None for a key that never carried a duration (e.g.\n`Server-Timing: pop;desc=\"DE-1331\"`), `values` is empty for a pure duration\nkey. `count` is the pageviews carrying the key in either map."},"ServerTimingKeyValue":{"properties":{"desc":{"type":"string","title":"Desc","description":"The header's desc text (e.g. 'DE-1331')"},"count":{"type":"integer","title":"Count","description":"Pageviews carrying this key/value pair, TRAFFIC: scaled by the sampling weight."}},"type":"object","required":["desc","count"],"title":"ServerTimingKeyValue","description":"One observed `desc` value of a categorical Server-Timing key."},"ServerTimingPhaseItem":{"properties":{"phase":{"type":"string","title":"Phase","description":"edge_dur/origin_dur/backend_dur/db_dur/http_dur/render_dur/search_dur/kv_dur/code_dur"},"count":{"type":"integer","title":"Count","description":"Pageviews reporting this phase (the n behind the percentiles). RAW: the rows that were measured, never scaled by the sampling weight, because it is the confidence behind the percentiles. Do not divide it by, or compare it with, the scaled `count` on `cache` or `top_keys`."},"p50_ms":{"title":"P50 Ms","type":"number"},"p75_ms":{"title":"P75 Ms","type":"number"},"p95_ms":{"title":"P95 Ms","type":"number"}},"type":"object","required":["phase","count"],"title":"ServerTimingPhaseItem","description":"Percentiles of one backend-phase duration (ms), with their sample size."},"ServerTimingRequest":{"properties":{"time_range":{"$ref":"#/components/schemas/TimeRange","description":"Time range for the query"},"filters":{"$ref":"#/components/schemas/Filters","description":"Optional filters"},"timezone":{"anyOf":[{"type":"string","maxLength":64},{"type":"null"}],"title":"Timezone","description":"IANA time zone the local hours of `filters.hour_of_day` are read in, such as `Europe/Berlin`. The filter requires it. This route buckets nothing, so the zone changes nothing else"},"sparse_buckets":{"anyOf":[{"$ref":"#/components/schemas/SparseBuckets"},{"type":"null"}],"description":"The sparse threshold of the page, the number `POST /analytics/sparse-hours` derives. With `exclude` the rows of the thin hours are left out. Without it the route only echoes the number in `meta.sparse_buckets`"},"limit":{"type":"integer","maximum":100.0,"minimum":1.0,"title":"Limit","description":"Max custom keys (top_keys block)","default":20}},"additionalProperties":false,"type":"object","required":["time_range"],"title":"ServerTimingRequest","description":"Request for the Server-Timing dashboard panel."},"ServerTimingResponse":{"properties":{"meta":{"$ref":"#/components/schemas/AnalyticsMeta","description":"Facts about the result"},"request":{"$ref":"#/components/schemas/AnalyticsRequestEcho","description":"The request as the server resolved it"},"cache":{"items":{"$ref":"#/components/schemas/ServerTimingCacheItem"},"type":"array","title":"Cache","description":"Cache-status distribution"},"cache_age":{"items":{"$ref":"#/components/schemas/ServerTimingCacheAgeItem"},"type":"array","title":"Cache Age","description":"Cache-age percentiles per layer, in seconds (migration 072)"},"cache_ttl":{"items":{"$ref":"#/components/schemas/ServerTimingCacheTtlItem"},"type":"array","title":"Cache Ttl","description":"Percentiles of the remaining cache lifetime per layer, in seconds (migration 082). What was left of the object's freshness when it was delivered, so cache age + ttl is the configured lifetime."},"phases":{"items":{"$ref":"#/components/schemas/ServerTimingPhaseItem"},"type":"array","title":"Phases","description":"Backend-phase percentiles"},"top_keys":{"items":{"$ref":"#/components/schemas/ServerTimingKeyItem"},"type":"array","title":"Top Keys","description":"Top custom keys by p75"}},"type":"object","required":["meta","request","cache","phases","top_keys","cache_age","cache_ttl"],"title":"ServerTimingResponse","description":"Response for the Server-Timing dashboard panel: five blocks."},"SessionConsent":{"type":"string","enum":["deferred","immediate"],"title":"SessionConsent","description":"When the served bundle writes the session identifier under consent (only\nmeaningful when `collect_sessions` is on).\n\nDEFERRED  - defer the session write until `window.fastmon.grantConsent()` is\n            called (consent-first; the privacy-safe default).\nIMMEDIATE - write the session on load (consent already handled / not required)."},"ShopInput":{"properties":{"active":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Active","description":"Whether the application is a shop. Overrides what the platform says, null goes back to following the platform."},"checkout":{"anyOf":[{"$ref":"#/components/schemas/CheckoutInput"},{"type":"null"}],"description":"The checkout funnel."}},"additionalProperties":false,"type":"object","title":"ShopInput"},"ShopOrderRevenueResponse":{"properties":{"seen_at":{"type":"string","format":"date-time","title":"Seen At","description":"The newest completed order with a numeric `value` in the last 30 days.","examples":["2026-04-14T09:50:01Z"]},"currency":{"type":"string","title":"Currency","description":"The `currency` most of those orders carried, as sent, `''` where they carried none. Never validated."}},"type":"object","required":["seen_at","currency"],"title":"ShopOrderRevenueResponse"},"ShopResponse":{"properties":{"active":{"title":"Active","description":"Whether the application is a shop. Absent when the platform is unknown.","type":"boolean"},"source":{"type":"string","enum":["platform","manual"],"title":"Source","description":"`manual` when a user set `active`, `platform` when it follows the platform."},"checkout":{"$ref":"#/components/schemas/CheckoutResponse","description":"The checkout funnel."},"order_revenue_observed":{"description":"Whether the shop's orders carry a value, checked once a day. Present, the dashboard shows a revenue line and writes a quiet day as zero in `currency`. Absent when no order of the last 30 days carried one. Read-only.","$ref":"#/components/schemas/ShopOrderRevenueResponse"}},"type":"object","required":["source","checkout"],"title":"ShopResponse"},"SiteCertificate":{"properties":{"issued_at":{"title":"Issued At","description":"When the site's TLS certificate became valid. Absent until a check completed a handshake and reported it.","examples":["2026-04-14T09:50:01Z"],"type":"string","format":"date-time"},"expires_at":{"title":"Expires At","description":"When the site's TLS certificate expires. Absent until a check completed a handshake.","examples":["2026-04-14T09:50:01Z"],"type":"string","format":"date-time"},"issuer":{"title":"Issuer","description":"The certificate issuer as scout reported it, such as `R11`. Absent until a check completed a handshake.","type":"string"},"is_chain_valid":{"title":"Is Chain Valid","description":"Whether the certificate chain verified against the probe's trust store. Absent until a check completed a handshake.","type":"boolean"},"server_ip":{"title":"Server Ip","description":"The address of the shop's server the newest check connected to. Absent until a check reached one.","type":"string"}},"type":"object","title":"SiteCertificate","description":"The certificate and server address the newest check of the site saw."},"SiteDefaultsInput":{"properties":{"data_retention_days":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Data Retention Days","description":"Days of beacon data a domain keeps."},"store_stitch":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Store Stitch","description":"Keep the edge-derived visitor id next to the beacon."},"count_visitors_by":{"anyOf":[{"$ref":"#/components/schemas/VisitorIdentity"},{"type":"null"}],"description":"Which identifier counts a visitor."}},"additionalProperties":false,"type":"object","title":"SiteDefaultsInput"},"SiteDefaultsResponse":{"properties":{"data_retention_days":{"type":"integer","title":"Data Retention Days","description":"Days of beacon data a domain keeps."},"store_stitch":{"type":"boolean","title":"Store Stitch","description":"Keep the edge-derived visitor id next to the beacon."},"count_visitors_by":{"$ref":"#/components/schemas/VisitorIdentity","description":"Which identifier counts a visitor."}},"type":"object","required":["data_retention_days","store_stitch","count_visitors_by"],"title":"SiteDefaultsResponse"},"SiteHit":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"],"description":"An ID, a UUID in lowercase with hyphens."},"name":{"type":"string","title":"Name"},"domain":{"type":"string","title":"Domain"},"is_active":{"type":"boolean","title":"Is Active"},"organization":{"$ref":"#/components/schemas/SearchOrganizationRef"},"application":{"$ref":"#/components/schemas/SearchApplicationRef"}},"type":"object","required":["id","name","domain","is_active","organization","application"],"title":"SiteHit"},"SitePolicy":{"type":"string","enum":["open","auto","strict"],"title":"SitePolicy","description":"How an application handles an UNKNOWN beacon hostname (one with no matching\nregistered Site). Replaces the old `auto_provision_sites` flag and the per-Site\n`enforce_domain_match`.\n\nOPEN   - record a discovery suggestion, drop the beacon (default).\nAUTO   - auto-create a Site for the hostname.\nSTRICT - drop; no suggestion, no auto-provision.\n\nEvery policy serves an exactly-registered domain, whatever the number of\nSites, and none binds a beacon to a Site of another hostname."},"SiteRef":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"],"description":"An ID, a UUID in lowercase with hyphens."},"domain":{"type":"string","title":"Domain"}},"type":"object","required":["id","domain"],"title":"SiteRef","description":"A site another resource belongs to or points at, named by its domain."},"SiteResponse":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":"Identifier of the domain.","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"organization_id":{"type":"string","format":"uuid","title":"Organization Id","description":"The organization this domain belongs to.","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"application_id":{"type":"string","format":"uuid","title":"Application Id","description":"The application whose embed this domain runs, and whose collection config applies to it.","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"name":{"type":"string","title":"Name","description":"Display name."},"domain":{"type":"string","title":"Domain","description":"The hostname beacons are attributed to, without scheme or port."},"is_active":{"type":"boolean","title":"Is Active","description":"Whether the domain is enabled."},"uptime_enabled":{"type":"boolean","title":"Uptime Enabled","description":"Whether the uptime probe checks this domain. On by default. The probe checks it only while its application's `uptime_enabled` is on as well."},"tags":{"items":{"type":"string"},"type":"array","title":"Tags","description":"Free-form labels, used to group domains and to scope notification rules.","default":[]},"data_starts_at":{"title":"Data Starts At","description":"The UTC midnight a complete analytics window of this domain starts at: the day of its first pageview, but never before the organization's `history_days` ago. Absent until the first pageview is 3 hours old.","examples":["2026-04-14T09:50:01Z"],"type":"string","format":"date-time"}},"type":"object","required":["id","organization_id","application_id","name","domain","is_active","uptime_enabled","tags"],"title":"SiteResponse","description":"A site: a pure domain / analytics unit belonging to one application.\n\nThe embed + collection config live on the application (fetch it via\n`application_id`); they are NOT mirrored here."},"SiteStatusResponse":{"properties":{"beacons_today":{"type":"integer","title":"Beacons Today","description":"Beacons received for this domain since midnight in the request's `timezone`, UTC without one."},"beacons_per_minute":{"type":"number","title":"Beacons Per Minute"},"last_beacon_at":{"title":"Last Beacon At","examples":["2026-04-14T09:50:01Z"],"description":"ISO 8601 in UTC with a `Z` suffix.","type":"string","format":"date-time"},"events_today":{"type":"integer","title":"Events Today","description":"Checkout events received for this domain since midnight in the request's `timezone`, UTC without one. 0 also whenever `events_available` is false.","default":0},"last_event_at":{"title":"Last Event At","description":"When the newest checkout event of the last 31 days arrived, absent when the domain has none in that window. A value proves the pixel reports. Its absence does not prove that it never did.","examples":["2026-04-14T09:50:01Z"],"type":"string","format":"date-time"},"events_available":{"type":"boolean","title":"Events Available","description":"Whether the checkout events could be read at all. False when the events table is absent or the probe for it failed, and then the two fields above say nothing about the pixel.","default":true}},"type":"object","required":["beacons_today","beacons_per_minute","events_today","events_available"],"title":"SiteStatusResponse"},"SiteUpdate":{"properties":{"name":{"anyOf":[{"type":"string","maxLength":255},{"type":"null"}],"title":"Name","description":"Display name."},"domain":{"anyOf":[{"type":"string","maxLength":8192},{"type":"null"}],"title":"Domain","description":"The hostname beacons are attributed to, without scheme or port. A pasted URL keeps its host."},"is_active":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Active","description":"Whether the domain is enabled."},"uptime_enabled":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Uptime Enabled","description":"Whether the uptime probe checks this domain while its application's switch is on. Off ends its open uptime observations at once."},"tags":{"anyOf":[{"items":{"type":"string"},"type":"array","maxItems":10},{"type":"null"}],"title":"Tags","description":"Free-form labels, used to group domains and to scope notification rules."}},"type":"object","title":"SiteUpdate"},"SiteUptimeResponse":{"properties":{"redirect_site_id":{"title":"Redirect Site Id","description":"The sibling site this site's home page redirects to, a site of the same application. The probe then checks only its home page, once per hour, outside the application's rotation. Absent for a site that serves its own pages.","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"],"type":"string","format":"uuid"},"outage":{"description":"The site's open outage, a Watchdog observation with metric `availability`: the site's own, or its application's, which has no `site_id` and names the site among its failing sites in `evidence.sites`. Absent while the site is up.","$ref":"#/components/schemas/ObservationResponse"},"is_unstable":{"type":"boolean","title":"Is Unstable","description":"True while the site has an open observation with metric `stability`: at least 3 of its last 20 checks failed without an outage."},"has_certificate_problem":{"type":"boolean","title":"Has Certificate Problem","description":"True while the site has an open observation with metric `certificate`: its certificate expires soon, has expired or does not verify."},"certificate":{"$ref":"#/components/schemas/SiteCertificate","description":"The certificate and server address of the newest check."},"baseline":{"description":"The response time baseline of the site, what a slow answer is measured against. Read from the probe's store, absent when that cannot answer.","$ref":"#/components/schemas/UptimeBaseline"},"samples":{"items":{"$ref":"#/components/schemas/UptimeSample"},"type":"array","title":"Samples","description":"The checks of the window, the newest first, at most 3000. A longer window holds the newest 3000 only. Empty while no check ran."},"series":{"items":{"$ref":"#/components/schemas/UptimeTargetSeries"},"type":"array","title":"Series","description":"The checks of the window per target, bucketed: one series per target with a check in the window, the home page first, then the page types in rotation order. Empty while no check ran."},"time_range":{"$ref":"#/components/schemas/TimeRange","description":"The window the samples, the series and the counts cover, as the server resolved it."}},"type":"object","required":["is_unstable","has_certificate_problem","certificate","samples","series","time_range"],"title":"SiteUptimeResponse","description":"What the uptime probe knows about one site now."},"SiteUptimeStatus":{"properties":{"site_id":{"type":"string","format":"uuid","title":"Site Id","description":"Identifier of the site.","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"application_id":{"type":"string","format":"uuid","title":"Application Id","description":"Identifier of the site's application.","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"domain":{"type":"string","title":"Domain","description":"The site's domain."},"uptime_enabled":{"type":"boolean","title":"Uptime Enabled","description":"Whether the uptime probe checks this domain. A row with it off shows no recent check and no open observation."},"redirect_site_id":{"title":"Redirect Site Id","description":"The sibling site this site's home page redirects to, a site of the same application. The probe then checks only its home page, once per hour, outside the application's rotation. Absent for a site that serves its own pages.","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"],"type":"string","format":"uuid"},"outage":{"description":"The site's open outage, a Watchdog observation with metric `availability`. Absent while the site is up.","$ref":"#/components/schemas/ObservationResponse"},"is_slow":{"type":"boolean","title":"Is Slow","description":"True while the site or its application has an open observation with metric `response_time`: the server answers the probe much slower than over the last 7 days."},"is_unstable":{"type":"boolean","title":"Is Unstable","description":"True while the site has an open observation with metric `stability`: at least 3 of its last 20 checks failed without an outage."},"has_certificate_problem":{"type":"boolean","title":"Has Certificate Problem","description":"True while the site has an open observation with metric `certificate`: its certificate expires soon, has expired or does not verify."},"certificate":{"$ref":"#/components/schemas/SiteCertificate","description":"The certificate and server address of the newest check."},"baseline":{"description":"The response time baseline of the site, what a slow answer is measured against. Read from the probe's store, absent when that cannot answer.","$ref":"#/components/schemas/UptimeBaseline"},"availability":{"type":"number","title":"Availability","description":"Share 0..1 of the window in which the site had no open outage, rounded to 4 decimals. 1 without an outage in the window."},"downtime_seconds":{"type":"integer","title":"Downtime Seconds","description":"Seconds of the window the site's outages covered, an open one up to now. 0 without an outage in the window."},"last_checked_at":{"title":"Last Checked At","description":"When the newest check of the last 24 hours ran. Absent without one.","examples":["2026-04-14T09:50:01Z"],"type":"string","format":"date-time"},"is_last_check_ok":{"title":"Is Last Check Ok","description":"Whether that check ended in a final status from 200 to 399. Absent without a check in the last 24 hours.","type":"boolean"}},"type":"object","required":["site_id","application_id","domain","uptime_enabled","is_slow","is_unstable","has_certificate_problem","certificate","availability","downtime_seconds"],"title":"SiteUptimeStatus","description":"Where one active site of an application stands with the uptime probe."},"SiteUsage":{"properties":{"site_id":{"type":"string","format":"uuid","title":"Site Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"],"description":"An ID, a UUID in lowercase with hyphens."},"site_name":{"type":"string","title":"Site Name"},"pageview_count":{"type":"integer","title":"Pageview Count","description":"Pageviews of the site over the window"}},"type":"object","required":["site_id","site_name","pageview_count"],"title":"SiteUsage"},"SortDirection":{"type":"string","enum":["asc","desc"],"title":"SortDirection","description":"Sort order direction."},"SparklinePoint":{"properties":{"timestamp":{"title":"Timestamp","examples":["2026-04-14T09:50:01Z"],"description":"ISO 8601 in UTC with a `Z` suffix.","type":"string","format":"date-time"},"desktop_score":{"title":"Desktop Score","type":"number"},"mobile_score":{"title":"Mobile Score","type":"number"}},"type":"object","title":"SparklinePoint","description":"One run's score in a sparkline series (newest first). CS scores are sums →\nfloat-safe."},"SparseBuckets":{"properties":{"min_pageviews":{"type":"integer","minimum":1.0,"title":"Min Pageviews","description":"The threshold in page views weighted by sampling, as the dashboard shows them. Derive it with `POST /analytics/sparse-hours` and send it here, so every card of a page applies the same number"},"exclude":{"type":"boolean","title":"Exclude","description":"Drop the rows of the hours `POST /analytics/sparse-hours` lists as thin for the same scope, window and `min_pageviews`. An hour that route does not judge is never dropped. On `/analytics/query` a row of a kept hour below the threshold still carries `is_sparse`","default":false}},"additionalProperties":false,"type":"object","required":["min_pageviews"],"title":"SparseBuckets","description":"The threshold below which a row of `/analytics/query` is sparse."},"SparseBucketsApplied":{"properties":{"min_pageviews":{"type":"integer","minimum":0.0,"title":"Min Pageviews","description":"The threshold applied, in page views weighted by sampling: the request's, 0 without `sparse_buckets`, or under the deprecated form 0 in mode `off` and the derived one in `automatic`"},"mode":{"$ref":"#/components/schemas/SparseBucketsMode","description":"Deprecated, read `min_pageviews`. `manual` for the number form, `off` without `sparse_buckets`, the mode the request sent for the deprecated form","deprecated":true},"excluded_hour_count":{"type":"integer","minimum":0.0,"title":"Excluded Hour Count","description":"The judged hours of the main window that `exclude` dropped, 0 without it. The same hours `POST /analytics/sparse-hours` lists in `excluded`"}},"type":"object","required":["min_pageviews","mode","excluded_hour_count"],"title":"SparseBucketsApplied","description":"The sparse threshold one analytics response applied."},"SparseBucketsByMode":{"properties":{"mode":{"$ref":"#/components/schemas/SparseBucketsMode","description":"`off` flags no row. `automatic` derives the threshold from the window: a fifth of the median `sample_count` of the returned rows, at least 30 measurements. `manual` uses `min_pageviews`"},"min_pageviews":{"anyOf":[{"type":"integer","minimum":1.0},{"type":"null"}],"title":"Min Pageviews","description":"The threshold in page views weighted by sampling, as the dashboard shows them. Required with mode `manual`, refused with every other mode"}},"additionalProperties":false,"type":"object","required":["mode"],"title":"SparseBucketsByMode","description":"The deprecated `{mode, min_pageviews}` form of `sparse_buckets`."},"SparseBucketsMode":{"type":"string","enum":["off","automatic","manual"],"title":"SparseBucketsMode","description":"The mode of the deprecated `sparse_buckets` form and of its `meta` echo."},"SparseHoursRequest":{"properties":{"time_range":{"$ref":"#/components/schemas/TimeRange","description":"The window whose hours are counted"},"filters":{"$ref":"#/components/schemas/Filters","description":"The scope the hours are counted in: `site_id`, `site_ids`, `application_id` and `hour_of_day`. Any other filter is a 422, since the threshold is derived from the whole traffic of the scope. An hour `hour_of_day` leaves out is not counted and never thin"},"timezone":{"anyOf":[{"type":"string","maxLength":64},{"type":"null"}],"title":"Timezone","description":"IANA time zone the local hours of `filters.hour_of_day` are read in, such as `Europe/Berlin`. The filter requires it. This route buckets nothing, so the zone changes nothing else"},"share":{"anyOf":[{"type":"number","maximum":0.5,"minimum":0.0},{"type":"null"}],"title":"Share","description":"The part of the window's thinnest hours to drop, 0 to 0.5: the threshold is the nearest-rank quantile of the hourly counts at this share, at least 30 raw measurements, so 0 still drops the hours under that floor. Absent with `min_pageviews` absent too is 0.2. Refused next to `min_pageviews`"},"min_pageviews":{"anyOf":[{"type":"integer","minimum":1.0},{"type":"null"}],"title":"Min Pageviews","description":"A fixed threshold in page views weighted by sampling, to preview which hours it drops. Refused next to `share`"}},"additionalProperties":false,"type":"object","required":["time_range"],"title":"SparseHoursRequest","description":"The window whose thin hours `/analytics/sparse-hours` finds, and the rule it finds them by."},"SparseHoursRequestEcho":{"properties":{"time_range":{"$ref":"#/components/schemas/TimeRange","description":"The window the query ran over, concrete even where the caller asked for a relative one"},"comparison_time_range":{"description":"The earlier window, absent unless a comparison ran","$ref":"#/components/schemas/TimeRange"},"granularity":{"description":"Bucket width of the series, absent where the response is not bucketed","$ref":"#/components/schemas/BucketGranularity"},"identity":{"description":"Identifier the visitors were counted by, absent where the response counts none","$ref":"#/components/schemas/VisitorIdentity"},"window_seconds":{"title":"Window Seconds","description":"Length of the window ending now, absent where the request names none","type":"integer"},"filters":{"additionalProperties":true,"type":"object","title":"Filters","description":"The filter values the query applied"},"url_param_key":{"title":"Url Param Key","description":"The query key the `url_param` rows of `/analytics/query` are the values of, absent without that dimension","type":"string"},"timezone":{"title":"Timezone","description":"The zone `filters.hour_of_day` was read in, absent without one","type":"string"},"share":{"title":"Share","description":"The share the threshold was derived at, 0.2 where the request named neither knob. Absent where `min_pageviews` applied","type":"number"},"min_pageviews":{"title":"Min Pageviews","description":"The fixed threshold the request named, absent where `share` applied","type":"integer"}},"type":"object","required":["time_range","filters"],"title":"SparseHoursRequestEcho","description":"The `/analytics/sparse-hours` request as the server resolved it."},"SparseHoursResponse":{"properties":{"meta":{"$ref":"#/components/schemas/AnalyticsMeta","description":"Facts about the result"},"request":{"$ref":"#/components/schemas/SparseHoursRequestEcho","description":"The request as the server resolved it"},"min_pageviews":{"type":"integer","minimum":0.0,"title":"Min Pageviews","description":"The threshold in page views weighted by sampling. An hour below it is thin. The value a route takes to drop the same hours"},"hour_count":{"type":"integer","minimum":0.0,"title":"Hour Count","description":"The hours judged: the whole hours of the window that `filters.hour_of_day` keeps and that are complete by `meta.complete_until`. A cut, running or unfinalized hour is not judged, so a window shorter than one whole hour answers 0"},"excluded":{"items":{"type":"string","format":"date-time","examples":["2026-04-14T09:50:01Z"]},"type":"array","title":"Excluded","description":"The UTC start of every thin hour among the judged ones, in time order. An hour without a page view is thin"}},"type":"object","required":["meta","request","min_pageviews","hour_count","excluded"],"title":"SparseHoursResponse","description":"The thin hours of a window and the threshold that made them thin."},"StatusCodeRange":{"properties":{"gte":{"anyOf":[{"type":"integer","maximum":599.0,"minimum":100.0},{"type":"null"}],"title":"Gte","description":"Keep reports with a status code >= this"},"lte":{"anyOf":[{"type":"integer","maximum":599.0,"minimum":100.0},{"type":"null"}],"title":"Lte","description":"Keep reports with a status code <= this"}},"additionalProperties":false,"type":"object","title":"StatusCodeRange","description":"Inclusive bounds on the HTTP status code of a Network Error Logging report."},"Storage":{"type":"string","enum":["shared","dedicated","external"],"title":"Storage","description":"Storage mode for organization data."},"SummaryMetric":{"type":"string","enum":["lcp","ttfb","inp","cls","fcp","tbt","page_load_time","dns_lookup","tcp_connection"],"title":"SummaryMetric","description":"A metric page whose summary the backend renders."},"SummarySection":{"type":"string","title":"SummarySection","description":"The section of the metric page a part of a sentence links to.","x-extensible-enum":["phases","elements","hosts","impact"]},"SummarySentenceType":{"type":"string","title":"SummarySentenceType","description":"What one summary sentence says.","x-extensible-enum":["rating","lead_phase","element_kind","early_hints","cdn_cache","host_outlier","level","change","change_phase","unchanged","change_group","new_outlier"]},"SummarySeverity":{"type":"string","title":"SummarySeverity","description":"How a sentence reads: a good state, a warning, a problem, or information.","x-extensible-enum":["good","warn","poor","neutral"]},"SymbolicatedFrame":{"properties":{"index":{"type":"integer","title":"Index","description":"Position in the stack, 0 is the top frame."},"host":{"type":"string","title":"Host"},"path":{"type":"string","title":"Path"},"line":{"type":"integer","title":"Line"},"column":{"type":"integer","title":"Column"},"status":{"type":"string","enum":["resolved","host_only","foreign_host","tracker","position_gone","no_position","unreachable","unavailable"],"title":"Status"},"module_id":{"type":"string","title":"Module Id","description":"Enclosing webpack module id, '' if none.","default":""},"method":{"type":"string","title":"Method","description":"Nearest preceding named method or function.","default":""},"object":{"type":"string","title":"Object","description":"Object of the member access at the column.","default":""},"property":{"type":"string","title":"Property","description":"Property of the member access at the column.","default":""},"snippet":{"type":"string","title":"Snippet","description":"Code around the column.","default":""},"caret_offset":{"type":"integer","title":"Caret Offset","description":"Byte offset of the column inside `snippet`.","default":0},"near_boundary":{"type":"boolean","title":"Near Boundary","description":"The position sits close behind the method head, so the attribution may belong to the previous scope.","default":false},"throw_kind":{"type":"string","enum":["","origin","rethrow"],"title":"Throw Kind","description":"Where a `throw` sits at the caret. 'origin' creates the error here, so this frame plus the message is the whole diagnosis. 'rethrow' only passes on something caught further down.","default":""},"library":{"type":"string","title":"Library","description":"The well-known library this file is, e.g. 'jQuery', 'fastmon tracker' for our own script, or '' when the file is not recognised. Decided by file name, not by host: a shop serves jQuery from its own domain. Set whatever the status is, because the name is read off the path rather than off the bundle.","default":""}},"type":"object","required":["index","host","path","line","column","status","module_id","method","object","property","snippet","caret_offset","near_boundary","throw_kind","library"],"title":"SymbolicatedFrame","description":"One stack frame resolved against the file the browser actually ran.\n\n`status` says what happened, and only \"resolved\" fills the code fields:\n\n- `resolved`: the file was fetched and the position found.\n- `host_only`: no path was stored, so there is nothing to fetch. Inline and\n  third-party frames without the frame opt-in.\n- `foreign_host`: the frame points at a host that is not a registered site\n  domain of this organization. Never fetched, with or without a path.\n- `tracker`: the frame is the fastmon tracker itself, which wraps fetch, XHR\n  and event handlers and so appears on stacks it did not cause. Never\n  fetched, `library` names it.\n- `position_gone`: the file no longer has that line and column, or the\n  position sits in a comment. Both are what a redeploy under an unchanged\n  name looks like.\n- `no_position`: the browser reported the file but no line and column.\n- `unreachable`: the file could not be fetched.\n- `unavailable`: symbolication is switched off or the service did not answer."},"SyntheticAnalysisStatus":{"properties":{"commerce_score_analysis_id":{"type":"string","title":"Commerce Score Analysis Id","description":"The run this progress is about."},"progress":{"type":"number","title":"Progress","description":"How far the run has got, 0..1."},"done":{"type":"boolean","title":"Done"}},"type":"object","required":["commerce_score_analysis_id","progress","done"],"title":"SyntheticAnalysisStatus","description":"Progress of an in-flight analysis (for run UX)."},"SyntheticDeviceType":{"type":"string","enum":["desktop","mobile"],"title":"SyntheticDeviceType","description":"The class of device commerce-score measures a page on (§28).\n\nTwo values, not the three of `DeviceType`: commerce-score runs Lighthouse\non a desktop and a mobile profile only, so a shared enum would promise a\ntablet run no route can answer."},"SyntheticPageCreate":{"properties":{"url":{"type":"string","maxLength":2048,"title":"Url"},"mode":{"type":"string","enum":["monitor","oneshot"],"title":"Mode","default":"monitor"},"schedule":{"type":"boolean","title":"Schedule","default":true},"ttfb_schedule":{"type":"boolean","title":"Ttfb Schedule","default":true},"nocache":{"type":"boolean","title":"Nocache","default":true}},"type":"object","required":["url"],"title":"SyntheticPageCreate","description":"Create a synthetic page. The URL is normalized to the beacon form and must be\nunder the site's own domain. Registering always runs one immediate analysis.\n\n`mode` picks the intent:\n- `monitor` (default): a sticky, quota-counted page. `schedule` (recurring 24h\n  Lighthouse, default on) and `ttfb_schedule` (recurring 5-min CS, default on) are\n  honored - set either false to register paused / opt out; the flags govern only\n  the *recurring* runs.\n- `oneshot`: an unbudgeted \"measure now\". The schedule flags are ignored (both\n  forced off), `nocache` is forced true (fresh origin fetch), and the single\n  creation run is mandatory - a missing run id is a hard 502, not tolerated."},"SyntheticPageCreateResponse":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"],"description":"An ID, a UUID in lowercase with hyphens."},"site_id":{"type":"string","format":"uuid","title":"Site Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"],"description":"An ID, a UUID in lowercase with hyphens."},"url":{"type":"string","title":"Url"},"source":{"$ref":"#/components/schemas/SyntheticPageSource"},"auto_rank":{"title":"Auto Rank","type":"integer"},"commerce_score_site_id":{"title":"Commerce Score Site Id","description":"The site commerce-score registered for this page.","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"],"type":"string","format":"uuid"},"schedule":{"type":"boolean","title":"Schedule"},"ttfb_schedule":{"type":"boolean","title":"Ttfb Schedule"},"nocache":{"type":"boolean","title":"Nocache"},"created_at":{"type":"string","format":"date-time","title":"Created At","examples":["2026-04-14T09:50:01Z"],"description":"ISO 8601 in UTC with a `Z` suffix."},"commerce_score_analysis_id":{"title":"Commerce Score Analysis Id","description":"The creation run commerce-score started, to poll the status with.","type":"string"},"analysis_status":{"title":"Analysis Status","type":"integer"}},"type":"object","required":["id","site_id","url","source","schedule","ttfb_schedule","nocache","created_at"],"title":"SyntheticPageCreateResponse","description":"A created/registered page plus the run that creation always triggers.\n\nCreating a CS site kicks off one immediate analysis regardless of the schedule\nflags - the flags gate only the *recurring* runs, so even a page created paused\n(`schedule=false`) produces this one creation run. Both manual create and one-shot\nsurface its `commerce_score_analysis_id` for the client to poll, instead of firing a\nredundant second run. It is null only if CS registered the site but returned no run\nid (manual create tolerates that; one-shot 502s)."},"SyntheticPageListItem":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"],"description":"An ID, a UUID in lowercase with hyphens."},"site_id":{"type":"string","format":"uuid","title":"Site Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"],"description":"An ID, a UUID in lowercase with hyphens."},"url":{"type":"string","title":"Url"},"source":{"$ref":"#/components/schemas/SyntheticPageSource"},"auto_rank":{"title":"Auto Rank","type":"integer"},"commerce_score_site_id":{"title":"Commerce Score Site Id","description":"The site commerce-score registered for this page.","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"],"type":"string","format":"uuid"},"schedule":{"type":"boolean","title":"Schedule"},"ttfb_schedule":{"type":"boolean","title":"Ttfb Schedule"},"nocache":{"type":"boolean","title":"Nocache"},"created_at":{"type":"string","format":"date-time","title":"Created At","examples":["2026-04-14T09:50:01Z"],"description":"ISO 8601 in UTC with a `Z` suffix."},"summary":{"$ref":"#/components/schemas/SyntheticPageSummary"}},"type":"object","required":["id","site_id","url","source","schedule","ttfb_schedule","nocache","created_at"],"title":"SyntheticPageListItem","description":"A page plus an optional last-result summary (populated when `summary=true`)."},"SyntheticPageResponse":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"],"description":"An ID, a UUID in lowercase with hyphens."},"site_id":{"type":"string","format":"uuid","title":"Site Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"],"description":"An ID, a UUID in lowercase with hyphens."},"url":{"type":"string","title":"Url"},"source":{"$ref":"#/components/schemas/SyntheticPageSource"},"auto_rank":{"title":"Auto Rank","type":"integer"},"commerce_score_site_id":{"title":"Commerce Score Site Id","description":"The site commerce-score registered for this page.","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"],"type":"string","format":"uuid"},"schedule":{"type":"boolean","title":"Schedule"},"ttfb_schedule":{"type":"boolean","title":"Ttfb Schedule"},"nocache":{"type":"boolean","title":"Nocache"},"created_at":{"type":"string","format":"date-time","title":"Created At","examples":["2026-04-14T09:50:01Z"],"description":"ISO 8601 in UTC with a `Z` suffix."}},"type":"object","required":["id","site_id","url","source","schedule","ttfb_schedule","nocache","created_at"],"title":"SyntheticPageResponse"},"SyntheticPageSource":{"type":"string","enum":["manual","auto","oneshot"],"title":"SyntheticPageSource","description":"How a synthetic page was added."},"SyntheticPageSummary":{"properties":{"last_run_at":{"title":"Last Run At","examples":["2026-04-14T09:50:01Z"],"description":"ISO 8601 in UTC with a `Z` suffix.","type":"string","format":"date-time"},"desktop_score":{"title":"Desktop Score","type":"number"},"mobile_score":{"title":"Mobile Score","type":"number"}},"type":"object","title":"SyntheticPageSummary","description":"Compact last-result health snapshot for list rows (avoids the N+1 of\nfetching results per page from the client)."},"SyntheticPageUpdate":{"properties":{"schedule":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Schedule"},"ttfb_schedule":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Ttfb Schedule"},"nocache":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Nocache"}},"type":"object","title":"SyntheticPageUpdate","description":"Patch monitoring config. All optional; only provided fields change.\n`schedule=false` pauses the recurring Lighthouse run - the page stays and is\nstill runnable on demand. `nocache` toggles CS cache-bypass for future runs."},"SyntheticQuota":{"properties":{"manual_used":{"type":"integer","title":"Manual Used"},"manual_limit":{"type":"integer","title":"Manual Limit"},"auto_used":{"type":"integer","title":"Auto Used"},"auto_limit":{"type":"integer","title":"Auto Limit"}},"type":"object","required":["manual_used","manual_limit","auto_used","auto_limit"],"title":"SyntheticQuota","description":"Org-wide synthetic page budget. Manual and auto pages have independent caps\n(derived from the org plan); one-shots are unbounded and not counted. Usage spans\nALL sites in the org, so it can exceed this site's `page_count`."},"SyntheticResultItem":{"properties":{"commerce_score_analysis_id":{"title":"Commerce Score Analysis Id","description":"The run this result is of.","type":"string"},"created_at":{"title":"Created At","examples":["2026-04-14T09:50:01Z"],"description":"ISO 8601 in UTC with a `Z` suffix.","type":"string","format":"date-time"},"result_by_device":{"additionalProperties":{"$ref":"#/components/schemas/ResultDevice"},"type":"object","title":"Result By Device","description":"The run's result per device."},"ttfb_by_page":{"additionalProperties":{"$ref":"#/components/schemas/ResultTtfbPhase"},"type":"object","title":"Ttfb By Page","description":"The run's TTFB phases per measured page, keyed as `pages` is."}},"type":"object","title":"SyntheticResultItem","required":["result_by_device","ttfb_by_page"]},"SyntheticResultsResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/SyntheticResultItem"},"type":"array","title":"Data"},"meta":{"$ref":"#/components/schemas/CappedListMeta"}},"type":"object","required":["data","meta"],"title":"SyntheticResultsResponse","description":"Shaped synthetic-monitoring result history. Asset URLs are stripped;\nscreenshots come from the proxy endpoint only."},"SyntheticRunListItem":{"properties":{"commerce_score_analysis_id":{"title":"Commerce Score Analysis Id","description":"The run's id.","type":"string"},"created_at":{"title":"Created At","examples":["2026-04-14T09:50:01Z"],"description":"ISO 8601 in UTC with a `Z` suffix.","type":"string","format":"date-time"},"desktop_score":{"title":"Desktop Score","type":"number"},"mobile_score":{"title":"Mobile Score","type":"number"}},"type":"object","title":"SyntheticRunListItem","description":"One run, trimmed to what a run-selector needs: id + when + per-device score.\nDeliberately omits scores[]/ttfb/curation so the selector payload stays small."},"SyntheticRunResponse":{"properties":{"commerce_score_analysis_id":{"type":"string","title":"Commerce Score Analysis Id","description":"The run commerce-score accepted, to poll the status with."},"commerce_score_site_id":{"type":"string","format":"uuid","title":"Commerce Score Site Id","description":"The site commerce-score ran the analysis for.","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]}},"type":"object","required":["commerce_score_analysis_id","commerce_score_site_id"],"title":"SyntheticRunResponse","description":"Result of triggering an on-demand analysis."},"SyntheticRunsResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/SyntheticRunListItem"},"type":"array","title":"Data"},"meta":{"$ref":"#/components/schemas/CappedListMeta"}},"type":"object","required":["data","meta"],"title":"SyntheticRunsResponse","description":"Lightweight run list for the run-selector (live from CS)."},"SyntheticSummaryResponse":{"properties":{"site_id":{"type":"string","format":"uuid","title":"Site Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"],"description":"An ID, a UUID in lowercase with hyphens."},"page_count":{"type":"integer","title":"Page Count"},"run_count":{"type":"integer","title":"Run Count"},"aggregate_desktop_score":{"title":"Aggregate Desktop Score","type":"number"},"aggregate_mobile_score":{"title":"Aggregate Mobile Score","type":"number"},"pages":{"items":{"$ref":"#/components/schemas/PageSparkline"},"type":"array","title":"Pages"},"partial":{"type":"boolean","title":"Partial","default":false},"quota":{"$ref":"#/components/schemas/SyntheticQuota"}},"type":"object","required":["site_id","page_count","run_count","pages","quota","partial"],"title":"SyntheticSummaryResponse","description":"Site-wide synthetic overview: aggregate latest score across pages, total runs,\nand a per-page sparkline each. Computed live from cached per-page series - no\nstored aggregate (CS stays the system of record)."},"ThirdPartyItem":{"properties":{"host":{"type":"string","title":"Host","description":"Third-party host the resource was loaded from"},"total_ms":{"type":"integer","title":"Total Ms","description":"Summed duration of the host's resources in milliseconds, scaled by the sampling weight. Parallel loads add up, so it is load time, not wall time. A pageview reports its 20 hosts with the largest sums"},"count":{"type":"integer","title":"Count","description":"Deprecated, use `total_ms`. It always held milliseconds, not requests.","deprecated":true,"readOnly":true,"x-replaced-by":"total_ms"}},"type":"object","required":["host","total_ms","count"],"title":"ThirdPartyItem","description":"Single third-party domain with data."},"ThirdPartyRequest":{"properties":{"time_range":{"$ref":"#/components/schemas/TimeRange","description":"Time range for the query"},"filters":{"$ref":"#/components/schemas/Filters","description":"Optional filters"},"timezone":{"anyOf":[{"type":"string","maxLength":64},{"type":"null"}],"title":"Timezone","description":"IANA time zone the local hours of `filters.hour_of_day` are read in, such as `Europe/Berlin`. The filter requires it. This route buckets nothing, so the zone changes nothing else"},"sparse_buckets":{"anyOf":[{"$ref":"#/components/schemas/SparseBuckets"},{"type":"null"}],"description":"The sparse threshold of the page, the number `POST /analytics/sparse-hours` derives. With `exclude` the rows of the thin hours are left out. Without it the route only echoes the number in `meta.sparse_buckets`"},"limit":{"type":"integer","maximum":50.0,"minimum":1.0,"title":"Limit","description":"Max domains to return","default":10}},"additionalProperties":false,"type":"object","required":["time_range"],"title":"ThirdPartyRequest","description":"Request for third-party blocking domains."},"ThirdPartyResponse":{"properties":{"meta":{"$ref":"#/components/schemas/AnalyticsMeta","description":"Facts about the result"},"request":{"$ref":"#/components/schemas/AnalyticsRequestEcho","description":"The request as the server resolved it"},"data":{"items":{"$ref":"#/components/schemas/ThirdPartyItem"},"type":"array","title":"Data","description":"Third-party domains"},"total_ms":{"type":"integer","title":"Total Ms","description":"Sum of `total_ms` over the returned hosts, not over every host"},"resource_count":{"type":"integer","title":"Resource Count","description":"Deprecated, use `total_ms`. It always held milliseconds, not requests.","deprecated":true,"readOnly":true,"x-replaced-by":"total_ms"}},"type":"object","required":["meta","request","data","total_ms","resource_count"],"title":"ThirdPartyResponse","description":"Response for third-party blocking domains."},"ThresholdBasis":{"type":"string","enum":["web_vitals","lighthouse_mobile","fastmon"],"title":"ThresholdBasis","description":"Where a pair of cutoffs comes from."},"ThresholdBetter":{"type":"string","enum":["lower","higher"],"title":"ThresholdBetter","description":"Which way a value improves."},"TimeRange":{"properties":{"from":{"type":"string","format":"date-time","title":"From","description":"Start of time range (inclusive)","examples":["2026-04-14T09:50:01Z"]},"to":{"type":"string","format":"date-time","title":"To","description":"End of time range (exclusive)","examples":["2026-04-14T09:50:01Z"]}},"type":"object","required":["from","to"],"title":"TimeRange","description":"Required time range for queries."},"TimeseriesResponse":{"properties":{"page_id":{"type":"string","format":"uuid","title":"Page Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"],"description":"An ID, a UUID in lowercase with hyphens."},"url":{"type":"string","title":"Url"},"device_type":{"$ref":"#/components/schemas/SyntheticDeviceType"},"window_days":{"type":"integer","title":"Window Days"},"granularity":{"$ref":"#/components/schemas/BucketGranularity"},"lab":{"items":{"$ref":"#/components/schemas/LabPoint"},"type":"array","title":"Lab"},"ttfb_series":{"items":{"$ref":"#/components/schemas/TtfbSeriesPoint"},"type":"array","title":"Ttfb Series"},"field":{"items":{"$ref":"#/components/schemas/FieldPoint"},"type":"array","title":"Field"}},"type":"object","required":["page_id","url","device_type","window_days","granularity","lab","ttfb_series","field"],"title":"TimeseriesResponse","description":"Series for charting, different time granularities by design: sparse `lab`\npoints (Lighthouse) and raw `ttfb` points (dedicated 5-min schedule) overlaid on\nthe regular `field` p75 line. `lab.ttfb` is Lighthouse's server-only TTFB; the\n`ttfb` series is the full phase breakdown - they are not the same measurement."},"TtfbDiagnosisResponse":{"properties":{"page_id":{"type":"string","format":"uuid","title":"Page Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"],"description":"An ID, a UUID in lowercase with hyphens."},"url":{"type":"string","title":"Url"},"window_days":{"type":"integer","title":"Window Days"},"lab_phases":{"$ref":"#/components/schemas/TtfbPhases"},"devices":{"items":{"$ref":"#/components/schemas/TtfbFieldDevice"},"type":"array","title":"Devices"}},"type":"object","required":["page_id","url","window_days","devices"],"title":"TtfbDiagnosisResponse"},"TtfbFieldDevice":{"properties":{"device_type":{"$ref":"#/components/schemas/SyntheticDeviceType"},"field_ttfb_p75_ms":{"title":"Field Ttfb P75 Ms","type":"number"},"field_dns_p75_ms":{"title":"Field Dns P75 Ms","type":"number"},"field_tcp_p75_ms":{"title":"Field Tcp P75 Ms","type":"number"},"sample_count":{"type":"integer","title":"Sample Count"},"sufficient":{"type":"boolean","title":"Sufficient"},"verdict":{"type":"string","title":"Verdict"}},"type":"object","required":["device_type","sample_count","sufficient","verdict"],"title":"TtfbFieldDevice"},"TtfbPhases":{"properties":{"dns_ms":{"title":"Dns Ms","type":"number"},"connection_ms":{"title":"Connection Ms","type":"number"},"tls_ms":{"title":"Tls Ms","type":"number"},"server_ms":{"title":"Server Ms","type":"number"},"transfer_ms":{"title":"Transfer Ms","type":"number"},"total_ms":{"title":"Total Ms","type":"number"},"server_dominant":{"type":"boolean","title":"Server Dominant"}},"type":"object","required":["server_dominant"],"title":"TtfbPhases","description":"CS server-side TTFB phase breakdown (ms), once per page (not per device)."},"TtfbSeriesPoint":{"properties":{"timestamp":{"title":"Timestamp","examples":["2026-04-14T09:50:01Z"],"description":"ISO 8601 in UTC with a `Z` suffix.","type":"string","format":"date-time"},"dns_ms":{"title":"Dns Ms","type":"number"},"connection_ms":{"title":"Connection Ms","type":"number"},"tls_ms":{"title":"Tls Ms","type":"number"},"server_ms":{"title":"Server Ms","type":"number"},"transfer_ms":{"title":"Transfer Ms","type":"number"},"total_ms":{"title":"Total Ms","type":"number"}},"type":"object","title":"TtfbSeriesPoint","description":"One dedicated TTFB run (5-min schedule): raw DNS→transfer phases + total (ms).\nDevice-independent - CS measures TTFB once per run, not per device."},"UnknownHostnameSuggestion":{"properties":{"domain":{"type":"string","title":"Domain","description":"The host the beacons came from, as a site would register it."},"hits":{"type":"integer","title":"Hits","description":"How often it was seen."},"application_id":{"title":"Application Id","description":"The application whose embed reported it.","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"],"type":"string","format":"uuid"},"application_name":{"title":"Application Name","description":"Name of that application.","type":"string"}},"type":"object","required":["domain","hits"],"title":"UnknownHostnameSuggestion","description":"A host observed hitting an application that matched no registered site -\na candidate to adopt as a new site (one site per domain). The observed value\nis a hostname (`urlparse().hostname`, port-free), which is what the customer\nregisters as a `Site.domain`. `application_id`/`application_name` say WHICH\napplication observed it (null only for legacy ephemeral entries recorded\nbefore the application dimension existed)."},"UnknownHostnamesResponse":{"properties":{"suggestions":{"items":{"$ref":"#/components/schemas/UnknownHostnameSuggestion"},"type":"array","title":"Suggestions"}},"type":"object","required":["suggestions"],"title":"UnknownHostnamesResponse"},"UptimeBaseline":{"properties":{"refreshed_at":{"title":"Refreshed At","description":"When the site's baselines were last computed, once a day. Absent before the first computation.","examples":["2026-04-14T09:50:01Z"],"type":"string","format":"date-time"},"ttfb_by_page_type":{"additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/UptimeTargetBaseline"},{"type":"null"}]},"propertyNames":{"$ref":"#/components/schemas/UptimeTargetPageType"},"type":"object","title":"Ttfb By Page Type","description":"The baseline per target the probe checks on the site, keyed by target: the home page and each page type in the site's rotation, empty for a site out of the rotation. A target with fewer than 50 successful checks in 7 days is listed without a value and is never slow."}},"type":"object","required":["ttfb_by_page_type"],"title":"UptimeBaseline","description":"What the uptime probe holds as a normal answer of one site, per target."},"UptimeBucket":{"properties":{"timestamp":{"type":"string","format":"date-time","title":"Timestamp","description":"Start of the bucket. `granularity` of its series says the width.","examples":["2026-04-14T09:50:01Z"]},"check_count":{"type":"integer","title":"Check Count","description":"Checks in this bucket, 0 for a bucket without one."},"failed_count":{"type":"integer","title":"Failed Count","description":"Checks in this bucket that did not end in a final status from 200 to 399."},"p50_ttfb_ms":{"title":"P50 Ttfb Ms","description":"Median time to first byte of the successful checks in this bucket. Absent without a successful check that measured one.","type":"integer"},"p95_ttfb_ms":{"title":"P95 Ttfb Ms","description":"95th percentile of the time to first byte of the successful checks in this bucket. Absent without a successful check that measured one.","type":"integer"},"p50_total_ms":{"title":"P50 Total Ms","description":"Median time the successful checks in this bucket took. Absent without a successful check that measured one.","type":"integer"},"p95_total_ms":{"title":"P95 Total Ms","description":"95th percentile of the time the successful checks in this bucket took. Absent without a successful check that measured one.","type":"integer"},"ttfb_breakdown":{"description":"What the TTFB of this bucket's checks was made of, as means, since quantiles of the parts would not add up. Absent without a check with a first byte.","$ref":"#/components/schemas/UptimeBucketTtfbBreakdown"},"phases":{"title":"Phases","description":"Per Server-Timing phase promoted as on the RUM routes, the quantiles over the checks of this bucket that reported it, failed ones included. In the order edge, origin, backend, db, render, kv, http. Absent where no check of the bucket reported one.","items":{"$ref":"#/components/schemas/UptimeServerTimingPhase"},"type":"array"},"server_timing":{"title":"Server Timing","description":"Per Server-Timing name of the shop's responses, the quantiles over the checks of this bucket that reported it, failed ones included. Names in alphabetical order. Absent where no check of the bucket reported one.","items":{"$ref":"#/components/schemas/UptimeServerTiming"},"type":"array"}},"type":"object","required":["timestamp","check_count","failed_count"],"title":"UptimeBucket","description":"The checks of one target in one bucket of the window."},"UptimeBucketTtfbBreakdown":{"properties":{"check_count":{"type":"integer","title":"Check Count","description":"Checks of the bucket with a first byte, the ones the means are over."},"ttfb_ms":{"type":"number","title":"Ttfb Ms","description":"Mean time to first byte of those checks."},"dns_ms":{"type":"number","title":"Dns Ms","description":"Mean over those checks. Time the name lookup took, the probe's own phase."},"connect_ms":{"type":"number","title":"Connect Ms","description":"Mean over those checks. Time the TCP connect took, the probe's own phase."},"tls_ms":{"type":"number","title":"Tls Ms","description":"Mean over those checks. Time the TLS handshake took, the probe's own phase."},"edge_ms":{"type":"number","title":"Edge Ms","description":"Mean over those checks. Time at the edge or CDN, `edge_dur` of the shop's Server-Timing, 0 without it."},"origin_ms":{"type":"number","title":"Origin Ms","description":"Mean over those checks. The part of `origin_dur` the backend does not cover, the CDN to origin network and queueing. 0 without `origin_dur`."},"backend_ms":{"type":"number","title":"Backend Ms","description":"Mean over those checks. `backend_dur` of the shop's Server-Timing, or without it the sum of `db_dur`, `render_dur`, `kv_dur`, `http_dur` and `code_dur`, 0 without any."},"unattributed_ms":{"type":"number","title":"Unattributed Ms","description":"Mean over those checks. The rest of the wait for the first byte that no phase names: network, queueing, a proxy or what the shop does not report. Never below 0."},"db_ms":{"type":"number","title":"Db Ms","description":"Mean over those checks. Database time inside `backend_ms`, not added to the sum. 0 without `db_dur`."},"render_ms":{"type":"number","title":"Render Ms","description":"Mean over those checks. Template or render time inside `backend_ms`, not added to the sum. 0 without `render_dur`."},"kv_ms":{"type":"number","title":"Kv Ms","description":"Mean over those checks. Key-value and cache tier time inside `backend_ms`, not added to the sum. 0 without `kv_dur`."},"http_ms":{"type":"number","title":"Http Ms","description":"Mean over those checks. Outbound HTTP call time inside `backend_ms`, not added to the sum. 0 without `http_dur`."},"code_ms":{"type":"number","title":"Code Ms","description":"Mean over those checks. Time in the application's own code inside `backend_ms`, not added to the sum. 0 without `code_dur`."}},"type":"object","required":["check_count","ttfb_ms","dns_ms","connect_ms","tls_ms","edge_ms","origin_ms","backend_ms","unattributed_ms","db_ms","render_ms","kv_ms","http_ms","code_ms"],"title":"UptimeBucketTtfbBreakdown","description":"What the TTFB of a bucket's checks was made of, as means. `dns_ms`,\n`connect_ms`, `tls_ms`, `edge_ms`, `origin_ms`, `backend_ms` and\n`unattributed_ms` add up to `ttfb_ms`, unless a check was skewed."},"UptimeChainCheck":{"properties":{"check_id":{"title":"Check Id","description":"The `check_id` of the check's sample, for `GET /sites/{site_id}/uptime/checks/{check_id}` with this check's `site_id`. Absent on a reference, which has no row.","type":"string"},"site_id":{"title":"Site Id","description":"The site the check belongs to, another site of the application in step 3. Absent on a reference, a host outside every shop.","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"],"type":"string","format":"uuid"},"page_type":{"type":"string","title":"Page Type","description":"The target the check belongs to: `home` for the home page, else the page type of the URL it fetched. `home` on a reference."},"url":{"type":"string","title":"Url","description":"The URL the check fetched, without the cache-buster."},"is_ok":{"type":"boolean","title":"Is Ok","description":"True when the check ended in a final status from 200 to 399."},"status_code":{"type":"integer","title":"Status Code","description":"The final HTTP status code, 0 for a check that got no HTTP response."},"uptime_error_class":{"description":"What the failed check ran into. Absent on a successful check.","$ref":"#/components/schemas/UptimeErrorClass"},"timestamp":{"type":"string","format":"date-time","title":"Timestamp","description":"When the check ran.","examples":["2026-04-14T09:50:01Z"]}},"type":"object","required":["page_type","url","is_ok","status_code","timestamp"],"title":"UptimeChainCheck","description":"One check of one step of a check chain."},"UptimeChainOutcome":{"type":"string","title":"UptimeChainOutcome","description":"What a check chain concluded.","x-extensible-enum":["hiccup","broken_page","site_down","application_down","probe_failure","unknown"]},"UptimeChainResponse":{"properties":{"chain_id":{"type":"string","format":"uuid","title":"Chain Id","description":"Identifier of the chain.","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"site_id":{"type":"string","format":"uuid","title":"Site Id","description":"The site whose failed check started the chain.","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"started_at":{"type":"string","format":"date-time","title":"Started At","description":"When the check that started the chain ran.","examples":["2026-04-14T09:50:01Z"]},"ended_at":{"type":"string","format":"date-time","title":"Ended At","description":"When the chain decided, or when its step ran out of time.","examples":["2026-04-14T09:50:01Z"]},"outcome":{"$ref":"#/components/schemas/UptimeChainOutcome","description":"What the chain concluded: `hiccup` nothing, `broken_page` one URL broken alone, `site_down` the site, `application_down` several sites of the application, `probe_failure` the probe itself, `unknown` a step whose answers did not come in time."},"observation_id":{"title":"Observation Id","description":"The observation the chain opened or landed in. Absent where it opened none, and where the global-failure guard held it.","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"],"type":"string","format":"uuid"},"steps":{"items":{"$ref":"#/components/schemas/UptimeChainStep"},"type":"array","title":"Steps","description":"The steps that have a check, in step order."}},"type":"object","required":["chain_id","site_id","started_at","ended_at","outcome","steps"],"title":"UptimeChainResponse","description":"One check chain of a site: how wide a failure was and what it opened."},"UptimeChainStep":{"properties":{"step":{"type":"integer","maximum":4.0,"minimum":1.0,"title":"Step","description":"1 the recheck of the failed URL, 2 the next URL of its type and the home page, 3 the home pages of the other sites, 4 the references."},"checks":{"items":{"$ref":"#/components/schemas/UptimeChainCheck"},"type":"array","title":"Checks","description":"The checks of the step. The failure that started the chain is the first check of step 1, or of step 2 for a home page. The rest follow by time."}},"type":"object","required":["step","checks"],"title":"UptimeChainStep","description":"The checks of one step of a check chain."},"UptimeCheckGroup":{"properties":{"site_id":{"title":"Site Id","description":"The site of the group's checks. Only where `group_by` names `site_id`.","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"],"type":"string","format":"uuid"},"page_type":{"title":"Page Type","description":"The target of the group's checks: `home` for the home page, else the page type such as `product`. Only where `group_by` names `page_type`.","type":"string"},"status_code":{"title":"Status Code","description":"The final HTTP status code of the group's checks, 0 for no HTTP response. Only where `group_by` names `status_code`.","type":"integer"},"cache_status":{"title":"Cache Status","description":"The cache status of the group's checks, `''` for checks whose response reported none. Only where `group_by` names `cache_status`. Uppercase, an open set: `HIT`, `MISS`, `DYNAMIC`...","type":"string"},"check_count":{"type":"integer","title":"Check Count","description":"Checks in the group."},"failed_count":{"type":"integer","title":"Failed Count","description":"Checks in the group that did not end in a final status from 200 to 399."},"p50_ttfb_ms":{"title":"P50 Ttfb Ms","description":"Median time to first byte of the group's successful checks. Absent without a successful check that measured one.","type":"integer"},"p95_ttfb_ms":{"title":"P95 Ttfb Ms","description":"95th percentile of the time to first byte of the group's successful checks. Absent without a successful check that measured one.","type":"integer"},"p50_total_ms":{"title":"P50 Total Ms","description":"Median time the group's successful checks took. Absent without a successful check that measured one.","type":"integer"},"p95_total_ms":{"title":"P95 Total Ms","description":"95th percentile of the time the group's successful checks took. Absent without a successful check that measured one.","type":"integer"},"ttfb_breakdown":{"description":"What the TTFB of the group's checks was made of, as means, the rule of a bucket of the series. Absent without a check with a first byte.","$ref":"#/components/schemas/UptimeBucketTtfbBreakdown"},"last_checked_at":{"type":"string","format":"date-time","title":"Last Checked At","description":"When the newest check of the group ran.","examples":["2026-04-14T09:50:01Z"]},"is_last_check_ok":{"type":"boolean","title":"Is Last Check Ok","description":"Whether that check ended in a final status from 200 to 399."},"last_status_code":{"type":"integer","title":"Last Status Code","description":"The final HTTP status code of that check, 0 for no HTTP response."},"last_uptime_error_class":{"description":"What that check ran into. Absent where it succeeded.","$ref":"#/components/schemas/UptimeErrorClass"}},"type":"object","required":["check_count","failed_count","last_checked_at","is_last_check_ok","last_status_code"],"title":"UptimeCheckGroup","description":"The checks of a window that share the values of the requested group keys."},"UptimeCheckGroupsResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/UptimeCheckGroup"},"type":"array","title":"Data","description":"One group per combination of the keys with a check, the most failed checks first, then the most checks, then by the keys. Empty while no check matched."},"time_range":{"$ref":"#/components/schemas/TimeRange","description":"The window the groups cover, as the server resolved it."}},"type":"object","required":["data","time_range"],"title":"UptimeCheckGroupsResponse","description":"The checks of a window grouped by one or two keys."},"UptimeCheckListResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/UptimeSample"},"type":"array","title":"Data"},"meta":{"$ref":"#/components/schemas/PaginationMeta"},"time_range":{"$ref":"#/components/schemas/TimeRange","description":"The window the checks and `meta.total` cover, as the server resolved it."}},"type":"object","required":["data","meta","time_range"],"title":"UptimeCheckListResponse","description":"One page of the checks of a window, the newest first."},"UptimeCheckResponse":{"properties":{"requested_at":{"type":"string","format":"date-time","title":"Requested At","description":"When the check was queued. Its results are the samples of `GET /sites/{site_id}/uptime` newer than this.","examples":["2026-04-14T09:50:01Z"]},"targets":{"items":{"$ref":"#/components/schemas/UptimeCheckTarget"},"type":"array","title":"Targets","description":"The URLs queued, the home page first and then the page types."}},"type":"object","required":["requested_at","targets"],"title":"UptimeCheckResponse","description":"What a manual check of a site queued."},"UptimeCheckTarget":{"properties":{"page_type":{"type":"string","title":"Page Type","description":"`home` for the home page, else the page type one of whose most viewed URLs is checked, such as `product`."},"url":{"type":"string","title":"Url","description":"The URL the check fetches, without the cache-buster."}},"type":"object","required":["page_type","url"],"title":"UptimeCheckTarget","description":"One URL a manual check queued."},"UptimeCheckType":{"type":"string","title":"UptimeCheckType","description":"How a check was scheduled, as the lease of the check knew it.","x-extensible-enum":["regular","recheck","priority","watch"]},"UptimeErrorClass":{"type":"string","enum":["dns","connect","tls","timeout","http_4xx","http_5xx","redirect_loop","other"],"title":"UptimeErrorClass","description":"What a failed check ran into, the set the ingest stores."},"UptimeGranularity":{"type":"string","enum":["five_minutes","hour","day"],"title":"UptimeGranularity","description":"The bucket width of the uptime series, picked from the window's length.\n\nNot `BucketGranularity`: the uptime series answers only these three\nwidths, and a reader of this enum would otherwise expect all eight."},"UptimePageType":{"type":"string","enum":["category","product","search"],"title":"UptimePageType","description":"A page type the uptime probe checks besides the home page."},"UptimePageTypeMode":{"type":"string","enum":["automatic","off","fixed"],"title":"UptimePageTypeMode","description":"How the uptime probe picks the URL of a page type."},"UptimePageTypeSetting":{"properties":{"mode":{"$ref":"#/components/schemas/UptimePageTypeMode","description":"`automatic` checks the most viewed URLs of the last 7 days, `off` checks none, `fixed` checks `fixed_path` alone."},"fixed_path":{"anyOf":[{"type":"string","maxLength":1024},{"type":"null"}],"title":"Fixed Path","description":"The path and query the probe checks on every domain of the application, as `https://{domain}{fixed_path}`, exactly as written. Only with `mode` `fixed`. Starts with `/`, no scheme, host or fragment, printable ASCII without spaces, at most 1024 characters. A 404 on it is a failure."},"sold_out_enabled":{"type":"boolean","title":"Sold Out Enabled","description":"Whether a 404 on a URL the probe picked from traffic means the page sold out rather than broke. The URL leaves the rotation and no broken page is reported, unless every picked URL of the type answers 404 within the day. A fixed path is never a picked URL, so it acts only while `mode` is `automatic`.","default":false}},"additionalProperties":false,"type":"object","required":["mode"],"title":"UptimePageTypeSetting","description":"How the uptime probe checks one page type of an application."},"UptimeSample":{"properties":{"check_id":{"type":"string","title":"Check Id","description":"Opaque id of the check within its site, for `GET /sites/{site_id}/uptime/checks/{check_id}`. Take it from here, never build it: its form may change. Two checks of one target in the same millisecond share it."},"timestamp":{"type":"string","format":"date-time","title":"Timestamp","description":"When the check ran.","examples":["2026-04-14T09:50:01Z"]},"site_id":{"title":"Site Id","description":"The site the check belongs to. On the application routes `GET /applications/{app_id}/uptime/series` and `GET /applications/{app_id}/uptime/checks` only, absent on the site routes, which read one site.","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"],"type":"string","format":"uuid"},"page_type":{"type":"string","title":"Page Type","description":"The target the check belongs to: `home` for the home page, else the page type one of whose most viewed URLs it fetched, such as `product`."},"url":{"type":"string","title":"Url","description":"The URL the check fetched, without the cache-buster."},"is_ok":{"type":"boolean","title":"Is Ok","description":"True when the check ended in a final status from 200 to 399."},"status_code":{"type":"integer","title":"Status Code","description":"The final HTTP status code, 0 for a check that got no HTTP response."},"uptime_error_class":{"description":"What the failed check ran into. Absent on a successful check.","$ref":"#/components/schemas/UptimeErrorClass"},"check_type":{"$ref":"#/components/schemas/UptimeCheckType","description":"How the check was scheduled: `regular` for a slot of the rotation, `recheck` for the second check of a URL that just failed, `watch` for a check of an open observation's watch, `priority` for a confirmation, a manual check and every other queued check. Checks stored before the field existed read `regular`."},"chain_id":{"title":"Chain Id","description":"The check chain the check answered, for `GET /applications/{app_id}/uptime/chains/{chain_id}`, or for `GET /sites/{site_id}/uptime/chains/{chain_id}` with the check's own site in steps 1 and 2. In step 3 the chain is another site's. A check in several chains names the chain of its own site, else the oldest. Absent outside a chain and while the chain still runs.","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"],"type":"string","format":"uuid"},"chain_step":{"title":"Chain Step","description":"The step of `chain_id` the check answered, 1 to 3. Step 4 checks the references, which have no sample. Absent where `chain_id` is.","type":"integer","maximum":3.0,"minimum":1.0},"ttfb_ms":{"type":"integer","title":"Ttfb Ms","description":"Time from the start of the check to the first response byte, from the probe's one vantage. 0 where no byte arrived."},"total_ms":{"type":"integer","title":"Total Ms","description":"Time the whole check took, redirects included. 0 where scout sent none."},"dns_ms":{"type":"integer","title":"Dns Ms","description":"Time the name lookup took, from the probe's one vantage. 0 where scout sent none."},"connect_ms":{"type":"integer","title":"Connect Ms","description":"Time the TCP connect took, from the probe's one vantage. 0 where scout sent none."},"tls_ms":{"type":"integer","title":"Tls Ms","description":"Time the TLS handshake took, from the probe's one vantage. 0 where scout sent none."},"redirect_count":{"type":"integer","title":"Redirect Count","description":"Redirects the check followed to `final_url`."},"body_bytes":{"type":"integer","title":"Body Bytes","description":"Size of the response body the check read. 0 where scout sent none."},"cache_status":{"title":"Cache Status","description":"The cache status the response headers reported, absent where none did. Uppercase, an open set: `HIT`, `MISS`, `DYNAMIC`...","type":"string"},"final_url":{"title":"Final Url","description":"The URL the redirects ended on. Absent where scout sent none.","type":"string"},"edge_dur":{"title":"Edge Dur","description":"Time at the edge or CDN in milliseconds, promoted from the shop's Server-Timing header as on the RUM routes. Absent where the response named no alias of it.","type":"number"},"origin_dur":{"title":"Origin Dur","description":"Origin response time in milliseconds, promoted from the shop's Server-Timing header as on the RUM routes. Absent where the response named no alias of it.","type":"number"},"backend_dur":{"title":"Backend Dur","description":"Whole backend or application time in milliseconds, promoted from the shop's Server-Timing header as on the RUM routes. Absent where the response named no alias of it.","type":"number"},"db_dur":{"title":"Db Dur","description":"Database time in milliseconds, promoted from the shop's Server-Timing header as on the RUM routes. Absent where the response named no alias of it.","type":"number"},"render_dur":{"title":"Render Dur","description":"Template or render time in milliseconds, promoted from the shop's Server-Timing header as on the RUM routes. Absent where the response named no alias of it.","type":"number"},"kv_dur":{"title":"Kv Dur","description":"Key-value and cache tier time, summed over its members, in milliseconds, promoted from the shop's Server-Timing header as on the RUM routes. Absent where the response named no alias of it.","type":"number"},"http_dur":{"title":"Http Dur","description":"Outbound HTTP call time, summed over its members, in milliseconds, promoted from the shop's Server-Timing header as on the RUM routes. Absent where the response named no alias of it.","type":"number"},"code_dur":{"title":"Code Dur","description":"Time in the application's own code in milliseconds, promoted from the shop's Server-Timing header as on the RUM routes. Absent where the response named no alias of it.","type":"number"},"ttfb_breakdown":{"description":"What `ttfb_ms` was made of. Absent where no first byte arrived.","$ref":"#/components/schemas/UptimeTtfbBreakdown"},"server_timing_phases":{"title":"Server Timing Phases","description":"The rest of the shop's own Server-Timing header of the response, name to milliseconds, names lowercased as on the RUM routes. A single-key source of a promoted phase is not repeated here, a member of a summed phase is. Absent where no entry is left or the check ran before the header was parsed.","additionalProperties":{"type":"number"},"type":"object"},"body_excerpt":{"title":"Body Excerpt","description":"The start of the response body the shop sent, cut to 2 KB. On a failed check only, absent on a successful one and where the shop sent no response or a status below 400: scout captures the body on every answer with status 400 or higher.","type":"string"},"response_headers":{"title":"Response Headers","description":"The response headers the shop sent, name lowercased to value, with the values of a repeated name joined by `, `. `set-cookie` is never stored, and the stored headers are cut to 4 KB, so the last value can be cut short. On a failed check only, absent on a successful one and where the shop sent no response or a status below 400.","additionalProperties":{"type":"string"},"type":"object"}},"type":"object","required":["check_id","timestamp","page_type","url","is_ok","status_code","check_type","ttfb_ms","total_ms","dns_ms","connect_ms","tls_ms","redirect_count","body_bytes"],"title":"UptimeSample","description":"One check of one URL of a site."},"UptimeSampleDetail":{"properties":{"check_id":{"type":"string","title":"Check Id","description":"Opaque id of the check within its site, for `GET /sites/{site_id}/uptime/checks/{check_id}`. Take it from here, never build it: its form may change. Two checks of one target in the same millisecond share it."},"timestamp":{"type":"string","format":"date-time","title":"Timestamp","description":"When the check ran.","examples":["2026-04-14T09:50:01Z"]},"site_id":{"title":"Site Id","description":"The site the check belongs to. On the application routes `GET /applications/{app_id}/uptime/series` and `GET /applications/{app_id}/uptime/checks` only, absent on the site routes, which read one site.","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"],"type":"string","format":"uuid"},"page_type":{"type":"string","title":"Page Type","description":"The target the check belongs to: `home` for the home page, else the page type one of whose most viewed URLs it fetched, such as `product`."},"url":{"type":"string","title":"Url","description":"The URL the check fetched, without the cache-buster."},"is_ok":{"type":"boolean","title":"Is Ok","description":"True when the check ended in a final status from 200 to 399."},"status_code":{"type":"integer","title":"Status Code","description":"The final HTTP status code, 0 for a check that got no HTTP response."},"uptime_error_class":{"description":"What the failed check ran into. Absent on a successful check.","$ref":"#/components/schemas/UptimeErrorClass"},"check_type":{"$ref":"#/components/schemas/UptimeCheckType","description":"How the check was scheduled: `regular` for a slot of the rotation, `recheck` for the second check of a URL that just failed, `watch` for a check of an open observation's watch, `priority` for a confirmation, a manual check and every other queued check. Checks stored before the field existed read `regular`."},"chain_id":{"title":"Chain Id","description":"The check chain the check answered, for `GET /applications/{app_id}/uptime/chains/{chain_id}`, or for `GET /sites/{site_id}/uptime/chains/{chain_id}` with the check's own site in steps 1 and 2. In step 3 the chain is another site's. A check in several chains names the chain of its own site, else the oldest. Absent outside a chain and while the chain still runs.","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"],"type":"string","format":"uuid"},"chain_step":{"title":"Chain Step","description":"The step of `chain_id` the check answered, 1 to 3. Step 4 checks the references, which have no sample. Absent where `chain_id` is.","type":"integer","maximum":3.0,"minimum":1.0},"ttfb_ms":{"type":"integer","title":"Ttfb Ms","description":"Time from the start of the check to the first response byte, from the probe's one vantage. 0 where no byte arrived."},"total_ms":{"type":"integer","title":"Total Ms","description":"Time the whole check took, redirects included. 0 where scout sent none."},"dns_ms":{"type":"integer","title":"Dns Ms","description":"Time the name lookup took, from the probe's one vantage. 0 where scout sent none."},"connect_ms":{"type":"integer","title":"Connect Ms","description":"Time the TCP connect took, from the probe's one vantage. 0 where scout sent none."},"tls_ms":{"type":"integer","title":"Tls Ms","description":"Time the TLS handshake took, from the probe's one vantage. 0 where scout sent none."},"redirect_count":{"type":"integer","title":"Redirect Count","description":"Redirects the check followed to `final_url`."},"body_bytes":{"type":"integer","title":"Body Bytes","description":"Size of the response body the check read. 0 where scout sent none."},"cache_status":{"title":"Cache Status","description":"The cache status the response headers reported, absent where none did. Uppercase, an open set: `HIT`, `MISS`, `DYNAMIC`...","type":"string"},"final_url":{"title":"Final Url","description":"The URL the redirects ended on. Absent where scout sent none.","type":"string"},"edge_dur":{"title":"Edge Dur","description":"Time at the edge or CDN in milliseconds, promoted from the shop's Server-Timing header as on the RUM routes. Absent where the response named no alias of it.","type":"number"},"origin_dur":{"title":"Origin Dur","description":"Origin response time in milliseconds, promoted from the shop's Server-Timing header as on the RUM routes. Absent where the response named no alias of it.","type":"number"},"backend_dur":{"title":"Backend Dur","description":"Whole backend or application time in milliseconds, promoted from the shop's Server-Timing header as on the RUM routes. Absent where the response named no alias of it.","type":"number"},"db_dur":{"title":"Db Dur","description":"Database time in milliseconds, promoted from the shop's Server-Timing header as on the RUM routes. Absent where the response named no alias of it.","type":"number"},"render_dur":{"title":"Render Dur","description":"Template or render time in milliseconds, promoted from the shop's Server-Timing header as on the RUM routes. Absent where the response named no alias of it.","type":"number"},"kv_dur":{"title":"Kv Dur","description":"Key-value and cache tier time, summed over its members, in milliseconds, promoted from the shop's Server-Timing header as on the RUM routes. Absent where the response named no alias of it.","type":"number"},"http_dur":{"title":"Http Dur","description":"Outbound HTTP call time, summed over its members, in milliseconds, promoted from the shop's Server-Timing header as on the RUM routes. Absent where the response named no alias of it.","type":"number"},"code_dur":{"title":"Code Dur","description":"Time in the application's own code in milliseconds, promoted from the shop's Server-Timing header as on the RUM routes. Absent where the response named no alias of it.","type":"number"},"ttfb_breakdown":{"description":"What `ttfb_ms` was made of. Absent where no first byte arrived.","$ref":"#/components/schemas/UptimeTtfbBreakdown"},"server_timing_phases":{"title":"Server Timing Phases","description":"The rest of the shop's own Server-Timing header of the response, name to milliseconds, names lowercased as on the RUM routes. A single-key source of a promoted phase is not repeated here, a member of a summed phase is. Absent where no entry is left or the check ran before the header was parsed.","additionalProperties":{"type":"number"},"type":"object"},"body_excerpt":{"title":"Body Excerpt","description":"The start of the response body the shop sent, cut to 2 KB. Absent where the shop sent no response or the status was below 400: scout captures the body on every answer with status 400 or higher.","type":"string"},"response_headers":{"title":"Response Headers","description":"The response headers the shop sent, name lowercased to value, with the values of a repeated name joined by `, `. `set-cookie` is never stored, and the stored headers are cut to 4 KB, so the last value can be cut short. Absent where the shop sent no response or the status was below 400.","additionalProperties":{"type":"string"},"type":"object"},"server_timing_header":{"title":"Server Timing Header","description":"The shop's raw `Server-Timing` response header, cut to 1 KB. Absent where the response carried none.","type":"string"}},"type":"object","required":["check_id","timestamp","page_type","url","is_ok","status_code","check_type","ttfb_ms","total_ms","dns_ms","connect_ms","tls_ms","redirect_count","body_bytes"],"title":"UptimeSampleDetail","description":"One check of one URL of a site, with what the shop answered."},"UptimeServerTiming":{"properties":{"key":{"type":"string","title":"Key","description":"The Server-Timing name, lowercased as on the RUM routes."},"p50_ms":{"type":"number","title":"P50 Ms","description":"Median duration the checks of the bucket reported."},"p95_ms":{"type":"number","title":"P95 Ms","description":"95th percentile of the duration the checks of the bucket reported."}},"type":"object","required":["key","p50_ms","p95_ms"],"title":"UptimeServerTiming","description":"The durations one Server-Timing name reported over the checks of a bucket."},"UptimeServerTimingPhase":{"properties":{"phase":{"type":"string","title":"Phase","description":"The phase under its RUM name: `edge_dur`, `origin_dur`, `backend_dur`, `db_dur`, `render_dur`, `kv_dur`, `http_dur` or `code_dur`."},"p50_ms":{"type":"number","title":"P50 Ms","description":"Median of the phase over the checks of the bucket that reported it."},"p95_ms":{"type":"number","title":"P95 Ms","description":"95th percentile of the phase over the checks of the bucket that reported it."}},"type":"object","required":["phase","p50_ms","p95_ms"],"title":"UptimeServerTimingPhase","description":"The durations one promoted Server-Timing phase reported over the checks of a bucket."},"UptimeSiteBucket":{"properties":{"timestamp":{"type":"string","format":"date-time","title":"Timestamp","description":"Start of the bucket. `granularity` of its series says the width.","examples":["2026-04-14T09:50:01Z"]},"check_count":{"type":"integer","title":"Check Count","description":"Checks of the site in this bucket, 0 without one."},"failed_count":{"type":"integer","title":"Failed Count","description":"Checks of the site in this bucket that did not end in a final status from 200 to 399."}},"type":"object","required":["timestamp","check_count","failed_count"],"title":"UptimeSiteBucket","description":"The checks of one site in one bucket of the window, over all its targets."},"UptimeSiteSeries":{"properties":{"site_id":{"type":"string","format":"uuid","title":"Site Id","description":"The site the series counts.","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"granularity":{"$ref":"#/components/schemas/UptimeGranularity","description":"Width of every bucket, the same as on `series` of the response."},"buckets":{"items":{"$ref":"#/components/schemas/UptimeSiteBucket"},"type":"array","title":"Buckets","description":"Every bucket of the window in time order on the grid of `series`, those without a check included."}},"type":"object","required":["site_id","granularity","buckets"],"title":"UptimeSiteSeries","description":"The checks of one site of an application over the window, bucketed, counts only."},"UptimeSummaryPart":{"properties":{"text":{"type":"string","title":"Text","description":"Plain text, no markup."},"site_id":{"title":"Site Id","description":"The site this part names, absent on plain text.","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"],"type":"string","format":"uuid"}},"type":"object","required":["text"],"title":"UptimeSummaryPart","description":"A stretch of plain text, the name of a site where it carries `site_id`."},"UptimeSummaryResponse":{"properties":{"language":{"type":"string","enum":["en","de"],"title":"Language","description":"The language the sentences are in."},"sentences":{"items":{"$ref":"#/components/schemas/UptimeSummarySentence"},"type":"array","title":"Sentences","description":"In reading order: outages, slow or unreliable sites, certificates, the sites that run normally, then the availability of the window."},"time_range":{"$ref":"#/components/schemas/TimeRange","description":"The window the availability covers, as the server resolved it."}},"type":"object","required":["language","sentences","time_range"],"title":"UptimeSummaryResponse","description":"The sentences of the uptime page's summary box."},"UptimeSummarySentence":{"properties":{"sentence_type":{"$ref":"#/components/schemas/UptimeSummarySentenceType","description":"What the sentence says."},"severity":{"$ref":"#/components/schemas/SummarySeverity","description":"How the sentence reads."},"parts":{"items":{"$ref":"#/components/schemas/UptimeSummaryPart"},"type":"array","title":"Parts","description":"The sentence in order, joined without a separator."}},"type":"object","required":["sentence_type","severity","parts"],"title":"UptimeSummarySentence","description":"One sentence of the uptime summary, in parts so a site name can link to its page."},"UptimeSummarySentenceType":{"type":"string","enum":["outage","slow","unstable","certificate","sites","availability"],"title":"UptimeSummarySentenceType","description":"What one sentence of the uptime summary says."},"UptimeTargetBaseline":{"properties":{"median_ms":{"type":"integer","title":"Median Ms","description":"Median time to first byte of the target's successful checks over the last 7 days. A check is slow above twice this and at least 500 ms over it."},"sample_count":{"title":"Sample Count","description":"The successful checks `median_ms` is the median of, at least 50. Absent for a baseline computed before the count was stored, until the next daily computation.","type":"integer"}},"type":"object","required":["median_ms"],"title":"UptimeTargetBaseline","description":"The response time one target of a site is held against."},"UptimeTargetPageType":{"type":"string","enum":["home","category","product","search"],"title":"UptimeTargetPageType","description":"A target of the uptime probe on one site, the home page or a page type."},"UptimeTargetSeries":{"properties":{"page_type":{"type":"string","title":"Page Type","description":"The target: `home` for the home page, else the page type whose most viewed URL the probe fetches, such as `product`."},"granularity":{"$ref":"#/components/schemas/UptimeGranularity","description":"Width of every bucket, the same on every series of a response: `five_minutes` for a window up to a day, `hour` up to 7 days, `day` above."},"buckets":{"items":{"$ref":"#/components/schemas/UptimeBucket"},"type":"array","title":"Buckets","description":"Every bucket of the window in time order, those without a check included."}},"type":"object","required":["page_type","granularity","buckets"],"title":"UptimeTargetSeries","description":"The checks of one target of the site over the window, bucketed."},"UptimeTtfbBreakdown":{"properties":{"dns_ms":{"type":"number","title":"Dns Ms","description":"Time the name lookup took, the probe's own phase."},"connect_ms":{"type":"number","title":"Connect Ms","description":"Time the TCP connect took, the probe's own phase."},"tls_ms":{"type":"number","title":"Tls Ms","description":"Time the TLS handshake took, the probe's own phase."},"edge_ms":{"type":"number","title":"Edge Ms","description":"Time at the edge or CDN, `edge_dur` of the shop's Server-Timing, 0 without it."},"origin_ms":{"type":"number","title":"Origin Ms","description":"The part of `origin_dur` the backend does not cover, the CDN to origin network and queueing. 0 without `origin_dur` and on a cache hit."},"backend_ms":{"type":"number","title":"Backend Ms","description":"`backend_dur` of the shop's Server-Timing, or without it the sum of `db_dur`, `render_dur`, `kv_dur`, `http_dur` and `code_dur`, 0 without any and on a cache hit, whose header replays the fill."},"unattributed_ms":{"type":"number","title":"Unattributed Ms","description":"The rest of the wait for the first byte that no phase names: network, queueing, a proxy or what the shop does not report. Never below 0."},"db_ms":{"type":"number","title":"Db Ms","description":"Database time inside `backend_ms`, not added to the sum. 0 without `db_dur`."},"render_ms":{"type":"number","title":"Render Ms","description":"Template or render time inside `backend_ms`, not added to the sum. 0 without `render_dur`."},"kv_ms":{"type":"number","title":"Kv Ms","description":"Key-value and cache tier time inside `backend_ms`, not added to the sum. 0 without `kv_dur`."},"http_ms":{"type":"number","title":"Http Ms","description":"Outbound HTTP call time inside `backend_ms`, not added to the sum. 0 without `http_dur`."},"code_ms":{"type":"number","title":"Code Ms","description":"Time in the application's own code inside `backend_ms`, not added to the sum. 0 without `code_dur`."},"is_skewed":{"type":"boolean","title":"Is Skewed","description":"True where the shop's Server-Timing claims more server time than the probe waited: clock or proxy skew, or a first byte that was a 103 Early Hints. `unattributed_ms` is then 0 and the parts add up to more than `ttfb_ms`."}},"type":"object","required":["dns_ms","connect_ms","tls_ms","edge_ms","origin_ms","backend_ms","unattributed_ms","db_ms","render_ms","kv_ms","http_ms","code_ms","is_skewed"],"title":"UptimeTtfbBreakdown","description":"What one check's TTFB was made of. `dns_ms`, `connect_ms`, `tls_ms`,\n`edge_ms`, `origin_ms`, `backend_ms` and `unattributed_ms` add up to\n`ttfb_ms` of the sample, unless `is_skewed`."},"UsageResponse":{"properties":{"pageview_count":{"type":"integer","title":"Pageview Count","description":"Pageviews counted over the window, one per pageview, unweighted, bots included"},"time_range":{"$ref":"#/components/schemas/TimeRange","description":"The window counted: the start of the calendar month to now"},"sites":{"items":{"$ref":"#/components/schemas/SiteUsage"},"type":"array","title":"Sites"}},"type":"object","required":["pageview_count","time_range","sites"],"title":"UsageResponse","description":"Pageviews the organization used in the current billing period."},"UserRef":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"],"description":"An ID, a UUID in lowercase with hyphens."},"full_name":{"title":"Full Name","description":"Absent when the account has no name.","type":"string"}},"type":"object","required":["id"],"title":"UserRef","description":"A person who did something to another resource."},"ValidationErrorBody":{"properties":{"code":{"$ref":"#/components/schemas/ErrorCode"},"message":{"type":"string","title":"Message"},"request_id":{"title":"Request Id","type":"string"},"doc_url":{"title":"Doc Url","type":"string"},"details":{"title":"Details","additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object"}},"type":"object","required":["code","message"],"title":"ValidationErrorBody","description":"The error body of a 422, whose `details` maps a field path to its messages (§14)."},"ValidationErrorResponse":{"properties":{"error":{"$ref":"#/components/schemas/ValidationErrorBody"}},"type":"object","required":["error"],"title":"ValidationErrorResponse"},"VisitorAggregateFilters":{"properties":{"min_page_count":{"anyOf":[{"type":"integer","minimum":1.0},{"type":"null"}],"title":"Min Page Count"},"max_page_count":{"anyOf":[{"type":"integer","minimum":1.0},{"type":"null"}],"title":"Max Page Count"},"min_duration_ms":{"anyOf":[{"type":"integer","minimum":0.0},{"type":"null"}],"title":"Min Duration Ms"},"max_duration_ms":{"anyOf":[{"type":"integer","minimum":0.0},{"type":"null"}],"title":"Max Duration Ms"},"min_avg_lcp_ms":{"anyOf":[{"type":"integer","minimum":0.0},{"type":"null"}],"title":"Min Avg Lcp Ms"},"max_avg_lcp_ms":{"anyOf":[{"type":"integer","minimum":0.0},{"type":"null"}],"title":"Max Avg Lcp Ms"},"min_errors":{"anyOf":[{"type":"integer","minimum":0.0},{"type":"null"}],"title":"Min Errors"},"contains_page_type":{"anyOf":[{"type":"string","maxLength":64},{"type":"null"}],"title":"Contains Page Type","description":"Only visitors whose session includes >=1 pageview of this page_type"},"contains_checkout_stage":{"anyOf":[{"type":"string","maxLength":32},{"type":"null"}],"title":"Contains Checkout Stage","description":"Only visitors who reached this checkout-funnel stage (cart/checkout/success) through an event in the window, by the funnel's mapping of event names to stages: `view_cart` for cart, `begin_checkout` for checkout, `order_placed` or `purchase` for success, whoever sent it. A pageview's `checkout_stage` never counts. The events are matched by stitch within the site scope, and the list's other filters select the visitors from their pageviews as before. Each row is still a pageview row, so a visitor known ONLY from events is counted by the funnel and has no row here. 422 under the identity `session`, which events do not carry."},"contains_cart_interaction":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Contains Cart Interaction","description":"True: only visitors whose session issued >=1 cart interaction (fetch/XHR cart mutation - add, change or remove; the kinds are not separable, see migration 065). False: only visitors with NONE observed. Omitted/null: no filter."}},"additionalProperties":false,"type":"object","title":"VisitorAggregateFilters","description":"Post-aggregation filters for `/visitors`.\n\nThese apply AFTER the `GROUP BY` on the resolved identity, so they emit HAVING\nclauses rather than WHERE. Fields are independent; omit any to skip that bound.\nNull `avg_lcp` rows (visitors with no LCP measurements) are excluded from any\n`min_avg_lcp_ms`/`max_avg_lcp_ms` bound."},"VisitorArrival":{"properties":{"arrival_type":{"$ref":"#/components/schemas/ArrivalType","description":"`first` on the visitor's first step in the window, `return` on a later hard navigation from outside the site"},"traffic_source":{"type":"string","title":"Traffic Source","description":"UTM source over the referrer source, empty for direct traffic"},"traffic_medium":{"type":"string","title":"Traffic Medium","description":"UTM medium over the referrer medium, empty for direct traffic"},"utm_campaign":{"title":"Utm Campaign","description":"UTM campaign of the step, absent when none","type":"string"}},"type":"object","required":["arrival_type","traffic_source","traffic_medium"],"title":"VisitorArrival","description":"Where a visitor came from on a journey step that is an arrival."},"VisitorDetailRequest":{"properties":{"time_range":{"$ref":"#/components/schemas/TimeRange","description":"Time range for the query"},"filters":{"$ref":"#/components/schemas/Filters","description":"Optional filters"},"timezone":{"anyOf":[{"type":"string","maxLength":64},{"type":"null"}],"title":"Timezone","description":"IANA time zone the local hours of `filters.hour_of_day` are read in, such as `Europe/Berlin`. The filter requires it. This route buckets nothing, so the zone changes nothing else"},"sparse_buckets":{"anyOf":[{"$ref":"#/components/schemas/SparseBuckets"},{"type":"null"}],"description":"The sparse threshold of the page, the number `POST /analytics/sparse-hours` derives. With `exclude` the rows of the thin hours are left out. Without it the route only echoes the number in `meta.sparse_buckets`"},"identity":{"anyOf":[{"type":"string","enum":["stitch","session"]},{"type":"null"}],"title":"Identity","description":"Identifier kind for `visitor_id`: 'session' or 'stitch'. Null resolves the same way the visitor list does (site's preferred/available identity)."},"visitor_id":{"type":"string","maxLength":1024,"minLength":1,"title":"Visitor Id","description":"Visitor ID to retrieve (session_id or stitch)"}},"additionalProperties":false,"type":"object","required":["time_range","visitor_id"],"title":"VisitorDetailRequest","description":"Request for visitor detail (all page visits)."},"VisitorDetailResponse":{"properties":{"meta":{"$ref":"#/components/schemas/AnalyticsMeta","description":"Facts about the result"},"request":{"$ref":"#/components/schemas/AnalyticsRequestEcho","description":"The request as the server resolved it"},"visitor_id":{"type":"string","title":"Visitor Id","description":"Visitor identifier (stitch hex or session_id)"},"pages":{"items":{"$ref":"#/components/schemas/VisitorPageVisit"},"type":"array","title":"Pages","description":"Chronological page visits"},"events":{"title":"Events","description":"Checkout events of this visitor, oldest first, in the REQUESTED time range and not merged into `pages`: interleave the two by time to draw the journey. An event before the first page of the range sorts first and is correct, the run began earlier than the range holds. ABSENT (per response_model_exclude_none) when events were not consulted for this request: `identity` is session (a pixel event carries no session id), a filter has no column on the events table (a URL or page type, in which case the branch is left out whole rather than applied in part), or the table is not installed. `[]` means they were consulted and this visitor has none, the same distinction payment_submitted_visitors makes on the checkout funnel. A visitor id that is not 32 lowercase hex also answers `[]`, and so do the pages beside it. Two order_placed seconds apart are two facts, not a bug: the checkout re-sends an in-flight event on pagehide, and where the client clock was too far off to trust, the server timed each copy on its own. Identical copies are collapsed.","items":{"$ref":"#/components/schemas/VisitorEvent"},"type":"array"},"nel_reports":{"title":"Nel Reports","description":"NEL reports of this visitor, the Network Error Logging reports its browser sent, oldest first, in the REQUESTED time range and not merged into `pages`: interleave them by `timestamp`. Each is a row of POST /analytics/nel/reports without `visitor_id`. At most the latest 100 reports of the window per visitor. POST /analytics/nel/reports with `filters.stitch` pages through all of them. ABSENT (per response_model_exclude_none) when reports were not consulted: `identity` is session, a filter has no column on the nel_reports table, or the table is not installed. `[]` means they were consulted and this visitor has none. A visitor id that is not 32 lowercase hex also answers `[]`. A report joins its visitor over the stitch, which has limits. Only sites with `store_stitch` carry one, and the zero stitch never joins. The edge rotates the stitch salt at 02:00 UTC, so a visitor's reports join within one day and the chain breaks at the boundary. A report may upload up to 48 hours after the failure and then carries the stitch of the upload, so a failure before a rotation that uploads after it belongs to no visitor. Only Chromium browsers report.","items":{"$ref":"#/components/schemas/NelReportRow"},"type":"array"},"csp_reports":{"title":"Csp Reports","description":"CSP reports of this visitor, the Content Security Policy violations its browser reported, oldest first, in the REQUESTED time range and not merged into `pages`: interleave them by `timestamp`. Each is a row of POST /analytics/csp/reports without `visitor_id` and `original_policy`, and one row stands for `report_count` identical reports. At most the latest 100 rows of the window per visitor. POST /analytics/csp/reports with `filters.stitch` pages through all of them. ABSENT (per response_model_exclude_none) when reports were not consulted: `identity` is session, a filter has no column on the csp_reports table, or the table is not installed. `[]` means they were consulted and this visitor has none. A visitor id that is not 32 lowercase hex also answers `[]`. A CSP report joins its visitor over the stitch, as a NEL report does. Only sites with `store_stitch` carry one, and the zero stitch never joins. The edge rotates the stitch salt at 02:00 UTC, so a visitor's reports join within one day and the chain breaks at the boundary. A `report-to` report may upload up to 48 hours after the violation and then carries the stitch of the upload, while a `report-uri` report is sent at once. Practically every browser reports.","items":{"$ref":"#/components/schemas/CspReportRow"},"type":"array"}},"type":"object","required":["meta","request","visitor_id","pages"],"title":"VisitorDetailResponse","description":"Response for visitor detail query."},"VisitorEvent":{"properties":{"event_id":{"type":"string","format":"uuid","title":"Event Id","description":"Opaque id of this event within its site. Pass it with `site_id` to PATCH or DELETE /sites/{site_id}/events/{event_id}. An edit keeps it","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"site_id":{"type":"string","format":"uuid","title":"Site Id","description":"The site the event was sent from","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"name":{"type":"string","title":"Name","description":"The event's name as the sender chose it, lowercased, matching `^[a-z0-9_.-]{1,48}$`. `view_cart`, `begin_checkout`, `add_payment_info` and `order_placed` are the checkout vocabulary and reach their stage whoever sent them. `purchase`, GA4's name, reaches `success` as well. Any other name is the shop's own, ..."},"stage":{"description":"Checkout stage this event's name reaches, whoever sent it. ABSENT (per response_model_exclude_none) for every other name and for add_payment_info, which is a payment fact and no stage: on Shopify a visitor who submitted payment and shows no order_placed most likely paid through a wallet whose completion Shopify does not report. Nothing here derives an abandonment from that.","$ref":"#/components/schemas/EventStage"},"source":{"type":"string","title":"Source","description":"Who sent the event: `shopify_pixel` for the Shopify checkout pixel, `collector` for the stage event derived from a checkout pageview, `tracker` for an event a page sent on purpose, through the tracker or a direct `POST /c/e/{collector_hash}`. The set grows with each way in, ..."},"props":{"additionalProperties":{"type":"string"},"type":"object","title":"Props","description":"The event's properties, flattened to dot notation, every value a string. An array is its JSON text, a number or a boolean its text. Empty when the sender sent none, and always empty on a `collector` event"},"timestamp":{"type":"string","format":"date-time","title":"Timestamp","description":"When the event happened (UTC).","examples":["2026-04-14T09:50:01Z"]}},"type":"object","required":["event_id","site_id","name","source","props","timestamp"],"title":"VisitorEvent","description":"One discrete fact of a visitor's run that no pageview carries."},"VisitorIdentity":{"type":"string","enum":["stitch","session"],"title":"VisitorIdentity","description":"Which identifier the `visitors` metric defaults to in reports (the\napplication's `count_visitors_by` field). A REPORTING preference, deliberately\nseparate from the store_stitch/collect_sessions COLLECTION flags (those decide\nwhether the data exists at all). The query-time resolver clamps this to what\nthe application actually stores, and a per-query `identity` param overrides\nit. See resolve_identity()."},"VisitorJourneyStep":{"properties":{"page_type":{"title":"Page Type","description":"Page classification, absent where unknown","type":"string"},"checkout_stage":{"description":"Funnel position of the pageview, absent outside the funnel","$ref":"#/components/schemas/CheckoutStage"},"duration_ms":{"type":"integer","minimum":0.0,"title":"Duration Ms","description":"Time on the page, 0 where the row has no end"},"error_count":{"type":"integer","minimum":0.0,"title":"Error Count","description":"Errors on this pageview","default":0},"arrival":{"description":"Where the visitor came from, absent when the step is no arrival","$ref":"#/components/schemas/VisitorArrival"}},"type":"object","required":["duration_ms","error_count"],"title":"VisitorJourneyStep","description":"One pageview of a visitor's journey, as the list row carries it.\n\nEnough to draw the visit as a strip (what kind of page, how long, whether\nit failed, where in the funnel) and nothing more: the full record of a\npageview stays on `/visitors/detail`."},"VisitorOutcome":{"type":"string","enum":["ordered","checkout","cart","browsed","bounced"],"title":"VisitorOutcome","description":"How a visit ended, the one word a list row says first (section 28).\n\nDecided from the stages the visitor's events reached, highest first, so a\nbuyer who also hit an error is `ordered` and nothing else. `cart` covers a\ncart stage event as well as a cart interaction without one, because a shop\nwhose cart is a drawer never produces a cart pageview."},"VisitorPageVisit":{"properties":{"url":{"type":"string","title":"Url","description":"Page URL"},"started_at":{"type":"string","format":"date-time","title":"Started At","description":"Pageview start (wall-clock). Anchor for replay timelines.","examples":["2026-04-14T09:50:01Z"]},"ended_at":{"type":"string","format":"date-time","title":"Ended At","description":"Pageview end (wall-clock): close-out / hidden / terminated moment. Together with `started_at` gives true pageview duration.","examples":["2026-04-14T09:50:01Z"]},"nav_type":{"title":"Nav Type","description":"Navigation type","type":"string"},"arrival":{"description":"Where the visitor came from, absent when the page is no arrival","$ref":"#/components/schemas/VisitorArrival"},"lcp":{"title":"Lcp","description":"Largest Contentful Paint (ms)","type":"number"},"fcp":{"title":"Fcp","description":"First Contentful Paint (ms)","type":"number"},"cls":{"title":"Cls","description":"Cumulative Layout Shift","type":"number"},"inp":{"title":"Inp","description":"Interaction to Next Paint (ms)","type":"number"},"ttfb":{"title":"Ttfb","description":"Time to First Byte (ms)","type":"number"},"ttfb_final":{"title":"Ttfb Final","description":"TTFB of the final (non-interim) response (ms); absent off-Chromium. Larger than ttfb when 103 Early Hints were in play.","type":"number"},"page_load_time":{"title":"Page Load Time","description":"Full page load time (ms)","type":"number"},"cdn_cache_status":{"title":"Cdn Cache Status","description":"CDN cache status for this pageview (HIT/MISS/…), if collected","type":"string"},"origin_cache_status":{"title":"Origin Cache Status","description":"Origin cache status for this pageview (HIT/MISS/…), if collected","type":"string"},"page_type":{"title":"Page Type","description":"Page type for this pageview (product/category/cart/…), if detected","type":"string"},"origin_host":{"title":"Origin Host","description":"Origin node that served this pageview (`fm-host`), if reported","type":"string"},"logged_in":{"title":"Logged In","description":"Whether this pageview was rendered for a logged-in visitor (`fm-loggedin`): 'yes' / 'no'; absent if not reported","type":"string"},"cdn_age":{"title":"Cdn Age","description":"Age of the delivered CDN cache object in SECONDS (`fm-cdn-age` or `cdn-cache-age`), if reported","type":"integer"},"origin_age":{"title":"Origin Age","description":"Age of the delivered origin cache object in SECONDS (`fm-origin-age` or `origin-cache-age`), if reported. Under a CDN hit this is the age at fetch time, frozen in the CDN object - the age the visitor saw is cdn_age + origin_age.","type":"integer"},"cdn_ttl":{"title":"Cdn Ttl","description":"Remaining freshness lifetime of the delivered CDN cache object in SECONDS (`fm-cdn-ttl` or `cdn-cache-ttl`), if reported. cdn_age + cdn_ttl is the configured lifetime.","type":"integer"},"origin_ttl":{"title":"Origin Ttl","description":"Remaining freshness lifetime of the delivered origin cache object in SECONDS (`fm-origin-ttl` or `origin-cache-ttl`), if reported. Under a CDN hit this is what was left when the CDN fetched.","type":"integer"},"checkout_stage":{"description":"Checkout-funnel stage of THIS pageview, absent for every pageview outside the funnel. The hook sits on the matching pageview only - the surrounding journey is in this same list because it belongs to the same visitor, not because it is marked.","$ref":"#/components/schemas/CheckoutStage"},"cart_interactions":{"type":"integer","title":"Cart Interactions","description":"Cart interactions (fetch/XHR cart mutations) THIS pageview issued; 0 = none observed.","default":0},"cart_interaction_errors":{"type":"integer","title":"Cart Interaction Errors","description":"Of those, failed ones (HTTP >= 400 or network failure) - the 'cart actions are failing' signal.","default":0},"cart_interaction_kinds":{"additionalProperties":{"type":"integer"},"type":"object","title":"Cart Interaction Kinds","description":"Kind -> calls (add/change/remove/other), where the shop system's endpoint reveals the kind."},"country":{"title":"Country","description":"Country (ISO code) of this pageview","type":"string"},"asn":{"title":"Asn","description":"Autonomous system number of the visitor's network, absent when unknown","type":"integer"},"isp":{"title":"Isp","description":"Name of that network, absent when unknown","type":"string"},"browser":{"title":"Browser","description":"Browser name","type":"string"},"browser_version":{"title":"Browser Version","description":"Browser version","type":"string"},"device_type":{"description":"Device type","$ref":"#/components/schemas/DeviceType"},"os":{"title":"Os","description":"Operating system","type":"string"},"datacenter":{"title":"Datacenter","description":"Datacenter/crawler network label (aws/googlebot/…); absent = normal network","type":"string"},"bot_name":{"title":"Bot Name","description":"Detected bot slug ('unknown' = generic heuristic); absent = no bot signal","type":"string"},"bot_type":{"title":"Bot Type","description":"Bot category tag (ai-crawler/search-engine/…); absent = no bot signal","type":"string"},"is_datacenter":{"type":"boolean","title":"Is Datacenter","description":"Derived: datacenter is set (datacenter/crawler network)","default":false},"is_bot":{"type":"boolean","title":"Is Bot","description":"Derived: bot_name is set (incl. 'unknown')","default":false},"ua_anomaly":{"title":"Ua Anomaly","description":"Client signal (headless/spoofed/non-browser/hyperactive/unnamed/webdriver/automation)","type":"string"},"bot_class":{"$ref":"#/components/schemas/BotClass","description":"Derived traffic verdict: bot / suspect / none","default":"none"},"lcp_ttfb":{"title":"Lcp Ttfb","description":"LCP phase 1: time to first byte (ms)","type":"number"},"lcp_load_delay":{"title":"Lcp Load Delay","description":"LCP phase 2: resource load delay - discovery gap (ms)","type":"number"},"lcp_load_duration":{"title":"Lcp Load Duration","description":"LCP phase 3: resource load duration - download (ms)","type":"number"},"lcp_render_delay":{"title":"Lcp Render Delay","description":"LCP phase 4: element render delay (ms)","type":"number"},"lcp_target":{"title":"Lcp Target","description":"CSS selector path of the LCP element, if captured","type":"string"},"cls_target":{"title":"Cls Target","description":"CSS selector path of the largest layout shift's element, if captured","type":"string"},"inp_input_delay":{"title":"Inp Input Delay","description":"INP subpart: input delay of the reported interaction (ms)","type":"number"},"inp_processing":{"title":"Inp Processing","description":"INP subpart: processing duration of the reported interaction (ms)","type":"number"},"inp_presentation":{"title":"Inp Presentation","description":"INP subpart: presentation delay of the reported interaction (ms)","type":"number"},"inp_interaction_type":{"title":"Inp Interaction Type","description":"Reported INP interaction type (pointer/keyboard), if captured","type":"string"},"inp_target":{"title":"Inp Target","description":"CSS selector path of the reported INP interaction's target, if captured","type":"string"},"error_count":{"type":"integer","title":"Error Count","description":"Errors on this page","default":0},"errors":{"items":{"$ref":"#/components/schemas/BeaconError"},"type":"array","title":"Errors","description":"Structured per-beacon errors (top 5 by occurrence)"}},"type":"object","required":["url","started_at","ended_at","cart_interactions","cart_interaction_errors","cart_interaction_kinds","is_datacenter","is_bot","bot_class","error_count","errors"],"title":"VisitorPageVisit","description":"Single page visit within a visitor's activity."},"VisitorSegmentsRequest":{"properties":{"time_range":{"$ref":"#/components/schemas/TimeRange","description":"Time range for the query"},"filters":{"$ref":"#/components/schemas/Filters","description":"Optional filters"},"timezone":{"anyOf":[{"type":"string","maxLength":64},{"type":"null"}],"title":"Timezone","description":"IANA time zone the local hours of `filters.hour_of_day` are read in, such as `Europe/Berlin`. The filter requires it. This route buckets nothing, so the zone changes nothing else"},"sparse_buckets":{"anyOf":[{"$ref":"#/components/schemas/SparseBuckets"},{"type":"null"}],"description":"The sparse threshold of the page, the number `POST /analytics/sparse-hours` derives. With `exclude` the rows of the thin hours are left out. Without it the route only echoes the number in `meta.sparse_buckets`"},"identity":{"anyOf":[{"type":"string","enum":["stitch","session"]},{"type":"null"}],"title":"Identity","description":"Identifier to group visitors by: 'stitch' or 'session'. Null resolves like /visitors, the application's default (stitch preferred)."}},"additionalProperties":false,"type":"object","required":["time_range"],"title":"VisitorSegmentsRequest","description":"Request for the visitor segment counts, the same scope the list takes."},"VisitorSegmentsResponse":{"properties":{"meta":{"$ref":"#/components/schemas/AnalyticsMeta","description":"Facts about the result"},"request":{"$ref":"#/components/schemas/AnalyticsRequestEcho","description":"The request as the server resolved it"},"visitors":{"type":"integer","title":"Visitors","description":"Every visitor in the window"},"affected_visitors":{"type":"integer","title":"Affected Visitors","description":"Visitors with at least one error (`min_errors: 1`)"},"slow_visitors":{"type":"integer","title":"Slow Visitors","description":"Visitors whose average LCP is at or above `slow_lcp_threshold_ms`"},"slow_lcp_threshold_ms":{"type":"integer","title":"Slow Lcp Threshold Ms","description":"The LCP bound `slow_visitors` was counted against"},"ordered_visitors":{"title":"Ordered Visitors","description":"Visitors who reached the success stage through an event, as `contains_checkout_stage` selects them. Absent under the identity `session`","type":"integer"},"checkout_visitors":{"title":"Checkout Visitors","description":"Visitors who reached the checkout stage through an event, as `contains_checkout_stage` selects them. Absent under the identity `session`","type":"integer"},"error_checkout_visitors":{"title":"Error Checkout Visitors","description":"Visitors who reached the checkout stage through an event and had at least one error, as `contains_checkout_stage: checkout` with `min_errors: 1` selects them. Absent under the identity `session`","type":"integer"},"cart_visitors":{"type":"integer","title":"Cart Visitors","description":"Visitors with a cart interaction (`contains_cart_interaction`)"},"single_page_visitors":{"type":"integer","title":"Single Page Visitors","description":"Visitors with exactly one pageview (`max_page_count: 1`)"}},"type":"object","required":["meta","request","visitors","affected_visitors","slow_visitors","slow_lcp_threshold_ms","cart_visitors","single_page_visitors"],"title":"VisitorSegmentsResponse","description":"How many visitors each fixed segment of the visitors list holds.\n\nEvery number counts the visitors `POST /analytics/visitors` would list\nwith that segment's `visitor_filters` applied, over the same scope, window\nand dimension filters. On an unsampled application a chip's count is the\nrow count its click produces, on a sampled one it is the weighted estimate\nof that count. The identity the visitors were grouped by is\n`request.identity`."},"VisitorSummaryItem":{"properties":{"visitor_id":{"type":"string","title":"Visitor Id","description":"Visitor identifier (stitch hex or session_id, per `identity`)"},"identity":{"$ref":"#/components/schemas/VisitorIdentity","description":"Identifier this row is grouped by"},"started_at":{"type":"string","format":"date-time","title":"Started At","description":"First pageview start for this visitor (wall-clock)","examples":["2026-04-14T09:50:01Z"]},"ended_at":{"type":"string","format":"date-time","title":"Ended At","description":"Last pageview end for this visitor (wall-clock)","examples":["2026-04-14T09:50:01Z"]},"duration_ms":{"type":"number","title":"Duration Ms","description":"Span from first to last pageview in milliseconds"},"page_count":{"type":"integer","title":"Page Count","description":"Number of page views"},"country":{"title":"Country","description":"Country (ISO code)","type":"string"},"asn":{"title":"Asn","description":"Autonomous system number of the visitor's network, absent when unknown","type":"integer"},"isp":{"title":"Isp","description":"Name of that network, absent when unknown","type":"string"},"browser":{"title":"Browser","description":"Browser name","type":"string"},"browser_version":{"title":"Browser Version","description":"Browser version","type":"string"},"device_type":{"description":"Device type","$ref":"#/components/schemas/DeviceType"},"os":{"title":"Os","description":"Operating system","type":"string"},"avg_lcp":{"title":"Avg Lcp","description":"Average LCP across pages","type":"number"},"avg_fcp":{"title":"Avg Fcp","description":"Average FCP across pages","type":"number"},"error_count":{"type":"integer","title":"Error Count","description":"Errors on this visitor's pageviews","default":0},"journey":{"items":{"$ref":"#/components/schemas/VisitorJourneyStep"},"type":"array","title":"Journey","description":"The pageviews of the visit in time order, the first 50 at most. `journey_truncated` says whether the cap cut it"},"journey_truncated":{"type":"boolean","title":"Journey Truncated","description":"True where `journey` holds the first steps only","default":false},"outcome":{"description":"How the visit ended: the furthest funnel stage an event of the visitor reached, `cart` also for a cart interaction, else `browsed`, else `bounced` for a single pageview. Absent under the identity `session`: the stages come from events, which identify a visitor by the stitch only","$ref":"#/components/schemas/VisitorOutcome"}},"type":"object","required":["visitor_id","identity","started_at","ended_at","duration_ms","page_count","error_count","journey","journey_truncated"],"title":"VisitorSummaryItem","description":"Summary of a single visitor (grouped by the resolved `identity`)."},"VisitorsListRequest":{"properties":{"time_range":{"$ref":"#/components/schemas/TimeRange","description":"Time range for the query"},"filters":{"$ref":"#/components/schemas/Filters","description":"Optional filters"},"timezone":{"anyOf":[{"type":"string","maxLength":64},{"type":"null"}],"title":"Timezone","description":"IANA time zone the local hours of `filters.hour_of_day` are read in, such as `Europe/Berlin`. The filter requires it. This route buckets nothing, so the zone changes nothing else"},"sparse_buckets":{"anyOf":[{"$ref":"#/components/schemas/SparseBuckets"},{"type":"null"}],"description":"The sparse threshold of the page, the number `POST /analytics/sparse-hours` derives. With `exclude` the rows of the thin hours are left out. Without it the route only echoes the number in `meta.sparse_buckets`"},"identity":{"anyOf":[{"type":"string","enum":["stitch","session"]},{"type":"null"}],"title":"Identity","description":"Identifier to group visitors by: 'stitch' or 'session'. Null → the application's default (stitch preferred)."},"visitor_filters":{"$ref":"#/components/schemas/VisitorAggregateFilters","description":"Post-aggregation filters (page count, duration, errors, avg LCP)"},"search":{"anyOf":[{"type":"string","maxLength":100},{"type":"null"}],"title":"Search","description":"Search by visitor ID"},"limit":{"type":"integer","maximum":100.0,"minimum":1.0,"title":"Limit","description":"Max visitors to return","default":50},"cursor":{"anyOf":[{"type":"string","maxLength":1024},{"type":"null"}],"title":"Cursor","description":"Opaque pagination cursor"}},"additionalProperties":false,"type":"object","required":["time_range"],"title":"VisitorsListRequest","description":"Request for the visitors list.\n\nCursor-paginated; always ordered by (start_time DESC, id DESC). Clients that\nwant to re-sort do so over the loaded rows client-side."},"VitalRating":{"type":"string","enum":["good","needs_improvement","poor"],"title":"VitalRating","description":"The web vitals rating of one value, with the cutoffs of `GET /metric-thresholds`."},"WebhookMessage":{"properties":{"title":{"type":"string","title":"Title","description":"One line naming the event."},"summary":{"type":"string","title":"Summary","description":"A few sentences on what happened."},"language":{"type":"string","enum":["en","de"],"title":"Language","description":"The channel's language the text is in."},"url":{"type":"string","title":"Url","description":"The page in fastmon the event is about."}},"type":"object","required":["title","summary","language","url"],"title":"WebhookMessage","description":"The human text of an event, as a chat channel shows it."},"WebhookObservation":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":"Identifier of the observation.","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"kind":{"$ref":"#/components/schemas/ObservationKind","description":"`shift` for a level change within a quarter hour, `trend` for a change over weeks."},"metric":{"$ref":"#/components/schemas/ObservationMetric","description":"What changed."},"direction":{"$ref":"#/components/schemas/ObservationDirection","description":"`worse` is a problem, `better` a highlight, `neutral` neither."},"status":{"$ref":"#/components/schemas/ObservationStatus","description":"`open`, or `acknowledged` once a person acknowledged it before the send."},"started_at":{"type":"string","format":"date-time","title":"Started At","description":"The start of the first occurrence, or the day a trend opened.","examples":["2026-04-14T09:50:01Z"]},"occurrence_count":{"type":"integer","title":"Occurrence Count","description":"Every occurrence so far. 1 for a trend."}},"type":"object","required":["id","kind","metric","direction","status","started_at","occurrence_count"],"title":"WebhookObservation","description":"The observation an event is about. `GET /observations/{observation_id}` has the rest."},"WebhookOccurrence":{"properties":{"started_at":{"type":"string","format":"date-time","title":"Started At","description":"The first quarter hour of the occurrence.","examples":["2026-04-14T09:50:01Z"]},"ended_at":{"title":"Ended At","description":"When it ended. Absent while it lasts, always on a recurrence. An opening delivered late, after a recurrence began, carries its ended first occurrence.","examples":["2026-04-14T09:50:01Z"],"type":"string","format":"date-time"},"reference":{"type":"number","title":"Reference","description":"The reference it opened against, in the unit `reference_unit` names."},"reference_unit":{"description":"What `reference` is measured in: `share` 0..1, `page_views` per quarter hour for `traffic` and `bot`, `milliseconds` for a TTFB or LCP p75.","$ref":"#/components/schemas/ReferenceUnit"},"peak_factor":{"title":"Peak Factor","description":"The largest factor against the reference so far, in the direction of the observation. Absent where the reference was zero.","type":"number"},"affected_pageviews":{"title":"Affected Pageviews","description":"The page views behind the change so far, weighted: the slow, failed or missing ones, or the bot page views.","type":"number"},"bot_change":{"description":"Which way the bot page views went, on a `bot` observation only.","$ref":"#/components/schemas/BotChange"}},"type":"object","required":["started_at","reference"],"title":"WebhookOccurrence","description":"The occurrence of a shift an event is about."},"WebhookRule":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":"Identifier of the rule.","examples":["019d8b65-a109-76c7-9f4a-bda57a7ab21d"]},"name":{"type":"string","title":"Name","description":"What the rule is called, as at the event."},"metric":{"type":"string","title":"Metric","description":"Which measurement is compared, a metric catalog id."},"aggregation":{"$ref":"#/components/schemas/RuleAggregation","description":"How the measurement is reduced over the window."},"identity":{"description":"Which identifier counts a visitor, on a `visitors` rule that sets one.","$ref":"#/components/schemas/VisitorIdentity"}},"type":"object","required":["id","name","metric","aggregation"],"title":"WebhookRule","description":"The rule an event is about. `GET /notifications/rules/{rule_id}` has the rest."}},"securitySchemes":{"bearerAuth":{"type":"http","description":"API token generated from the fastmon dashboard (Account → API Token) or at organization level (`fmo_…`, one that outlives its creator). Send as `Authorization: Bearer fm_...` or paste the full token (including its prefix) into the Authorize dialog.","scheme":"bearer","bearerFormat":"fm_… / fmo_…"},"oauth2":{"type":"oauth2","description":"An app connection approved by a user of the organization. The flow takes PKCE with `S256`, and a client may register itself first at `/auth/app/register`. The server metadata is at `/.well-known/oauth-authorization-server`. The access token is sent as `Authorization: Bearer fmt_...`.","flows":{"authorizationCode":{"authorizationUrl":"https://api.fastmon.eu/auth/app/authorize","tokenUrl":"https://api.fastmon.eu/auth/app/token","refreshUrl":"https://api.fastmon.eu/auth/app/token","scopes":{"ai:ask":"Ask the AI assistant (billed per request)","analytics:read":"Query analytics data","app:delete":"Delete applications and everything under them","app:read":"See applications and their configuration","app:rotate_hashes":"Rotate an application's hashes, invalidating its live embed","app:write":"Create and change applications","audit:read":"Read the audit log","billing:manage":"Buy, change or cancel the subscription and its add-ons","billing:read":"See the plan, invoices and billing profile","feedback:create":"Send feedback to the Fastmon team, also from an AI assistant","invite:manage":"Invite people and revoke invitations","invite:read":"See pending invitations","issue:read":"See what the Watchdog observed","member:manage":"Add, remove and re-role members","member:read":"See who is in the organization","notification:delete":"Delete notification rules","notification:read":"See notification rules and their history","notification:test":"Send test notifications to real recipients","notification:write":"Create and change notification rules","observation:write":"Acknowledge what the Watchdog observed and an error signature, and leave a note on it","org:delete":"Delete the organization and all of its data","org:read":"See the organization and its settings","org:transfer":"Transfer ownership of the organization","org:update":"Change organization settings, including AI and monitoring consent","partner:manage":"Manage partner relationships","partner:read":"See partner relationships","release:delete":"Delete releases","release:read":"See releases","release:write":"Create and change releases","site:delete":"Delete sites, including their data","site:read":"See sites and their configuration","site:write":"Create and change sites","support:read":"Read the organization's support conversations","support:write":"Write to support, attach files, close and reopen conversations","synthetic:delete":"Delete synthetic monitoring pages","synthetic:read":"See synthetic monitoring pages and results","synthetic:run":"Start synthetic runs (billed per run)","synthetic:write":"Create and change synthetic monitoring pages","usage:read":"See beacon usage for the billing period"}}}}},"headers":{"X-Request-ID":{"description":"The request's correlation ID: the one the client sent, else a UUID v7. An error body repeats it as `error.request_id`. Missing only on a 500 from an unhandled error.","schema":{"type":"string"}},"WWW-Authenticate":{"description":"The bearer challenge of RFC 6750, sent when the request carried a bearer credential. Absent when a session cookie failed.","schema":{"type":"string"}}}},"tags":[{"name":"organizations","description":"Manage organizations: the top-level tenant that owns sites, members, and analytics data. Covers organization CRUD, usage summaries, and ownership transfer."},{"name":"members","description":"List and manage members of an organization, including their roles."},{"name":"api-keys","description":"The organization's own API keys (`fmo_...`): mint, rename, rescope, rotate and revoke. Such a key belongs to the organization and not to the person who created it, so it keeps working when that person leaves. Its scopes are capped at what the caller holds and can never include key management, and the secret is returned exactly once, on creation and on rotation. Managing keys takes a signed-in dashboard session: no credential may hold `org_key:manage`, so a bearer token is refused on every endpoint here."},{"name":"connections","description":"Apps connected to the organization through OAuth, a shop plugin for example. A connection is what somebody approved when they clicked Connect, and it renews itself indefinitely, so this is where it is seen and ended. Revoking takes effect at once and the app has to be connected again from its own side. Like the organization's keys, these endpoints take a signed-in dashboard session and refuse a bearer token."},{"name":"sites","description":"Manage the sites (domains) monitored under an organization, each a domain/analytics unit belonging to one application. Includes site CRUD, tag- and application-based filtering, per-domain settings, and live beacon-receipt status. (The embed + hash rotation live on the application.)"},{"name":"applications","description":"Manage applications: the tracking embed (script + collector hashes + collection config) that a site's beacons post to. An application runs on one or more domains (its sites); each beacon's site is resolved at ingest by its page-URL host. Covers application CRUD, script/collector hash rotation, domain (site) membership, and discovery of unregistered hostnames seen hitting the application."},{"name":"releases","description":"Track releases per application so analytics can be correlated with deploys (regressions, rollouts, before/after comparisons)."},{"name":"analytics","description":"**Beta.** Query monitoring data: Core Web Vitals, performance timings, JS errors, third-party impact, sessions, and aggregate experience scores. Supports time-series and breakdown queries with filters. The response shape may still change before general availability."},{"name":"synthetic","description":"**Beta.** Synthetic monitoring (Commerce-Score): scheduled Lighthouse-style lab runs for key pages, with lab-vs-field comparison and historical trends. Requires the organization to opt in to Synthetic Monitoring; available to all organization members. Surface and response shape may still change before general availability."},{"name":"observations","description":"What the Watchdog observed on an application: a shift within a quarter hour or a trend over weeks, worse, better or neutral. Read the list or one observation. Detection has no endpoint: it runs server-side, needs no configuration and ends each observation by itself."},{"name":"notifications","description":"Rule-based alerting on Core Web Vitals, traffic, and error metrics. Manage rules, inspect send history, run test evaluations, apply presets, and preview rules against historical data."},{"name":"partners","description":"Endpoints for partner organizations that manage multiple client organizations with aggregated billing and usage reporting."},{"name":"search","description":"Find organizations, applications and sites across everything the calling credential reaches, in one request. Reach and permissions are the ones every other endpoint applies: a key sees the organizations it was issued for, and needs `site:read` or `app:read` for those kinds. Returns one bounded list per kind rather than a paginated collection."},{"name":"collector","description":"Beacon ingestion from end-user devices. Unauthenticated: the collector hash in the URL says which application the beacon belongs to. Only the pixel fallback is described here. The `POST` that the tracker normally uses, and the script delivery under `/s/`, have their own wire contract in `API_STANDARDS.md` §22 and are exempt from the response envelope."}],"security":[{"bearerAuth":[]}]}