{ "openapi": "3.1.0", "info": { "title": "DebugBundle HTTP API", "version": "v1", "description": "Source-backed OpenAPI description for the public DebugBundle HTTP API." }, "servers": [ { "url": "https://api.debugbundle.com", "description": "DebugBundle Cloud API" } ], "tags": [ { "name": "System" }, { "name": "Auth" }, { "name": "Account" }, { "name": "Ingestion" }, { "name": "Incidents" }, { "name": "Improvements" }, { "name": "Services" }, { "name": "Projects" }, { "name": "Health" }, { "name": "Slack" }, { "name": "Billing" }, { "name": "Tokens" }, { "name": "Alerts" }, { "name": "Weekly Reports" }, { "name": "Webhooks" }, { "name": "Probes" }, { "name": "Capture Rules" }, { "name": "Capture Policy" }, { "name": "Analytics" }, { "name": "SDK" } ], "paths": { "/health": { "get": { "operationId": "getHealth", "summary": "Get service health", "tags": [ "System" ], "responses": { "200": { "description": "Current health status.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HealthResponse" } } } } } } }, "/ready": { "get": { "operationId": "getReadiness", "summary": "Get readiness status", "tags": [ "System" ], "responses": { "200": { "description": "Current readiness status.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReadyResponse" } } } }, "503": { "description": "A required runtime dependency is unavailable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotReadyResponse" } } } } } } }, "/live": { "get": { "operationId": "getLiveness", "summary": "Get liveness status", "tags": [ "System" ], "responses": { "200": { "description": "Current liveness status.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LiveResponse" } } } } } } }, "/v1/auth/request-code": { "post": { "operationId": "requestEmailCode", "summary": "Request a one-time email code", "tags": [ "Auth" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RequestEmailCodeBody" } } } }, "responses": { "200": { "description": "Email code request accepted.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } }, "400": { "description": "Invalid request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "429": { "description": "Too many auth attempts from this IP.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "503": { "description": "Auth is not configured.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } } }, "/v1/auth/verify-code": { "post": { "operationId": "verifyEmailCode", "summary": "Verify a one-time email code and create a browser session", "tags": [ "Auth" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VerifyEmailCodeBody" } } } }, "responses": { "200": { "description": "Browser session created.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionResponse" } } } }, "400": { "description": "Invalid code or request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "429": { "description": "Too many auth attempts from this IP.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "503": { "description": "Auth is not configured.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } } }, "/v1/auth/github/start": { "get": { "operationId": "startGithubLogin", "summary": "Start GitHub OAuth", "tags": [ "Auth" ], "responses": { "302": { "description": "Redirects to GitHub authorization.", "headers": { "Location": { "description": "GitHub authorization URL.", "schema": { "type": "string", "format": "uri" } } } }, "503": { "description": "Auth is not configured.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } } }, "/v1/auth/github/callback": { "get": { "operationId": "completeGithubLogin", "summary": "Complete GitHub OAuth", "tags": [ "Auth" ], "parameters": [ { "name": "code", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1 } }, { "name": "state", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1 } } ], "responses": { "302": { "description": "Redirects back to the application callback URL.", "headers": { "Location": { "description": "Application redirect URL.", "schema": { "type": "string", "format": "uri" } } } }, "400": { "description": "Invalid callback query.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "503": { "description": "Auth is not configured.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } } }, "/v1/auth/github/device/start": { "post": { "operationId": "startGithubDeviceLogin", "summary": "Start GitHub device login", "tags": [ "Auth" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GithubDeviceStartBody" } } } }, "responses": { "200": { "description": "GitHub device authorization created.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GithubDeviceStartResponse" } } } }, "400": { "description": "Invalid request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "429": { "description": "Too many auth attempts from this IP.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "503": { "description": "GitHub device auth is unavailable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } } }, "/v1/auth/github/device/poll": { "post": { "operationId": "pollGithubDeviceLogin", "summary": "Poll GitHub device login status", "tags": [ "Auth" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GithubDevicePollBody" } } } }, "responses": { "200": { "description": "Current GitHub device authorization status.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GithubDevicePollResponse" } } } }, "400": { "description": "Invalid request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "description": "Device authorization request was not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "429": { "description": "Too many auth attempts from this IP.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "503": { "description": "GitHub device auth is unavailable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } } }, "/v1/auth/github/device/claim": { "post": { "operationId": "claimGithubDeviceLogin", "summary": "Claim the member token issued by GitHub device login", "tags": [ "Auth" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GithubDeviceClaimBody" } } } }, "responses": { "200": { "description": "Member token issued.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TokenResponse" } } } }, "400": { "description": "Invalid request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "description": "Device authorization request was not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "409": { "description": "Device authorization is not claimable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "429": { "description": "Too many auth attempts from this IP.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "503": { "description": "GitHub device auth is unavailable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } } }, "/v1/auth/github/token/exchange": { "post": { "operationId": "exchangeGithubAccessToken", "summary": "Exchange a GitHub access token for a DebugBundle member token", "tags": [ "Auth" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GithubTokenExchangeBody" } } } }, "responses": { "200": { "description": "Member token issued.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TokenResponse" } } } }, "400": { "description": "Invalid request body or missing GitHub email.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "description": "GitHub access token is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "403": { "description": "GitHub identity cannot bootstrap this account.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "429": { "description": "Too many auth attempts from this IP.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "503": { "description": "GitHub auth is unavailable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } } }, "/v1/auth/session": { "get": { "operationId": "getSession", "summary": "Resolve the current browser session", "tags": [ "Auth" ], "security": [ { "browserSession": [] } ], "responses": { "200": { "description": "Current browser session or null when signed out.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionResponse" } } } }, "503": { "description": "Auth is not configured.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } } }, "/v1/auth/logout": { "post": { "operationId": "logout", "summary": "Revoke the current browser session", "tags": [ "Auth" ], "security": [ { "browserSession": [] } ], "responses": { "200": { "description": "Browser session revoked.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } }, "401": { "description": "Browser session is missing or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "503": { "description": "Auth is not configured.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } } }, "/v1/auth/project-invite/accept": { "post": { "operationId": "acceptInvite", "summary": "Accept a project invite", "tags": [ "Auth" ], "security": [ { "browserSession": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AcceptInviteBody" } } } }, "responses": { "200": { "description": "Invite accepted.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AcceptInviteResponse" } } } }, "400": { "description": "Invalid invite token or payload.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "description": "Browser session is missing or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "403": { "description": "Invite email does not match the signed-in account.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "503": { "description": "Auth is not configured.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } } }, "/v1/account/export": { "get": { "operationId": "exportAccount", "summary": "Export retained organization account data", "tags": [ "Account" ], "security": [ { "browserSession": [] } ], "responses": { "200": { "description": "Account export JSON attachment.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountExportResponse" } } } }, "401": { "description": "Browser session is missing or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "403": { "description": "Owner access is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "description": "Account export was not available.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "503": { "description": "Account management is not configured.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } } }, "/v1/account/avatar": { "get": { "operationId": "getAccountAvatar", "summary": "Get the current account avatar image", "tags": [ "Account" ], "security": [ { "browserSession": [] } ], "responses": { "200": { "description": "Avatar image bytes.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AvatarImageResponse" } } } }, "401": { "description": "Browser session is missing or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "description": "Avatar was not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "503": { "description": "Account management is not configured.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } } }, "/v1/account/avatar/import-gravatar": { "post": { "operationId": "importAccountAvatarFromGravatar", "summary": "Import and cache a Gravatar avatar for the signed-in account", "tags": [ "Account" ], "security": [ { "browserSession": [] } ], "responses": { "200": { "description": "Avatar imported and cached.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountAvatarImportResponse" } } } }, "401": { "description": "Browser session is missing or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "description": "No Gravatar image was found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "502": { "description": "Avatar import failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "503": { "description": "Account management is not configured.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } } }, "/v1/account/delete/request-otp": { "post": { "operationId": "requestAccountDeletionOtp", "summary": "Request an email OTP for account deletion", "tags": [ "Account" ], "security": [ { "browserSession": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountDeleteRequestOtpBody" } } } }, "responses": { "200": { "description": "Deletion OTP requested.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } }, "400": { "description": "Invalid confirmation payload.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "description": "Browser session is missing or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "403": { "description": "Owner access is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "429": { "description": "Deletion verification requests are rate limited.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "503": { "description": "Account deletion verification is unavailable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } } }, "/v1/account": { "delete": { "operationId": "deleteAccount", "summary": "Delete the current organization account", "tags": [ "Account" ], "security": [ { "browserSession": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountDeleteBody" } } } }, "responses": { "200": { "description": "Account deleted.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountDeletionResponse" } } } }, "400": { "description": "Invalid confirmation payload.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "description": "Browser session is missing or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "403": { "description": "Owner access is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "description": "Account was not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "409": { "description": "Other owner-scoped organizations or projects still exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "429": { "description": "Deletion attempts are rate limited.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "503": { "description": "Account management is not configured.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } } }, "/v1/events": { "post": { "operationId": "ingestEvents", "summary": "Ingest batched events", "tags": [ "Ingestion" ], "security": [ { "projectBearerToken": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IngestionRequest" } } } }, "responses": { "202": { "description": "Events accepted for processing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IngestionAcceptedResponse" } } } }, "400": { "description": "Malformed ingestion payload.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IngestionAcceptedResponse" } } } }, "401": { "description": "Project token is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IngestionAcceptedResponse" } } } }, "429": { "description": "Rate limit or monthly ingestion quota exceeded.", "headers": { "Retry-After": { "description": "Seconds until the caller should retry.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IngestionAcceptedResponse" } } } } } } }, "/v1/incidents": { "get": { "operationId": "listIncidents", "summary": "List incidents", "tags": [ "Incidents" ], "security": [ { "browserSession": [] }, { "memberBearerToken": [] } ], "parameters": [ { "name": "project_id", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "environment", "in": "query", "required": false, "schema": { "type": "string", "minLength": 1 } }, { "name": "service", "in": "query", "required": false, "schema": { "type": "string", "minLength": 1 } }, { "name": "status", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "active", "open", "resolved", "regressed" ] } }, { "name": "severity", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "low", "medium", "high", "critical" ] } }, { "name": "first_seen_after", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "attention_after", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string", "minLength": 1 } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 } } ], "responses": { "200": { "description": "Incident list.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IncidentListResponse" } } } }, "400": { "description": "Invalid query parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "description": "Member token is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } } }, "/v1/incidents/resolve": { "post": { "operationId": "resolveIncidents", "summary": "Resolve incidents in bulk", "tags": [ "Incidents" ], "security": [ { "browserSession": [] }, { "memberBearerToken": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkIncidentMutationBody" } } } }, "responses": { "200": { "description": "Resolved incident details in request order.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkIncidentResponse" } } } }, "400": { "description": "Invalid request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "description": "Member token is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "description": "One or more incidents were not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "500": { "description": "Incident resolution is unavailable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } } }, "/v1/incidents/reopen": { "post": { "operationId": "reopenIncidents", "summary": "Reopen incidents in bulk", "tags": [ "Incidents" ], "security": [ { "browserSession": [] }, { "memberBearerToken": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkIncidentMutationBody" } } } }, "responses": { "200": { "description": "Reopened incident details in request order.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkIncidentResponse" } } } }, "400": { "description": "Invalid request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "description": "Member token is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "description": "One or more incidents were not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "500": { "description": "Incident reopen is unavailable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } } }, "/v1/incidents/{id}": { "get": { "operationId": "getIncident", "summary": "Get a single incident", "tags": [ "Incidents" ], "security": [ { "browserSession": [] }, { "memberBearerToken": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Incident details.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IncidentResponse" } } } }, "400": { "description": "Invalid incident id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "description": "Member token is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "description": "Incident was not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } } }, "/v1/incidents/{id}/resolve": { "post": { "operationId": "resolveIncident", "summary": "Resolve an incident", "tags": [ "Incidents" ], "security": [ { "browserSession": [] }, { "memberBearerToken": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Resolved incident details.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IncidentResponse" } } } }, "400": { "description": "Invalid incident id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "description": "Member token is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "description": "Incident was not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "500": { "description": "Incident resolution is unavailable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } } }, "/v1/incidents/{id}/reopen": { "post": { "operationId": "reopenIncident", "summary": "Reopen an incident", "tags": [ "Incidents" ], "security": [ { "memberBearerToken": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Reopened incident details.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IncidentResponse" } } } }, "400": { "description": "Invalid incident id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "description": "Member token is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "description": "Incident was not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "500": { "description": "Incident reopen is unavailable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } } }, "/v1/incidents/{id}/bundle": { "get": { "operationId": "getBundle", "summary": "Get the generated bundle for an incident", "tags": [ "Incidents" ], "security": [ { "memberBearerToken": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Bundle document or a generation status.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/BundleDocument" }, { "$ref": "#/components/schemas/PendingStatus" }, { "$ref": "#/components/schemas/BundleFailedStatus" } ] } } } }, "400": { "description": "Invalid incident id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "description": "Member token is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "description": "Incident was not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } } }, "/v1/incidents/{id}/reproduction": { "get": { "operationId": "getReproduction", "summary": "Get the reproduction artifact for an incident", "tags": [ "Incidents" ], "security": [ { "memberBearerToken": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Reproduction artifact or a pending status.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReproductionResponse" } } } }, "400": { "description": "Invalid incident id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "description": "Member token is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "description": "Incident or reproduction artifact was not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } } }, "/v1/improvements": { "get": { "operationId": "listImprovements", "summary": "List hosted improvement opportunities", "tags": [ "Improvements" ], "security": [ { "memberBearerToken": [] } ], "parameters": [ { "name": "project_id", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "environment", "in": "query", "required": false, "schema": { "type": "string", "minLength": 1 } }, { "name": "service", "in": "query", "required": false, "schema": { "type": "string", "minLength": 1 } }, { "name": "status", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "open", "resolved", "snoozed" ] } }, { "name": "severity", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "low", "medium", "high", "critical" ] } }, { "name": "kind", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "warning_hotspot", "slow_request", "request_failure_pattern", "recurring_incident", "post_deploy_regression" ] } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string", "minLength": 1 } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 } } ], "responses": { "200": { "description": "Improvement opportunity list.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImprovementListResponse" } } } }, "400": { "description": "Invalid query parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "description": "Member token is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "description": "Improvement management is unavailable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } } }, "/v1/improvements/{id}": { "get": { "operationId": "getImprovement", "summary": "Get a hosted improvement opportunity", "tags": [ "Improvements" ], "security": [ { "memberBearerToken": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1 } } ], "responses": { "200": { "description": "Improvement opportunity details.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImprovementResponse" } } } }, "400": { "description": "Invalid improvement id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "description": "Member token is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "description": "Improvement opportunity was not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } } }, "/v1/improvements/{id}/resolve": { "post": { "operationId": "resolveImprovement", "summary": "Resolve a hosted improvement opportunity", "tags": [ "Improvements" ], "security": [ { "memberBearerToken": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1 } } ], "responses": { "200": { "description": "Resolved improvement opportunity.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImprovementResponse" } } } }, "400": { "description": "Invalid improvement id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "description": "Member token is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "description": "Improvement opportunity was not found or resolution is unavailable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } } }, "/v1/improvements/{id}/reopen": { "post": { "operationId": "reopenImprovement", "summary": "Reopen a hosted improvement opportunity", "tags": [ "Improvements" ], "security": [ { "memberBearerToken": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1 } } ], "responses": { "200": { "description": "Reopened improvement opportunity.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImprovementResponse" } } } }, "400": { "description": "Invalid improvement id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "description": "Member token is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "description": "Improvement opportunity was not found or reopen is unavailable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } } }, "/v1/improvements/{id}/snooze": { "post": { "operationId": "snoozeImprovement", "summary": "Snooze a hosted improvement opportunity", "tags": [ "Improvements" ], "security": [ { "memberBearerToken": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImprovementSnoozeBody" } } } }, "responses": { "200": { "description": "Snoozed improvement opportunity.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImprovementResponse" } } } }, "400": { "description": "Invalid improvement id or snooze timestamp.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "description": "Member token is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "description": "Improvement opportunity was not found or snooze is unavailable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } } }, "/v1/projects/{id}/improvements/{improvementId}/bundle": { "get": { "operationId": "getImprovementBundle", "summary": "Get the hosted bundle for an improvement opportunity", "tags": [ "Improvements" ], "security": [ { "browserSession": [] }, { "memberBearerToken": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "improvementId", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1 } } ], "responses": { "200": { "description": "Improvement bundle document or generation status.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/BundleDocument" }, { "$ref": "#/components/schemas/PendingStatus" }, { "$ref": "#/components/schemas/BundleFailedStatus" } ] } } } }, "400": { "description": "Invalid project or improvement id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "description": "Authentication is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "description": "Project or improvement opportunity was not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } } }, "/v1/logs": { "get": { "operationId": "getLogs", "summary": "Query incident logs", "tags": [ "Incidents" ], "security": [ { "memberBearerToken": [] } ], "parameters": [ { "name": "incident_id", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "level", "in": "query", "required": false, "schema": { "type": "string", "minLength": 1 } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string", "minLength": 1 } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 } } ], "responses": { "200": { "description": "Incident logs.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LogsResponse" } } } }, "400": { "description": "Invalid query parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "description": "Member token is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } } }, "/v1/services": { "get": { "operationId": "listServices", "summary": "List services for a project", "tags": [ "Services" ], "security": [ { "memberBearerToken": [] } ], "parameters": [ { "name": "project_id", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 100 } } ], "responses": { "200": { "description": "Project services.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServicesResponse" } } } }, "400": { "description": "Invalid query parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "description": "Member token is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "description": "Project was not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "500": { "description": "Service retrieval is unavailable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } } }, "/v1/projects/{id}/members": { "get": { "operationId": "listProjectMembers", "summary": "List project members", "tags": [ "Projects" ], "security": [ { "browserSession": [] }, { "memberBearerToken": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Project members.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectMemberListResponse" } } } }, "400": { "description": "Invalid project id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "description": "Authentication is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "403": { "description": "Shared collaborator access is paused until the owner upgrades again.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "description": "Project was not found or collaboration is unavailable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } } }, "/v1/projects/{id}/invites": { "get": { "operationId": "listProjectInvites", "summary": "List pending project invites", "tags": [ "Projects" ], "security": [ { "browserSession": [] }, { "memberBearerToken": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Pending project invites.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectInviteListResponse" } } } }, "400": { "description": "Invalid project id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "description": "Authentication is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "description": "Project was not found or collaboration is unavailable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } } }, "/v1/projects/{id}/members/{userId}/avatar": { "get": { "operationId": "getProjectMemberAvatar", "summary": "Get a cached project member avatar image", "tags": [ "Projects" ], "security": [ { "browserSession": [] }, { "memberBearerToken": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "userId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Avatar image bytes.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AvatarImageResponse" } } } }, "400": { "description": "Invalid member id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "description": "Authentication is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "description": "Project, member, or avatar was not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "503": { "description": "Account management is not configured.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } } }, "/v1/projects/{id}/invite": { "post": { "operationId": "inviteProjectMember", "summary": "Invite a project member", "tags": [ "Projects" ], "security": [ { "browserSession": [] }, { "memberBearerToken": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateProjectInviteBody" } } } }, "responses": { "201": { "description": "Invite created.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectInviteResponse" } } } }, "400": { "description": "Invalid project id or request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "description": "Authentication is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "403": { "description": "Admin or owner access and verified email are required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "description": "Project was not found or collaboration is unavailable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "409": { "description": "Member or invite already exists, or collaborator limits were reached.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "500": { "description": "Unexpected invite creation failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } } }, "/v1/projects/{id}/invites/{inviteId}": { "delete": { "operationId": "cancelProjectInvite", "summary": "Cancel a project invite", "tags": [ "Projects" ], "security": [ { "browserSession": [] }, { "memberBearerToken": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "inviteId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Invite cancelled.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectInviteResponse" } } } }, "400": { "description": "Invalid request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "description": "Authentication is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "403": { "description": "Admin or owner access and verified email are required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "description": "Invite was not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } } }, "/v1/projects/{id}/members/{userId}": { "patch": { "operationId": "updateProjectMemberRole", "summary": "Update a project member role", "tags": [ "Projects" ], "security": [ { "browserSession": [] }, { "memberBearerToken": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "userId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateProjectMemberRoleBody" } } } }, "responses": { "200": { "description": "Updated project member.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectMemberResponse" } } } }, "400": { "description": "Invalid member id or payload.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "description": "Authentication is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "403": { "description": "Admin or owner access is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "description": "Member was not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "409": { "description": "Owner role cannot be changed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } }, "delete": { "operationId": "removeProjectMember", "summary": "Remove a project member", "tags": [ "Projects" ], "security": [ { "browserSession": [] }, { "memberBearerToken": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "userId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Removed project member.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectMemberResponse" } } } }, "400": { "description": "Invalid member id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "description": "Authentication is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "403": { "description": "Admin or owner access is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "description": "Member was not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "409": { "description": "Owner cannot be removed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } } }, "/v1/projects/{id}/membership": { "delete": { "operationId": "leaveProject", "summary": "Leave a shared project", "tags": [ "Projects" ], "security": [ { "browserSession": [] }, { "memberBearerToken": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Left project membership.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectMemberResponse" } } } }, "400": { "description": "Invalid project id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "description": "Authentication is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "description": "Project membership was not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "409": { "description": "Owners cannot leave their own project.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } } }, "/v1/projects": { "get": { "operationId": "listProjects", "summary": "List projects", "tags": [ "Projects" ], "security": [ { "browserSession": [] }, { "memberBearerToken": [] } ], "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 } } ], "responses": { "200": { "description": "Projects for the caller organization.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectListResponse" } } } }, "400": { "description": "Invalid query parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "description": "Authentication is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "description": "Projects are unavailable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } }, "post": { "operationId": "createProject", "summary": "Create a project", "tags": [ "Projects" ], "security": [ { "browserSession": [] }, { "memberBearerToken": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateProjectBody" } } } }, "responses": { "201": { "description": "Project created.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectCreateResponse" } } } }, "400": { "description": "Invalid request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "description": "Authentication is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "403": { "description": "Owner access is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "description": "Projects are unavailable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "409": { "description": "Project slug already exists.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } } }, "/v1/projects/{id}": { "patch": { "operationId": "updateProject", "summary": "Update a project", "tags": [ "Projects" ], "security": [ { "browserSession": [] }, { "memberBearerToken": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateProjectBody" } } } }, "responses": { "200": { "description": "Updated project.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectUpdateResponse" } } } }, "400": { "description": "Invalid project id or request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "description": "Authentication is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "403": { "description": "Owner access is required, and paused shared collaborator access cannot mutate the project.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "description": "Project was not found or projects are unavailable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "409": { "description": "Project slug is already in use.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } }, "delete": { "operationId": "deleteProject", "summary": "Delete a project", "tags": [ "Projects" ], "security": [ { "browserSession": [] }, { "memberBearerToken": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Deleted project.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectDeleteResponse" } } } }, "400": { "description": "Invalid project id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "description": "Authentication is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "403": { "description": "Owner access is required, and paused shared collaborator access cannot delete the project.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "description": "Project was not found or projects are unavailable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } } }, "/v1/projects/{id}/availability-checks": { "get": { "operationId": "listAvailabilityChecks", "summary": "List hosted health checks for a project", "tags": [ "Health" ], "security": [ { "browserSession": [] }, { "memberBearerToken": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 } } ], "responses": { "200": { "description": "Hosted health checks plus project plan limits.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AvailabilityCheckListResponse" } } } }, "400": { "description": "Invalid project id or query parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "description": "Authentication is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "description": "Project was not found or availability checks are unavailable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } }, "post": { "operationId": "createAvailabilityCheck", "summary": "Create a hosted health check", "tags": [ "Health" ], "security": [ { "browserSession": [] }, { "memberBearerToken": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AvailabilityCheckCreateBody" } } } }, "responses": { "201": { "description": "Hosted health check created.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AvailabilityCheckMutationResponse" } } } }, "400": { "description": "Invalid project id, payload, or blocked target.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "description": "Authentication is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "403": { "description": "Owner or admin project access is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "description": "Project was not found or availability checks are unavailable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "409": { "description": "Tier count or minimum-interval limit was reached.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } } }, "/v1/projects/{id}/availability-checks/{checkId}": { "get": { "operationId": "getAvailabilityCheck", "summary": "Get one hosted health check", "tags": [ "Health" ], "security": [ { "browserSession": [] }, { "memberBearerToken": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "checkId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Hosted health check detail plus project plan limits.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AvailabilityCheckResponse" } } } }, "400": { "description": "Invalid project id or check id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "description": "Authentication is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "description": "Health check was not found or availability checks are unavailable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } }, "patch": { "operationId": "updateAvailabilityCheck", "summary": "Update a hosted health check", "tags": [ "Health" ], "security": [ { "browserSession": [] }, { "memberBearerToken": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "checkId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AvailabilityCheckUpdateBody" } } } }, "responses": { "200": { "description": "Hosted health check updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AvailabilityCheckMutationResponse" } } } }, "400": { "description": "Invalid project id, check id, payload, or blocked target.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "description": "Authentication is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "403": { "description": "Owner or admin project access is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "description": "Health check was not found or availability checks are unavailable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "409": { "description": "Minimum-interval limit was reached.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } }, "delete": { "operationId": "deleteAvailabilityCheck", "summary": "Delete a hosted health check", "tags": [ "Health" ], "security": [ { "browserSession": [] }, { "memberBearerToken": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "checkId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Hosted health check deleted.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AvailabilityCheckDeleteResponse" } } } }, "400": { "description": "Invalid project id or check id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "description": "Authentication is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "403": { "description": "Owner or admin project access is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "description": "Health check was not found or availability checks are unavailable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } } }, "/v1/projects/{id}/availability-checks/{checkId}/results": { "get": { "operationId": "listAvailabilityCheckResults", "summary": "List retained health-check execution results", "tags": [ "Health" ], "security": [ { "browserSession": [] }, { "memberBearerToken": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "checkId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 } } ], "responses": { "200": { "description": "Recent retained execution results.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AvailabilityCheckResultsResponse" } } } }, "400": { "description": "Invalid project id, check id, or query parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "description": "Authentication is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "description": "Health check was not found or availability checks are unavailable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } } }, "/v1/projects/{id}/availability-checks/{checkId}/daily-rollups": { "get": { "operationId": "listAvailabilityCheckDailyRollups", "summary": "List retained per-day health-check history", "tags": [ "Health" ], "security": [ { "browserSession": [] }, { "memberBearerToken": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "checkId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 } } ], "responses": { "200": { "description": "Retained daily health history.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AvailabilityCheckDailyRollupsResponse" } } } }, "400": { "description": "Invalid project id, check id, or query parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "description": "Authentication is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "description": "Health check was not found or availability checks are unavailable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } } }, "/v1/projects/{id}/availability-checks/test": { "post": { "operationId": "testAvailabilityCheck", "summary": "Run a side-effect-free hosted health-check test", "tags": [ "Health" ], "security": [ { "browserSession": [] }, { "memberBearerToken": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AvailabilityCheckTestBody" } } } }, "responses": { "200": { "description": "Side-effect-free health-check test result.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AvailabilityCheckTestResponse" } } } }, "400": { "description": "Invalid project id, payload, or blocked target.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "description": "Authentication is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "403": { "description": "Owner or admin project access is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "description": "Project was not found or availability checks are unavailable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } } }, "/v1/slack/app/install-url": { "get": { "operationId": "getSlackAppInstallUrl", "summary": "Create a Slack OAuth install URL", "tags": [ "Slack" ], "security": [ { "browserSession": [] }, { "memberBearerToken": [] } ], "parameters": [ { "name": "project_id", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "return_to", "in": "query", "required": false, "schema": { "type": "string", "minLength": 1 } } ], "responses": { "200": { "description": "Slack OAuth install URL.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SlackInstallUrlResponse" } } } }, "400": { "description": "Invalid query parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "description": "Authentication is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "403": { "description": "Owner access is required, or paused shared collaborator access cannot delete preserved Slack setup.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "description": "Project was not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "503": { "description": "Slack integration is not configured.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } } }, "/v1/slack/app/callback": { "get": { "operationId": "completeSlackAppInstall", "summary": "Complete the Slack OAuth install flow", "tags": [ "Slack" ], "parameters": [ { "name": "code", "in": "query", "required": false, "schema": { "type": "string", "minLength": 1 } }, { "name": "state", "in": "query", "required": false, "schema": { "type": "string", "minLength": 1 } }, { "name": "error", "in": "query", "required": false, "schema": { "type": "string", "minLength": 1 } } ], "responses": { "302": { "description": "Redirects back to the application after Slack OAuth completes or is cancelled." } } } }, "/v1/projects/{id}/slack/destinations": { "get": { "operationId": "listProjectSlackDestinations", "summary": "List reusable Slack destinations for a project organization", "tags": [ "Slack" ], "security": [ { "browserSession": [] }, { "memberBearerToken": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Reusable Slack destinations.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SlackDestinationListResponse" } } } }, "400": { "description": "Invalid project id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "description": "Authentication is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "403": { "description": "Paused shared collaborator access cannot view preserved Slack destinations.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "description": "Project was not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "503": { "description": "Slack integration is not configured.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } } }, "/v1/projects/{id}/slack/destinations/{destinationId}/test": { "post": { "operationId": "testProjectSlackDestination", "summary": "Send a test message to a reusable Slack destination", "tags": [ "Slack" ], "security": [ { "browserSession": [] }, { "memberBearerToken": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "destinationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Slack destination test delivered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SlackDestinationTestResponse" } } } }, "400": { "description": "Invalid project id or Slack destination id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "description": "Authentication is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "403": { "description": "Owner access or Team tier is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "description": "Project or Slack destination was not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "502": { "description": "Slack delivery failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "503": { "description": "Slack integration is not configured.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } } }, "/v1/projects/{id}/slack/destinations/{destinationId}": { "delete": { "operationId": "deleteProjectSlackDestination", "summary": "Delete a reusable Slack destination", "tags": [ "Slack" ], "security": [ { "browserSession": [] }, { "memberBearerToken": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "destinationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "Slack destination deleted." }, "400": { "description": "Invalid project id or Slack destination id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "description": "Authentication is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "403": { "description": "Owner access is required, or paused shared collaborator access cannot delete preserved Slack setup.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "description": "Slack destination was not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "409": { "description": "Slack destination is still referenced by an alert rule or weekly report.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "503": { "description": "Slack integration is not configured.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } } }, "/v1/billing": { "get": { "operationId": "getBillingSummary", "summary": "Get the billing summary", "tags": [ "Billing" ], "security": [ { "browserSession": [] }, { "memberBearerToken": [] } ], "responses": { "200": { "description": "Billing summary.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BillingSummaryResponse" } } } }, "401": { "description": "Authentication is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "403": { "description": "Owner access is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "description": "Billing was not found or is unavailable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } } }, "/v1/billing/checkout": { "post": { "operationId": "createBillingCheckout", "summary": "Create a Stripe checkout link", "tags": [ "Billing" ], "security": [ { "browserSession": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BillingCheckoutBody" } } } }, "responses": { "200": { "description": "Hosted checkout URL.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BillingLinkResponse" } } } }, "400": { "description": "Invalid request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "description": "Browser session is missing or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "403": { "description": "Owner access or a verified email is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "description": "Billing was not found or is unavailable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "409": { "description": "Requested plan change is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "503": { "description": "Billing is not configured.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } } }, "/v1/billing/checkout/confirm": { "post": { "operationId": "confirmBillingCheckout", "summary": "Confirm a returned Stripe checkout session", "tags": [ "Billing" ], "security": [ { "browserSession": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BillingCheckoutConfirmBody" } } } }, "responses": { "200": { "description": "Updated billing summary.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BillingSummaryResponse" } } } }, "400": { "description": "Invalid request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "description": "Browser session is missing or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "403": { "description": "Owner access is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "description": "Billing or checkout session was not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "409": { "description": "Checkout session is not complete.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "503": { "description": "Billing confirmation is unavailable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } } }, "/v1/billing/portal": { "post": { "operationId": "createBillingPortal", "summary": "Create a Stripe customer portal link", "tags": [ "Billing" ], "security": [ { "browserSession": [] } ], "responses": { "200": { "description": "Hosted billing portal URL.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BillingLinkResponse" } } } }, "401": { "description": "Browser session is missing or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "403": { "description": "Owner access or a verified email is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "description": "Billing was not found or is unavailable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "409": { "description": "No active subscription exists.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "503": { "description": "Billing is not configured.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } } }, "/v1/billing/capacity/increase": { "post": { "operationId": "increaseCapacity", "summary": "Increase capacity immediately", "tags": [ "Billing" ], "security": [ { "browserSession": [] }, { "memberBearerToken": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BillingCapacityBody" } } } }, "responses": { "200": { "description": "Updated billing summary.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BillingSummaryResponse" } } } }, "400": { "description": "Invalid request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "description": "Authentication is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "403": { "description": "Owner access or a verified email is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "description": "Billing was not found or is unavailable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "409": { "description": "Requested capacity change is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "503": { "description": "Billing is not configured.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } } }, "/v1/billing/capacity/scheduled-reduction": { "post": { "operationId": "scheduleCapacityReduction", "summary": "Schedule a capacity reduction", "tags": [ "Billing" ], "security": [ { "browserSession": [] }, { "memberBearerToken": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BillingCapacityBody" } } } }, "responses": { "200": { "description": "Updated billing summary.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BillingSummaryResponse" } } } }, "400": { "description": "Invalid request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "description": "Authentication is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "403": { "description": "Owner access or a verified email is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "description": "Billing was not found or is unavailable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "409": { "description": "Requested capacity reduction is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "503": { "description": "Billing is not configured.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } }, "delete": { "operationId": "cancelCapacityReduction", "summary": "Cancel a scheduled capacity reduction", "tags": [ "Billing" ], "security": [ { "browserSession": [] }, { "memberBearerToken": [] } ], "responses": { "200": { "description": "Updated billing summary.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BillingSummaryResponse" } } } }, "401": { "description": "Authentication is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "403": { "description": "Owner access or a verified email is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "description": "Billing was not found or is unavailable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "409": { "description": "No scheduled reduction exists.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "503": { "description": "Billing is not configured.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } } }, "/v1/projects/{id}/tokens": { "get": { "operationId": "listProjectTokens", "summary": "List project tokens", "tags": [ "Tokens" ], "security": [ { "browserSession": [] }, { "memberBearerToken": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 } } ], "responses": { "200": { "description": "Project tokens.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TokenListResponse" } } } }, "400": { "description": "Invalid project id or query parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "description": "Authentication is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "description": "Project was not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } }, "post": { "operationId": "createProjectToken", "summary": "Create a project token", "tags": [ "Tokens" ], "security": [ { "browserSession": [] }, { "memberBearerToken": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateProjectTokenBody" } } } }, "responses": { "201": { "description": "Project token created.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TokenResponse" } } } }, "400": { "description": "Invalid project id or request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "description": "Authentication is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "403": { "description": "Owner or admin project access is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "description": "Project was not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } } }, "/v1/projects/{id}/tokens/{tokenId}/revoke": { "post": { "operationId": "revokeProjectToken", "summary": "Revoke a project token", "tags": [ "Tokens" ], "security": [ { "browserSession": [] }, { "memberBearerToken": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "tokenId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Revoked project token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TokenResponse" } } } }, "400": { "description": "Invalid token id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "description": "Authentication is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "403": { "description": "Owner or admin project access is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "description": "Token was not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } } }, "/v1/member/tokens": { "get": { "operationId": "listMemberTokens", "summary": "List member tokens", "tags": [ "Tokens" ], "security": [ { "browserSession": [] }, { "memberBearerToken": [] } ], "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 } } ], "responses": { "200": { "description": "Member tokens.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TokenListResponse" } } } }, "400": { "description": "Invalid query parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "description": "Authentication is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } }, "post": { "operationId": "createMemberToken", "summary": "Create a member token", "tags": [ "Tokens" ], "security": [ { "browserSession": [] }, { "memberBearerToken": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateTokenBody" } } } }, "responses": { "201": { "description": "Member token created.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TokenResponse" } } } }, "400": { "description": "Invalid request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "description": "Authentication is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "403": { "description": "Verified email is required before creating the first member token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } } }, "/v1/member/tokens/{tokenId}/revoke": { "post": { "operationId": "revokeMemberToken", "summary": "Revoke a member token", "tags": [ "Tokens" ], "security": [ { "browserSession": [] }, { "memberBearerToken": [] } ], "parameters": [ { "name": "tokenId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Revoked member token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TokenResponse" } } } }, "400": { "description": "Invalid token id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "description": "Authentication is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "description": "Token was not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } } }, "/v1/alerts": { "get": { "operationId": "listAlerts", "summary": "List alert rules", "tags": [ "Alerts" ], "security": [ { "browserSession": [] }, { "memberBearerToken": [] } ], "parameters": [ { "name": "project_id", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 } } ], "responses": { "200": { "description": "Alert rules.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlertListResponse" } } } }, "400": { "description": "Invalid query parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "description": "Authentication is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "description": "Project was not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } }, "post": { "operationId": "createAlert", "summary": "Create an alert rule", "tags": [ "Alerts" ], "security": [ { "browserSession": [] }, { "memberBearerToken": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateAlertBody" } } } }, "responses": { "201": { "description": "Alert rule created.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlertResponse" } } } }, "400": { "description": "Invalid request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "description": "Authentication is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "description": "Project was not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } } }, "/v1/alerts/{id}": { "patch": { "operationId": "updateAlert", "summary": "Update an alert rule", "tags": [ "Alerts" ], "security": [ { "browserSession": [] }, { "memberBearerToken": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateAlertBody" } } } }, "responses": { "200": { "description": "Updated alert rule.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlertResponse" } } } }, "400": { "description": "Invalid alert id or request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "description": "Authentication is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "description": "Alert was not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } }, "delete": { "operationId": "deleteAlert", "summary": "Delete an alert rule", "tags": [ "Alerts" ], "security": [ { "browserSession": [] }, { "memberBearerToken": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "Alert rule deleted." }, "400": { "description": "Invalid alert id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "description": "Authentication is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "description": "Alert was not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } } }, "/v1/weekly-report-channels": { "get": { "operationId": "listWeeklyReportChannels", "summary": "List weekly report channels", "tags": [ "Weekly Reports" ], "security": [ { "browserSession": [] }, { "memberBearerToken": [] } ], "parameters": [ { "name": "project_id", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 } } ], "responses": { "200": { "description": "Weekly report channels, including preserved Slack channels paused by downgrade.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WeeklyReportChannelListResponse" } } } }, "400": { "description": "Invalid query parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "description": "Authentication is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "description": "Project was not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } }, "post": { "operationId": "createWeeklyReportChannel", "summary": "Create a weekly report channel", "tags": [ "Weekly Reports" ], "security": [ { "browserSession": [] }, { "memberBearerToken": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateWeeklyReportChannelBody" } } } }, "responses": { "201": { "description": "Weekly report channel created.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WeeklyReportChannelResponse" } } } }, "400": { "description": "Invalid request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "description": "Authentication is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "403": { "description": "Team tier is required for connected Slack destinations, and paused shared collaborator access cannot manage weekly reports.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "description": "Project was not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "503": { "description": "Slack integration is not configured.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } } }, "/v1/weekly-report-channels/{id}": { "patch": { "operationId": "updateWeeklyReportChannel", "summary": "Update a weekly report channel", "tags": [ "Weekly Reports" ], "security": [ { "browserSession": [] }, { "memberBearerToken": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateWeeklyReportChannelBody" } } } }, "responses": { "200": { "description": "Updated weekly report channel.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WeeklyReportChannelResponse" } } } }, "400": { "description": "Invalid channel id or request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "description": "Authentication is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "403": { "description": "Team tier is required for connected Slack destinations, and paused shared collaborator access cannot manage weekly reports.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "description": "Weekly report channel was not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "503": { "description": "Slack integration is not configured.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } }, "delete": { "operationId": "deleteWeeklyReportChannel", "summary": "Delete a weekly report channel", "tags": [ "Weekly Reports" ], "security": [ { "browserSession": [] }, { "memberBearerToken": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1 } } ], "responses": { "204": { "description": "Weekly report channel deleted." }, "400": { "description": "Invalid channel id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "description": "Authentication is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "description": "Weekly report channel was not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } } }, "/v1/webhooks": { "get": { "operationId": "listWebhooks", "summary": "List webhooks", "tags": [ "Webhooks" ], "security": [ { "browserSession": [] }, { "memberBearerToken": [] } ], "parameters": [ { "name": "project_id", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 } } ], "responses": { "200": { "description": "Webhooks for a project.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookListResponse" } } } }, "400": { "description": "Invalid query parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "description": "Authentication is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "description": "Project was not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } }, "post": { "operationId": "createWebhook", "summary": "Create a webhook", "tags": [ "Webhooks" ], "security": [ { "browserSession": [] }, { "memberBearerToken": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateWebhookBody" } } } }, "responses": { "201": { "description": "Webhook created.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookCreateResponse" } } } }, "400": { "description": "Invalid request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "description": "Authentication is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "description": "Project was not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } } }, "/v1/webhooks/{id}": { "get": { "operationId": "getWebhook", "summary": "Get a webhook", "tags": [ "Webhooks" ], "security": [ { "browserSession": [] }, { "memberBearerToken": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Webhook details.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookResponse" } } } }, "400": { "description": "Invalid webhook id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "description": "Authentication is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "description": "Webhook was not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } }, "patch": { "operationId": "updateWebhook", "summary": "Update a webhook", "tags": [ "Webhooks" ], "security": [ { "browserSession": [] }, { "memberBearerToken": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateWebhookBody" } } } }, "responses": { "200": { "description": "Updated webhook.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookResponse" } } } }, "400": { "description": "Invalid webhook id or request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "description": "Authentication is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "description": "Webhook was not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } }, "delete": { "operationId": "deleteWebhook", "summary": "Delete a webhook", "tags": [ "Webhooks" ], "security": [ { "browserSession": [] }, { "memberBearerToken": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "Webhook deleted." }, "400": { "description": "Invalid webhook id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "description": "Authentication is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "description": "Webhook was not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } } }, "/v1/webhooks/{id}/test": { "post": { "operationId": "testWebhook", "summary": "Queue a synthetic webhook delivery", "tags": [ "Webhooks" ], "security": [ { "browserSession": [] }, { "memberBearerToken": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookTestBody" } } } }, "responses": { "200": { "description": "Synthetic delivery queued.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookTestResponse" } } } }, "400": { "description": "Invalid webhook id or request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "description": "Authentication is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "description": "Webhook was not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } } }, "/v1/webhooks/{id}/deliveries": { "get": { "operationId": "listWebhookDeliveries", "summary": "List webhook deliveries", "tags": [ "Webhooks" ], "security": [ { "browserSession": [] }, { "memberBearerToken": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1 } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 } }, { "name": "project_id", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Webhook deliveries.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookDeliveriesResponse" } } } }, "400": { "description": "Invalid webhook id or query parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "description": "Authentication is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "description": "Webhook was not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } } }, "/v1/webhooks/{id}/deliveries/{deliveryId}/retry": { "post": { "operationId": "retryWebhookDelivery", "summary": "Retry a webhook delivery", "tags": [ "Webhooks" ], "security": [ { "browserSession": [] }, { "memberBearerToken": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "deliveryId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Webhook delivery reset for retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookRetryResponse" } } } }, "400": { "description": "Invalid webhook or delivery id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "description": "Authentication is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "description": "Webhook or delivery was not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } } }, "/v1/projects/{id}/probes/activate": { "post": { "operationId": "activateProbes", "summary": "Activate remote probes", "tags": [ "Probes" ], "security": [ { "memberBearerToken": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProbeActivateBody" } } } }, "responses": { "201": { "description": "Probe activation created.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProbeActivationResponse" } } } }, "400": { "description": "Invalid project id or request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "description": "Member token is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "403": { "description": "Paused shared collaborator access cannot manage probes.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "description": "Project was not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "409": { "description": "Concurrent activation limit reached.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "429": { "description": "Monthly remote activation quota exceeded.", "headers": { "Retry-After": { "description": "Seconds until the caller should retry.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } } }, "/v1/projects/{id}/probes": { "get": { "operationId": "listActiveProbes", "summary": "List active remote probes", "tags": [ "Probes" ], "security": [ { "memberBearerToken": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Active probe activations.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProbeActivationListResponse" } } } }, "400": { "description": "Invalid project id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "description": "Member token is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "403": { "description": "Paused shared collaborator access cannot view preserved probe activations.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "description": "Project was not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } } }, "/v1/projects/{id}/probes/deactivate": { "post": { "operationId": "deactivateProbes", "summary": "Deactivate a remote probe", "tags": [ "Probes" ], "security": [ { "memberBearerToken": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProbeDeactivateBody" } } } }, "responses": { "200": { "description": "Probe activation deactivated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProbeDeactivationResponse" } } } }, "400": { "description": "Invalid project id or request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "description": "Member token is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "403": { "description": "Remote probes are not available for the caller tier, and paused shared collaborator access cannot manage probes.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "description": "Activation was not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } } }, "/v1/incidents/{id}/capture-rule-suggestion": { "post": { "operationId": "suggestCaptureRule", "summary": "Generate deterministic capture rule suggestions from an incident bundle", "tags": [ "Capture Rules" ], "security": [ { "browserSession": [] }, { "memberBearerToken": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Capture rule suggestions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaptureRuleSuggestionsResponse" } } } }, "400": { "description": "Invalid incident id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "description": "Authentication is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "description": "Incident was not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } } }, "/v1/incidents/{id}/capture-rules": { "post": { "operationId": "createCaptureRuleFromSuggestion", "summary": "Create a project capture rule from an incident suggestion", "tags": [ "Capture Rules" ], "security": [ { "browserSession": [] }, { "memberBearerToken": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateCaptureRuleFromSuggestion" } } } }, "responses": { "201": { "description": "Capture rule created.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaptureRuleResponse" } } } }, "400": { "description": "Invalid incident id or request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "description": "Authentication is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "403": { "description": "Owner/admin access is required, and paused shared collaborator access cannot create capture rules.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "description": "Incident, suggestion, or project was not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "409": { "description": "Suggestion generation is unavailable until a bundle is ready.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } } }, "/v1/projects/{id}/capture-rules": { "get": { "operationId": "listCaptureRules", "summary": "List project capture rules", "tags": [ "Capture Rules" ], "security": [ { "browserSession": [] }, { "memberBearerToken": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Project capture rules.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaptureRulesResponse" } } } }, "400": { "description": "Invalid project id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "description": "Authentication is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "description": "Project was not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } }, "post": { "operationId": "createCaptureRule", "summary": "Create a project capture rule", "tags": [ "Capture Rules" ], "security": [ { "browserSession": [] }, { "memberBearerToken": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaptureRuleCreate" } } } }, "responses": { "201": { "description": "Capture rule created.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaptureRuleResponse" } } } }, "400": { "description": "Invalid project id or request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "description": "Authentication is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "403": { "description": "Owner/admin access is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "description": "Project was not found or capture rules are unavailable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } } }, "/v1/projects/{id}/capture-rules/{ruleId}": { "patch": { "operationId": "updateCaptureRule", "summary": "Update a project capture rule", "tags": [ "Capture Rules" ], "security": [ { "browserSession": [] }, { "memberBearerToken": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "ruleId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaptureRuleUpdate" } } } }, "responses": { "200": { "description": "Capture rule updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaptureRuleResponse" } } } }, "400": { "description": "Invalid project id, rule id, or request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "description": "Authentication is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "403": { "description": "Owner/admin access is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "description": "Capture rule was not found or capture rules are unavailable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } }, "delete": { "operationId": "deleteCaptureRule", "summary": "Delete a project capture rule", "tags": [ "Capture Rules" ], "security": [ { "browserSession": [] }, { "memberBearerToken": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "ruleId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Capture rule deleted.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } }, "400": { "description": "Invalid project id or rule id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "description": "Authentication is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "403": { "description": "Owner/admin access is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "description": "Capture rule was not found or capture rules are unavailable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } } }, "/v1/projects/{id}/capture-policy": { "get": { "operationId": "getCapturePolicy", "summary": "Get the resolved capture policy for a project", "tags": [ "Capture Policy" ], "security": [ { "browserSession": [] }, { "memberBearerToken": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Resolved capture policy.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CapturePolicyResponse" } } } }, "400": { "description": "Invalid project id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "description": "Authentication is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "description": "Project was not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } }, "patch": { "operationId": "updateCapturePolicy", "summary": "Update the capture policy for a project", "tags": [ "Capture Policy" ], "security": [ { "browserSession": [] }, { "memberBearerToken": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CapturePolicyUpdate" } } } }, "responses": { "200": { "description": "Updated resolved capture policy.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CapturePolicyResponse" } } } }, "400": { "description": "Invalid project id or request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "description": "Authentication is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "403": { "description": "Owner access is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "description": "Project was not found or capture policy is unavailable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } } }, "/v1/projects/{id}/improvement-settings": { "get": { "operationId": "getImprovementSettings", "summary": "Get automated improvement settings for a project", "tags": [ "Improvements" ], "security": [ { "browserSession": [] }, { "memberBearerToken": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Automated improvement settings.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImprovementSettingsResponse" } } } }, "400": { "description": "Invalid project id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "description": "Authentication is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "description": "Project was not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } }, "patch": { "operationId": "updateImprovementSettings", "summary": "Update automated improvement settings for a project", "tags": [ "Improvements" ], "security": [ { "browserSession": [] }, { "memberBearerToken": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImprovementSettingsUpdate" } } } }, "responses": { "200": { "description": "Updated automated improvement settings.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImprovementSettingsResponse" } } } }, "400": { "description": "Invalid project id or request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "description": "Authentication is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "403": { "description": "Owner/admin access or an eligible paid tier is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "description": "Project was not found or improvement settings are unavailable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } } }, "/v1/projects/{id}/analytics/saved-funnels": { "get": { "operationId": "listSavedAnalyticsFunnels", "summary": "List active saved analytics funnels for a project", "tags": [ "Analytics" ], "security": [ { "browserSession": [] }, { "memberBearerToken": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Active saved analytics funnels.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnalyticsSavedFunnelsResponse" } } } }, "400": { "description": "Invalid query parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "description": "Authentication is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "403": { "description": "An eligible tier is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "description": "Project was not found or analytics metrics are unavailable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } }, "post": { "operationId": "createSavedAnalyticsFunnel", "summary": "Create a saved analytics funnel for a project", "tags": [ "Analytics" ], "security": [ { "browserSession": [] }, { "memberBearerToken": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnalyticsSavedFunnelCreate" } } } }, "responses": { "201": { "description": "Saved analytics funnel created.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnalyticsSavedFunnelResponse" } } } }, "400": { "description": "Invalid query parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "description": "Authentication is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "403": { "description": "An eligible tier is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "description": "Project was not found or analytics metrics are unavailable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "409": { "description": "The key exists or the saved-funnel limit was reached.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } } }, "/v1/projects/{id}/analytics/saved-funnels/{funnelKey}": { "patch": { "operationId": "updateSavedAnalyticsFunnel", "summary": "Update a saved analytics funnel", "tags": [ "Analytics" ], "security": [ { "browserSession": [] }, { "memberBearerToken": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "funnelKey", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 120, "pattern": "^[A-Za-z][A-Za-z0-9_.:-]*$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnalyticsSavedFunnelUpdate" } } } }, "responses": { "200": { "description": "Saved analytics funnel updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnalyticsSavedFunnelResponse" } } } }, "400": { "description": "Invalid query parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "description": "Authentication is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "403": { "description": "An eligible tier is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "description": "Project was not found or analytics metrics are unavailable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } }, "delete": { "operationId": "archiveSavedAnalyticsFunnel", "summary": "Archive a saved analytics funnel", "tags": [ "Analytics" ], "security": [ { "browserSession": [] }, { "memberBearerToken": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "funnelKey", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 120, "pattern": "^[A-Za-z][A-Za-z0-9_.:-]*$" } } ], "responses": { "200": { "description": "Saved analytics funnel archived.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnalyticsSavedFunnelResponse" } } } }, "400": { "description": "Invalid query parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "description": "Authentication is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "403": { "description": "An eligible tier is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "description": "Project was not found or analytics metrics are unavailable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } } }, "/v1/analytics/bundles": { "get": { "operationId": "listAnalyticsBundles", "summary": "List AnalyticsBundle generations for a project or across the caller organization", "tags": [ "Analytics" ], "security": [ { "browserSession": [] }, { "memberBearerToken": [] } ], "parameters": [ { "name": "project_id", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "status", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "enum": [ "pending", "running", "completed", "failed" ] }, { "type": "string", "const": "all" } ] } }, { "name": "kind", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "usage_summary", "route_health", "funnel_dropoff", "journey_friction", "feature_usage", "incident_impact", "deploy_comparison", "conversion_path" ] } }, { "name": "service", "in": "query", "required": false, "schema": { "type": "string", "minLength": 1, "maxLength": 120 } }, { "name": "environment", "in": "query", "required": false, "schema": { "type": "string", "minLength": 1, "maxLength": 120 } }, { "name": "from", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "to", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100 } } ], "responses": { "200": { "description": "AnalyticsBundle generations.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnalyticsBundleGenerationsListResponse" } } } }, "400": { "description": "Invalid query parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "description": "Authentication is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "403": { "description": "An eligible tier is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "description": "Project was not found or analytics metrics are unavailable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } }, "post": { "operationId": "generateAnalyticsBundle", "summary": "Request generation of a project analytics bundle", "tags": [ "Analytics" ], "security": [ { "browserSession": [] }, { "memberBearerToken": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnalyticsBundleCreate" } } } }, "responses": { "200": { "description": "Analytics bundle or explicit generation state.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnalyticsBundleResponse" } } } }, "400": { "description": "Invalid query parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "description": "Authentication is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "403": { "description": "An eligible tier is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "description": "Project was not found or analytics metrics are unavailable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "429": { "description": "Analytics generation allowance exhausted.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } } }, "/v1/analytics/bundles/{id}": { "get": { "operationId": "getAnalyticsBundle", "summary": "Get a generated analytics bundle or its generation state", "tags": [ "Analytics" ], "security": [ { "browserSession": [] }, { "memberBearerToken": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "project_id", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Analytics bundle or explicit generation state.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnalyticsBundleResponse" } } } }, "400": { "description": "Invalid query parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "description": "Authentication is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "403": { "description": "An eligible tier is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "description": "Project was not found or analytics metrics are unavailable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } } }, "/v1/analytics/opportunities": { "get": { "operationId": "listAnalyticsOpportunities", "summary": "List AnalyticsBundle opportunities for a project or across the caller organization", "tags": [ "Analytics" ], "security": [ { "browserSession": [] }, { "memberBearerToken": [] } ], "parameters": [ { "name": "project_id", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "status", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "open", "resolved", "snoozed", "all" ] } }, { "name": "kind", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "usage_summary", "route_health", "funnel_dropoff", "journey_friction", "feature_usage", "incident_impact", "deploy_comparison", "conversion_path" ] } }, { "name": "service", "in": "query", "required": false, "schema": { "type": "string", "minLength": 1, "maxLength": 120 } }, { "name": "environment", "in": "query", "required": false, "schema": { "type": "string", "minLength": 1, "maxLength": 120 } }, { "name": "severity", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "low", "medium", "high" ] } }, { "name": "bundle_status", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "not_requested", "pending", "running", "completed", "failed" ] } }, { "name": "from", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "to", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100 } } ], "responses": { "200": { "description": "Analytics opportunities.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnalyticsOpportunitiesListResponse" } } } }, "400": { "description": "Invalid query parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "description": "Authentication is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "403": { "description": "An eligible tier is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "description": "Project was not found or analytics metrics are unavailable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } } }, "/v1/analytics/opportunities/{id}": { "get": { "operationId": "getAnalyticsOpportunity", "summary": "Get an AnalyticsBundle opportunity for a project", "tags": [ "Analytics" ], "security": [ { "browserSession": [] }, { "memberBearerToken": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "project_id", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Analytics opportunity.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnalyticsOpportunityResponse" } } } }, "400": { "description": "Invalid query parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "description": "Authentication is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "403": { "description": "An eligible tier is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "description": "Project was not found or analytics metrics are unavailable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } } }, "/v1/analytics/journey-samples": { "get": { "operationId": "listAnalyticsJourneySamples", "summary": "List retained redacted analytics journey samples for a project", "tags": [ "Analytics" ], "security": [ { "browserSession": [] }, { "memberBearerToken": [] } ], "parameters": [ { "name": "project_id", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "service", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "environment", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "tag", "in": "query", "required": false, "schema": { "type": "string", "minLength": 1, "maxLength": 120 } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100 } } ], "responses": { "200": { "description": "Retained analytics journey sample metadata.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnalyticsJourneySamplesListResponse" } } } }, "400": { "description": "Invalid query parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "description": "Authentication is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "403": { "description": "An eligible tier is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "description": "Project was not found or analytics metrics are unavailable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } } }, "/v1/analytics/journey-samples/{id}": { "get": { "operationId": "getAnalyticsJourneySample", "summary": "Get a retained redacted analytics journey sample", "tags": [ "Analytics" ], "security": [ { "browserSession": [] }, { "memberBearerToken": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "project_id", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Retained analytics journey artifact.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnalyticsJourneySampleResponse" } } } }, "400": { "description": "Invalid query parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "description": "Authentication is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "403": { "description": "An eligible tier is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "description": "Project was not found or analytics metrics are unavailable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } } }, "/v1/analytics/summary": { "get": { "operationId": "getAnalyticsSummary", "summary": "Get aggregate AnalyticsBundle usage summary metrics for a project", "tags": [ "Analytics" ], "security": [ { "browserSession": [] }, { "memberBearerToken": [] } ], "parameters": [ { "name": "project_id", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "from", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "to", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "last", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "granularity", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "hour", "day" ] } }, { "name": "service", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "environment", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "route", "in": "query", "required": false, "schema": { "type": "string", "minLength": 1, "maxLength": 2048, "pattern": "^[^?#]+$" } }, { "name": "device_type", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "browser", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "os", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "language", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "country", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "auth_state", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "anonymous", "authenticated", "unknown" ] } }, { "name": "referrer", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "utm_source", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "utm_medium", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "utm_campaign", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "custom_dimensions", "in": "query", "required": false, "schema": { "type": "object", "additionalProperties": { "type": "string" } } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100 } } ], "responses": { "200": { "description": "Analytics usage summary metrics.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnalyticsUsageSummaryResponse" } } } }, "400": { "description": "Invalid query parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "description": "Authentication is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "403": { "description": "An eligible tier is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "description": "Project was not found or analytics metrics are unavailable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } } }, "/v1/analytics/routes": { "get": { "operationId": "getAnalyticsRoutes", "summary": "Get aggregate AnalyticsBundle route metrics for a project", "tags": [ "Analytics" ], "security": [ { "browserSession": [] }, { "memberBearerToken": [] } ], "parameters": [ { "name": "project_id", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "from", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "to", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "last", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "granularity", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "hour", "day" ] } }, { "name": "service", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "environment", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "route", "in": "query", "required": false, "schema": { "type": "string", "minLength": 1, "maxLength": 2048, "pattern": "^[^?#]+$" } }, { "name": "device_type", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "browser", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "os", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "language", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "country", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "auth_state", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "anonymous", "authenticated", "unknown" ] } }, { "name": "referrer", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "utm_source", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "utm_medium", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "utm_campaign", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "custom_dimensions", "in": "query", "required": false, "schema": { "type": "object", "additionalProperties": { "type": "string" } } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100 } } ], "responses": { "200": { "description": "Analytics route metrics.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnalyticsRouteMetricsResponse" } } } }, "400": { "description": "Invalid query parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "description": "Authentication is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "403": { "description": "An eligible tier is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "description": "Project was not found or analytics metrics are unavailable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } } }, "/v1/analytics/devices": { "get": { "operationId": "getAnalyticsDevices", "summary": "Get aggregate AnalyticsBundle device metrics for a project", "tags": [ "Analytics" ], "security": [ { "browserSession": [] }, { "memberBearerToken": [] } ], "parameters": [ { "name": "project_id", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "from", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "to", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "last", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "granularity", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "hour", "day" ] } }, { "name": "service", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "environment", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "route", "in": "query", "required": false, "schema": { "type": "string", "minLength": 1, "maxLength": 2048, "pattern": "^[^?#]+$" } }, { "name": "device_type", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "browser", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "os", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "language", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "country", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "auth_state", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "anonymous", "authenticated", "unknown" ] } }, { "name": "referrer", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "utm_source", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "utm_medium", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "utm_campaign", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "custom_dimensions", "in": "query", "required": false, "schema": { "type": "object", "additionalProperties": { "type": "string" } } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100 } } ], "responses": { "200": { "description": "Analytics device, browser, OS, and language metrics.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnalyticsDeviceBreakdownResponse" } } } }, "400": { "description": "Invalid query parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "description": "Authentication is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "403": { "description": "An eligible tier is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "description": "Project was not found or analytics metrics are unavailable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } } }, "/v1/analytics/journey-patterns": { "get": { "operationId": "getAnalyticsJourneyPatterns", "summary": "Get aggregate AnalyticsBundle journey transition patterns for a project", "tags": [ "Analytics" ], "security": [ { "browserSession": [] }, { "memberBearerToken": [] } ], "parameters": [ { "name": "project_id", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "from", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "to", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "last", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "granularity", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "hour", "day" ] } }, { "name": "service", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "environment", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "route", "in": "query", "required": false, "schema": { "type": "string", "minLength": 1, "maxLength": 2048, "pattern": "^[^?#]+$" } }, { "name": "device_type", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "browser", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "os", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "language", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "country", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "auth_state", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "anonymous", "authenticated", "unknown" ] } }, { "name": "referrer", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "utm_source", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "utm_medium", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "utm_campaign", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "custom_dimensions", "in": "query", "required": false, "schema": { "type": "object", "additionalProperties": { "type": "string" } } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100 } } ], "responses": { "200": { "description": "Analytics journey transition patterns.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnalyticsJourneyPatternsResponse" } } } }, "400": { "description": "Invalid query parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "description": "Authentication is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "403": { "description": "An eligible tier is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "description": "Project was not found or analytics metrics are unavailable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } } }, "/v1/analytics/referrers": { "get": { "operationId": "getAnalyticsReferrers", "summary": "Get aggregate AnalyticsBundle referrer and UTM metrics for a project", "tags": [ "Analytics" ], "security": [ { "browserSession": [] }, { "memberBearerToken": [] } ], "parameters": [ { "name": "project_id", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "from", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "to", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "last", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "granularity", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "hour", "day" ] } }, { "name": "service", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "environment", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "route", "in": "query", "required": false, "schema": { "type": "string", "minLength": 1, "maxLength": 2048, "pattern": "^[^?#]+$" } }, { "name": "device_type", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "browser", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "os", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "language", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "country", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "auth_state", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "anonymous", "authenticated", "unknown" ] } }, { "name": "referrer", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "utm_source", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "utm_medium", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "utm_campaign", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "custom_dimensions", "in": "query", "required": false, "schema": { "type": "object", "additionalProperties": { "type": "string" } } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100 } } ], "responses": { "200": { "description": "Analytics referrer and UTM metrics.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnalyticsReferrerMetricsResponse" } } } }, "400": { "description": "Invalid query parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "description": "Authentication is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "403": { "description": "An eligible tier is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "description": "Project was not found or analytics metrics are unavailable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } } }, "/v1/analytics/actions": { "get": { "operationId": "getAnalyticsActions", "summary": "Get aggregate AnalyticsBundle action and conversion metrics for a project", "tags": [ "Analytics" ], "security": [ { "browserSession": [] }, { "memberBearerToken": [] } ], "parameters": [ { "name": "project_id", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "from", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "to", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "last", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "granularity", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "hour", "day" ] } }, { "name": "service", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "environment", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "route", "in": "query", "required": false, "schema": { "type": "string", "minLength": 1, "maxLength": 2048, "pattern": "^[^?#]+$" } }, { "name": "device_type", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "browser", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "os", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "language", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "country", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "auth_state", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "anonymous", "authenticated", "unknown" ] } }, { "name": "referrer", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "utm_source", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "utm_medium", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "utm_campaign", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "custom_dimensions", "in": "query", "required": false, "schema": { "type": "object", "additionalProperties": { "type": "string" } } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100 } } ], "responses": { "200": { "description": "Analytics action, marker, and conversion metrics.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnalyticsActionMetricsResponse" } } } }, "400": { "description": "Invalid query parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "description": "Authentication is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "403": { "description": "An eligible tier is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "description": "Project was not found or analytics metrics are unavailable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } } }, "/v1/analytics/funnels": { "get": { "operationId": "listAnalyticsFunnels", "summary": "List aggregate AnalyticsBundle funnel conversion summaries for a project", "tags": [ "Analytics" ], "security": [ { "browserSession": [] }, { "memberBearerToken": [] } ], "parameters": [ { "name": "project_id", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "from", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "to", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "last", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "granularity", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "hour", "day" ] } }, { "name": "service", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "environment", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "route", "in": "query", "required": false, "schema": { "type": "string", "minLength": 1, "maxLength": 2048, "pattern": "^[^?#]+$" } }, { "name": "device_type", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "browser", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "os", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "language", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "country", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "auth_state", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "anonymous", "authenticated", "unknown" ] } }, { "name": "referrer", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "utm_source", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "utm_medium", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "utm_campaign", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "custom_dimensions", "in": "query", "required": false, "schema": { "type": "object", "additionalProperties": { "type": "string" } } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100 } } ], "responses": { "200": { "description": "Analytics funnel conversion summaries.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnalyticsFunnelsResponse" } } } }, "400": { "description": "Invalid query parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "description": "Authentication is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "403": { "description": "An eligible tier is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "description": "Project was not found or analytics metrics are unavailable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } } }, "/v1/analytics/funnels/{key}": { "get": { "operationId": "getAnalyticsFunnel", "summary": "Get aggregate AnalyticsBundle funnel conversion and dropoff metrics for a project", "tags": [ "Analytics" ], "security": [ { "browserSession": [] }, { "memberBearerToken": [] } ], "parameters": [ { "name": "key", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 120 } }, { "name": "project_id", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "from", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "to", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "last", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "granularity", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "hour", "day" ] } }, { "name": "service", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "environment", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "route", "in": "query", "required": false, "schema": { "type": "string", "minLength": 1, "maxLength": 2048, "pattern": "^[^?#]+$" } }, { "name": "device_type", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "browser", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "os", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "language", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "country", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "auth_state", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "anonymous", "authenticated", "unknown" ] } }, { "name": "referrer", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "utm_source", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "utm_medium", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "utm_campaign", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "custom_dimensions", "in": "query", "required": false, "schema": { "type": "object", "additionalProperties": { "type": "string" } } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100 } } ], "responses": { "200": { "description": "Analytics funnel conversion and dropoff metrics.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnalyticsFunnelAnalysisResponse" } } } }, "400": { "description": "Invalid query parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "description": "Authentication is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "403": { "description": "An eligible tier is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "description": "Project was not found or analytics metrics are unavailable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } } }, "/v1/analytics/incidents/{id}/impact": { "get": { "operationId": "getAnalyticsIncidentImpact", "summary": "Get aggregate analytics impact for an incident", "tags": [ "Analytics" ], "security": [ { "browserSession": [] }, { "memberBearerToken": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "project_id", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "from", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "to", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "last", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "granularity", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "hour", "day" ] } }, { "name": "service", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "environment", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "route", "in": "query", "required": false, "schema": { "type": "string", "minLength": 1, "maxLength": 2048, "pattern": "^[^?#]+$" } }, { "name": "device_type", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "browser", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "os", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "language", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "country", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "auth_state", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "anonymous", "authenticated", "unknown" ] } }, { "name": "referrer", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "utm_source", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "utm_medium", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "utm_campaign", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "custom_dimensions", "in": "query", "required": false, "schema": { "type": "object", "additionalProperties": { "type": "string" } } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100 } } ], "responses": { "200": { "description": "Aggregate incident impact metrics.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnalyticsIncidentImpactResponse" } } } }, "400": { "description": "Invalid query parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "description": "Authentication is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "403": { "description": "An eligible tier is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "description": "Project was not found or analytics metrics are unavailable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } } }, "/v1/projects/{id}/analytics-settings": { "get": { "operationId": "getAnalyticsSettings", "summary": "Get AnalyticsBundle settings for a project", "tags": [ "Analytics" ], "security": [ { "browserSession": [] }, { "memberBearerToken": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "AnalyticsBundle settings.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnalyticsSettingsResponse" } } } }, "400": { "description": "Invalid project id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "description": "Authentication is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "description": "Project was not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } }, "patch": { "operationId": "updateAnalyticsSettings", "summary": "Update AnalyticsBundle settings for a project", "tags": [ "Analytics" ], "security": [ { "browserSession": [] }, { "memberBearerToken": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnalyticsSettingsUpdate" } } } }, "responses": { "200": { "description": "Updated AnalyticsBundle settings.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnalyticsSettingsResponse" } } } }, "400": { "description": "Invalid project id or request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "description": "Authentication is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "403": { "description": "Owner/admin access or an eligible tier is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "description": "Project was not found or analytics settings are unavailable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } } }, "/v1/sdk/config": { "get": { "operationId": "getSdkConfig", "summary": "Get SDK config for a project token", "tags": [ "SDK" ], "security": [ { "projectBearerToken": [] } ], "responses": { "200": { "description": "SDK config payload.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SdkConfigResponse" } } } }, "304": { "description": "SDK config has not changed since the provided ETag." }, "401": { "description": "Project token is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } } } }, "components": { "securitySchemes": { "browserSession": { "type": "apiKey", "in": "cookie", "name": "dbundle_session", "description": "Browser session cookie for interactive authenticated routes." }, "memberBearerToken": { "type": "http", "scheme": "bearer", "bearerFormat": "Opaque member token", "description": "Bearer member token used by the CLI, MCP, and automation." }, "projectBearerToken": { "type": "http", "scheme": "bearer", "bearerFormat": "Opaque project token", "description": "Bearer project token used by ingestion and SDK config routes." } }, "schemas": { "HealthResponse": { "type": "object", "properties": { "status": { "type": "string", "const": "ok" }, "version": { "type": "string" }, "uptime": { "type": "number" } }, "required": [ "status", "version", "uptime" ], "additionalProperties": false }, "ReadyResponse": { "type": "object", "properties": { "status": { "type": "string", "const": "ready" } }, "required": [ "status" ], "additionalProperties": false }, "NotReadyResponse": { "type": "object", "properties": { "status": { "type": "string", "const": "not_ready" }, "reason": { "type": "string" } }, "required": [ "status", "reason" ], "additionalProperties": false }, "LiveResponse": { "type": "object", "properties": { "status": { "type": "string", "const": "live" } }, "required": [ "status" ], "additionalProperties": false }, "RequestEmailCodeBody": { "type": "object", "properties": { "email": { "type": "string", "format": "email" }, "accepted_terms": { "type": "boolean", "const": true }, "requested_trial_plan": { "type": "string", "enum": [ "solo", "team" ] } }, "required": [ "email", "accepted_terms" ], "additionalProperties": false }, "SuccessResponse": { "type": "object", "properties": { "success": { "type": "boolean" } }, "required": [ "success" ], "additionalProperties": false }, "ApiError": { "type": "object", "properties": { "error": { "type": "string" } }, "required": [ "error" ], "additionalProperties": false }, "VerifyEmailCodeBody": { "type": "object", "properties": { "email": { "type": "string", "format": "email" }, "code": { "type": "string", "pattern": "^\\d{6}$" }, "requested_trial_plan": { "type": "string", "enum": [ "solo", "team" ] } }, "required": [ "email", "code" ], "additionalProperties": false }, "SessionResponse": { "type": "object", "properties": { "session": { "anyOf": [ { "type": "object", "properties": { "session_id": { "type": "string" }, "user_id": { "type": "string" }, "email": { "type": "string", "format": "email" }, "email_verified_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] }, "organization_id": { "type": "string" }, "organization_plan": { "type": "string", "enum": [ "free", "solo", "team" ] }, "role": { "type": "string", "enum": [ "owner", "member" ] }, "created_at": { "type": "string", "format": "date-time" }, "expires_at": { "type": "string", "format": "date-time" }, "revoked_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] }, "avatar_url": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "csrf_token": { "type": "string" }, "auth_methods": { "type": "object", "properties": { "email": { "type": "boolean" }, "github": { "type": "boolean" } }, "required": [ "email", "github" ], "additionalProperties": false } }, "required": [ "session_id", "user_id", "email", "email_verified_at", "organization_id", "organization_plan", "role", "created_at", "expires_at", "revoked_at", "avatar_url", "csrf_token", "auth_methods" ], "additionalProperties": false }, { "type": "null" } ] } }, "required": [ "session" ], "additionalProperties": false }, "GithubDeviceStartBody": { "type": "object", "properties": { "accepted_terms": { "type": "boolean", "const": true } }, "required": [ "accepted_terms" ], "additionalProperties": false }, "GithubDeviceStartResponse": { "type": "object", "properties": { "request_id": { "type": "string", "format": "uuid" }, "user_code": { "type": "string" }, "verification_uri": { "type": "string", "format": "uri" }, "interval_seconds": { "type": "integer", "exclusiveMinimum": true, "minimum": 0 }, "expires_at": { "type": "string", "format": "date-time" } }, "required": [ "request_id", "user_code", "verification_uri", "interval_seconds", "expires_at" ], "additionalProperties": false }, "GithubDevicePollBody": { "type": "object", "properties": { "request_id": { "type": "string", "format": "uuid" } }, "required": [ "request_id" ], "additionalProperties": false }, "GithubDevicePollResponse": { "anyOf": [ { "type": "object", "properties": { "status": { "type": "string", "const": "pending" }, "interval_seconds": { "type": "integer", "exclusiveMinimum": true, "minimum": 0 }, "expires_at": { "type": "string", "format": "date-time" } }, "required": [ "status", "interval_seconds", "expires_at" ], "additionalProperties": false }, { "type": "object", "properties": { "status": { "type": "string", "enum": [ "approved", "claimed" ] }, "expires_at": { "type": "string", "format": "date-time" } }, "required": [ "status", "expires_at" ], "additionalProperties": false }, { "type": "object", "properties": { "status": { "type": "string", "enum": [ "denied", "expired", "rejected" ] }, "reason": { "type": "string" }, "expires_at": { "type": "string", "format": "date-time" } }, "required": [ "status", "reason", "expires_at" ], "additionalProperties": false } ] }, "GithubDeviceClaimBody": { "type": "object", "properties": { "request_id": { "type": "string", "format": "uuid" }, "label": { "type": "string", "minLength": 1, "maxLength": 120 } }, "required": [ "request_id", "label" ], "additionalProperties": false }, "TokenResponse": { "type": "object", "properties": { "token": { "anyOf": [ { "type": "object", "properties": { "token_id": { "type": "string" }, "project_id": { "type": "string" }, "label": { "type": "string" }, "allowed_origins": { "type": "array", "items": { "type": "string" }, "default": [] }, "created_at": { "type": "string" }, "last_used_at": { "type": [ "string", "null" ] }, "revoked_at": { "type": [ "string", "null" ] }, "expires_at": { "type": [ "string", "null" ] }, "plaintext": { "type": "string" } }, "required": [ "token_id", "project_id", "label", "created_at", "last_used_at", "revoked_at", "expires_at" ], "additionalProperties": false }, { "type": "object", "properties": { "token_id": { "type": "string" }, "user_id": { "type": "string" }, "organization_id": { "type": "string" }, "label": { "type": "string" }, "created_at": { "type": "string" }, "last_used_at": { "type": [ "string", "null" ] }, "revoked_at": { "type": [ "string", "null" ] }, "expires_at": { "type": [ "string", "null" ] }, "plaintext": { "type": "string" } }, "required": [ "token_id", "user_id", "organization_id", "label", "created_at", "last_used_at", "revoked_at", "expires_at" ], "additionalProperties": false } ] } }, "required": [ "token" ], "additionalProperties": false }, "GithubTokenExchangeBody": { "type": "object", "properties": { "github_access_token": { "type": "string", "minLength": 1 }, "label": { "type": "string", "minLength": 1, "maxLength": 120 }, "accepted_terms": { "type": "boolean", "const": true } }, "required": [ "github_access_token", "label", "accepted_terms" ], "additionalProperties": false }, "AcceptInviteBody": { "type": "object", "properties": { "token": { "type": "string", "minLength": 1 } }, "required": [ "token" ], "additionalProperties": false }, "AcceptInviteResponse": { "type": "object", "properties": { "membership": { "type": "object", "properties": { "project_id": { "type": "string" }, "user_id": { "type": "string" }, "role": { "type": "string", "enum": [ "owner", "admin", "member" ] }, "membership_type": { "type": "string", "enum": [ "owner", "collaborator" ] } }, "required": [ "project_id", "user_id", "role" ], "additionalProperties": false } }, "required": [ "membership" ], "additionalProperties": false }, "AccountExportResponse": { "type": "object", "properties": { "export_version": { "type": "number", "const": 1 }, "exported_at": { "type": "string", "format": "date-time" }, "user": { "type": "object", "additionalProperties": {} }, "organization": { "type": "object", "additionalProperties": {} }, "members": { "type": "array", "items": { "type": "object", "additionalProperties": {} } }, "project_members": { "type": "array", "items": { "type": "object", "additionalProperties": {} } }, "project_invites": { "type": "array", "items": { "type": "object", "additionalProperties": {} } }, "member_tokens": { "type": "array", "items": { "type": "object", "additionalProperties": {} } }, "projects": { "type": "array", "items": { "type": "object", "additionalProperties": {} } }, "slack_destinations": { "type": "array", "items": { "type": "object", "additionalProperties": {} } }, "project_tokens": { "type": "array", "items": { "type": "object", "additionalProperties": {} } }, "probe_activations": { "type": "array", "items": { "type": "object", "additionalProperties": {} } }, "capture_policies": { "type": "array", "items": { "type": "object", "additionalProperties": {} } }, "services": { "type": "array", "items": { "type": "object", "additionalProperties": {} } }, "deployments": { "type": "array", "items": { "type": "object", "additionalProperties": {} } }, "processed_events": { "type": "array", "items": { "type": "object", "additionalProperties": {} } }, "improvement_opportunities": { "type": "array", "items": { "type": "object", "additionalProperties": {} } }, "improvement_opportunity_events": { "type": "array", "items": { "type": "object", "additionalProperties": {} } }, "incidents": { "type": "array", "items": { "type": "object", "additionalProperties": {} } }, "incident_events": { "type": "array", "items": { "type": "object", "additionalProperties": {} } }, "bundle_generations": { "type": "array", "items": { "type": "object", "additionalProperties": {} } }, "alert_rules": { "type": "array", "items": { "type": "object", "additionalProperties": {} } }, "alert_deliveries": { "type": "array", "items": { "type": "object", "additionalProperties": {} } }, "alert_email_digests": { "type": "array", "items": { "type": "object", "additionalProperties": {} } }, "alert_email_digest_items": { "type": "array", "items": { "type": "object", "additionalProperties": {} } }, "weekly_report_channels": { "type": "array", "items": { "type": "object", "additionalProperties": {} } }, "weekly_report_deliveries": { "type": "array", "items": { "type": "object", "additionalProperties": {} } }, "agent_webhooks": { "type": "array", "items": { "type": "object", "additionalProperties": {} } }, "webhook_deliveries": { "type": "array", "items": { "type": "object", "additionalProperties": {} } }, "github_installations": { "type": "array", "items": { "type": "object", "additionalProperties": {} } }, "github_marketplace_accounts": { "type": "array", "items": { "type": "object", "additionalProperties": {} } }, "project_github_repos": { "type": "array", "items": { "type": "object", "additionalProperties": {} } }, "github_dispatch_rules": { "type": "array", "items": { "type": "object", "additionalProperties": {} } }, "github_dispatch_deliveries": { "type": "array", "items": { "type": "object", "additionalProperties": {} } }, "org_usage_counters": { "type": "array", "items": { "type": "object", "additionalProperties": {} } }, "processed_billing_events": { "type": "array", "items": { "type": "object", "additionalProperties": {} } }, "processed_github_marketplace_events": { "type": "array", "items": { "type": "object", "additionalProperties": {} } }, "plan_cleanup_tasks": { "type": "array", "items": { "type": "object", "additionalProperties": {} } }, "operational_email_deliveries": { "type": "array", "items": { "type": "object", "additionalProperties": {} } }, "audit_logs": { "type": "array", "items": { "type": "object", "additionalProperties": {} } }, "artifacts": { "type": "object", "properties": { "raw_events": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "content": {} }, "required": [ "key" ], "additionalProperties": false } }, "bundles": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "content": {} }, "required": [ "key" ], "additionalProperties": false } }, "reproductions": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "content": {} }, "required": [ "key" ], "additionalProperties": false } } }, "required": [ "raw_events", "bundles", "reproductions" ], "additionalProperties": false } }, "required": [ "export_version", "exported_at", "user", "organization", "members", "project_members", "project_invites", "member_tokens", "projects", "slack_destinations", "project_tokens", "probe_activations", "capture_policies", "services", "deployments", "processed_events", "improvement_opportunities", "improvement_opportunity_events", "incidents", "incident_events", "bundle_generations", "alert_rules", "alert_deliveries", "alert_email_digests", "alert_email_digest_items", "weekly_report_channels", "weekly_report_deliveries", "agent_webhooks", "webhook_deliveries", "github_installations", "github_marketplace_accounts", "project_github_repos", "github_dispatch_rules", "github_dispatch_deliveries", "org_usage_counters", "processed_billing_events", "processed_github_marketplace_events", "plan_cleanup_tasks", "operational_email_deliveries", "audit_logs", "artifacts" ], "additionalProperties": false }, "AvatarImageResponse": { "type": "string" }, "AccountAvatarImportResponse": { "type": "object", "properties": { "avatar": { "type": "object", "properties": { "source": { "type": "string", "enum": [ "github", "gravatar" ] }, "avatar_url": { "type": "string", "minLength": 1 }, "updated_at": { "type": "string", "format": "date-time" } }, "required": [ "source", "avatar_url", "updated_at" ], "additionalProperties": false } }, "required": [ "avatar" ], "additionalProperties": false }, "AccountDeleteRequestOtpBody": { "type": "object", "properties": { "confirmation_text": { "type": "string", "minLength": 1, "maxLength": 64 } }, "required": [ "confirmation_text" ], "additionalProperties": false }, "AccountDeleteBody": { "type": "object", "properties": { "confirmation_text": { "type": "string", "minLength": 1, "maxLength": 64 }, "otp": { "type": "string", "pattern": "^\\d{6}$" } }, "required": [ "confirmation_text", "otp" ], "additionalProperties": false }, "AccountDeletionResponse": { "type": "object", "properties": { "account": { "type": "object", "properties": { "deleted_at": { "type": "string", "format": "date-time" }, "organization_id": { "type": "string" }, "deleted_project_ids": { "type": "array", "items": { "type": "string" } }, "user_deleted": { "type": "boolean" }, "deleted_member_token_count": { "type": "integer", "minimum": 0 } }, "required": [ "deleted_at", "organization_id", "deleted_project_ids", "user_deleted", "deleted_member_token_count" ], "additionalProperties": false } }, "required": [ "account" ], "additionalProperties": false }, "IngestionRequest": { "type": "object", "properties": { "events": { "type": "array", "items": { "anyOf": [ { "anyOf": [ { "type": "object", "properties": { "schema_version": { "type": "string", "minLength": 1 }, "event_id": { "type": "string", "format": "uuid" }, "event_type": { "type": "string", "const": "backend_exception" }, "project_token": { "type": "string", "minLength": 1 }, "project_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "sdk_name": { "type": "string", "minLength": 1 }, "sdk_version": { "type": "string", "minLength": 1 }, "service": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1 }, "runtime": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "framework": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "environment": { "type": "string", "minLength": 1 } }, "required": [ "name", "environment" ], "additionalProperties": false }, "occurred_at": { "type": "string", "format": "date-time" }, "correlation": { "type": "object", "properties": { "request_id": { "type": [ "string", "null" ] }, "trace_id": { "type": [ "string", "null" ] }, "session_id": { "type": [ "string", "null" ] }, "user_id_hash": { "type": [ "string", "null" ] } }, "additionalProperties": false }, "context": { "type": "object", "additionalProperties": {} }, "payload": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 }, "stack": { "type": "string", "minLength": 1 }, "handled": { "type": "boolean" }, "request": { "type": "object", "properties": { "method": { "type": "string", "minLength": 1 }, "path": { "type": "string", "minLength": 1 }, "query": { "type": "object", "additionalProperties": {} }, "headers": { "type": "object", "additionalProperties": {} }, "body": { "anyOf": [ {}, { "type": "null" } ] } }, "required": [ "method", "path", "query", "headers" ], "additionalProperties": false }, "response": { "type": "object", "properties": { "status_code": { "type": "integer", "minimum": 0 }, "headers": { "type": "object", "additionalProperties": {} }, "body": {} }, "required": [ "status_code" ], "additionalProperties": false }, "runtime": { "type": "object", "properties": { "version": { "type": "string", "minLength": 1 }, "platform": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "arch": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "pid": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ] }, "cwd": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "uptime_sec": { "anyOf": [ { "type": "number", "minimum": 0 }, { "type": "null" } ] }, "hostname": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "thread_id": { "anyOf": [ { "type": [ "string", "number" ] }, { "type": "null" } ] }, "framework_version": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "memory": { "anyOf": [ { "type": "object", "properties": { "rss": { "anyOf": [ { "type": "number", "minimum": 0 }, { "type": "null" } ] }, "heap_total": { "anyOf": [ { "type": "number", "minimum": 0 }, { "type": "null" } ] }, "heap_used": { "anyOf": [ { "type": "number", "minimum": 0 }, { "type": "null" } ] }, "external": { "anyOf": [ { "type": "number", "minimum": 0 }, { "type": "null" } ] }, "peak": { "anyOf": [ { "type": "number", "minimum": 0 }, { "type": "null" } ] } }, "required": [ "rss", "heap_total", "heap_used", "external", "peak" ], "additionalProperties": false }, { "type": "null" } ] }, "framework_extras": { "anyOf": [ { "type": "object", "additionalProperties": {} }, { "type": "null" } ] } }, "required": [ "version" ], "additionalProperties": false }, "probe_data": { "type": "object", "properties": { "version": { "type": "number", "const": 1 }, "items": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "minLength": 1 }, "data": { "type": "object", "additionalProperties": {} }, "timestamp": { "type": "string", "format": "date-time" }, "activation_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] } }, "required": [ "label", "data", "timestamp", "activation_id" ], "additionalProperties": false } } }, "required": [ "version", "items" ], "additionalProperties": false } }, "required": [ "name", "message", "stack", "handled", "request", "response", "runtime" ], "additionalProperties": false } }, "required": [ "schema_version", "event_id", "event_type", "sdk_name", "sdk_version", "service", "occurred_at", "payload" ], "additionalProperties": false }, { "type": "object", "properties": { "schema_version": { "type": "string", "minLength": 1 }, "event_id": { "type": "string", "format": "uuid" }, "event_type": { "type": "string", "const": "request_event" }, "project_token": { "type": "string", "minLength": 1 }, "project_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "sdk_name": { "type": "string", "minLength": 1 }, "sdk_version": { "type": "string", "minLength": 1 }, "service": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1 }, "runtime": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "framework": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "environment": { "type": "string", "minLength": 1 } }, "required": [ "name", "environment" ], "additionalProperties": false }, "occurred_at": { "type": "string", "format": "date-time" }, "correlation": { "type": "object", "properties": { "request_id": { "type": [ "string", "null" ] }, "trace_id": { "type": [ "string", "null" ] }, "session_id": { "type": [ "string", "null" ] }, "user_id_hash": { "type": [ "string", "null" ] } }, "additionalProperties": false }, "context": { "type": "object", "additionalProperties": {} }, "payload": { "anyOf": [ { "type": "object", "properties": { "method": { "type": "string", "minLength": 1 }, "path": { "type": "string", "minLength": 1 }, "query": { "type": "object", "additionalProperties": {} }, "headers": { "type": "object", "additionalProperties": {} }, "body": { "anyOf": [ {}, { "type": "null" } ] }, "response_status": { "type": "integer", "minimum": 0 }, "duration_ms": { "type": "number", "minimum": 0 }, "route_template": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "response_headers": { "type": "object", "additionalProperties": {} }, "response_body": {} }, "required": [ "method", "path", "query", "headers", "response_status", "duration_ms" ], "additionalProperties": false }, { "type": "object", "properties": { "method": { "type": "string", "minLength": 1 }, "path": { "type": "string", "minLength": 1 }, "query": { "type": "object", "additionalProperties": {} }, "headers": { "type": "object", "additionalProperties": {} }, "body": { "anyOf": [ {}, { "type": "null" } ] }, "response_status": { "type": "integer", "minimum": 0 }, "duration_ms": { "type": "number", "minimum": 0 }, "route_template": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "response_headers": { "type": "object", "additionalProperties": {} }, "response_body": {}, "device": { "type": "object", "properties": { "user_agent": { "type": [ "string", "null" ] }, "os": { "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "version": { "type": [ "string", "null" ] } }, "required": [ "name", "version" ], "additionalProperties": false }, "device_type": { "type": "string", "enum": [ "desktop", "mobile", "tablet", "unknown" ] }, "screen": { "type": "object", "properties": { "width": { "type": "integer", "minimum": 0 }, "height": { "type": "integer", "minimum": 0 } }, "required": [ "width", "height" ], "additionalProperties": false }, "viewport": { "type": "object", "properties": { "width": { "type": "integer", "minimum": 0 }, "height": { "type": "integer", "minimum": 0 } }, "required": [ "width", "height" ], "additionalProperties": false }, "device_pixel_ratio": { "anyOf": [ { "type": "number", "exclusiveMinimum": true, "minimum": 0 }, { "type": "null" } ] }, "touch_capable": { "type": [ "boolean", "null" ] }, "language": { "type": [ "string", "null" ] }, "connection_type": { "type": [ "string", "null" ] }, "color_scheme_preference": { "anyOf": [ { "type": "string", "enum": [ "light", "dark", "no-preference" ] }, { "type": "null" } ] }, "app_version": { "type": [ "string", "null" ] }, "build_number": { "type": [ "string", "null" ] }, "release_channel": { "type": [ "string", "null" ] }, "api_level": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ] }, "manufacturer": { "type": [ "string", "null" ] }, "model": { "type": [ "string", "null" ] }, "timezone": { "type": [ "string", "null" ] }, "battery_level": { "anyOf": [ { "type": "number", "minimum": 0 }, { "type": "null" } ] }, "battery_charging": { "type": [ "boolean", "null" ] }, "free_disk_bytes": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ] }, "free_memory_bytes": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ] }, "jailbroken": { "type": [ "boolean", "null" ] } }, "required": [ "user_agent", "os", "device_type", "screen", "viewport", "device_pixel_ratio", "touch_capable", "language", "connection_type", "color_scheme_preference" ], "additionalProperties": false } }, "required": [ "method", "path", "query", "headers", "response_status", "duration_ms", "device" ], "additionalProperties": false } ] } }, "required": [ "schema_version", "event_id", "event_type", "sdk_name", "sdk_version", "service", "occurred_at", "payload" ], "additionalProperties": false }, { "type": "object", "properties": { "schema_version": { "type": "string", "minLength": 1 }, "event_id": { "type": "string", "format": "uuid" }, "event_type": { "type": "string", "const": "log_event" }, "project_token": { "type": "string", "minLength": 1 }, "project_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "sdk_name": { "type": "string", "minLength": 1 }, "sdk_version": { "type": "string", "minLength": 1 }, "service": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1 }, "runtime": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "framework": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "environment": { "type": "string", "minLength": 1 } }, "required": [ "name", "environment" ], "additionalProperties": false }, "occurred_at": { "type": "string", "format": "date-time" }, "correlation": { "type": "object", "properties": { "request_id": { "type": [ "string", "null" ] }, "trace_id": { "type": [ "string", "null" ] }, "session_id": { "type": [ "string", "null" ] }, "user_id_hash": { "type": [ "string", "null" ] } }, "additionalProperties": false }, "context": { "type": "object", "additionalProperties": {} }, "payload": { "anyOf": [ { "type": "object", "properties": { "level": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 }, "attributes": { "type": "object", "additionalProperties": {} } }, "required": [ "level", "message", "attributes" ], "additionalProperties": false }, { "type": "object", "properties": { "level": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 }, "attributes": { "type": "object", "additionalProperties": {} }, "device": { "type": "object", "properties": { "user_agent": { "type": [ "string", "null" ] }, "os": { "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "version": { "type": [ "string", "null" ] } }, "required": [ "name", "version" ], "additionalProperties": false }, "device_type": { "type": "string", "enum": [ "desktop", "mobile", "tablet", "unknown" ] }, "screen": { "type": "object", "properties": { "width": { "type": "integer", "minimum": 0 }, "height": { "type": "integer", "minimum": 0 } }, "required": [ "width", "height" ], "additionalProperties": false }, "viewport": { "type": "object", "properties": { "width": { "type": "integer", "minimum": 0 }, "height": { "type": "integer", "minimum": 0 } }, "required": [ "width", "height" ], "additionalProperties": false }, "device_pixel_ratio": { "anyOf": [ { "type": "number", "exclusiveMinimum": true, "minimum": 0 }, { "type": "null" } ] }, "touch_capable": { "type": [ "boolean", "null" ] }, "language": { "type": [ "string", "null" ] }, "connection_type": { "type": [ "string", "null" ] }, "color_scheme_preference": { "anyOf": [ { "type": "string", "enum": [ "light", "dark", "no-preference" ] }, { "type": "null" } ] }, "app_version": { "type": [ "string", "null" ] }, "build_number": { "type": [ "string", "null" ] }, "release_channel": { "type": [ "string", "null" ] }, "api_level": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ] }, "manufacturer": { "type": [ "string", "null" ] }, "model": { "type": [ "string", "null" ] }, "timezone": { "type": [ "string", "null" ] }, "battery_level": { "anyOf": [ { "type": "number", "minimum": 0 }, { "type": "null" } ] }, "battery_charging": { "type": [ "boolean", "null" ] }, "free_disk_bytes": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ] }, "free_memory_bytes": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ] }, "jailbroken": { "type": [ "boolean", "null" ] } }, "required": [ "user_agent", "os", "device_type", "screen", "viewport", "device_pixel_ratio", "touch_capable", "language", "connection_type", "color_scheme_preference" ], "additionalProperties": false } }, "required": [ "level", "message", "attributes", "device" ], "additionalProperties": false } ] } }, "required": [ "schema_version", "event_id", "event_type", "sdk_name", "sdk_version", "service", "occurred_at", "payload" ], "additionalProperties": false }, { "type": "object", "properties": { "schema_version": { "type": "string", "minLength": 1 }, "event_id": { "type": "string", "format": "uuid" }, "event_type": { "type": "string", "const": "frontend_breadcrumb" }, "project_token": { "type": "string", "minLength": 1 }, "project_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "sdk_name": { "type": "string", "minLength": 1 }, "sdk_version": { "type": "string", "minLength": 1 }, "service": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1 }, "runtime": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "framework": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "environment": { "type": "string", "minLength": 1 } }, "required": [ "name", "environment" ], "additionalProperties": false }, "occurred_at": { "type": "string", "format": "date-time" }, "correlation": { "type": "object", "properties": { "request_id": { "type": [ "string", "null" ] }, "trace_id": { "type": [ "string", "null" ] }, "session_id": { "type": [ "string", "null" ] }, "user_id_hash": { "type": [ "string", "null" ] } }, "additionalProperties": false }, "context": { "type": "object", "additionalProperties": {} }, "payload": { "anyOf": [ { "type": "object", "properties": { "breadcrumb_type": { "type": "string", "enum": [ "route_change", "click", "form_submit", "console_log", "network_request" ] }, "route": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "data": { "type": "object", "additionalProperties": {} } }, "required": [ "breadcrumb_type", "data" ], "additionalProperties": false }, { "type": "object", "properties": { "breadcrumb_type": { "type": "string", "minLength": 1 }, "route": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "data": { "type": "object", "additionalProperties": {} }, "device": { "type": "object", "properties": { "user_agent": { "type": [ "string", "null" ] }, "os": { "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "version": { "type": [ "string", "null" ] } }, "required": [ "name", "version" ], "additionalProperties": false }, "device_type": { "type": "string", "enum": [ "desktop", "mobile", "tablet", "unknown" ] }, "screen": { "type": "object", "properties": { "width": { "type": "integer", "minimum": 0 }, "height": { "type": "integer", "minimum": 0 } }, "required": [ "width", "height" ], "additionalProperties": false }, "viewport": { "type": "object", "properties": { "width": { "type": "integer", "minimum": 0 }, "height": { "type": "integer", "minimum": 0 } }, "required": [ "width", "height" ], "additionalProperties": false }, "device_pixel_ratio": { "anyOf": [ { "type": "number", "exclusiveMinimum": true, "minimum": 0 }, { "type": "null" } ] }, "touch_capable": { "type": [ "boolean", "null" ] }, "language": { "type": [ "string", "null" ] }, "connection_type": { "type": [ "string", "null" ] }, "color_scheme_preference": { "anyOf": [ { "type": "string", "enum": [ "light", "dark", "no-preference" ] }, { "type": "null" } ] }, "app_version": { "type": [ "string", "null" ] }, "build_number": { "type": [ "string", "null" ] }, "release_channel": { "type": [ "string", "null" ] }, "api_level": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ] }, "manufacturer": { "type": [ "string", "null" ] }, "model": { "type": [ "string", "null" ] }, "timezone": { "type": [ "string", "null" ] }, "battery_level": { "anyOf": [ { "type": "number", "minimum": 0 }, { "type": "null" } ] }, "battery_charging": { "type": [ "boolean", "null" ] }, "free_disk_bytes": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ] }, "free_memory_bytes": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ] }, "jailbroken": { "type": [ "boolean", "null" ] } }, "required": [ "user_agent", "os", "device_type", "screen", "viewport", "device_pixel_ratio", "touch_capable", "language", "connection_type", "color_scheme_preference" ], "additionalProperties": false } }, "required": [ "breadcrumb_type", "data", "device" ], "additionalProperties": false } ] } }, "required": [ "schema_version", "event_id", "event_type", "sdk_name", "sdk_version", "service", "occurred_at", "payload" ], "additionalProperties": false }, { "type": "object", "properties": { "schema_version": { "type": "string", "minLength": 1 }, "event_id": { "type": "string", "format": "uuid" }, "event_type": { "type": "string", "const": "frontend_exception" }, "project_token": { "type": "string", "minLength": 1 }, "project_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "sdk_name": { "type": "string", "minLength": 1 }, "sdk_version": { "type": "string", "minLength": 1 }, "service": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1 }, "runtime": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "framework": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "environment": { "type": "string", "minLength": 1 } }, "required": [ "name", "environment" ], "additionalProperties": false }, "occurred_at": { "type": "string", "format": "date-time" }, "correlation": { "type": "object", "properties": { "request_id": { "type": [ "string", "null" ] }, "trace_id": { "type": [ "string", "null" ] }, "session_id": { "type": [ "string", "null" ] }, "user_id_hash": { "type": [ "string", "null" ] } }, "additionalProperties": false }, "context": { "type": "object", "additionalProperties": {} }, "payload": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 }, "stack": { "type": "string", "minLength": 1 }, "route": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "browser": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1 }, "version": { "type": "string", "minLength": 1 } }, "required": [ "name", "version" ], "additionalProperties": false }, "breadcrumbs": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "breadcrumb_type": { "type": "string", "enum": [ "route_change", "click", "form_submit", "console_log", "network_request" ] }, "route": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "data": { "type": "object", "additionalProperties": {} }, "ts": { "type": "string", "format": "date-time" } }, "required": [ "breadcrumb_type", "data", "ts" ], "additionalProperties": false }, { "type": "object", "properties": { "breadcrumb_type": { "type": "string", "minLength": 1 }, "route": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "data": { "type": "object", "additionalProperties": {} }, "ts": { "type": "string", "format": "date-time" } }, "required": [ "breadcrumb_type", "data", "ts" ], "additionalProperties": false } ] } }, "device": { "anyOf": [ { "anyOf": [ { "type": "object", "properties": { "user_agent": { "type": [ "string", "null" ] }, "os": { "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "version": { "type": [ "string", "null" ] } }, "required": [ "name", "version" ], "additionalProperties": false }, "device_type": { "type": "string", "enum": [ "desktop", "mobile", "tablet", "unknown" ] }, "screen": { "type": "object", "properties": { "width": { "type": "integer", "minimum": 0 }, "height": { "type": "integer", "minimum": 0 } }, "required": [ "width", "height" ], "additionalProperties": false }, "viewport": { "type": "object", "properties": { "width": { "type": "integer", "minimum": 0 }, "height": { "type": "integer", "minimum": 0 } }, "required": [ "width", "height" ], "additionalProperties": false }, "device_pixel_ratio": { "anyOf": [ { "type": "number", "exclusiveMinimum": true, "minimum": 0 }, { "type": "null" } ] }, "touch_capable": { "type": [ "boolean", "null" ] }, "language": { "type": [ "string", "null" ] }, "connection_type": { "type": [ "string", "null" ] }, "color_scheme_preference": { "anyOf": [ { "type": "string", "enum": [ "light", "dark", "no-preference" ] }, { "type": "null" } ] } }, "required": [ "user_agent", "os", "device_type", "screen", "viewport", "device_pixel_ratio", "touch_capable", "language", "connection_type", "color_scheme_preference" ], "additionalProperties": false }, { "type": "object", "properties": { "user_agent": { "type": [ "string", "null" ] }, "os": { "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "version": { "type": [ "string", "null" ] } }, "required": [ "name", "version" ], "additionalProperties": false }, "device_type": { "type": "string", "enum": [ "desktop", "mobile", "tablet", "unknown" ] }, "screen": { "type": "object", "properties": { "width": { "type": "integer", "minimum": 0 }, "height": { "type": "integer", "minimum": 0 } }, "required": [ "width", "height" ], "additionalProperties": false }, "viewport": { "type": "object", "properties": { "width": { "type": "integer", "minimum": 0 }, "height": { "type": "integer", "minimum": 0 } }, "required": [ "width", "height" ], "additionalProperties": false }, "device_pixel_ratio": { "anyOf": [ { "type": "number", "exclusiveMinimum": true, "minimum": 0 }, { "type": "null" } ] }, "touch_capable": { "type": [ "boolean", "null" ] }, "language": { "type": [ "string", "null" ] }, "connection_type": { "type": [ "string", "null" ] }, "color_scheme_preference": { "anyOf": [ { "type": "string", "enum": [ "light", "dark", "no-preference" ] }, { "type": "null" } ] }, "app_version": { "type": [ "string", "null" ] }, "build_number": { "type": [ "string", "null" ] }, "release_channel": { "type": [ "string", "null" ] }, "api_level": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ] }, "manufacturer": { "type": [ "string", "null" ] }, "model": { "type": [ "string", "null" ] }, "timezone": { "type": [ "string", "null" ] }, "battery_level": { "anyOf": [ { "type": "number", "minimum": 0 }, { "type": "null" } ] }, "battery_charging": { "type": [ "boolean", "null" ] }, "free_disk_bytes": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ] }, "free_memory_bytes": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ] }, "jailbroken": { "type": [ "boolean", "null" ] } }, "required": [ "user_agent", "os", "device_type", "screen", "viewport", "device_pixel_ratio", "touch_capable", "language", "connection_type", "color_scheme_preference" ], "additionalProperties": false } ] }, { "type": "null" } ] }, "browser_event": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "window_error", "resource_error" ] }, "message": { "type": [ "string", "null" ] }, "file_name": { "type": [ "string", "null" ] }, "line_number": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ] }, "column_number": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ] }, "target": { "anyOf": [ { "type": "object", "properties": { "tag_name": { "type": [ "string", "null" ] }, "source_url": { "type": [ "string", "null" ] }, "attributes": { "type": "object", "properties": { "rel": { "type": "string" }, "as": { "type": "string" }, "type": { "type": "string" }, "media": { "type": "string" }, "cross_origin": { "type": "string" }, "async": { "type": "boolean" }, "defer": { "type": "boolean" }, "integrity_present": { "type": "boolean" } }, "additionalProperties": false } }, "required": [ "tag_name", "source_url" ], "additionalProperties": false }, { "type": "null" } ] }, "page": { "type": "object", "properties": { "url": { "type": [ "string", "null" ] }, "referrer": { "type": [ "string", "null" ] }, "ready_state": { "anyOf": [ { "type": "string", "enum": [ "loading", "interactive", "complete" ] }, { "type": "null" } ] }, "visibility_state": { "anyOf": [ { "type": "string", "enum": [ "visible", "hidden", "prerender", "unloaded" ] }, { "type": "null" } ] } }, "required": [ "url", "referrer", "ready_state", "visibility_state" ], "additionalProperties": false }, "opaque": { "type": "boolean" } }, "required": [ "kind", "message", "file_name", "line_number", "column_number", "target", "opaque" ], "additionalProperties": false }, "rejection_reason": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "error", "string", "object", "null", "undefined", "unknown" ] }, "name": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 }, "preview": { "type": "string", "minLength": 1 } }, "required": [ "kind" ], "additionalProperties": false }, "dom_context": { "anyOf": [ { "type": "object", "properties": { "mode": { "type": "string", "const": "lightweight" }, "html_excerpt": { "type": "string", "minLength": 1 } }, "required": [ "mode", "html_excerpt" ], "additionalProperties": false }, { "type": "null" } ] }, "probe_data": { "type": "object", "properties": { "version": { "type": "number", "const": 1 }, "items": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "minLength": 1 }, "data": { "type": "object", "additionalProperties": {} }, "timestamp": { "type": "string", "format": "date-time" }, "activation_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] } }, "required": [ "label", "data", "timestamp", "activation_id" ], "additionalProperties": false } } }, "required": [ "version", "items" ], "additionalProperties": false } }, "required": [ "name", "message", "stack" ], "additionalProperties": false } }, "required": [ "schema_version", "event_id", "event_type", "sdk_name", "sdk_version", "service", "occurred_at", "payload" ], "additionalProperties": false }, { "type": "object", "properties": { "schema_version": { "type": "string", "minLength": 1 }, "event_id": { "type": "string", "format": "uuid" }, "event_type": { "type": "string", "const": "deploy_metadata" }, "project_token": { "type": "string", "minLength": 1 }, "project_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "sdk_name": { "type": "string", "minLength": 1 }, "sdk_version": { "type": "string", "minLength": 1 }, "service": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1 }, "runtime": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "framework": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "environment": { "type": "string", "minLength": 1 } }, "required": [ "name", "environment" ], "additionalProperties": false }, "occurred_at": { "type": "string", "format": "date-time" }, "correlation": { "type": "object", "properties": { "request_id": { "type": [ "string", "null" ] }, "trace_id": { "type": [ "string", "null" ] }, "session_id": { "type": [ "string", "null" ] }, "user_id_hash": { "type": [ "string", "null" ] } }, "additionalProperties": false }, "context": { "type": "object", "additionalProperties": {} }, "payload": { "type": "object", "properties": { "commit_sha": { "type": "string", "minLength": 1 }, "version": { "type": "string", "minLength": 1 }, "branch": { "type": "string", "minLength": 1 }, "environment": { "type": "string", "minLength": 1 }, "deployed_at": { "type": "string", "format": "date-time" } }, "required": [ "commit_sha", "version", "branch", "environment", "deployed_at" ], "additionalProperties": false } }, "required": [ "schema_version", "event_id", "event_type", "sdk_name", "sdk_version", "service", "occurred_at", "payload" ], "additionalProperties": false }, { "type": "object", "properties": { "schema_version": { "type": "string", "minLength": 1 }, "event_id": { "type": "string", "format": "uuid" }, "event_type": { "type": "string", "const": "error_suppressed" }, "project_token": { "type": "string", "minLength": 1 }, "project_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "sdk_name": { "type": "string", "minLength": 1 }, "sdk_version": { "type": "string", "minLength": 1 }, "service": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1 }, "runtime": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "framework": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "environment": { "type": "string", "minLength": 1 } }, "required": [ "name", "environment" ], "additionalProperties": false }, "occurred_at": { "type": "string", "format": "date-time" }, "correlation": { "type": "object", "properties": { "request_id": { "type": [ "string", "null" ] }, "trace_id": { "type": [ "string", "null" ] }, "session_id": { "type": [ "string", "null" ] }, "user_id_hash": { "type": [ "string", "null" ] } }, "additionalProperties": false }, "context": { "type": "object", "additionalProperties": {} }, "payload": { "anyOf": [ { "type": "object", "properties": { "fingerprint": { "type": "string", "minLength": 1 }, "suppressed_count": { "type": "integer", "minimum": 0 }, "window_seconds": { "type": "integer", "exclusiveMinimum": true, "minimum": 0 }, "first_seen": { "type": "string", "format": "date-time" }, "last_seen": { "type": "string", "format": "date-time" } }, "required": [ "fingerprint", "suppressed_count", "window_seconds", "first_seen", "last_seen" ], "additionalProperties": false }, { "type": "object", "properties": { "fingerprint": { "type": "string", "minLength": 1 }, "suppressed_count": { "type": "integer", "minimum": 0 }, "window_seconds": { "type": "integer", "exclusiveMinimum": true, "minimum": 0 }, "first_seen": { "type": "string", "format": "date-time" }, "last_seen": { "type": "string", "format": "date-time" }, "device": { "type": "object", "properties": { "user_agent": { "type": [ "string", "null" ] }, "os": { "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "version": { "type": [ "string", "null" ] } }, "required": [ "name", "version" ], "additionalProperties": false }, "device_type": { "type": "string", "enum": [ "desktop", "mobile", "tablet", "unknown" ] }, "screen": { "type": "object", "properties": { "width": { "type": "integer", "minimum": 0 }, "height": { "type": "integer", "minimum": 0 } }, "required": [ "width", "height" ], "additionalProperties": false }, "viewport": { "type": "object", "properties": { "width": { "type": "integer", "minimum": 0 }, "height": { "type": "integer", "minimum": 0 } }, "required": [ "width", "height" ], "additionalProperties": false }, "device_pixel_ratio": { "anyOf": [ { "type": "number", "exclusiveMinimum": true, "minimum": 0 }, { "type": "null" } ] }, "touch_capable": { "type": [ "boolean", "null" ] }, "language": { "type": [ "string", "null" ] }, "connection_type": { "type": [ "string", "null" ] }, "color_scheme_preference": { "anyOf": [ { "type": "string", "enum": [ "light", "dark", "no-preference" ] }, { "type": "null" } ] }, "app_version": { "type": [ "string", "null" ] }, "build_number": { "type": [ "string", "null" ] }, "release_channel": { "type": [ "string", "null" ] }, "api_level": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ] }, "manufacturer": { "type": [ "string", "null" ] }, "model": { "type": [ "string", "null" ] }, "timezone": { "type": [ "string", "null" ] }, "battery_level": { "anyOf": [ { "type": "number", "minimum": 0 }, { "type": "null" } ] }, "battery_charging": { "type": [ "boolean", "null" ] }, "free_disk_bytes": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ] }, "free_memory_bytes": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ] }, "jailbroken": { "type": [ "boolean", "null" ] } }, "required": [ "user_agent", "os", "device_type", "screen", "viewport", "device_pixel_ratio", "touch_capable", "language", "connection_type", "color_scheme_preference" ], "additionalProperties": false } }, "required": [ "fingerprint", "suppressed_count", "window_seconds", "first_seen", "last_seen", "device" ], "additionalProperties": false } ] } }, "required": [ "schema_version", "event_id", "event_type", "sdk_name", "sdk_version", "service", "occurred_at", "payload" ], "additionalProperties": false }, { "type": "object", "properties": { "schema_version": { "type": "string", "minLength": 1 }, "event_id": { "type": "string", "format": "uuid" }, "event_type": { "type": "string", "const": "probe_event" }, "project_token": { "type": "string", "minLength": 1 }, "project_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "sdk_name": { "type": "string", "minLength": 1 }, "sdk_version": { "type": "string", "minLength": 1 }, "service": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1 }, "runtime": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "framework": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "environment": { "type": "string", "minLength": 1 } }, "required": [ "name", "environment" ], "additionalProperties": false }, "occurred_at": { "type": "string", "format": "date-time" }, "correlation": { "type": "object", "properties": { "request_id": { "type": [ "string", "null" ] }, "trace_id": { "type": [ "string", "null" ] }, "session_id": { "type": [ "string", "null" ] }, "user_id_hash": { "type": [ "string", "null" ] } }, "additionalProperties": false }, "context": { "type": "object", "additionalProperties": {} }, "payload": { "anyOf": [ { "type": "object", "properties": { "label": { "type": "string", "minLength": 1 }, "data": { "type": "object", "additionalProperties": {} }, "activation_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "probe_label_pattern": { "type": "string", "minLength": 1 } }, "required": [ "label", "data", "activation_id", "probe_label_pattern" ], "additionalProperties": false }, { "type": "object", "properties": { "label": { "type": "string", "minLength": 1 }, "data": { "type": "object", "additionalProperties": {} }, "activation_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "probe_label_pattern": { "type": "string", "minLength": 1 }, "device": { "type": "object", "properties": { "user_agent": { "type": [ "string", "null" ] }, "os": { "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "version": { "type": [ "string", "null" ] } }, "required": [ "name", "version" ], "additionalProperties": false }, "device_type": { "type": "string", "enum": [ "desktop", "mobile", "tablet", "unknown" ] }, "screen": { "type": "object", "properties": { "width": { "type": "integer", "minimum": 0 }, "height": { "type": "integer", "minimum": 0 } }, "required": [ "width", "height" ], "additionalProperties": false }, "viewport": { "type": "object", "properties": { "width": { "type": "integer", "minimum": 0 }, "height": { "type": "integer", "minimum": 0 } }, "required": [ "width", "height" ], "additionalProperties": false }, "device_pixel_ratio": { "anyOf": [ { "type": "number", "exclusiveMinimum": true, "minimum": 0 }, { "type": "null" } ] }, "touch_capable": { "type": [ "boolean", "null" ] }, "language": { "type": [ "string", "null" ] }, "connection_type": { "type": [ "string", "null" ] }, "color_scheme_preference": { "anyOf": [ { "type": "string", "enum": [ "light", "dark", "no-preference" ] }, { "type": "null" } ] }, "app_version": { "type": [ "string", "null" ] }, "build_number": { "type": [ "string", "null" ] }, "release_channel": { "type": [ "string", "null" ] }, "api_level": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ] }, "manufacturer": { "type": [ "string", "null" ] }, "model": { "type": [ "string", "null" ] }, "timezone": { "type": [ "string", "null" ] }, "battery_level": { "anyOf": [ { "type": "number", "minimum": 0 }, { "type": "null" } ] }, "battery_charging": { "type": [ "boolean", "null" ] }, "free_disk_bytes": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ] }, "free_memory_bytes": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ] }, "jailbroken": { "type": [ "boolean", "null" ] } }, "required": [ "user_agent", "os", "device_type", "screen", "viewport", "device_pixel_ratio", "touch_capable", "language", "connection_type", "color_scheme_preference" ], "additionalProperties": false } }, "required": [ "label", "data", "activation_id", "probe_label_pattern", "device" ], "additionalProperties": false } ] } }, "required": [ "schema_version", "event_id", "event_type", "sdk_name", "sdk_version", "service", "occurred_at", "payload" ], "additionalProperties": false } ] }, { "type": "object", "properties": { "schema_version": { "type": "string", "const": "2026-07-analytics-01" }, "event_id": { "type": "string", "format": "uuid" }, "event_type": { "type": "string", "const": "analytics_event" }, "project_token": { "type": "string", "minLength": 1, "maxLength": 256 }, "project_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "occurred_at": { "type": "string", "format": "date-time" }, "sdk_name": { "type": "string", "minLength": 1, "maxLength": 120 }, "sdk_version": { "type": "string", "minLength": 1, "maxLength": 80 }, "service": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 120 }, "runtime": { "anyOf": [ { "type": "string", "const": "browser" }, { "type": "null" } ] }, "framework": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 80 }, { "type": "null" } ] }, "environment": { "type": "string", "minLength": 1, "maxLength": 120 } }, "required": [ "name", "environment" ], "additionalProperties": false }, "correlation": { "type": "object", "properties": { "session_id": { "type": "string", "minLength": 1, "maxLength": 128 }, "visitor_id_hash": { "anyOf": [ { "type": "string", "pattern": "^sha256:[a-f0-9]{64}$" }, { "type": "null" } ] }, "user_id_hash": { "anyOf": [ { "type": "string", "pattern": "^sha256:[a-f0-9]{64}$" }, { "type": "null" } ] }, "trace_id": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 128 }, { "type": "null" } ] }, "deploy_id": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 128 }, { "type": "null" } ] } }, "required": [ "session_id", "visitor_id_hash", "user_id_hash", "trace_id", "deploy_id" ], "additionalProperties": false }, "payload": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "session_start", "page_view", "route_change", "action", "funnel_step", "conversion", "journey_marker", "session_summary" ] }, "privacy": { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "strict", "standard", "custom" ] }, "consent_granted": { "type": "boolean" } }, "required": [ "mode", "consent_granted" ], "additionalProperties": false, "default": { "mode": "strict", "consent_granted": false } }, "session": { "type": "object", "properties": { "duration_ms": { "type": "integer", "minimum": 0, "maximum": 86400000 }, "pageviews": { "type": "integer", "minimum": 0, "maximum": 100000 } }, "required": [ "duration_ms", "pageviews" ], "additionalProperties": false }, "signal": { "type": "object", "properties": { "action_key": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 120, "pattern": "^[A-Za-z][A-Za-z0-9_.:-]*$" }, { "type": "null" } ] }, "funnel_key": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 120, "pattern": "^[A-Za-z][A-Za-z0-9_.:-]*$" }, { "type": "null" } ] }, "step_key": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 120, "pattern": "^[A-Za-z][A-Za-z0-9_.:-]*$" }, { "type": "null" } ] }, "conversion_key": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 120, "pattern": "^[A-Za-z][A-Za-z0-9_.:-]*$" }, { "type": "null" } ] }, "marker_key": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 120, "pattern": "^[A-Za-z][A-Za-z0-9_.:-]*$" }, { "type": "null" } ] } }, "additionalProperties": false }, "route": { "anyOf": [ { "type": "object", "properties": { "path": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 2048 }, { "type": "null" } ] }, "normalized_path": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 2048 }, { "type": "null" } ] }, "title": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 200 }, { "type": "null" } ] } }, "required": [ "path", "normalized_path", "title" ], "additionalProperties": false }, { "type": "null" } ] }, "previous_route": { "anyOf": [ { "type": "object", "properties": { "path": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 2048 }, { "type": "null" } ] }, "normalized_path": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 2048 }, { "type": "null" } ] }, "title": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 200 }, { "type": "null" } ] } }, "required": [ "path", "normalized_path", "title" ], "additionalProperties": false }, { "type": "null" } ] }, "dimensions": { "type": "object", "properties": { "auth_state": { "type": "string", "enum": [ "anonymous", "authenticated", "unknown" ] }, "device_type": { "type": "string", "enum": [ "desktop", "mobile", "tablet", "unknown" ] }, "browser_family": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 80 }, { "type": "null" } ] }, "browser_major": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 10000 }, { "type": "null" } ] }, "os_family": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 80 }, { "type": "null" } ] }, "os_major": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 10000 }, { "type": "null" } ] }, "language": { "anyOf": [ { "type": "string", "minLength": 2, "maxLength": 35, "pattern": "^[A-Za-z]{2,8}(-[A-Za-z0-9]{1,8})*$" }, { "type": "null" } ] }, "locale": { "anyOf": [ { "type": "string", "minLength": 2, "maxLength": 35, "pattern": "^[A-Za-z]{2,8}(-[A-Za-z0-9]{1,8})*$" }, { "type": "null" } ] }, "viewport_bucket": { "type": "string", "enum": [ "small", "medium", "large", "unknown" ] }, "referrer_domain": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 255 }, { "type": "null" } ] }, "utm_source": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 128 }, { "type": "null" } ] }, "utm_medium": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 128 }, { "type": "null" } ] }, "utm_campaign": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 128 }, { "type": "null" } ] }, "country_code": { "anyOf": [ { "type": "string", "pattern": "^[A-Z]{2}$" }, { "type": "null" } ] }, "region_code": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 16, "pattern": "^[A-Za-z0-9-]+$" }, { "type": "null" } ] } }, "required": [ "auth_state", "device_type", "browser_family", "browser_major", "os_family", "os_major", "language", "locale", "viewport_bucket", "referrer_domain", "utm_source", "utm_medium", "utm_campaign", "country_code", "region_code" ], "additionalProperties": false }, "custom_dimensions": { "type": "object", "additionalProperties": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 128 }, { "type": "number", "minimum": -1000000, "maximum": 1000000 }, { "type": "boolean" }, { "type": "null" } ] }, "default": {} } }, "required": [ "kind", "dimensions" ], "additionalProperties": false } }, "required": [ "schema_version", "event_id", "event_type", "occurred_at", "sdk_name", "sdk_version", "service", "correlation", "payload" ], "additionalProperties": false } ] } } }, "required": [ "events" ], "additionalProperties": false }, "IngestionAcceptedResponse": { "type": "object", "properties": { "accepted": { "type": "integer", "minimum": 0 }, "rejected": { "type": "integer", "minimum": 0 }, "errors": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "integer" }, "reason": { "type": "string" } }, "required": [ "index", "reason" ], "additionalProperties": false } }, "retry_after_ms": { "type": "integer", "exclusiveMinimum": true, "minimum": 0 }, "probe_directives": { "type": "object", "properties": { "active_probes": { "type": "array", "items": { "type": "object", "properties": { "activation_id": { "type": "string", "format": "uuid" }, "label_pattern": { "type": "string" }, "service": { "type": "string" }, "environment": { "type": "string" }, "expires_at": { "type": "string", "format": "date-time" }, "trigger_expires_at": { "type": "string", "format": "date-time" } }, "required": [ "activation_id", "label_pattern", "service", "environment", "expires_at", "trigger_expires_at" ], "additionalProperties": false } } }, "required": [ "active_probes" ], "additionalProperties": false } }, "required": [ "accepted", "rejected", "errors" ], "additionalProperties": false }, "IncidentListResponse": { "type": "object", "properties": { "incidents": { "type": "array", "items": { "type": "object", "properties": { "incident_id": { "type": "string" }, "project_id": { "type": "string" }, "project_name": { "type": "string" }, "project_color_tag": {}, "service_id": { "type": [ "string", "null" ] }, "service_name": { "type": [ "string", "null" ] }, "latest_deployment_id": { "type": [ "string", "null" ] }, "environment": { "type": "string" }, "fingerprint": { "type": "string" }, "fingerprint_version": { "type": "string" }, "title": { "type": "string" }, "severity": { "type": "string" }, "status": { "type": "string" }, "first_seen_at": { "type": "string" }, "last_seen_at": { "type": "string" }, "occurrence_count": { "type": "integer" }, "spike_detected_at": { "type": [ "string", "null" ] }, "resolved_at": { "type": [ "string", "null" ] }, "regressed_at": { "type": [ "string", "null" ] }, "matched_fields": { "type": "array", "items": { "type": "string" } }, "incident_reason": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "backend_exception", "frontend_exception", "request_failure", "error_log" ] }, "description": { "type": "string" }, "event_type": { "type": "string", "enum": [ "backend_exception", "frontend_exception", "request_event", "log_event" ] }, "event_class": { "type": "string", "const": "incident_signal" }, "matched_policy": { "type": "string" } }, "required": [ "kind", "description", "event_type", "event_class", "matched_policy" ], "additionalProperties": false } }, "required": [ "incident_id", "project_id", "project_name", "service_id", "service_name", "latest_deployment_id", "environment", "fingerprint", "fingerprint_version", "title", "severity", "status", "first_seen_at", "last_seen_at", "occurrence_count", "spike_detected_at", "regressed_at", "matched_fields" ], "additionalProperties": false } }, "next_cursor": { "type": [ "string", "null" ] } }, "required": [ "incidents" ], "additionalProperties": false }, "BulkIncidentMutationBody": { "type": "object", "properties": { "incident_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "minItems": 1, "maxItems": 1000 } }, "required": [ "incident_ids" ], "additionalProperties": false }, "BulkIncidentResponse": { "type": "object", "properties": { "incidents": { "type": "array", "items": { "type": "object", "properties": { "incident_id": { "type": "string" }, "project_id": { "type": "string" }, "project_name": { "type": "string" }, "project_color_tag": {}, "service_id": { "type": [ "string", "null" ] }, "service_name": { "type": [ "string", "null" ] }, "latest_deployment_id": { "type": [ "string", "null" ] }, "environment": { "type": "string" }, "fingerprint": { "type": "string" }, "fingerprint_version": { "type": "string" }, "title": { "type": "string" }, "severity": { "type": "string" }, "status": { "type": "string" }, "first_seen_at": { "type": "string" }, "last_seen_at": { "type": "string" }, "occurrence_count": { "type": "integer" }, "spike_detected_at": { "type": [ "string", "null" ] }, "resolved_at": { "type": [ "string", "null" ] }, "regressed_at": { "type": [ "string", "null" ] }, "matched_fields": { "type": "array", "items": { "type": "string" } }, "incident_reason": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "backend_exception", "frontend_exception", "request_failure", "error_log" ] }, "description": { "type": "string" }, "event_type": { "type": "string", "enum": [ "backend_exception", "frontend_exception", "request_event", "log_event" ] }, "event_class": { "type": "string", "const": "incident_signal" }, "matched_policy": { "type": "string" } }, "required": [ "kind", "description", "event_type", "event_class", "matched_policy" ], "additionalProperties": false } }, "required": [ "incident_id", "project_id", "project_name", "service_id", "service_name", "latest_deployment_id", "environment", "fingerprint", "fingerprint_version", "title", "severity", "status", "first_seen_at", "last_seen_at", "occurrence_count", "spike_detected_at", "regressed_at", "matched_fields" ], "additionalProperties": false } } }, "required": [ "incidents" ], "additionalProperties": false }, "IncidentResponse": { "type": "object", "properties": { "incident": { "type": "object", "properties": { "incident_id": { "type": "string" }, "project_id": { "type": "string" }, "project_name": { "type": "string" }, "project_color_tag": {}, "service_id": { "type": [ "string", "null" ] }, "service_name": { "type": [ "string", "null" ] }, "latest_deployment_id": { "type": [ "string", "null" ] }, "environment": { "type": "string" }, "fingerprint": { "type": "string" }, "fingerprint_version": { "type": "string" }, "title": { "type": "string" }, "severity": { "type": "string" }, "status": { "type": "string" }, "first_seen_at": { "type": "string" }, "last_seen_at": { "type": "string" }, "occurrence_count": { "type": "integer" }, "spike_detected_at": { "type": [ "string", "null" ] }, "resolved_at": { "type": [ "string", "null" ] }, "regressed_at": { "type": [ "string", "null" ] }, "matched_fields": { "type": "array", "items": { "type": "string" } }, "incident_reason": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "backend_exception", "frontend_exception", "request_failure", "error_log" ] }, "description": { "type": "string" }, "event_type": { "type": "string", "enum": [ "backend_exception", "frontend_exception", "request_event", "log_event" ] }, "event_class": { "type": "string", "const": "incident_signal" }, "matched_policy": { "type": "string" } }, "required": [ "kind", "description", "event_type", "event_class", "matched_policy" ], "additionalProperties": false } }, "required": [ "incident_id", "project_id", "project_name", "service_id", "service_name", "latest_deployment_id", "environment", "fingerprint", "fingerprint_version", "title", "severity", "status", "first_seen_at", "last_seen_at", "occurrence_count", "spike_detected_at", "regressed_at", "matched_fields" ], "additionalProperties": false } }, "required": [ "incident" ], "additionalProperties": false }, "BundleDocument": { "type": "object", "properties": { "bundle_version": { "type": "number", "const": 1 }, "bundle_id": { "type": "string", "minLength": 1 }, "bundle_type": { "type": "string", "enum": [ "failure", "improvement" ] }, "captured_at": { "type": "string", "format": "date-time" }, "sdk": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1 }, "version": { "type": "string", "minLength": 1 } }, "required": [ "name", "version" ], "additionalProperties": false }, "project": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "slug": { "type": "string", "minLength": 1 }, "environment": { "type": "string", "minLength": 1 } }, "required": [ "id", "slug", "environment" ], "additionalProperties": false }, "service": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "name": { "type": "string", "minLength": 1 }, "runtime": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "framework": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "version": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "region": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] } }, "required": [ "id", "name", "runtime", "framework", "version", "region" ], "additionalProperties": false }, "signal": { "type": "object", "properties": { "signal_id": { "type": "string", "minLength": 1 }, "signal_type": { "type": "string", "enum": [ "exception", "fatal_error", "request_failure", "frontend_exception", "warning", "deprecation", "performance_issue", "retry_loop", "slow_query" ] }, "severity": { "type": "string", "enum": [ "low", "medium", "high", "critical" ] }, "fingerprint": { "type": "string", "minLength": 1 }, "first_seen_at": { "type": "string", "format": "date-time" }, "last_seen_at": { "type": "string", "format": "date-time" }, "occurrence_count": { "type": "integer", "minimum": 0 }, "source_event_types": { "type": "array", "items": { "type": "string", "minLength": 1 } } }, "required": [ "signal_id", "signal_type", "severity", "fingerprint", "first_seen_at", "last_seen_at", "occurrence_count", "source_event_types" ], "additionalProperties": false }, "summary": { "type": "object", "properties": { "title": { "type": "string", "minLength": 1 }, "description": { "type": "string", "minLength": 1 }, "likely_cause": { "type": [ "string", "null" ] }, "confidence": { "type": "number", "minimum": 0, "maximum": 1 }, "recommended_action": { "type": [ "string", "null" ] }, "severity": { "type": "string", "enum": [ "low", "medium", "high", "critical" ] }, "error_type": { "type": [ "string", "null" ] }, "error_message": { "type": [ "string", "null" ] }, "first_application_frame": { "anyOf": [ { "type": "object", "properties": { "file": { "type": [ "string", "null" ] }, "line": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ] }, "function": { "type": [ "string", "null" ] } }, "required": [ "file", "line", "function" ], "additionalProperties": false }, { "type": "null" } ] }, "primary_signal": { "type": [ "string", "null" ] }, "signals": { "type": "object", "properties": { "new_deploy": { "type": "boolean" }, "regression_suspected": { "type": "boolean" }, "customer_visible": { "type": "boolean" } }, "required": [ "new_deploy", "regression_suspected", "customer_visible" ], "additionalProperties": false } }, "required": [ "title", "description", "likely_cause", "confidence", "recommended_action", "severity", "error_type", "error_message", "first_application_frame", "primary_signal", "signals" ], "additionalProperties": false }, "impact": { "type": "object", "properties": { "affected_users_estimate": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ] }, "affected_requests_estimate": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ] }, "business_criticality": { "type": "string", "enum": [ "low", "medium", "high", "critical" ] }, "customer_visible": { "type": "boolean" }, "regression_suspected": { "type": "boolean" } }, "required": [ "affected_users_estimate", "affected_requests_estimate", "business_criticality", "customer_visible", "regression_suspected" ], "additionalProperties": false }, "context": { "type": "object", "properties": { "error": { "anyOf": [ { "anyOf": [ { "type": "object", "properties": { "version": { "type": "number", "const": 1 }, "name": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 }, "stack": { "type": "string", "minLength": 1 }, "handled": { "type": "boolean" }, "top_frames": { "type": "array", "items": { "type": "string" } } }, "required": [ "version", "name", "message", "stack", "handled", "top_frames" ], "additionalProperties": false }, { "type": "null" } ] }, { "type": "null" } ] }, "request": { "anyOf": [ { "type": "object", "properties": { "version": { "type": "number", "const": 1 }, "method": { "type": "string", "minLength": 1 }, "path": { "type": "string", "minLength": 1 }, "route_template": { "type": [ "string", "null" ] }, "query": { "type": "object", "additionalProperties": {} }, "headers": { "type": "object", "additionalProperties": {} }, "body": { "anyOf": [ {}, { "type": "null" } ] }, "request_id": { "type": [ "string", "null" ] } }, "required": [ "version", "method", "path", "route_template", "query", "headers", "request_id" ], "additionalProperties": false }, { "type": "null" } ] }, "response": { "anyOf": [ { "type": "object", "properties": { "version": { "type": "number", "const": 1 }, "status_code": { "type": "integer" }, "duration_ms": { "anyOf": [ { "type": "number", "minimum": 0 }, { "type": "null" } ] }, "headers": { "type": "object", "additionalProperties": {} }, "body": {} }, "required": [ "version", "status_code", "duration_ms" ], "additionalProperties": false }, { "type": "null" } ] }, "logs": { "anyOf": [ { "type": "object", "properties": { "version": { "type": "number", "const": 1 }, "items": { "type": "array", "items": { "type": "object", "properties": { "level": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 }, "timestamp": { "type": "string", "format": "date-time" }, "attributes": { "type": "object", "additionalProperties": {} } }, "required": [ "level", "message", "timestamp", "attributes" ], "additionalProperties": false } } }, "required": [ "version", "items" ], "additionalProperties": false }, { "type": "null" } ] }, "frontend": { "anyOf": [ { "type": "object", "properties": { "version": { "type": "number", "const": 1 }, "route_changes": { "type": "array", "items": { "type": "object", "properties": { "from": { "type": "string" }, "to": { "type": "string" }, "ts": { "type": "string", "format": "date-time" } }, "required": [ "from", "to", "ts" ], "additionalProperties": false } }, "clicks": { "type": "array", "items": { "type": "object", "properties": { "selector": { "type": "string" }, "label": { "type": "string" }, "ts": { "type": "string", "format": "date-time" } }, "required": [ "selector", "label", "ts" ], "additionalProperties": false } }, "form_submissions": { "type": "array", "items": { "type": "object", "properties": { "form": { "type": "string" }, "fields": { "type": "object", "additionalProperties": {} }, "ts": { "type": "string", "format": "date-time" } }, "required": [ "form", "fields", "ts" ], "additionalProperties": false } }, "console_logs": { "type": "array", "items": {} }, "network_requests": { "type": "array", "items": { "type": "object", "properties": { "method": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "integer" }, "ts": { "type": "string", "format": "date-time" }, "duration_ms": { "type": "number", "minimum": 0 }, "caller_trace": { "type": "array", "items": { "type": "string" } }, "response_body": {}, "request_body": {}, "response_headers": { "type": "object", "additionalProperties": { "type": "string" } }, "response_content_length": { "type": "integer", "minimum": 0 } }, "required": [ "method", "url", "status", "ts" ], "additionalProperties": false } }, "exceptions": { "type": "array", "items": {} }, "dom_context": { "anyOf": [ { "type": "object", "properties": { "mode": { "type": "string", "const": "lightweight" }, "html_excerpt": { "type": "string" } }, "required": [ "mode", "html_excerpt" ], "additionalProperties": false }, { "type": "null" } ] } }, "required": [ "version", "route_changes", "clicks", "form_submissions", "console_logs", "network_requests", "exceptions", "dom_context" ], "additionalProperties": false }, { "type": "null" } ] }, "environment": { "anyOf": [ { "type": "object", "properties": { "version": { "type": "number", "const": 1 }, "os": { "type": [ "string", "null" ] }, "host": { "type": [ "string", "null" ] }, "container_id": { "type": [ "string", "null" ] } }, "required": [ "version", "os", "host", "container_id" ], "additionalProperties": false }, { "type": "null" } ] }, "deploy": { "anyOf": [ { "type": "object", "properties": { "version": { "type": "number", "const": 1 }, "commit_sha": { "type": [ "string", "null" ] }, "deploy_version": { "type": [ "string", "null" ] }, "branch": { "type": [ "string", "null" ] }, "deployed_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] }, "regression_window": { "type": [ "boolean", "null" ] } }, "required": [ "version", "commit_sha", "deploy_version", "branch", "deployed_at", "regression_window" ], "additionalProperties": false }, { "type": "null" } ] }, "runtime": { "anyOf": [ { "type": "object", "properties": { "version": { "type": "number", "const": 1 }, "name": { "type": "string", "minLength": 1 }, "runtime_version": { "type": [ "string", "null" ] }, "platform": { "type": [ "string", "null" ] }, "arch": { "type": [ "string", "null" ] }, "pid": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "cwd": { "type": [ "string", "null" ] }, "uptime_sec": { "anyOf": [ { "type": "number", "minimum": 0 }, { "type": "null" } ] }, "hostname": { "type": [ "string", "null" ] }, "thread_id": { "anyOf": [ { "type": [ "string", "number" ] }, { "type": "null" } ] }, "framework": { "type": [ "string", "null" ] }, "framework_version": { "type": [ "string", "null" ] }, "memory": { "anyOf": [ { "type": "object", "properties": { "rss": { "anyOf": [ { "type": "number", "minimum": 0 }, { "type": "null" } ] }, "heap_total": { "anyOf": [ { "type": "number", "minimum": 0 }, { "type": "null" } ] }, "heap_used": { "anyOf": [ { "type": "number", "minimum": 0 }, { "type": "null" } ] }, "external": { "anyOf": [ { "type": "number", "minimum": 0 }, { "type": "null" } ] }, "peak": { "anyOf": [ { "type": "number", "minimum": 0 }, { "type": "null" } ] } }, "required": [ "rss", "heap_total", "heap_used", "external", "peak" ], "additionalProperties": false }, { "type": "null" } ] }, "framework_extras": { "anyOf": [ { "type": "object", "additionalProperties": {} }, { "type": "null" } ] } }, "required": [ "version", "name", "runtime_version", "platform", "arch", "pid", "cwd", "uptime_sec", "hostname", "thread_id", "framework", "framework_version", "memory" ], "additionalProperties": false }, { "type": "null" } ] }, "git": { "anyOf": [ { "type": "object", "properties": { "version": { "type": "number", "const": 1 }, "commit": { "type": [ "string", "null" ] }, "commit_short": { "type": [ "string", "null" ] }, "branch": { "type": [ "string", "null" ] }, "repo": { "type": [ "string", "null" ] }, "dirty": { "type": "boolean" }, "source": { "type": "string", "enum": [ "config", "env", "local", "unknown" ] } }, "required": [ "version", "commit", "commit_short", "branch", "repo", "dirty", "source" ], "additionalProperties": false }, { "type": "null" } ] }, "dependencies": { "anyOf": [ { "type": "object", "properties": { "version": { "type": "number", "const": 1 }, "items": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1 }, "status": { "type": "string", "enum": [ "ok", "degraded", "failed", "unknown" ] }, "notes": { "type": [ "string", "null" ] } }, "required": [ "name", "status", "notes" ], "additionalProperties": false } } }, "required": [ "version", "items" ], "additionalProperties": false }, { "type": "null" } ] }, "probe_data": { "anyOf": [ { "type": "object", "properties": { "version": { "type": "number", "const": 1 }, "items": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "minLength": 1 }, "data": { "type": "object", "additionalProperties": {} }, "timestamp": { "type": "string", "format": "date-time" }, "activation_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] } }, "required": [ "label", "data", "timestamp", "activation_id" ], "additionalProperties": false } } }, "required": [ "version", "items" ], "additionalProperties": false }, { "type": "null" } ] }, "device": { "anyOf": [ { "type": "object", "properties": { "version": { "type": "number", "const": 1 }, "user_agent": { "type": [ "string", "null" ] }, "browser": { "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "version": { "type": [ "string", "null" ] } }, "required": [ "name", "version" ], "additionalProperties": false }, "os": { "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "version": { "type": [ "string", "null" ] } }, "required": [ "name", "version" ], "additionalProperties": false }, "device_type": { "type": "string", "enum": [ "desktop", "mobile", "tablet", "unknown" ] }, "screen": { "type": "object", "properties": { "width": { "type": "integer", "minimum": 0 }, "height": { "type": "integer", "minimum": 0 } }, "required": [ "width", "height" ], "additionalProperties": false }, "viewport": { "type": "object", "properties": { "width": { "type": "integer", "minimum": 0 }, "height": { "type": "integer", "minimum": 0 } }, "required": [ "width", "height" ], "additionalProperties": false }, "device_pixel_ratio": { "anyOf": [ { "type": "number", "exclusiveMinimum": true, "minimum": 0 }, { "type": "null" } ] }, "touch_capable": { "type": [ "boolean", "null" ] }, "language": { "type": [ "string", "null" ] }, "connection_type": { "type": [ "string", "null" ] }, "color_scheme_preference": { "anyOf": [ { "type": "string", "enum": [ "light", "dark", "no-preference" ] }, { "type": "null" } ] } }, "required": [ "version", "user_agent", "browser", "os", "device_type", "screen", "viewport", "device_pixel_ratio", "touch_capable", "language", "connection_type", "color_scheme_preference" ], "additionalProperties": false }, { "type": "null" } ] } }, "additionalProperties": false }, "reproduction": { "type": "object", "properties": { "possible": { "type": "boolean" }, "confidence": { "type": "number", "minimum": 0, "maximum": 1 }, "reason": { "type": "string" }, "artifacts": { "anyOf": [ { "type": "object", "properties": { "curl": { "type": [ "string", "null" ] }, "httpie": { "type": [ "string", "null" ] }, "json_spec": { "anyOf": [ { "type": "object", "properties": { "method": { "type": "string" }, "url": { "type": "string" }, "headers": { "type": "object", "additionalProperties": {} }, "query": { "type": "object", "additionalProperties": {} }, "body": { "anyOf": [ {}, { "type": "null" } ] } }, "required": [ "method", "url", "headers" ], "additionalProperties": false }, { "type": "null" } ] } }, "required": [ "curl", "httpie", "json_spec" ], "additionalProperties": false }, { "type": "null" } ] }, "feasibility_reference": { "anyOf": [ { "type": "object", "properties": { "standard_http_bugs": { "type": "string" }, "frontend_interaction_plus_failing_request": { "type": "string" }, "background_jobs": { "type": "string" }, "race_conditions": { "type": "string" }, "external_outage_timing": { "type": "string" } }, "required": [ "standard_http_bugs", "frontend_interaction_plus_failing_request", "background_jobs", "race_conditions", "external_outage_timing" ], "additionalProperties": false }, { "type": "null" } ] } }, "required": [ "possible", "confidence", "reason", "artifacts" ], "additionalProperties": false }, "verification": { "type": "object", "properties": { "verification_type": { "type": [ "string", "null" ] }, "synthetic": { "type": "boolean" }, "local_verified": { "type": "boolean" }, "production_verified": { "type": "boolean" } }, "required": [ "verification_type", "synthetic", "local_verified", "production_verified" ], "additionalProperties": false }, "links": { "type": "object", "properties": { "self": { "type": [ "string", "null" ] }, "reproduction": { "type": [ "string", "null" ] }, "incident": { "type": [ "string", "null" ] }, "project": { "type": [ "string", "null" ] }, "docs": { "type": [ "string", "null" ] } }, "required": [ "self", "reproduction", "incident", "project", "docs" ], "additionalProperties": false }, "redaction": { "type": "object", "properties": { "redacted": { "type": "boolean" }, "fields": { "type": "array", "items": { "type": "string" } }, "notes": { "type": [ "string", "null" ] } }, "required": [ "redacted", "fields", "notes" ], "additionalProperties": false }, "metadata": { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "generator_version": { "type": "string", "minLength": 1 }, "generation_number": { "type": "integer", "exclusiveMinimum": true, "minimum": 0 } }, "required": [ "created_at", "updated_at", "generator_version", "generation_number" ], "additionalProperties": false } }, "required": [ "bundle_version", "bundle_id", "bundle_type", "captured_at", "sdk", "project", "service", "signal", "summary", "impact", "context", "reproduction", "verification", "links", "redaction", "metadata" ], "additionalProperties": false }, "PendingStatus": { "type": "object", "properties": { "status": { "type": "string", "const": "pending" } }, "required": [ "status" ], "additionalProperties": false }, "BundleFailedStatus": { "type": "object", "properties": { "status": { "type": "string", "const": "failed" }, "reason": { "type": "string" } }, "required": [ "status", "reason" ], "additionalProperties": false }, "ReproductionResponse": { "anyOf": [ { "type": "object", "properties": { "status": { "type": "string", "const": "pending" } }, "required": [ "status" ], "additionalProperties": false }, { "type": "object", "properties": { "possible": { "type": "boolean" }, "confidence": { "type": "number" }, "reason": { "type": "string" }, "artifacts": { "anyOf": [ { "type": "object", "properties": { "curl": { "type": [ "string", "null" ] }, "httpie": { "type": [ "string", "null" ] }, "json_spec": { "anyOf": [ {}, { "type": "null" } ] } }, "additionalProperties": false }, { "type": "null" } ] }, "feasibility_reference": { "anyOf": [ {}, { "type": "null" } ] } }, "required": [ "possible", "confidence", "reason", "artifacts" ], "additionalProperties": false } ] }, "ImprovementListResponse": { "type": "object", "properties": { "improvements": { "type": "array", "items": { "type": "object", "properties": { "improvement_id": { "type": "string" }, "project_id": { "type": "string" }, "project_name": { "type": "string" }, "project_color_tag": {}, "project_slug": { "type": "string" }, "service_id": { "type": [ "string", "null" ] }, "service_name": { "type": "string" }, "service_runtime": { "type": [ "string", "null" ] }, "service_framework": { "type": [ "string", "null" ] }, "environment": { "type": "string" }, "kind": { "type": "string", "enum": [ "warning_hotspot", "slow_request", "request_failure_pattern", "recurring_incident", "post_deploy_regression" ] }, "status": { "type": "string", "enum": [ "open", "resolved", "snoozed" ] }, "severity": { "type": "string", "enum": [ "low", "medium", "high", "critical" ] }, "confidence": { "type": "number" }, "fingerprint": { "type": "string" }, "title": { "type": "string" }, "summary": { "type": "string" }, "occurrence_count": { "type": "integer" }, "evidence": { "type": "object", "additionalProperties": {} }, "related_incident_ids": { "type": "array", "items": { "type": "string" } }, "first_detected_at": { "type": "string" }, "last_detected_at": { "type": "string" }, "resolved_at": { "type": [ "string", "null" ] }, "snoozed_until": { "type": [ "string", "null" ] }, "bundle_generation_number": { "type": "integer" }, "bundle_created_at": { "type": [ "string", "null" ] }, "bundle_updated_at": { "type": [ "string", "null" ] }, "bundle_failure_reason": { "type": [ "string", "null" ] } }, "required": [ "improvement_id", "project_id", "project_name", "project_slug", "service_id", "service_name", "service_runtime", "service_framework", "environment", "kind", "status", "severity", "confidence", "fingerprint", "title", "summary", "occurrence_count", "evidence", "related_incident_ids", "first_detected_at", "last_detected_at", "resolved_at", "snoozed_until", "bundle_generation_number", "bundle_created_at", "bundle_updated_at", "bundle_failure_reason" ], "additionalProperties": false } }, "next_cursor": { "type": [ "string", "null" ] } }, "required": [ "improvements" ], "additionalProperties": false }, "ImprovementResponse": { "type": "object", "properties": { "improvement": { "type": "object", "properties": { "improvement_id": { "type": "string" }, "project_id": { "type": "string" }, "project_name": { "type": "string" }, "project_color_tag": {}, "project_slug": { "type": "string" }, "service_id": { "type": [ "string", "null" ] }, "service_name": { "type": "string" }, "service_runtime": { "type": [ "string", "null" ] }, "service_framework": { "type": [ "string", "null" ] }, "environment": { "type": "string" }, "kind": { "type": "string", "enum": [ "warning_hotspot", "slow_request", "request_failure_pattern", "recurring_incident", "post_deploy_regression" ] }, "status": { "type": "string", "enum": [ "open", "resolved", "snoozed" ] }, "severity": { "type": "string", "enum": [ "low", "medium", "high", "critical" ] }, "confidence": { "type": "number" }, "fingerprint": { "type": "string" }, "title": { "type": "string" }, "summary": { "type": "string" }, "occurrence_count": { "type": "integer" }, "evidence": { "type": "object", "additionalProperties": {} }, "related_incident_ids": { "type": "array", "items": { "type": "string" } }, "first_detected_at": { "type": "string" }, "last_detected_at": { "type": "string" }, "resolved_at": { "type": [ "string", "null" ] }, "snoozed_until": { "type": [ "string", "null" ] }, "bundle_generation_number": { "type": "integer" }, "bundle_created_at": { "type": [ "string", "null" ] }, "bundle_updated_at": { "type": [ "string", "null" ] }, "bundle_failure_reason": { "type": [ "string", "null" ] } }, "required": [ "improvement_id", "project_id", "project_name", "project_slug", "service_id", "service_name", "service_runtime", "service_framework", "environment", "kind", "status", "severity", "confidence", "fingerprint", "title", "summary", "occurrence_count", "evidence", "related_incident_ids", "first_detected_at", "last_detected_at", "resolved_at", "snoozed_until", "bundle_generation_number", "bundle_created_at", "bundle_updated_at", "bundle_failure_reason" ], "additionalProperties": false } }, "required": [ "improvement" ], "additionalProperties": false }, "ImprovementSnoozeBody": { "type": "object", "properties": { "snoozed_until": { "type": "string", "format": "date-time" } }, "required": [ "snoozed_until" ], "additionalProperties": false }, "LogsResponse": { "type": "object", "properties": { "logs": { "type": "array", "items": { "type": "object", "properties": { "event_id": { "type": "string" }, "event_type": { "type": "string" }, "occurred_at": { "type": "string" }, "is_sampled": { "type": "boolean" }, "level": { "type": [ "string", "null" ] } }, "required": [ "event_id", "event_type", "occurred_at", "is_sampled", "level" ], "additionalProperties": false } }, "next_cursor": { "type": [ "string", "null" ] } }, "required": [ "logs" ], "additionalProperties": false }, "ServicesResponse": { "type": "object", "properties": { "services": { "type": "array", "items": { "type": "object", "properties": { "service_id": { "type": "string" }, "project_id": { "type": "string" }, "name": { "type": "string" }, "runtime": { "type": [ "string", "null" ] }, "framework": { "type": [ "string", "null" ] }, "environment": { "type": "string" } }, "required": [ "service_id", "project_id", "name", "runtime", "framework", "environment" ], "additionalProperties": false } } }, "required": [ "services" ], "additionalProperties": false }, "ProjectMemberListResponse": { "type": "object", "properties": { "members": { "type": "array", "items": { "type": "object", "properties": { "user_id": { "type": "string" }, "email": { "type": "string", "format": "email" }, "role": { "type": "string", "enum": [ "owner", "admin", "member" ] }, "membership_type": { "type": "string", "enum": [ "owner", "collaborator" ] }, "avatar_url": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "created_at": { "type": "string", "format": "date-time" } }, "required": [ "user_id", "email", "role", "membership_type", "avatar_url", "created_at" ], "additionalProperties": false } } }, "required": [ "members" ], "additionalProperties": false }, "ProjectInviteListResponse": { "type": "object", "properties": { "invites": { "type": "array", "items": { "type": "object", "properties": { "invite_id": { "type": "string", "format": "uuid" }, "project_id": { "type": "string" }, "email": { "type": "string", "format": "email" }, "role": { "type": "string", "enum": [ "admin", "member" ] }, "invited_by_user_id": { "type": "string" }, "accepted_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] }, "canceled_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] }, "expires_at": { "type": "string", "format": "date-time" }, "created_at": { "type": "string", "format": "date-time" } }, "required": [ "invite_id", "project_id", "email", "role", "invited_by_user_id", "accepted_at", "canceled_at", "expires_at", "created_at" ], "additionalProperties": false } } }, "required": [ "invites" ], "additionalProperties": false }, "CreateProjectInviteBody": { "type": "object", "properties": { "email": { "type": "string", "format": "email" }, "role": { "type": "string", "enum": [ "admin", "member" ], "default": "member" } }, "required": [ "email" ], "additionalProperties": false }, "ProjectInviteResponse": { "type": "object", "properties": { "invite": { "type": "object", "properties": { "invite_id": { "type": "string", "format": "uuid" }, "project_id": { "type": "string" }, "email": { "type": "string", "format": "email" }, "role": { "type": "string", "enum": [ "admin", "member" ] }, "invited_by_user_id": { "type": "string" }, "accepted_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] }, "canceled_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] }, "expires_at": { "type": "string", "format": "date-time" }, "created_at": { "type": "string", "format": "date-time" } }, "required": [ "invite_id", "project_id", "email", "role", "invited_by_user_id", "accepted_at", "canceled_at", "expires_at", "created_at" ], "additionalProperties": false } }, "required": [ "invite" ], "additionalProperties": false }, "UpdateProjectMemberRoleBody": { "type": "object", "properties": { "role": { "type": "string", "enum": [ "admin", "member" ] } }, "required": [ "role" ], "additionalProperties": false }, "ProjectMemberResponse": { "type": "object", "properties": { "member": { "type": "object", "properties": { "user_id": { "type": "string" }, "email": { "type": "string", "format": "email" }, "role": { "type": "string", "enum": [ "owner", "admin", "member" ] }, "membership_type": { "type": "string", "enum": [ "owner", "collaborator" ] }, "avatar_url": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "created_at": { "type": "string", "format": "date-time" } }, "required": [ "user_id", "email", "role", "membership_type", "avatar_url", "created_at" ], "additionalProperties": false } }, "required": [ "member" ], "additionalProperties": false }, "ProjectListResponse": { "type": "object", "properties": { "projects": { "type": "array", "items": { "type": "object", "properties": { "project_id": { "type": "string" }, "organization_id": { "type": "string" }, "owner_user_id": { "type": "string" }, "owner_email": { "type": "string", "format": "email" }, "relationship": { "type": "string", "enum": [ "owned", "shared" ] }, "sharing_state": { "type": "string", "enum": [ "private", "shared_by_you", "shared_with_you" ] }, "effective_role": { "type": "string", "enum": [ "owner", "admin", "member" ] }, "shared_access_suspended": { "type": "boolean" }, "name": { "type": "string" }, "slug": { "type": "string" }, "environment_default": { "type": "string" }, "color_tag": {}, "organization_plan": { "type": "string", "enum": [ "free", "solo", "team" ] }, "metrics": { "type": "object", "properties": { "open_incidents": { "type": "integer", "minimum": 0, "default": 0 }, "regressed_incidents": { "type": "integer", "minimum": 0, "default": 0 }, "attention_incidents_today": { "type": "integer", "minimum": 0, "default": 0 }, "opened_incidents_today": { "type": "integer", "minimum": 0, "default": 0 }, "opened_incidents_month": { "type": "integer", "minimum": 0, "default": 0 }, "monthly_bundle_requests": { "type": "integer", "minimum": 0 }, "monthly_raw_ingested_events": { "type": "integer", "minimum": 0 }, "retained_bundles": { "type": "integer", "minimum": 0 }, "monthly_alert_deliveries": { "type": "integer", "minimum": 0 } }, "required": [ "monthly_bundle_requests", "monthly_raw_ingested_events", "retained_bundles", "monthly_alert_deliveries" ], "additionalProperties": false }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "required": [ "project_id", "organization_id", "owner_user_id", "owner_email", "relationship", "sharing_state", "effective_role", "name", "slug", "environment_default", "organization_plan", "metrics", "created_at", "updated_at" ], "additionalProperties": false } } }, "required": [ "projects" ], "additionalProperties": false }, "CreateProjectBody": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 120 }, "slug": { "type": "string", "minLength": 1, "maxLength": 80, "pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$" }, "environment_default": { "type": "string", "minLength": 1, "maxLength": 50, "default": "production" }, "color_tag": { "anyOf": [ { "type": "string", "enum": [ "red", "orange", "amber", "yellow", "lime", "green", "emerald", "teal", "cyan", "sky", "blue", "indigo", "violet", "purple", "fuchsia", "pink", "rose", "slate" ] }, { "type": "null" } ], "default": null }, "weekly_report_timezone": { "type": "string", "minLength": 1, "default": "UTC" } }, "required": [ "name", "slug" ], "additionalProperties": false }, "ProjectCreateResponse": { "type": "object", "properties": { "project": { "type": "object", "properties": { "project_id": { "type": "string" }, "organization_id": { "type": "string" }, "owner_user_id": { "type": "string" }, "owner_email": { "type": "string", "format": "email" }, "relationship": { "type": "string", "enum": [ "owned", "shared" ] }, "sharing_state": { "type": "string", "enum": [ "private", "shared_by_you", "shared_with_you" ] }, "effective_role": { "type": "string", "enum": [ "owner", "admin", "member" ] }, "shared_access_suspended": { "type": "boolean" }, "name": { "type": "string" }, "slug": { "type": "string" }, "environment_default": { "type": "string" }, "color_tag": {}, "organization_plan": { "type": "string", "enum": [ "free", "solo", "team" ] }, "metrics": { "type": "object", "properties": { "open_incidents": { "type": "integer", "minimum": 0, "default": 0 }, "regressed_incidents": { "type": "integer", "minimum": 0, "default": 0 }, "attention_incidents_today": { "type": "integer", "minimum": 0, "default": 0 }, "opened_incidents_today": { "type": "integer", "minimum": 0, "default": 0 }, "opened_incidents_month": { "type": "integer", "minimum": 0, "default": 0 }, "monthly_bundle_requests": { "type": "integer", "minimum": 0 }, "monthly_raw_ingested_events": { "type": "integer", "minimum": 0 }, "retained_bundles": { "type": "integer", "minimum": 0 }, "monthly_alert_deliveries": { "type": "integer", "minimum": 0 } }, "required": [ "monthly_bundle_requests", "monthly_raw_ingested_events", "retained_bundles", "monthly_alert_deliveries" ], "additionalProperties": false }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "required": [ "project_id", "organization_id", "owner_user_id", "owner_email", "relationship", "sharing_state", "effective_role", "name", "slug", "environment_default", "organization_plan", "metrics", "created_at", "updated_at" ], "additionalProperties": false } }, "required": [ "project" ], "additionalProperties": false }, "UpdateProjectBody": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 120 }, "slug": { "type": "string", "minLength": 1, "maxLength": 80, "pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$" }, "environment_default": { "type": "string", "minLength": 1, "maxLength": 50 }, "color_tag": { "anyOf": [ { "type": "string", "enum": [ "red", "orange", "amber", "yellow", "lime", "green", "emerald", "teal", "cyan", "sky", "blue", "indigo", "violet", "purple", "fuchsia", "pink", "rose", "slate" ] }, { "type": "null" } ] } }, "additionalProperties": false }, "ProjectUpdateResponse": { "type": "object", "properties": { "project": { "type": "object", "properties": { "project_id": { "type": "string" }, "organization_id": { "type": "string" }, "owner_user_id": { "type": "string" }, "owner_email": { "type": "string", "format": "email" }, "relationship": { "type": "string", "enum": [ "owned", "shared" ] }, "sharing_state": { "type": "string", "enum": [ "private", "shared_by_you", "shared_with_you" ] }, "effective_role": { "type": "string", "enum": [ "owner", "admin", "member" ] }, "shared_access_suspended": { "type": "boolean" }, "name": { "type": "string" }, "slug": { "type": "string" }, "environment_default": { "type": "string" }, "color_tag": {}, "organization_plan": { "type": "string", "enum": [ "free", "solo", "team" ] }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "metrics": { "type": "object", "properties": { "open_incidents": { "type": "integer", "minimum": 0 }, "regressed_incidents": { "type": "integer", "minimum": 0 }, "attention_incidents_today": { "type": "integer", "minimum": 0 }, "opened_incidents_today": { "type": "integer", "minimum": 0 }, "opened_incidents_month": { "type": "integer", "minimum": 0 }, "monthly_bundle_requests": { "type": "integer", "minimum": 0 }, "monthly_raw_ingested_events": { "type": "integer", "minimum": 0 }, "retained_bundles": { "type": "integer", "minimum": 0 }, "monthly_alert_deliveries": { "type": "integer", "minimum": 0 } }, "required": [ "open_incidents", "regressed_incidents", "attention_incidents_today", "opened_incidents_today", "opened_incidents_month", "monthly_bundle_requests", "monthly_raw_ingested_events", "retained_bundles", "monthly_alert_deliveries" ], "additionalProperties": false } }, "required": [ "project_id", "organization_id", "owner_user_id", "owner_email", "relationship", "sharing_state", "effective_role", "name", "slug", "environment_default", "organization_plan", "created_at", "updated_at", "metrics" ], "additionalProperties": false } }, "required": [ "project" ], "additionalProperties": false }, "ProjectDeleteResponse": { "type": "object", "properties": { "project": { "type": "object", "properties": { "project_id": { "type": "string" }, "organization_id": { "type": "string" }, "owner_user_id": { "type": "string" }, "owner_email": { "type": "string", "format": "email" }, "relationship": { "type": "string", "enum": [ "owned", "shared" ] }, "sharing_state": { "type": "string", "enum": [ "private", "shared_by_you", "shared_with_you" ] }, "effective_role": { "type": "string", "enum": [ "owner", "admin", "member" ] }, "shared_access_suspended": { "type": "boolean" }, "name": { "type": "string" }, "slug": { "type": "string" }, "environment_default": { "type": "string" }, "color_tag": {}, "organization_plan": { "type": "string", "enum": [ "free", "solo", "team" ] }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "required": [ "project_id", "organization_id", "owner_user_id", "owner_email", "relationship", "sharing_state", "effective_role", "name", "slug", "environment_default", "organization_plan", "created_at", "updated_at" ], "additionalProperties": false } }, "required": [ "project" ], "additionalProperties": false }, "AvailabilityCheckListResponse": { "type": "object", "properties": { "checks": { "type": "array", "items": { "type": "object", "properties": { "check_id": { "type": "string", "format": "uuid" }, "project_id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "url": { "type": "string", "format": "uri" }, "method": { "type": "string", "enum": [ "GET", "HEAD" ] }, "expected_status_min": { "type": "integer", "minimum": 100, "maximum": 599 }, "expected_status_max": { "type": "integer", "minimum": 100, "maximum": 599 }, "timeout_ms": { "type": "integer", "minimum": 500, "maximum": 5000 }, "interval_seconds": { "type": "integer", "minimum": 30 }, "failure_threshold": { "type": "integer", "minimum": 1, "maximum": 10 }, "recovery_threshold": { "type": "integer", "minimum": 1, "maximum": 10 }, "environment": { "type": "string" }, "service_name": { "type": [ "string", "null" ] }, "enabled": { "type": "boolean" }, "status": { "type": "string", "enum": [ "unknown", "passing", "failing", "paused" ] }, "paused_reason": { "type": [ "string", "null" ] }, "organization_plan": { "type": "string", "enum": [ "free", "solo", "team" ] }, "consecutive_failures": { "type": "integer", "minimum": 0 }, "consecutive_successes": { "type": "integer", "minimum": 0 }, "linked_incident_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "linked_incident_status": { "anyOf": [ { "type": "string", "enum": [ "open", "resolved", "regressed" ] }, { "type": "null" } ] }, "last_checked_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] }, "next_check_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] }, "last_result_status": { "anyOf": [ { "type": "string", "enum": [ "success", "http_status_mismatch", "timeout", "dns_error", "tls_error", "connection_error", "redirect_blocked", "security_blocked", "internal_error" ] }, { "type": "null" } ] }, "last_result_http_status": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "last_result_error_kind": { "type": [ "string", "null" ] }, "last_result_error_message": { "type": [ "string", "null" ] }, "last_result_duration_ms": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } }, "required": [ "check_id", "project_id", "name", "url", "method", "expected_status_min", "expected_status_max", "timeout_ms", "interval_seconds", "failure_threshold", "recovery_threshold", "environment", "service_name", "enabled", "status", "paused_reason", "organization_plan", "consecutive_failures", "consecutive_successes", "linked_incident_id", "linked_incident_status", "last_checked_at", "next_check_at", "last_result_status", "last_result_http_status", "last_result_error_kind", "last_result_error_message", "last_result_duration_ms", "created_at", "updated_at" ], "additionalProperties": false } }, "limits": { "type": "object", "properties": { "max_checks_per_project": { "type": "integer", "minimum": 0 }, "min_interval_seconds": { "type": "integer", "exclusiveMinimum": true, "minimum": 0 } }, "required": [ "max_checks_per_project", "min_interval_seconds" ], "additionalProperties": false } }, "required": [ "checks", "limits" ], "additionalProperties": false }, "AvailabilityCheckCreateBody": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 120 }, "url": { "type": "string", "format": "uri" }, "method": { "type": "string", "enum": [ "GET", "HEAD" ], "default": "GET" }, "expected_status_min": { "type": "integer", "minimum": 100, "maximum": 599, "default": 200 }, "expected_status_max": { "type": "integer", "minimum": 100, "maximum": 599, "default": 399 }, "timeout_ms": { "type": "integer", "minimum": 500, "maximum": 5000, "default": 2500 }, "interval_seconds": { "type": "integer", "minimum": 30, "maximum": 86400 }, "failure_threshold": { "type": "integer", "minimum": 1, "maximum": 10, "default": 3 }, "recovery_threshold": { "type": "integer", "minimum": 1, "maximum": 10, "default": 2 }, "environment": { "type": "string", "minLength": 1, "maxLength": 50 }, "service_name": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 120 }, { "type": "null" } ] }, "enabled": { "type": "boolean", "default": true } }, "required": [ "name", "url", "interval_seconds" ], "additionalProperties": false }, "AvailabilityCheckMutationResponse": { "type": "object", "properties": { "check": { "type": "object", "properties": { "check_id": { "type": "string", "format": "uuid" }, "project_id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "url": { "type": "string", "format": "uri" }, "method": { "type": "string", "enum": [ "GET", "HEAD" ] }, "expected_status_min": { "type": "integer", "minimum": 100, "maximum": 599 }, "expected_status_max": { "type": "integer", "minimum": 100, "maximum": 599 }, "timeout_ms": { "type": "integer", "minimum": 500, "maximum": 5000 }, "interval_seconds": { "type": "integer", "minimum": 30 }, "failure_threshold": { "type": "integer", "minimum": 1, "maximum": 10 }, "recovery_threshold": { "type": "integer", "minimum": 1, "maximum": 10 }, "environment": { "type": "string" }, "service_name": { "type": [ "string", "null" ] }, "enabled": { "type": "boolean" }, "status": { "type": "string", "enum": [ "unknown", "passing", "failing", "paused" ] }, "paused_reason": { "type": [ "string", "null" ] }, "organization_plan": { "type": "string", "enum": [ "free", "solo", "team" ] }, "consecutive_failures": { "type": "integer", "minimum": 0 }, "consecutive_successes": { "type": "integer", "minimum": 0 }, "linked_incident_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "linked_incident_status": { "anyOf": [ { "type": "string", "enum": [ "open", "resolved", "regressed" ] }, { "type": "null" } ] }, "last_checked_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] }, "next_check_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] }, "last_result_status": { "anyOf": [ { "type": "string", "enum": [ "success", "http_status_mismatch", "timeout", "dns_error", "tls_error", "connection_error", "redirect_blocked", "security_blocked", "internal_error" ] }, { "type": "null" } ] }, "last_result_http_status": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "last_result_error_kind": { "type": [ "string", "null" ] }, "last_result_error_message": { "type": [ "string", "null" ] }, "last_result_duration_ms": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } }, "required": [ "check_id", "project_id", "name", "url", "method", "expected_status_min", "expected_status_max", "timeout_ms", "interval_seconds", "failure_threshold", "recovery_threshold", "environment", "service_name", "enabled", "status", "paused_reason", "organization_plan", "consecutive_failures", "consecutive_successes", "linked_incident_id", "linked_incident_status", "last_checked_at", "next_check_at", "last_result_status", "last_result_http_status", "last_result_error_kind", "last_result_error_message", "last_result_duration_ms", "created_at", "updated_at" ], "additionalProperties": false } }, "required": [ "check" ], "additionalProperties": false }, "AvailabilityCheckResponse": { "type": "object", "properties": { "check": { "type": "object", "properties": { "check_id": { "type": "string", "format": "uuid" }, "project_id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "url": { "type": "string", "format": "uri" }, "method": { "type": "string", "enum": [ "GET", "HEAD" ] }, "expected_status_min": { "type": "integer", "minimum": 100, "maximum": 599 }, "expected_status_max": { "type": "integer", "minimum": 100, "maximum": 599 }, "timeout_ms": { "type": "integer", "minimum": 500, "maximum": 5000 }, "interval_seconds": { "type": "integer", "minimum": 30 }, "failure_threshold": { "type": "integer", "minimum": 1, "maximum": 10 }, "recovery_threshold": { "type": "integer", "minimum": 1, "maximum": 10 }, "environment": { "type": "string" }, "service_name": { "type": [ "string", "null" ] }, "enabled": { "type": "boolean" }, "status": { "type": "string", "enum": [ "unknown", "passing", "failing", "paused" ] }, "paused_reason": { "type": [ "string", "null" ] }, "organization_plan": { "type": "string", "enum": [ "free", "solo", "team" ] }, "consecutive_failures": { "type": "integer", "minimum": 0 }, "consecutive_successes": { "type": "integer", "minimum": 0 }, "linked_incident_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "linked_incident_status": { "anyOf": [ { "type": "string", "enum": [ "open", "resolved", "regressed" ] }, { "type": "null" } ] }, "last_checked_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] }, "next_check_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] }, "last_result_status": { "anyOf": [ { "type": "string", "enum": [ "success", "http_status_mismatch", "timeout", "dns_error", "tls_error", "connection_error", "redirect_blocked", "security_blocked", "internal_error" ] }, { "type": "null" } ] }, "last_result_http_status": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "last_result_error_kind": { "type": [ "string", "null" ] }, "last_result_error_message": { "type": [ "string", "null" ] }, "last_result_duration_ms": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } }, "required": [ "check_id", "project_id", "name", "url", "method", "expected_status_min", "expected_status_max", "timeout_ms", "interval_seconds", "failure_threshold", "recovery_threshold", "environment", "service_name", "enabled", "status", "paused_reason", "organization_plan", "consecutive_failures", "consecutive_successes", "linked_incident_id", "linked_incident_status", "last_checked_at", "next_check_at", "last_result_status", "last_result_http_status", "last_result_error_kind", "last_result_error_message", "last_result_duration_ms", "created_at", "updated_at" ], "additionalProperties": false }, "limits": { "type": "object", "properties": { "max_checks_per_project": { "type": "integer", "minimum": 0 }, "min_interval_seconds": { "type": "integer", "exclusiveMinimum": true, "minimum": 0 } }, "required": [ "max_checks_per_project", "min_interval_seconds" ], "additionalProperties": false } }, "required": [ "check", "limits" ], "additionalProperties": false }, "AvailabilityCheckUpdateBody": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 120 }, "url": { "type": "string", "format": "uri" }, "method": { "type": "string", "enum": [ "GET", "HEAD" ], "default": "GET" }, "expected_status_min": { "type": "integer", "minimum": 100, "maximum": 599, "default": 200 }, "expected_status_max": { "type": "integer", "minimum": 100, "maximum": 599, "default": 399 }, "timeout_ms": { "type": "integer", "minimum": 500, "maximum": 5000, "default": 2500 }, "interval_seconds": { "type": "integer", "minimum": 30, "maximum": 86400 }, "failure_threshold": { "type": "integer", "minimum": 1, "maximum": 10, "default": 3 }, "recovery_threshold": { "type": "integer", "minimum": 1, "maximum": 10, "default": 2 }, "environment": { "type": "string", "minLength": 1, "maxLength": 50 }, "service_name": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 120 }, { "type": "null" } ] }, "enabled": { "type": "boolean", "default": true } }, "additionalProperties": false }, "AvailabilityCheckDeleteResponse": { "type": "object", "properties": { "deleted": { "type": "boolean", "const": true } }, "required": [ "deleted" ], "additionalProperties": false }, "AvailabilityCheckResultsResponse": { "type": "object", "properties": { "results": { "type": "array", "items": { "type": "object", "properties": { "result_id": { "type": "string", "format": "uuid" }, "check_id": { "type": "string", "format": "uuid" }, "project_id": { "type": "string", "format": "uuid" }, "started_at": { "type": "string", "format": "date-time" }, "completed_at": { "type": "string", "format": "date-time" }, "duration_ms": { "type": "integer", "minimum": 0 }, "status": { "type": "string", "enum": [ "success", "http_status_mismatch", "timeout", "dns_error", "tls_error", "connection_error", "redirect_blocked", "security_blocked", "internal_error" ] }, "http_status": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "error_kind": { "type": [ "string", "null" ] }, "error_message": { "type": [ "string", "null" ] }, "redirect_count": { "type": "integer", "minimum": 0 }, "checked_url_host": { "type": "string" }, "final_url": { "type": "string", "format": "uri" } }, "required": [ "result_id", "check_id", "project_id", "started_at", "completed_at", "duration_ms", "status", "http_status", "error_kind", "error_message", "redirect_count", "checked_url_host", "final_url" ], "additionalProperties": false } } }, "required": [ "results" ], "additionalProperties": false }, "AvailabilityCheckDailyRollupsResponse": { "type": "object", "properties": { "rollups": { "type": "array", "items": { "type": "object", "properties": { "check_id": { "type": "string", "format": "uuid" }, "project_id": { "type": "string", "format": "uuid" }, "day": { "type": "string" }, "state": { "type": "string", "enum": [ "unknown", "operational", "degraded", "down", "paused" ] }, "total_checks": { "type": "integer", "minimum": 0 }, "successful_checks": { "type": "integer", "minimum": 0 }, "failed_checks": { "type": "integer", "minimum": 0 }, "degraded_checks": { "type": "integer", "minimum": 0 }, "avg_duration_ms": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "first_checked_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] }, "last_checked_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] }, "downtime_seconds": { "type": "integer", "minimum": 0 }, "incident_ids": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, "required": [ "check_id", "project_id", "day", "state", "total_checks", "successful_checks", "failed_checks", "degraded_checks", "avg_duration_ms", "first_checked_at", "last_checked_at", "downtime_seconds", "incident_ids" ], "additionalProperties": false } } }, "required": [ "rollups" ], "additionalProperties": false }, "AvailabilityCheckTestBody": { "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "method": { "type": "string", "enum": [ "GET", "HEAD" ], "default": "GET" }, "expected_status_min": { "type": "integer", "minimum": 100, "maximum": 599, "default": 200 }, "expected_status_max": { "type": "integer", "minimum": 100, "maximum": 599, "default": 399 }, "timeout_ms": { "type": "integer", "minimum": 500, "maximum": 5000, "default": 2500 } }, "required": [ "url" ], "additionalProperties": false }, "AvailabilityCheckTestResponse": { "type": "object", "properties": { "normalized_url": { "type": "string", "format": "uri" }, "result": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "success", "http_status_mismatch", "timeout", "dns_error", "tls_error", "connection_error", "redirect_blocked", "security_blocked", "internal_error" ] }, "http_status": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "duration_ms": { "type": "integer", "minimum": 0 }, "error_kind": { "type": [ "string", "null" ] }, "error_message": { "type": [ "string", "null" ] }, "checked_url_host": { "type": "string" }, "checked_url_path": { "type": "string" }, "checked_url_query": { "type": "object", "additionalProperties": { "type": "string" } }, "final_url": { "type": "string", "format": "uri" }, "redirect_count": { "type": "integer", "minimum": 0 } }, "required": [ "status", "http_status", "duration_ms", "error_kind", "error_message", "checked_url_host", "checked_url_path", "checked_url_query", "final_url", "redirect_count" ], "additionalProperties": false } }, "required": [ "normalized_url", "result" ], "additionalProperties": false }, "SlackInstallUrlResponse": { "type": "object", "properties": { "install_url": { "type": "string", "format": "uri" } }, "required": [ "install_url" ], "additionalProperties": false }, "SlackDestinationListResponse": { "type": "object", "properties": { "destinations": { "type": "array", "items": { "type": "object", "properties": { "slack_destination_id": { "type": "string", "format": "uuid" }, "organization_id": { "type": "string", "format": "uuid" }, "slack_team_id": { "type": "string", "minLength": 1 }, "slack_team_name": { "type": [ "string", "null" ] }, "slack_channel_id": { "type": "string", "minLength": 1 }, "slack_channel_name": { "type": [ "string", "null" ] }, "installed_by_member_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "is_active": { "type": "boolean" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } }, "required": [ "slack_destination_id", "organization_id", "slack_team_id", "slack_team_name", "slack_channel_id", "slack_channel_name", "installed_by_member_id", "is_active", "created_at", "updated_at" ], "additionalProperties": false } } }, "required": [ "destinations" ], "additionalProperties": false }, "SlackDestinationTestResponse": { "type": "object", "properties": { "delivered": { "type": "boolean", "const": true } }, "required": [ "delivered" ], "additionalProperties": false }, "BillingSummaryResponse": { "type": "object", "properties": { "billing": { "type": "object", "properties": { "plan": { "type": "string", "enum": [ "free", "solo", "team" ] }, "billing_state": { "anyOf": [ { "type": "string", "enum": [ "active", "past_due", "canceled", "unpaid", "incomplete", "admin_override", "trialing", "trial_expired" ] }, { "type": "null" } ] }, "stripe_customer_id": { "type": [ "string", "null" ] }, "active_projects": { "type": "integer", "minimum": 0 }, "capacity_units": { "type": "object", "properties": { "total": { "type": "integer", "minimum": 0 }, "included": { "type": "integer", "minimum": 0 }, "additional_purchased": { "type": "integer", "minimum": 0 }, "pending_reduction": { "anyOf": [ { "type": "object", "properties": { "additional_purchased": { "type": "integer", "minimum": 0 }, "total": { "type": "integer", "minimum": 0 }, "effective_at": { "type": "string" } }, "required": [ "additional_purchased", "total", "effective_at" ], "additionalProperties": false }, { "type": "null" } ] } }, "required": [ "total", "included", "additional_purchased", "pending_reduction" ], "additionalProperties": false }, "usage_window": { "type": "object", "properties": { "starts_at": { "type": "string" }, "ends_at": { "type": "string" } }, "required": [ "starts_at", "ends_at" ], "additionalProperties": false }, "allowances": { "type": "object", "properties": { "monthly_bundle_requests": { "type": "object", "properties": { "used": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 0 } }, "required": [ "used", "limit" ], "additionalProperties": false }, "monthly_raw_ingested_events": { "type": "object", "properties": { "used": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 0 } }, "required": [ "used", "limit" ], "additionalProperties": false }, "retained_bundle_cap": { "type": "object", "properties": { "used": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 0 } }, "required": [ "used", "limit" ], "additionalProperties": false }, "monthly_remote_activations": { "type": "object", "properties": { "used": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 0 } }, "required": [ "used", "limit" ], "additionalProperties": false }, "monthly_alert_deliveries": { "type": "object", "properties": { "used": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 0 } }, "required": [ "used", "limit" ], "additionalProperties": false }, "monthly_webhook_deliveries": { "type": "object", "properties": { "used": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 0 } }, "required": [ "used", "limit" ], "additionalProperties": false } }, "required": [ "monthly_bundle_requests", "monthly_raw_ingested_events", "retained_bundle_cap", "monthly_remote_activations", "monthly_alert_deliveries", "monthly_webhook_deliveries" ], "additionalProperties": false }, "trial": { "type": "object", "properties": { "available": { "type": "boolean" }, "active": { "type": "boolean" }, "plan": { "anyOf": [ { "type": "string", "enum": [ "solo", "team" ] }, { "type": "null" } ] }, "started_at": { "type": [ "string", "null" ] }, "ends_at": { "type": [ "string", "null" ] }, "used_at": { "type": [ "string", "null" ] }, "converted_at": { "type": [ "string", "null" ] }, "expired_at": { "type": [ "string", "null" ] }, "days_remaining": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] } }, "required": [ "available", "active", "plan", "started_at", "ends_at", "used_at", "converted_at", "expired_at", "days_remaining" ], "additionalProperties": false } }, "required": [ "plan", "billing_state", "stripe_customer_id", "active_projects", "capacity_units", "usage_window", "allowances", "trial" ], "additionalProperties": false } }, "required": [ "billing" ], "additionalProperties": false }, "BillingCheckoutBody": { "type": "object", "properties": { "target_plan": { "type": "string", "enum": [ "solo", "team" ] } }, "required": [ "target_plan" ], "additionalProperties": false }, "BillingLinkResponse": { "type": "object", "properties": { "url": { "type": "string", "format": "uri" } }, "required": [ "url" ], "additionalProperties": false }, "BillingCheckoutConfirmBody": { "type": "object", "properties": { "session_id": { "type": "string", "minLength": 1, "maxLength": 255 } }, "required": [ "session_id" ], "additionalProperties": false }, "BillingCapacityBody": { "type": "object", "properties": { "target_additional_capacity_units": { "type": "integer", "minimum": 0, "maximum": 99 } }, "required": [ "target_additional_capacity_units" ], "additionalProperties": false }, "TokenListResponse": { "type": "object", "properties": { "tokens": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "token_id": { "type": "string" }, "project_id": { "type": "string" }, "label": { "type": "string" }, "allowed_origins": { "type": "array", "items": { "type": "string" }, "default": [] }, "created_at": { "type": "string" }, "last_used_at": { "type": [ "string", "null" ] }, "revoked_at": { "type": [ "string", "null" ] }, "expires_at": { "type": [ "string", "null" ] }, "plaintext": { "type": "string" } }, "required": [ "token_id", "project_id", "label", "created_at", "last_used_at", "revoked_at", "expires_at" ], "additionalProperties": false }, { "type": "object", "properties": { "token_id": { "type": "string" }, "user_id": { "type": "string" }, "organization_id": { "type": "string" }, "label": { "type": "string" }, "created_at": { "type": "string" }, "last_used_at": { "type": [ "string", "null" ] }, "revoked_at": { "type": [ "string", "null" ] }, "expires_at": { "type": [ "string", "null" ] }, "plaintext": { "type": "string" } }, "required": [ "token_id", "user_id", "organization_id", "label", "created_at", "last_used_at", "revoked_at", "expires_at" ], "additionalProperties": false } ] } } }, "required": [ "tokens" ], "additionalProperties": false }, "CreateProjectTokenBody": { "type": "object", "properties": { "label": { "type": "string", "minLength": 1, "maxLength": 120 }, "allowed_origins": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 2048 }, "maxItems": 20 } }, "required": [ "label" ], "additionalProperties": false }, "CreateTokenBody": { "type": "object", "properties": { "label": { "type": "string", "minLength": 1, "maxLength": 120 } }, "required": [ "label" ], "additionalProperties": false }, "AlertListResponse": { "type": "object", "properties": { "alerts": { "type": "array", "items": { "type": "object", "properties": { "alert_id": { "type": "string" }, "project_id": { "type": "string" }, "created_by_user_id": { "type": "string" }, "service_id": { "type": [ "string", "null" ] }, "channel": { "type": "string", "enum": [ "email", "slack", "discord", "webhook" ] }, "condition_type": { "type": "string", "enum": [ "new_incident", "incident_regressed", "error_spike", "severity_threshold", "regression_after_deploy" ] }, "severity_min": { "anyOf": [ { "type": "string", "enum": [ "low", "medium", "high", "critical" ] }, { "type": "null" } ] }, "severity_lifecycle_scope": { "anyOf": [ { "type": "string", "enum": [ "new_incident", "incident_regressed", "both" ] }, { "type": "null" } ], "default": null }, "cooldown_seconds": { "type": "integer", "minimum": 0 }, "config": { "type": "object", "additionalProperties": {} }, "is_enabled": { "type": "boolean" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "required": [ "alert_id", "project_id", "created_by_user_id", "service_id", "channel", "condition_type", "severity_min", "cooldown_seconds", "config", "is_enabled", "created_at", "updated_at" ], "additionalProperties": false } } }, "required": [ "alerts" ], "additionalProperties": false }, "CreateAlertBody": { "anyOf": [ { "type": "object", "properties": { "project_id": { "type": "string", "format": "uuid" }, "service_id": { "type": "string", "format": "uuid" }, "condition_type": { "type": "string", "enum": [ "new_incident", "incident_regressed", "error_spike", "severity_threshold", "regression_after_deploy" ] }, "severity_min": { "type": "string", "enum": [ "low", "medium", "high", "critical" ] }, "severity_lifecycle_scope": { "type": "string", "enum": [ "new_incident", "incident_regressed", "both" ] }, "cooldown_seconds": { "type": "integer", "minimum": 0, "maximum": 604800, "default": 0 }, "is_enabled": { "type": "boolean", "default": true }, "channel": { "type": "string", "const": "email" }, "config": { "type": "object", "properties": { "to": { "type": "string", "format": "email" } }, "required": [ "to" ], "additionalProperties": false } }, "required": [ "project_id", "condition_type", "channel", "config" ], "additionalProperties": false }, { "type": "object", "properties": { "project_id": { "type": "string", "format": "uuid" }, "service_id": { "type": "string", "format": "uuid" }, "condition_type": { "type": "string", "enum": [ "new_incident", "incident_regressed", "error_spike", "severity_threshold", "regression_after_deploy" ] }, "severity_min": { "type": "string", "enum": [ "low", "medium", "high", "critical" ] }, "severity_lifecycle_scope": { "type": "string", "enum": [ "new_incident", "incident_regressed", "both" ] }, "cooldown_seconds": { "type": "integer", "minimum": 0, "maximum": 604800, "default": 0 }, "is_enabled": { "type": "boolean", "default": true }, "channel": { "type": "string", "const": "slack" }, "config": { "anyOf": [ { "type": "object", "properties": { "webhook_url": { "type": "string", "format": "uri", "maxLength": 2000 } }, "required": [ "webhook_url" ], "additionalProperties": false }, { "type": "object", "properties": { "slack_destination_id": { "type": "string", "format": "uuid" } }, "required": [ "slack_destination_id" ], "additionalProperties": false } ] } }, "required": [ "project_id", "condition_type", "channel", "config" ], "additionalProperties": false }, { "type": "object", "properties": { "project_id": { "type": "string", "format": "uuid" }, "service_id": { "type": "string", "format": "uuid" }, "condition_type": { "type": "string", "enum": [ "new_incident", "incident_regressed", "error_spike", "severity_threshold", "regression_after_deploy" ] }, "severity_min": { "type": "string", "enum": [ "low", "medium", "high", "critical" ] }, "severity_lifecycle_scope": { "type": "string", "enum": [ "new_incident", "incident_regressed", "both" ] }, "cooldown_seconds": { "type": "integer", "minimum": 0, "maximum": 604800, "default": 0 }, "is_enabled": { "type": "boolean", "default": true }, "channel": { "type": "string", "const": "discord" }, "config": { "type": "object", "properties": { "webhook_url": { "type": "string", "format": "uri", "maxLength": 2000 } }, "required": [ "webhook_url" ], "additionalProperties": false } }, "required": [ "project_id", "condition_type", "channel", "config" ], "additionalProperties": false }, { "type": "object", "properties": { "project_id": { "type": "string", "format": "uuid" }, "service_id": { "type": "string", "format": "uuid" }, "condition_type": { "type": "string", "enum": [ "new_incident", "incident_regressed", "error_spike", "severity_threshold", "regression_after_deploy" ] }, "severity_min": { "type": "string", "enum": [ "low", "medium", "high", "critical" ] }, "severity_lifecycle_scope": { "type": "string", "enum": [ "new_incident", "incident_regressed", "both" ] }, "cooldown_seconds": { "type": "integer", "minimum": 0, "maximum": 604800, "default": 0 }, "is_enabled": { "type": "boolean", "default": true }, "channel": { "type": "string", "const": "webhook" }, "config": { "type": "object", "properties": { "target_url": { "type": "string", "format": "uri", "maxLength": 2000 } }, "required": [ "target_url" ], "additionalProperties": false } }, "required": [ "project_id", "condition_type", "channel", "config" ], "additionalProperties": false } ] }, "AlertResponse": { "type": "object", "properties": { "alert": { "type": "object", "properties": { "alert_id": { "type": "string" }, "project_id": { "type": "string" }, "created_by_user_id": { "type": "string" }, "service_id": { "type": [ "string", "null" ] }, "channel": { "type": "string", "enum": [ "email", "slack", "discord", "webhook" ] }, "condition_type": { "type": "string", "enum": [ "new_incident", "incident_regressed", "error_spike", "severity_threshold", "regression_after_deploy" ] }, "severity_min": { "anyOf": [ { "type": "string", "enum": [ "low", "medium", "high", "critical" ] }, { "type": "null" } ] }, "severity_lifecycle_scope": { "anyOf": [ { "type": "string", "enum": [ "new_incident", "incident_regressed", "both" ] }, { "type": "null" } ], "default": null }, "cooldown_seconds": { "type": "integer", "minimum": 0 }, "config": { "type": "object", "additionalProperties": {} }, "is_enabled": { "type": "boolean" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "required": [ "alert_id", "project_id", "created_by_user_id", "service_id", "channel", "condition_type", "severity_min", "cooldown_seconds", "config", "is_enabled", "created_at", "updated_at" ], "additionalProperties": false } }, "required": [ "alert" ], "additionalProperties": false }, "UpdateAlertBody": { "anyOf": [ { "type": "object", "properties": { "service_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "condition_type": { "type": "string", "enum": [ "new_incident", "incident_regressed", "error_spike", "severity_threshold", "regression_after_deploy" ] }, "severity_min": { "anyOf": [ { "type": "string", "enum": [ "low", "medium", "high", "critical" ] }, { "type": "null" } ] }, "severity_lifecycle_scope": { "anyOf": [ { "type": "string", "enum": [ "new_incident", "incident_regressed", "both" ] }, { "type": "null" } ] }, "cooldown_seconds": { "type": "integer", "minimum": 0, "maximum": 604800 }, "is_enabled": { "type": "boolean" }, "channel": { "type": "string", "const": "email" }, "config": { "anyOf": [ { "type": "object", "properties": { "to": { "type": "string", "format": "email" } }, "required": [ "to" ], "additionalProperties": false }, { "type": "null" } ] } }, "required": [ "channel" ], "additionalProperties": false }, { "type": "object", "properties": { "service_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "condition_type": { "type": "string", "enum": [ "new_incident", "incident_regressed", "error_spike", "severity_threshold", "regression_after_deploy" ] }, "severity_min": { "anyOf": [ { "type": "string", "enum": [ "low", "medium", "high", "critical" ] }, { "type": "null" } ] }, "severity_lifecycle_scope": { "anyOf": [ { "type": "string", "enum": [ "new_incident", "incident_regressed", "both" ] }, { "type": "null" } ] }, "cooldown_seconds": { "type": "integer", "minimum": 0, "maximum": 604800 }, "is_enabled": { "type": "boolean" }, "channel": { "type": "string", "const": "slack" }, "config": { "anyOf": [ { "anyOf": [ { "type": "object", "properties": { "webhook_url": { "type": "string", "format": "uri", "maxLength": 2000 } }, "required": [ "webhook_url" ], "additionalProperties": false }, { "type": "object", "properties": { "slack_destination_id": { "type": "string", "format": "uuid" } }, "required": [ "slack_destination_id" ], "additionalProperties": false } ] }, { "type": "null" } ] } }, "required": [ "channel" ], "additionalProperties": false }, { "type": "object", "properties": { "service_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "condition_type": { "type": "string", "enum": [ "new_incident", "incident_regressed", "error_spike", "severity_threshold", "regression_after_deploy" ] }, "severity_min": { "anyOf": [ { "type": "string", "enum": [ "low", "medium", "high", "critical" ] }, { "type": "null" } ] }, "severity_lifecycle_scope": { "anyOf": [ { "type": "string", "enum": [ "new_incident", "incident_regressed", "both" ] }, { "type": "null" } ] }, "cooldown_seconds": { "type": "integer", "minimum": 0, "maximum": 604800 }, "is_enabled": { "type": "boolean" }, "channel": { "type": "string", "const": "discord" }, "config": { "anyOf": [ { "type": "object", "properties": { "webhook_url": { "type": "string", "format": "uri", "maxLength": 2000 } }, "required": [ "webhook_url" ], "additionalProperties": false }, { "type": "null" } ] } }, "required": [ "channel" ], "additionalProperties": false }, { "type": "object", "properties": { "service_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "condition_type": { "type": "string", "enum": [ "new_incident", "incident_regressed", "error_spike", "severity_threshold", "regression_after_deploy" ] }, "severity_min": { "anyOf": [ { "type": "string", "enum": [ "low", "medium", "high", "critical" ] }, { "type": "null" } ] }, "severity_lifecycle_scope": { "anyOf": [ { "type": "string", "enum": [ "new_incident", "incident_regressed", "both" ] }, { "type": "null" } ] }, "cooldown_seconds": { "type": "integer", "minimum": 0, "maximum": 604800 }, "is_enabled": { "type": "boolean" }, "channel": { "type": "string", "const": "webhook" }, "config": { "anyOf": [ { "type": "object", "properties": { "target_url": { "type": "string", "format": "uri", "maxLength": 2000 } }, "required": [ "target_url" ], "additionalProperties": false }, { "type": "null" } ] } }, "required": [ "channel" ], "additionalProperties": false }, { "type": "object", "properties": { "service_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "condition_type": { "type": "string", "enum": [ "new_incident", "incident_regressed", "error_spike", "severity_threshold", "regression_after_deploy" ] }, "severity_min": { "anyOf": [ { "type": "string", "enum": [ "low", "medium", "high", "critical" ] }, { "type": "null" } ] }, "severity_lifecycle_scope": { "anyOf": [ { "type": "string", "enum": [ "new_incident", "incident_regressed", "both" ] }, { "type": "null" } ] }, "cooldown_seconds": { "type": "integer", "minimum": 0, "maximum": 604800 }, "is_enabled": { "type": "boolean" }, "channel": { "type": "string", "enum": [ "email", "slack", "discord", "webhook" ] } }, "additionalProperties": false } ] }, "WeeklyReportChannelListResponse": { "type": "object", "properties": { "channels": { "type": "array", "items": { "type": "object", "properties": { "channel_id": { "type": "string" }, "project_id": { "type": "string" }, "channel": { "type": "string", "enum": [ "email", "slack" ] }, "config": { "type": "object", "additionalProperties": {} }, "schedule": { "type": "object", "properties": { "day_of_week": { "type": "string", "enum": [ "monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday" ] }, "hour_of_day": { "type": "integer", "minimum": 0, "maximum": 23 }, "timezone": { "type": "string", "minLength": 1 } }, "required": [ "day_of_week", "hour_of_day", "timezone" ], "additionalProperties": false }, "is_enabled": { "type": "boolean" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "required": [ "channel_id", "project_id", "channel", "config", "schedule", "is_enabled", "created_at", "updated_at" ], "additionalProperties": false } } }, "required": [ "channels" ], "additionalProperties": false }, "CreateWeeklyReportChannelBody": { "anyOf": [ { "type": "object", "properties": { "project_id": { "type": "string", "format": "uuid" }, "channel": { "type": "string", "const": "email" }, "config": { "type": "object", "properties": { "to": { "type": "array", "items": { "type": "string", "format": "email" }, "minItems": 1, "maxItems": 3 } }, "required": [ "to" ], "additionalProperties": false }, "schedule": { "type": "object", "properties": { "day_of_week": { "type": "string", "enum": [ "monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday" ] }, "hour_of_day": { "type": "integer", "minimum": 0, "maximum": 23 }, "timezone": { "type": "string", "minLength": 1 } }, "required": [ "day_of_week", "hour_of_day", "timezone" ], "additionalProperties": false }, "is_enabled": { "type": "boolean", "default": true } }, "required": [ "project_id", "channel", "config", "schedule" ], "additionalProperties": false }, { "type": "object", "properties": { "project_id": { "type": "string", "format": "uuid" }, "channel": { "type": "string", "const": "slack" }, "config": { "anyOf": [ { "type": "object", "properties": { "webhook_url": { "type": "string", "format": "uri", "maxLength": 2000 } }, "required": [ "webhook_url" ], "additionalProperties": false }, { "type": "object", "properties": { "slack_destination_id": { "type": "string", "format": "uuid" } }, "required": [ "slack_destination_id" ], "additionalProperties": false } ] }, "schedule": { "type": "object", "properties": { "day_of_week": { "type": "string", "enum": [ "monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday" ] }, "hour_of_day": { "type": "integer", "minimum": 0, "maximum": 23 }, "timezone": { "type": "string", "minLength": 1 } }, "required": [ "day_of_week", "hour_of_day", "timezone" ], "additionalProperties": false }, "is_enabled": { "type": "boolean", "default": true } }, "required": [ "project_id", "channel", "config", "schedule" ], "additionalProperties": false } ] }, "WeeklyReportChannelResponse": { "type": "object", "properties": { "channel": { "type": "object", "properties": { "channel_id": { "type": "string" }, "project_id": { "type": "string" }, "channel": { "type": "string", "enum": [ "email", "slack" ] }, "config": { "type": "object", "additionalProperties": {} }, "schedule": { "type": "object", "properties": { "day_of_week": { "type": "string", "enum": [ "monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday" ] }, "hour_of_day": { "type": "integer", "minimum": 0, "maximum": 23 }, "timezone": { "type": "string", "minLength": 1 } }, "required": [ "day_of_week", "hour_of_day", "timezone" ], "additionalProperties": false }, "is_enabled": { "type": "boolean" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "required": [ "channel_id", "project_id", "channel", "config", "schedule", "is_enabled", "created_at", "updated_at" ], "additionalProperties": false } }, "required": [ "channel" ], "additionalProperties": false }, "UpdateWeeklyReportChannelBody": { "type": "object", "properties": { "config": { "anyOf": [ { "type": "object", "properties": { "to": { "type": "array", "items": { "type": "string", "format": "email" }, "minItems": 1, "maxItems": 3 } }, "required": [ "to" ], "additionalProperties": false }, { "anyOf": [ { "type": "object", "properties": { "webhook_url": { "type": "string", "format": "uri", "maxLength": 2000 } }, "required": [ "webhook_url" ], "additionalProperties": false }, { "type": "object", "properties": { "slack_destination_id": { "type": "string", "format": "uuid" } }, "required": [ "slack_destination_id" ], "additionalProperties": false } ] } ] }, "schedule": { "type": "object", "properties": { "day_of_week": { "type": "string", "enum": [ "monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday" ] }, "hour_of_day": { "type": "integer", "minimum": 0, "maximum": 23 }, "timezone": { "type": "string", "minLength": 1 } }, "required": [ "day_of_week", "hour_of_day", "timezone" ], "additionalProperties": false }, "is_enabled": { "type": "boolean" } }, "additionalProperties": false }, "WebhookListResponse": { "type": "object", "properties": { "webhooks": { "type": "array", "items": { "type": "object", "properties": { "webhook_id": { "type": "string" }, "project_id": { "type": "string" }, "created_by_user_id": { "type": "string" }, "url": { "type": "string" }, "events": { "type": "array", "items": { "type": "string", "enum": [ "bundle.created", "bundle.updated", "bundle.reopened", "bundle.resolved", "verification.passed", "verification.failed", "improvement_bundle.created", "incident.spike_detected" ] } }, "filters": { "type": "object", "properties": { "environment": { "type": "array", "items": { "type": "string" } }, "service": { "type": "array", "items": { "type": "string" } }, "severity_min": { "type": "string", "enum": [ "low", "medium", "high", "critical" ] }, "bundle_type": { "type": "array", "items": { "type": "string", "enum": [ "failure", "improvement" ] } }, "verification": { "type": "boolean" } }, "additionalProperties": false }, "is_enabled": { "type": "boolean" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "required": [ "webhook_id", "project_id", "created_by_user_id", "url", "events", "filters", "is_enabled", "created_at", "updated_at" ], "additionalProperties": false } } }, "required": [ "webhooks" ], "additionalProperties": false }, "CreateWebhookBody": { "type": "object", "properties": { "project_id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri", "maxLength": 2000 }, "events": { "type": "array", "items": { "type": "string", "enum": [ "bundle.created", "bundle.updated", "bundle.reopened", "bundle.resolved", "verification.passed", "verification.failed", "improvement_bundle.created", "incident.spike_detected" ] }, "minItems": 1 }, "filters": { "type": "object", "properties": { "environment": { "type": "array", "items": { "type": "string", "minLength": 1 } }, "service": { "type": "array", "items": { "type": "string", "minLength": 1 } }, "severity_min": { "type": "string", "enum": [ "low", "medium", "high", "critical" ] }, "bundle_type": { "type": "array", "items": { "type": "string", "enum": [ "failure", "improvement" ] } }, "verification": { "type": "boolean" } }, "additionalProperties": false, "default": {} }, "is_enabled": { "type": "boolean", "default": true } }, "required": [ "project_id", "url", "events" ], "additionalProperties": false }, "WebhookCreateResponse": { "type": "object", "properties": { "webhook": { "type": "object", "properties": { "webhook_id": { "type": "string" }, "project_id": { "type": "string" }, "created_by_user_id": { "type": "string" }, "url": { "type": "string" }, "events": { "type": "array", "items": { "type": "string", "enum": [ "bundle.created", "bundle.updated", "bundle.reopened", "bundle.resolved", "verification.passed", "verification.failed", "improvement_bundle.created", "incident.spike_detected" ] } }, "filters": { "type": "object", "properties": { "environment": { "type": "array", "items": { "type": "string" } }, "service": { "type": "array", "items": { "type": "string" } }, "severity_min": { "type": "string", "enum": [ "low", "medium", "high", "critical" ] }, "bundle_type": { "type": "array", "items": { "type": "string", "enum": [ "failure", "improvement" ] } }, "verification": { "type": "boolean" } }, "additionalProperties": false }, "is_enabled": { "type": "boolean" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "signing_secret": { "type": "string" } }, "required": [ "webhook_id", "project_id", "created_by_user_id", "url", "events", "filters", "is_enabled", "created_at", "updated_at", "signing_secret" ], "additionalProperties": false } }, "required": [ "webhook" ], "additionalProperties": false }, "WebhookResponse": { "type": "object", "properties": { "webhook": { "type": "object", "properties": { "webhook_id": { "type": "string" }, "project_id": { "type": "string" }, "created_by_user_id": { "type": "string" }, "url": { "type": "string" }, "events": { "type": "array", "items": { "type": "string", "enum": [ "bundle.created", "bundle.updated", "bundle.reopened", "bundle.resolved", "verification.passed", "verification.failed", "improvement_bundle.created", "incident.spike_detected" ] } }, "filters": { "type": "object", "properties": { "environment": { "type": "array", "items": { "type": "string" } }, "service": { "type": "array", "items": { "type": "string" } }, "severity_min": { "type": "string", "enum": [ "low", "medium", "high", "critical" ] }, "bundle_type": { "type": "array", "items": { "type": "string", "enum": [ "failure", "improvement" ] } }, "verification": { "type": "boolean" } }, "additionalProperties": false }, "is_enabled": { "type": "boolean" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "required": [ "webhook_id", "project_id", "created_by_user_id", "url", "events", "filters", "is_enabled", "created_at", "updated_at" ], "additionalProperties": false } }, "required": [ "webhook" ], "additionalProperties": false }, "UpdateWebhookBody": { "type": "object", "properties": { "url": { "type": "string", "format": "uri", "maxLength": 2000 }, "events": { "type": "array", "items": { "type": "string", "enum": [ "bundle.created", "bundle.updated", "bundle.reopened", "bundle.resolved", "verification.passed", "verification.failed", "improvement_bundle.created", "incident.spike_detected" ] }, "minItems": 1 }, "filters": { "type": "object", "properties": { "environment": { "type": "array", "items": { "type": "string", "minLength": 1 } }, "service": { "type": "array", "items": { "type": "string", "minLength": 1 } }, "severity_min": { "type": "string", "enum": [ "low", "medium", "high", "critical" ] }, "bundle_type": { "type": "array", "items": { "type": "string", "enum": [ "failure", "improvement" ] } }, "verification": { "type": "boolean" } }, "additionalProperties": false }, "is_enabled": { "type": "boolean" } }, "additionalProperties": false }, "WebhookTestBody": { "type": "object", "properties": { "event_type": { "type": "string", "enum": [ "bundle.created", "bundle.updated", "bundle.reopened", "bundle.resolved", "verification.passed", "verification.failed", "improvement_bundle.created", "incident.spike_detected" ], "default": "verification.passed" } }, "additionalProperties": false }, "WebhookTestResponse": { "type": "object", "properties": { "delivery": { "type": "object", "properties": { "delivery_id": { "type": "string" }, "event_type": { "type": "string", "enum": [ "bundle.created", "bundle.updated", "bundle.reopened", "bundle.resolved", "verification.passed", "verification.failed", "improvement_bundle.created", "incident.spike_detected" ] }, "status": { "type": "string", "enum": [ "pending", "retrying", "delivered", "failed", "disabled" ] }, "attempt_count": { "type": "number" }, "next_attempt_at": { "type": [ "string", "null" ] }, "last_response_code": { "type": [ "number", "null" ] }, "last_attempted_at": { "type": [ "string", "null" ] }, "last_error": { "type": [ "string", "null" ] } }, "required": [ "delivery_id", "event_type", "status", "attempt_count", "next_attempt_at", "last_response_code", "last_attempted_at", "last_error" ], "additionalProperties": false } }, "required": [ "delivery" ], "additionalProperties": false }, "WebhookDeliveriesResponse": { "type": "object", "properties": { "deliveries": { "type": "array", "items": { "type": "object", "properties": { "delivery_id": { "type": "string" }, "event_type": { "type": "string", "enum": [ "bundle.created", "bundle.updated", "bundle.reopened", "bundle.resolved", "verification.passed", "verification.failed", "improvement_bundle.created", "incident.spike_detected" ] }, "status": { "type": "string", "enum": [ "pending", "retrying", "delivered", "failed", "disabled" ] }, "attempt_count": { "type": "number" }, "next_attempt_at": { "type": [ "string", "null" ] }, "last_response_code": { "type": [ "number", "null" ] }, "last_attempted_at": { "type": [ "string", "null" ] }, "last_error": { "type": [ "string", "null" ] } }, "required": [ "delivery_id", "event_type", "status", "attempt_count", "next_attempt_at", "last_response_code", "last_attempted_at", "last_error" ], "additionalProperties": false } } }, "required": [ "deliveries" ], "additionalProperties": false }, "WebhookRetryResponse": { "type": "object", "properties": { "delivery_id": { "type": "string" }, "event_type": { "type": "string", "enum": [ "bundle.created", "bundle.updated", "bundle.reopened", "bundle.resolved", "verification.passed", "verification.failed", "improvement_bundle.created", "incident.spike_detected" ] } }, "required": [ "delivery_id", "event_type" ], "additionalProperties": false }, "ProbeActivateBody": { "type": "object", "properties": { "label_pattern": { "type": "string", "minLength": 1, "maxLength": 200 }, "service": { "type": "string", "minLength": 1, "maxLength": 200, "default": "*" }, "environment": { "type": "string", "minLength": 1, "maxLength": 200, "default": "*" }, "ttl_seconds": { "type": "integer", "minimum": 60, "maximum": 3600 }, "trigger_ttl_seconds": { "type": "integer", "minimum": 60, "maximum": 86400 } }, "required": [ "label_pattern", "ttl_seconds" ], "additionalProperties": false }, "ProbeActivationResponse": { "type": "object", "properties": { "activation": { "type": "object", "properties": { "activation_id": { "type": "string", "format": "uuid" }, "label_pattern": { "type": "string" }, "service": { "type": "string" }, "environment": { "type": "string" }, "expires_at": { "type": "string", "format": "date-time" }, "trigger_expires_at": { "type": "string", "format": "date-time" } }, "required": [ "activation_id", "label_pattern", "service", "environment", "expires_at", "trigger_expires_at" ], "additionalProperties": false }, "trigger_token": { "type": "string" } }, "required": [ "activation", "trigger_token" ], "additionalProperties": false }, "ProbeActivationListResponse": { "type": "object", "properties": { "activations": { "type": "array", "items": { "type": "object", "properties": { "activation_id": { "type": "string", "format": "uuid" }, "label_pattern": { "type": "string" }, "service": { "type": "string" }, "environment": { "type": "string" }, "expires_at": { "type": "string", "format": "date-time" }, "trigger_expires_at": { "type": "string", "format": "date-time" } }, "required": [ "activation_id", "label_pattern", "service", "environment", "expires_at", "trigger_expires_at" ], "additionalProperties": false } } }, "required": [ "activations" ], "additionalProperties": false }, "ProbeDeactivateBody": { "type": "object", "properties": { "activation_id": { "type": "string", "format": "uuid" } }, "required": [ "activation_id" ], "additionalProperties": false }, "ProbeDeactivationResponse": { "type": "object", "properties": { "deactivated": { "type": "object", "properties": { "activation_id": { "type": "string", "format": "uuid" }, "deactivated_at": { "type": "string", "format": "date-time" } }, "required": [ "activation_id", "deactivated_at" ], "additionalProperties": false } }, "required": [ "deactivated" ], "additionalProperties": false }, "CaptureRuleSuggestionsResponse": { "type": "object", "properties": { "suggestions": { "type": "array", "items": { "type": "object", "properties": { "suggestion_id": { "type": "string", "minLength": 1, "maxLength": 120 }, "label": { "type": "string", "minLength": 1, "maxLength": 200 }, "recommended_action": { "type": "string", "enum": [ "demote", "sample", "drop" ] }, "confidence": { "type": "string", "enum": [ "high", "medium", "low" ] }, "reason": { "type": "string", "minLength": 1, "maxLength": 500 }, "requires_confirmation": { "type": "boolean" }, "created_rule_id": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 120 }, { "type": "null" } ], "default": null }, "created_rule_enabled": { "type": [ "boolean", "null" ], "default": null }, "rule": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 120 }, "description": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ], "default": null }, "enabled": { "type": "boolean", "default": true }, "action": { "type": "string", "enum": [ "demote", "sample", "drop" ] }, "matcher": { "type": "object", "properties": { "event_types": { "type": "array", "items": { "type": "string", "enum": [ "backend_exception", "request_event", "log_event", "frontend_breadcrumb", "frontend_exception", "deploy_metadata", "error_suppressed", "probe_event" ] }, "minItems": 1 }, "services": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 120 }, "minItems": 1 }, "environments": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 120 }, "minItems": 1 }, "runtime": { "type": "array", "items": { "type": "string", "enum": [ "browser", "node", "python", "php", "java", "go", "ruby", "unknown" ] }, "minItems": 1 }, "first_party": { "type": "boolean" }, "error_name": { "type": "string", "minLength": 1, "maxLength": 120 }, "message_contains": { "type": "string", "minLength": 1, "maxLength": 500 }, "message_equals": { "type": "string", "minLength": 1, "maxLength": 500 }, "browser_event_kind": { "type": "string", "enum": [ "window_error", "resource_error" ] }, "browser_event_opaque": { "type": "boolean" }, "client_kind": { "type": "string", "enum": [ "human", "bot", "unknown" ] }, "bot_family": { "type": "string", "minLength": 1, "maxLength": 120 }, "resource_url": { "type": "object", "properties": { "host": { "type": "string", "minLength": 1, "maxLength": 255 }, "host_suffix": { "type": "string", "minLength": 1, "maxLength": 255 }, "path_prefix": { "type": "string", "minLength": 1, "maxLength": 1024 }, "path_equals": { "type": "string", "minLength": 1, "maxLength": 1024 } }, "additionalProperties": false }, "request_url": { "type": "object", "properties": { "host": { "type": "string", "minLength": 1, "maxLength": 255 }, "host_suffix": { "type": "string", "minLength": 1, "maxLength": 255 }, "path_prefix": { "type": "string", "minLength": 1, "maxLength": 1024 }, "path_equals": { "type": "string", "minLength": 1, "maxLength": 1024 } }, "additionalProperties": false }, "status_codes": { "type": "array", "items": { "type": "integer", "minimum": 100, "maximum": 599 }, "minItems": 1 }, "status_ranges": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 100, "maximum": 599 }, "end": { "type": "integer", "minimum": 100, "maximum": 599 } }, "required": [ "start", "end" ], "additionalProperties": false }, "minItems": 1 }, "fingerprint": { "type": "object", "properties": { "version": { "type": "string", "minLength": 1, "maxLength": 32 }, "value": { "type": "string", "minLength": 1, "maxLength": 256 } }, "required": [ "version", "value" ], "additionalProperties": false } }, "additionalProperties": false }, "sample_rate": { "anyOf": [ { "type": "number", "minimum": 0, "maximum": 1 }, { "type": "null" } ] }, "sample_event_class": { "anyOf": [ { "type": "string", "enum": [ "preserve", "context" ] }, { "type": "null" } ] }, "created_by_user_id": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 120 }, { "type": "null" } ], "default": null }, "created_from_incident_id": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 120 }, { "type": "null" } ], "default": null }, "created_from_event_id": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 120 }, { "type": "null" } ], "default": null }, "expires_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "default": null } }, "required": [ "name", "action", "matcher" ], "additionalProperties": false } }, "required": [ "suggestion_id", "label", "recommended_action", "confidence", "reason", "requires_confirmation", "rule" ], "additionalProperties": false } }, "bundle_status": { "type": "string", "enum": [ "ready", "pending", "failed" ] }, "bundle_reason": { "type": [ "string", "null" ] } }, "required": [ "suggestions" ], "additionalProperties": false }, "CreateCaptureRuleFromSuggestion": { "type": "object", "properties": { "suggestion_id": { "type": "string", "minLength": 1, "maxLength": 120 }, "name": { "type": "string", "minLength": 1, "maxLength": 120 }, "description": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ] }, "enabled": { "type": "boolean" }, "expires_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] } }, "required": [ "suggestion_id" ], "additionalProperties": false }, "CaptureRuleResponse": { "type": "object", "properties": { "rule": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 120 }, "description": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ] }, "enabled": { "type": "boolean" }, "action": { "type": "string", "enum": [ "demote", "sample", "drop" ] }, "matcher": { "type": "object", "properties": { "event_types": { "type": "array", "items": { "type": "string", "enum": [ "backend_exception", "request_event", "log_event", "frontend_breadcrumb", "frontend_exception", "deploy_metadata", "error_suppressed", "probe_event" ] }, "minItems": 1 }, "services": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 120 }, "minItems": 1 }, "environments": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 120 }, "minItems": 1 }, "runtime": { "type": "array", "items": { "type": "string", "enum": [ "browser", "node", "python", "php", "java", "go", "ruby", "unknown" ] }, "minItems": 1 }, "first_party": { "type": "boolean" }, "error_name": { "type": "string", "minLength": 1, "maxLength": 120 }, "message_contains": { "type": "string", "minLength": 1, "maxLength": 500 }, "message_equals": { "type": "string", "minLength": 1, "maxLength": 500 }, "browser_event_kind": { "type": "string", "enum": [ "window_error", "resource_error" ] }, "browser_event_opaque": { "type": "boolean" }, "client_kind": { "type": "string", "enum": [ "human", "bot", "unknown" ] }, "bot_family": { "type": "string", "minLength": 1, "maxLength": 120 }, "resource_url": { "type": "object", "properties": { "host": { "type": "string", "minLength": 1, "maxLength": 255 }, "host_suffix": { "type": "string", "minLength": 1, "maxLength": 255 }, "path_prefix": { "type": "string", "minLength": 1, "maxLength": 1024 }, "path_equals": { "type": "string", "minLength": 1, "maxLength": 1024 } }, "additionalProperties": false }, "request_url": { "type": "object", "properties": { "host": { "type": "string", "minLength": 1, "maxLength": 255 }, "host_suffix": { "type": "string", "minLength": 1, "maxLength": 255 }, "path_prefix": { "type": "string", "minLength": 1, "maxLength": 1024 }, "path_equals": { "type": "string", "minLength": 1, "maxLength": 1024 } }, "additionalProperties": false }, "status_codes": { "type": "array", "items": { "type": "integer", "minimum": 100, "maximum": 599 }, "minItems": 1 }, "status_ranges": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 100, "maximum": 599 }, "end": { "type": "integer", "minimum": 100, "maximum": 599 } }, "required": [ "start", "end" ], "additionalProperties": false }, "minItems": 1 }, "fingerprint": { "type": "object", "properties": { "version": { "type": "string", "minLength": 1, "maxLength": 32 }, "value": { "type": "string", "minLength": 1, "maxLength": 256 } }, "required": [ "version", "value" ], "additionalProperties": false } }, "additionalProperties": false }, "sample_rate": { "anyOf": [ { "type": "number", "minimum": 0, "maximum": 1 }, { "type": "null" } ] }, "sample_event_class": { "anyOf": [ { "type": "string", "enum": [ "preserve", "context" ] }, { "type": "null" } ] }, "created_by_user_id": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 120 }, { "type": "null" } ] }, "created_from_incident_id": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 120 }, { "type": "null" } ] }, "created_from_event_id": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 120 }, { "type": "null" } ] }, "expires_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] }, "id": { "type": "string", "format": "uuid" }, "project_id": { "type": "string", "minLength": 1, "maxLength": 120 }, "hit_count": { "type": "integer", "minimum": 0 }, "last_matched_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } }, "required": [ "name", "description", "enabled", "action", "matcher", "sample_rate", "sample_event_class", "created_by_user_id", "created_from_incident_id", "created_from_event_id", "expires_at", "id", "project_id", "hit_count", "last_matched_at", "created_at", "updated_at" ], "additionalProperties": false } }, "required": [ "rule" ], "additionalProperties": false }, "CaptureRulesResponse": { "type": "object", "properties": { "access_mode": { "type": "string", "enum": [ "manage", "preview" ] }, "rules": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 120 }, "description": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ] }, "enabled": { "type": "boolean" }, "action": { "type": "string", "enum": [ "demote", "sample", "drop" ] }, "matcher": { "type": "object", "properties": { "event_types": { "type": "array", "items": { "type": "string", "enum": [ "backend_exception", "request_event", "log_event", "frontend_breadcrumb", "frontend_exception", "deploy_metadata", "error_suppressed", "probe_event" ] }, "minItems": 1 }, "services": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 120 }, "minItems": 1 }, "environments": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 120 }, "minItems": 1 }, "runtime": { "type": "array", "items": { "type": "string", "enum": [ "browser", "node", "python", "php", "java", "go", "ruby", "unknown" ] }, "minItems": 1 }, "first_party": { "type": "boolean" }, "error_name": { "type": "string", "minLength": 1, "maxLength": 120 }, "message_contains": { "type": "string", "minLength": 1, "maxLength": 500 }, "message_equals": { "type": "string", "minLength": 1, "maxLength": 500 }, "browser_event_kind": { "type": "string", "enum": [ "window_error", "resource_error" ] }, "browser_event_opaque": { "type": "boolean" }, "client_kind": { "type": "string", "enum": [ "human", "bot", "unknown" ] }, "bot_family": { "type": "string", "minLength": 1, "maxLength": 120 }, "resource_url": { "type": "object", "properties": { "host": { "type": "string", "minLength": 1, "maxLength": 255 }, "host_suffix": { "type": "string", "minLength": 1, "maxLength": 255 }, "path_prefix": { "type": "string", "minLength": 1, "maxLength": 1024 }, "path_equals": { "type": "string", "minLength": 1, "maxLength": 1024 } }, "additionalProperties": false }, "request_url": { "type": "object", "properties": { "host": { "type": "string", "minLength": 1, "maxLength": 255 }, "host_suffix": { "type": "string", "minLength": 1, "maxLength": 255 }, "path_prefix": { "type": "string", "minLength": 1, "maxLength": 1024 }, "path_equals": { "type": "string", "minLength": 1, "maxLength": 1024 } }, "additionalProperties": false }, "status_codes": { "type": "array", "items": { "type": "integer", "minimum": 100, "maximum": 599 }, "minItems": 1 }, "status_ranges": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 100, "maximum": 599 }, "end": { "type": "integer", "minimum": 100, "maximum": 599 } }, "required": [ "start", "end" ], "additionalProperties": false }, "minItems": 1 }, "fingerprint": { "type": "object", "properties": { "version": { "type": "string", "minLength": 1, "maxLength": 32 }, "value": { "type": "string", "minLength": 1, "maxLength": 256 } }, "required": [ "version", "value" ], "additionalProperties": false } }, "additionalProperties": false }, "sample_rate": { "anyOf": [ { "type": "number", "minimum": 0, "maximum": 1 }, { "type": "null" } ] }, "sample_event_class": { "anyOf": [ { "type": "string", "enum": [ "preserve", "context" ] }, { "type": "null" } ] }, "created_by_user_id": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 120 }, { "type": "null" } ] }, "created_from_incident_id": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 120 }, { "type": "null" } ] }, "created_from_event_id": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 120 }, { "type": "null" } ] }, "expires_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] }, "id": { "type": "string", "format": "uuid" }, "project_id": { "type": "string", "minLength": 1, "maxLength": 120 }, "hit_count": { "type": "integer", "minimum": 0 }, "last_matched_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } }, "required": [ "name", "description", "enabled", "action", "matcher", "sample_rate", "sample_event_class", "created_by_user_id", "created_from_incident_id", "created_from_event_id", "expires_at", "id", "project_id", "hit_count", "last_matched_at", "created_at", "updated_at" ], "additionalProperties": false } } }, "required": [ "access_mode", "rules" ], "additionalProperties": false }, "CaptureRuleCreate": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 120 }, "description": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ], "default": null }, "enabled": { "type": "boolean", "default": true }, "action": { "type": "string", "enum": [ "demote", "sample", "drop" ] }, "matcher": { "type": "object", "properties": { "event_types": { "type": "array", "items": { "type": "string", "enum": [ "backend_exception", "request_event", "log_event", "frontend_breadcrumb", "frontend_exception", "deploy_metadata", "error_suppressed", "probe_event" ] }, "minItems": 1 }, "services": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 120 }, "minItems": 1 }, "environments": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 120 }, "minItems": 1 }, "runtime": { "type": "array", "items": { "type": "string", "enum": [ "browser", "node", "python", "php", "java", "go", "ruby", "unknown" ] }, "minItems": 1 }, "first_party": { "type": "boolean" }, "error_name": { "type": "string", "minLength": 1, "maxLength": 120 }, "message_contains": { "type": "string", "minLength": 1, "maxLength": 500 }, "message_equals": { "type": "string", "minLength": 1, "maxLength": 500 }, "browser_event_kind": { "type": "string", "enum": [ "window_error", "resource_error" ] }, "browser_event_opaque": { "type": "boolean" }, "client_kind": { "type": "string", "enum": [ "human", "bot", "unknown" ] }, "bot_family": { "type": "string", "minLength": 1, "maxLength": 120 }, "resource_url": { "type": "object", "properties": { "host": { "type": "string", "minLength": 1, "maxLength": 255 }, "host_suffix": { "type": "string", "minLength": 1, "maxLength": 255 }, "path_prefix": { "type": "string", "minLength": 1, "maxLength": 1024 }, "path_equals": { "type": "string", "minLength": 1, "maxLength": 1024 } }, "additionalProperties": false }, "request_url": { "type": "object", "properties": { "host": { "type": "string", "minLength": 1, "maxLength": 255 }, "host_suffix": { "type": "string", "minLength": 1, "maxLength": 255 }, "path_prefix": { "type": "string", "minLength": 1, "maxLength": 1024 }, "path_equals": { "type": "string", "minLength": 1, "maxLength": 1024 } }, "additionalProperties": false }, "status_codes": { "type": "array", "items": { "type": "integer", "minimum": 100, "maximum": 599 }, "minItems": 1 }, "status_ranges": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 100, "maximum": 599 }, "end": { "type": "integer", "minimum": 100, "maximum": 599 } }, "required": [ "start", "end" ], "additionalProperties": false }, "minItems": 1 }, "fingerprint": { "type": "object", "properties": { "version": { "type": "string", "minLength": 1, "maxLength": 32 }, "value": { "type": "string", "minLength": 1, "maxLength": 256 } }, "required": [ "version", "value" ], "additionalProperties": false } }, "additionalProperties": false }, "sample_rate": { "anyOf": [ { "type": "number", "minimum": 0, "maximum": 1 }, { "type": "null" } ] }, "sample_event_class": { "anyOf": [ { "type": "string", "enum": [ "preserve", "context" ] }, { "type": "null" } ] }, "created_by_user_id": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 120 }, { "type": "null" } ], "default": null }, "created_from_incident_id": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 120 }, { "type": "null" } ], "default": null }, "created_from_event_id": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 120 }, { "type": "null" } ], "default": null }, "expires_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "default": null } }, "required": [ "name", "action", "matcher" ], "additionalProperties": false }, "CaptureRuleUpdate": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 120 }, "description": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ] }, "enabled": { "type": "boolean" }, "action": { "type": "string", "enum": [ "demote", "sample", "drop" ] }, "matcher": { "type": "object", "properties": { "event_types": { "type": "array", "items": { "type": "string", "enum": [ "backend_exception", "request_event", "log_event", "frontend_breadcrumb", "frontend_exception", "deploy_metadata", "error_suppressed", "probe_event" ] }, "minItems": 1 }, "services": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 120 }, "minItems": 1 }, "environments": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 120 }, "minItems": 1 }, "runtime": { "type": "array", "items": { "type": "string", "enum": [ "browser", "node", "python", "php", "java", "go", "ruby", "unknown" ] }, "minItems": 1 }, "first_party": { "type": "boolean" }, "error_name": { "type": "string", "minLength": 1, "maxLength": 120 }, "message_contains": { "type": "string", "minLength": 1, "maxLength": 500 }, "message_equals": { "type": "string", "minLength": 1, "maxLength": 500 }, "browser_event_kind": { "type": "string", "enum": [ "window_error", "resource_error" ] }, "browser_event_opaque": { "type": "boolean" }, "client_kind": { "type": "string", "enum": [ "human", "bot", "unknown" ] }, "bot_family": { "type": "string", "minLength": 1, "maxLength": 120 }, "resource_url": { "type": "object", "properties": { "host": { "type": "string", "minLength": 1, "maxLength": 255 }, "host_suffix": { "type": "string", "minLength": 1, "maxLength": 255 }, "path_prefix": { "type": "string", "minLength": 1, "maxLength": 1024 }, "path_equals": { "type": "string", "minLength": 1, "maxLength": 1024 } }, "additionalProperties": false }, "request_url": { "type": "object", "properties": { "host": { "type": "string", "minLength": 1, "maxLength": 255 }, "host_suffix": { "type": "string", "minLength": 1, "maxLength": 255 }, "path_prefix": { "type": "string", "minLength": 1, "maxLength": 1024 }, "path_equals": { "type": "string", "minLength": 1, "maxLength": 1024 } }, "additionalProperties": false }, "status_codes": { "type": "array", "items": { "type": "integer", "minimum": 100, "maximum": 599 }, "minItems": 1 }, "status_ranges": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 100, "maximum": 599 }, "end": { "type": "integer", "minimum": 100, "maximum": 599 } }, "required": [ "start", "end" ], "additionalProperties": false }, "minItems": 1 }, "fingerprint": { "type": "object", "properties": { "version": { "type": "string", "minLength": 1, "maxLength": 32 }, "value": { "type": "string", "minLength": 1, "maxLength": 256 } }, "required": [ "version", "value" ], "additionalProperties": false } }, "additionalProperties": false }, "sample_rate": { "anyOf": [ { "type": "number", "minimum": 0, "maximum": 1 }, { "type": "null" } ] }, "sample_event_class": { "anyOf": [ { "type": "string", "enum": [ "preserve", "context" ] }, { "type": "null" } ] }, "expires_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] } }, "additionalProperties": false }, "CapturePolicyResponse": { "type": "object", "properties": { "access_mode": { "type": "string", "enum": [ "manage", "preview" ] }, "policy": { "type": "object", "properties": { "preset": { "type": "string", "enum": [ "minimal", "balanced", "investigative" ] }, "capture_logs": { "type": "string", "enum": [ "off", "error", "warning", "info" ] }, "capture_request_events": { "type": "string", "enum": [ "off", "failures_only", "filtered", "all" ] }, "capture_breadcrumbs": { "type": "string", "enum": [ "local_only", "exception_only", "standalone" ] }, "capture_probe_events": { "type": "string", "enum": [ "buffer_only", "standalone_when_activated" ] }, "immediate_client_error_statuses": { "type": "array", "items": { "type": "integer", "minimum": 400, "maximum": 499 }, "maxItems": 12 }, "immediate_client_error_path_rules": { "type": "array", "items": { "type": "object", "properties": { "status_code": { "type": "integer", "minimum": 400, "maximum": 499 }, "path_pattern": { "type": "string", "minLength": 1, "maxLength": 256 }, "methods": { "type": "array", "items": { "type": "string", "enum": [ "GET", "POST", "PUT", "PATCH", "DELETE", "HEAD", "OPTIONS" ] }, "maxItems": 7, "default": [] } }, "required": [ "status_code", "path_pattern" ], "additionalProperties": false }, "maxItems": 25, "default": [] } }, "required": [ "preset", "capture_logs", "capture_request_events", "capture_breadcrumbs", "capture_probe_events", "immediate_client_error_statuses" ], "additionalProperties": false }, "overrides": { "type": "object", "properties": { "capture_logs": { "anyOf": [ { "type": "string", "enum": [ "off", "error", "warning", "info" ] }, { "type": "null" } ] }, "capture_request_events": { "anyOf": [ { "type": "string", "enum": [ "off", "failures_only", "filtered", "all" ] }, { "type": "null" } ] }, "capture_breadcrumbs": { "anyOf": [ { "type": "string", "enum": [ "local_only", "exception_only", "standalone" ] }, { "type": "null" } ] }, "capture_probe_events": { "anyOf": [ { "type": "string", "enum": [ "buffer_only", "standalone_when_activated" ] }, { "type": "null" } ] }, "immediate_client_error_statuses": { "anyOf": [ { "type": "array", "items": { "type": "integer", "minimum": 400, "maximum": 499 }, "maxItems": 12 }, { "type": "null" } ] }, "immediate_client_error_path_rules": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "status_code": { "type": "integer", "minimum": 400, "maximum": 499 }, "path_pattern": { "type": "string", "minLength": 1, "maxLength": 256 }, "methods": { "type": "array", "items": { "type": "string", "enum": [ "GET", "POST", "PUT", "PATCH", "DELETE", "HEAD", "OPTIONS" ] }, "maxItems": 7, "default": [] } }, "required": [ "status_code", "path_pattern" ], "additionalProperties": false }, "maxItems": 25 }, { "type": "null" } ], "default": null } }, "required": [ "capture_logs", "capture_request_events", "capture_breadcrumbs", "capture_probe_events", "immediate_client_error_statuses" ], "additionalProperties": false } }, "required": [ "access_mode", "policy", "overrides" ], "additionalProperties": false }, "CapturePolicyUpdate": { "type": "object", "properties": { "preset": { "type": "string", "enum": [ "minimal", "balanced", "investigative" ] }, "capture_logs": { "anyOf": [ { "type": "string", "enum": [ "off", "error", "warning", "info" ] }, { "type": "null" } ] }, "capture_request_events": { "anyOf": [ { "type": "string", "enum": [ "off", "failures_only", "filtered", "all" ] }, { "type": "null" } ] }, "capture_breadcrumbs": { "anyOf": [ { "type": "string", "enum": [ "local_only", "exception_only", "standalone" ] }, { "type": "null" } ] }, "capture_probe_events": { "anyOf": [ { "type": "string", "enum": [ "buffer_only", "standalone_when_activated" ] }, { "type": "null" } ] }, "immediate_client_error_statuses": { "anyOf": [ { "type": "array", "items": { "type": "integer", "minimum": 400, "maximum": 499 }, "maxItems": 12 }, { "type": "null" } ] }, "immediate_client_error_path_rules": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "status_code": { "type": "integer", "minimum": 400, "maximum": 499 }, "path_pattern": { "type": "string", "minLength": 1, "maxLength": 256 }, "methods": { "type": "array", "items": { "type": "string", "enum": [ "GET", "POST", "PUT", "PATCH", "DELETE", "HEAD", "OPTIONS" ] }, "maxItems": 7, "default": [] } }, "required": [ "status_code", "path_pattern" ], "additionalProperties": false }, "maxItems": 25 }, { "type": "null" } ] } }, "additionalProperties": false }, "ImprovementSettingsResponse": { "type": "object", "properties": { "access_mode": { "type": "string", "enum": [ "manage", "preview" ] }, "cloud_automation_available": { "type": "boolean" }, "settings": { "type": "object", "properties": { "automated_improvement_bundles_enabled": { "type": "boolean" }, "improvement_bundle_sensitivity": { "type": "string", "enum": [ "high_confidence", "balanced", "verbose" ] } }, "required": [ "automated_improvement_bundles_enabled", "improvement_bundle_sensitivity" ], "additionalProperties": false } }, "required": [ "access_mode", "cloud_automation_available", "settings" ], "additionalProperties": false }, "ImprovementSettingsUpdate": { "type": "object", "properties": { "automated_improvement_bundles_enabled": { "type": "boolean" }, "improvement_bundle_sensitivity": { "type": "string", "enum": [ "high_confidence", "balanced", "verbose" ] } }, "additionalProperties": false }, "AnalyticsSavedFunnelsResponse": { "type": "object", "properties": { "funnels": { "type": "array", "items": { "type": "object", "properties": { "funnel_key": { "type": "string", "minLength": 1, "maxLength": 120, "pattern": "^[A-Za-z][A-Za-z0-9_.:-]*$" }, "display_name": { "type": "string", "minLength": 1, "maxLength": 120 }, "steps": { "type": "array", "items": { "type": "object", "properties": { "step_key": { "type": "string", "minLength": 1, "maxLength": 120, "pattern": "^[A-Za-z][A-Za-z0-9_.:-]*$" }, "display_name": { "type": "string", "minLength": 1, "maxLength": 120 } }, "required": [ "step_key", "display_name" ], "additionalProperties": false }, "minItems": 2, "maxItems": 20 }, "project_id": { "type": "string", "format": "uuid" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "archived_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] } }, "required": [ "funnel_key", "display_name", "steps", "project_id", "created_at", "updated_at", "archived_at" ], "additionalProperties": false }, "maxItems": 100 } }, "required": [ "funnels" ], "additionalProperties": false }, "AnalyticsSavedFunnelCreate": { "type": "object", "properties": { "funnel_key": { "type": "string", "minLength": 1, "maxLength": 120, "pattern": "^[A-Za-z][A-Za-z0-9_.:-]*$" }, "display_name": { "type": "string", "minLength": 1, "maxLength": 120 }, "steps": { "type": "array", "items": { "type": "object", "properties": { "step_key": { "type": "string", "minLength": 1, "maxLength": 120, "pattern": "^[A-Za-z][A-Za-z0-9_.:-]*$" }, "display_name": { "type": "string", "minLength": 1, "maxLength": 120 } }, "required": [ "step_key", "display_name" ], "additionalProperties": false }, "minItems": 2, "maxItems": 20 } }, "required": [ "funnel_key", "display_name", "steps" ], "additionalProperties": false }, "AnalyticsSavedFunnelResponse": { "type": "object", "properties": { "funnel": { "type": "object", "properties": { "funnel_key": { "type": "string", "minLength": 1, "maxLength": 120, "pattern": "^[A-Za-z][A-Za-z0-9_.:-]*$" }, "display_name": { "type": "string", "minLength": 1, "maxLength": 120 }, "steps": { "type": "array", "items": { "type": "object", "properties": { "step_key": { "type": "string", "minLength": 1, "maxLength": 120, "pattern": "^[A-Za-z][A-Za-z0-9_.:-]*$" }, "display_name": { "type": "string", "minLength": 1, "maxLength": 120 } }, "required": [ "step_key", "display_name" ], "additionalProperties": false }, "minItems": 2, "maxItems": 20 }, "project_id": { "type": "string", "format": "uuid" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "archived_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] } }, "required": [ "funnel_key", "display_name", "steps", "project_id", "created_at", "updated_at", "archived_at" ], "additionalProperties": false } }, "required": [ "funnel" ], "additionalProperties": false }, "AnalyticsSavedFunnelUpdate": { "type": "object", "properties": { "display_name": { "type": "string", "minLength": 1, "maxLength": 120 }, "steps": { "type": "array", "items": { "type": "object", "properties": { "step_key": { "type": "string", "minLength": 1, "maxLength": 120, "pattern": "^[A-Za-z][A-Za-z0-9_.:-]*$" }, "display_name": { "type": "string", "minLength": 1, "maxLength": 120 } }, "required": [ "step_key", "display_name" ], "additionalProperties": false }, "minItems": 2, "maxItems": 20 } }, "additionalProperties": false }, "AnalyticsBundleGenerationsListResponse": { "type": "object", "properties": { "bundles": { "type": "array", "items": { "type": "object", "properties": { "generation_id": { "type": "string", "format": "uuid" }, "project_id": { "type": "string", "format": "uuid" }, "project_name": { "type": "string", "minLength": 1, "maxLength": 200 }, "project_color_tag": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 32 }, { "type": "null" } ] }, "opportunity_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "requested_by_user_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "analysis_kind": { "type": "string", "enum": [ "usage_summary", "route_health", "funnel_dropoff", "journey_friction", "feature_usage", "incident_impact", "deploy_comparison", "conversion_path" ] }, "analysis_spec": { "type": "object", "additionalProperties": {} }, "input_fingerprint": { "type": "string", "pattern": "^sha256:[a-f0-9]{64}$" }, "status": { "type": "string", "enum": [ "pending", "running", "completed", "failed" ] }, "has_artifact": { "type": "boolean" }, "failure_reason": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 240 }, { "type": "null" } ] }, "created_at": { "type": "string", "format": "date-time" }, "claimed_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] }, "completed_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] }, "updated_at": { "type": "string", "format": "date-time" } }, "required": [ "generation_id", "project_id", "opportunity_id", "requested_by_user_id", "analysis_kind", "analysis_spec", "input_fingerprint", "status", "has_artifact", "failure_reason", "created_at", "claimed_at", "completed_at", "updated_at" ], "additionalProperties": false }, "maxItems": 100 }, "next_cursor": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] } }, "required": [ "bundles", "next_cursor" ], "additionalProperties": false }, "AnalyticsBundleCreate": { "type": "object", "properties": { "project_id": { "type": "string", "format": "uuid" }, "opportunity_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "analysis_kind": { "type": "string", "enum": [ "usage_summary", "route_health", "funnel_dropoff", "journey_friction", "feature_usage", "incident_impact", "deploy_comparison", "conversion_path" ] }, "from": { "type": "string", "format": "date-time" }, "to": { "type": "string", "format": "date-time" }, "last": { "type": "string", "minLength": 2, "maxLength": 16 }, "funnel": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 120 }, { "type": "null" } ] }, "route": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 2048, "pattern": "^[^?#]+$" }, { "type": "null" } ] }, "incident_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "deploy_id": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 120 }, { "type": "null" } ] }, "filters": { "type": "object", "additionalProperties": {} } }, "required": [ "project_id", "analysis_kind" ], "additionalProperties": false }, "AnalyticsBundleResponse": { "anyOf": [ { "type": "object", "properties": { "schema_version": { "type": "string", "const": "analytics_bundle.v1" }, "bundle_type": { "type": "string", "const": "analytics" }, "analysis_kind": { "type": "string", "enum": [ "usage_summary", "route_health", "funnel_dropoff", "journey_friction", "feature_usage", "incident_impact", "deploy_comparison", "conversion_path" ] }, "project": { "type": "object", "properties": { "project_id": { "type": "string", "format": "uuid" }, "service": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 120 }, { "type": "null" } ] }, "environment": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 120 }, { "type": "null" } ] } }, "required": [ "project_id", "service", "environment" ], "additionalProperties": false }, "analysis_window": { "type": "object", "properties": { "from": { "type": "string", "format": "date-time" }, "to": { "type": "string", "format": "date-time" }, "granularity": { "type": "string", "enum": [ "hour", "day", "week", "month" ] } }, "required": [ "from", "to", "granularity" ], "additionalProperties": false }, "summary": { "type": "object", "properties": { "title": { "type": "string", "minLength": 1, "maxLength": 240 }, "description": { "type": "string", "minLength": 1, "maxLength": 2000 }, "confidence": { "type": "string", "enum": [ "low", "medium", "high" ] }, "severity": { "type": "string", "enum": [ "low", "medium", "high" ] } }, "required": [ "title", "description", "confidence", "severity" ], "additionalProperties": false }, "metrics": { "type": "object", "properties": { "sessions_analyzed": { "type": "integer", "minimum": 0 }, "affected_sessions": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ] }, "baseline": { "type": "object", "additionalProperties": {} }, "current": { "type": "object", "additionalProperties": {} } }, "required": [ "sessions_analyzed", "affected_sessions", "baseline", "current" ], "additionalProperties": false }, "segments": { "type": "array", "items": { "type": "object", "additionalProperties": {} }, "maxItems": 100 }, "journey_patterns": { "type": "array", "items": { "type": "object", "additionalProperties": {} }, "maxItems": 100 }, "representative_journeys": { "type": "array", "items": { "type": "object", "additionalProperties": {} }, "maxItems": 25 }, "linked_incidents": { "type": "array", "items": { "type": "object", "additionalProperties": {} }, "maxItems": 100 }, "linked_deploys": { "type": "array", "items": { "type": "object", "additionalProperties": {} }, "maxItems": 50 }, "recommendations": { "type": "array", "items": { "type": "object", "additionalProperties": {} }, "maxItems": 50 }, "redaction": { "type": "object", "properties": { "rules_applied": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 120 }, "maxItems": 50 }, "omitted_fields": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 200 }, "maxItems": 100 } }, "required": [ "rules_applied", "omitted_fields" ], "additionalProperties": false }, "metadata": { "type": "object", "properties": { "input_fingerprint": { "type": "string", "pattern": "^sha256:[a-f0-9]{64}$" } }, "required": [ "input_fingerprint" ], "additionalProperties": false } }, "required": [ "schema_version", "bundle_type", "analysis_kind", "project", "analysis_window", "summary", "metrics", "segments", "journey_patterns", "representative_journeys", "linked_incidents", "linked_deploys", "recommendations", "redaction", "metadata" ], "additionalProperties": false }, { "type": "object", "properties": { "status": { "type": "string", "const": "pending" }, "bundle_generation_id": { "type": "string", "format": "uuid" } }, "required": [ "status", "bundle_generation_id" ], "additionalProperties": false }, { "type": "object", "properties": { "status": { "type": "string", "const": "failed" }, "reason": { "type": "string" } }, "required": [ "status", "reason" ], "additionalProperties": false } ] }, "AnalyticsOpportunitiesListResponse": { "type": "object", "properties": { "opportunities": { "type": "array", "items": { "type": "object", "properties": { "opportunity_id": { "type": "string", "format": "uuid" }, "project_id": { "type": "string", "format": "uuid" }, "project_name": { "type": "string", "minLength": 1, "maxLength": 200 }, "project_color_tag": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 32 }, { "type": "null" } ] }, "service": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 120 }, { "type": "null" } ] }, "environment": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 120 }, { "type": "null" } ] }, "kind": { "type": "string", "enum": [ "usage_summary", "route_health", "funnel_dropoff", "journey_friction", "feature_usage", "incident_impact", "deploy_comparison", "conversion_path" ] }, "status": { "type": "string", "enum": [ "open", "resolved", "snoozed" ] }, "severity": { "type": "string", "enum": [ "low", "medium", "high" ] }, "confidence": { "type": "number", "minimum": 0, "maximum": 1 }, "title": { "type": "string", "minLength": 1, "maxLength": 240 }, "summary": { "type": "string", "minLength": 1, "maxLength": 2000 }, "evidence": { "type": "object", "additionalProperties": {} }, "related_incident_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "maxItems": 100 }, "related_deploy_ids": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 128 }, "maxItems": 100 }, "first_detected_at": { "type": "string", "format": "date-time" }, "last_detected_at": { "type": "string", "format": "date-time" }, "resolved_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] }, "snoozed_until": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] }, "bundle_generation_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "bundle_status": { "type": "string", "enum": [ "not_requested", "pending", "running", "completed", "failed" ] }, "bundle_created_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] }, "bundle_updated_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] }, "bundle_failure_reason": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 240 }, { "type": "null" } ] } }, "required": [ "opportunity_id", "project_id", "project_name", "project_color_tag", "service", "environment", "kind", "status", "severity", "confidence", "title", "summary", "evidence", "related_incident_ids", "related_deploy_ids", "first_detected_at", "last_detected_at", "resolved_at", "snoozed_until", "bundle_generation_id", "bundle_status", "bundle_created_at", "bundle_updated_at", "bundle_failure_reason" ], "additionalProperties": false }, "maxItems": 100 }, "next_cursor": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] } }, "required": [ "opportunities", "next_cursor" ], "additionalProperties": false }, "AnalyticsOpportunityResponse": { "type": "object", "properties": { "opportunity": { "type": "object", "properties": { "opportunity_id": { "type": "string", "format": "uuid" }, "project_id": { "type": "string", "format": "uuid" }, "project_name": { "type": "string", "minLength": 1, "maxLength": 200 }, "project_color_tag": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 32 }, { "type": "null" } ] }, "service": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 120 }, { "type": "null" } ] }, "environment": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 120 }, { "type": "null" } ] }, "kind": { "type": "string", "enum": [ "usage_summary", "route_health", "funnel_dropoff", "journey_friction", "feature_usage", "incident_impact", "deploy_comparison", "conversion_path" ] }, "status": { "type": "string", "enum": [ "open", "resolved", "snoozed" ] }, "severity": { "type": "string", "enum": [ "low", "medium", "high" ] }, "confidence": { "type": "number", "minimum": 0, "maximum": 1 }, "title": { "type": "string", "minLength": 1, "maxLength": 240 }, "summary": { "type": "string", "minLength": 1, "maxLength": 2000 }, "evidence": { "type": "object", "additionalProperties": {} }, "related_incident_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "maxItems": 100 }, "related_deploy_ids": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 128 }, "maxItems": 100 }, "first_detected_at": { "type": "string", "format": "date-time" }, "last_detected_at": { "type": "string", "format": "date-time" }, "resolved_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] }, "snoozed_until": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] }, "bundle_generation_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "bundle_status": { "type": "string", "enum": [ "not_requested", "pending", "running", "completed", "failed" ] }, "bundle_created_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] }, "bundle_updated_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] }, "bundle_failure_reason": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 240 }, { "type": "null" } ] } }, "required": [ "opportunity_id", "project_id", "project_name", "project_color_tag", "service", "environment", "kind", "status", "severity", "confidence", "title", "summary", "evidence", "related_incident_ids", "related_deploy_ids", "first_detected_at", "last_detected_at", "resolved_at", "snoozed_until", "bundle_generation_id", "bundle_status", "bundle_created_at", "bundle_updated_at", "bundle_failure_reason" ], "additionalProperties": false } }, "required": [ "opportunity" ], "additionalProperties": false }, "AnalyticsJourneySamplesListResponse": { "type": "object", "properties": { "samples": { "type": "array", "items": { "type": "object", "properties": { "sample_id": { "type": "string", "format": "uuid" }, "project_id": { "type": "string", "format": "uuid" }, "service": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 120 }, { "type": "null" } ] }, "environment": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 120 }, { "type": "null" } ] }, "session_id_hash": { "type": "string", "minLength": 1, "maxLength": 200 }, "visitor_id_hash": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 200 }, { "type": "null" } ] }, "analysis_tags": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 120 }, "maxItems": 50 }, "first_seen_at": { "type": "string", "format": "date-time" }, "last_seen_at": { "type": "string", "format": "date-time" }, "dimensions_summary": { "type": "object", "additionalProperties": {} }, "has_artifact": { "type": "boolean" }, "expires_at": { "type": "string", "format": "date-time" }, "created_at": { "type": "string", "format": "date-time" } }, "required": [ "sample_id", "project_id", "service", "environment", "session_id_hash", "visitor_id_hash", "analysis_tags", "first_seen_at", "last_seen_at", "dimensions_summary", "has_artifact", "expires_at", "created_at" ], "additionalProperties": false }, "maxItems": 100 }, "next_cursor": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] } }, "required": [ "samples", "next_cursor" ], "additionalProperties": false }, "AnalyticsJourneySampleResponse": { "type": "object", "properties": { "sample": { "type": "object", "properties": { "sample_id": { "type": "string", "format": "uuid" }, "project_id": { "type": "string", "format": "uuid" }, "service": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 120 }, { "type": "null" } ] }, "environment": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 120 }, { "type": "null" } ] }, "session_id_hash": { "type": "string", "minLength": 1, "maxLength": 200 }, "visitor_id_hash": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 200 }, { "type": "null" } ] }, "analysis_tags": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 120 }, "maxItems": 50 }, "first_seen_at": { "type": "string", "format": "date-time" }, "last_seen_at": { "type": "string", "format": "date-time" }, "dimensions_summary": { "type": "object", "additionalProperties": {} }, "has_artifact": { "type": "boolean" }, "expires_at": { "type": "string", "format": "date-time" }, "created_at": { "type": "string", "format": "date-time" } }, "required": [ "sample_id", "project_id", "service", "environment", "session_id_hash", "visitor_id_hash", "analysis_tags", "first_seen_at", "last_seen_at", "dimensions_summary", "has_artifact", "expires_at", "created_at" ], "additionalProperties": false }, "journey": { "type": "object", "properties": { "schema_version": { "type": "string", "const": "analytics_journey_sample.v1" }, "sample_id": { "type": "string", "format": "uuid" }, "project_id": { "type": "string", "format": "uuid" }, "service": { "type": "string", "minLength": 1, "maxLength": 120 }, "environment": { "type": "string", "minLength": 1, "maxLength": 120 }, "session_id_hash": { "type": "string", "minLength": 1, "maxLength": 200 }, "visitor_id_hash": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 200 }, { "type": "null" } ] }, "first_seen_at": { "type": "string", "format": "date-time" }, "last_seen_at": { "type": "string", "format": "date-time" }, "analysis_tags": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 120 }, "maxItems": 50 }, "dimensions_summary": { "type": "object", "additionalProperties": { "anyOf": [ { "anyOf": [ { "type": "string", "maxLength": 256 }, { "type": "number" }, { "type": "boolean" }, { "type": "null" } ] }, { "type": "object", "additionalProperties": { "anyOf": [ { "type": "string", "maxLength": 256 }, { "type": "number" }, { "type": "boolean" }, { "type": "null" } ] }, "propertyNames": { "minLength": 1, "maxLength": 64 } } ] }, "propertyNames": { "minLength": 1, "maxLength": 64 } }, "events": { "type": "array", "items": { "type": "object", "properties": { "event_id": { "type": "string", "minLength": 1, "maxLength": 128 }, "occurred_at": { "type": "string", "format": "date-time" }, "kind": { "type": "string", "enum": [ "session_start", "page_view", "route_change", "action", "funnel_step", "conversion", "journey_marker", "session_summary" ] }, "route": { "anyOf": [ { "type": "object", "properties": { "path": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 2048 }, { "type": "null" } ] }, "normalized_path": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 2048 }, { "type": "null" } ] }, "title": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 200 }, { "type": "null" } ] } }, "additionalProperties": false }, { "type": "null" } ] }, "previous_route": { "anyOf": [ { "type": "object", "properties": { "path": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 2048 }, { "type": "null" } ] }, "normalized_path": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 2048 }, { "type": "null" } ] }, "title": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 200 }, { "type": "null" } ] } }, "additionalProperties": false }, { "type": "null" } ] }, "signal": { "anyOf": [ { "type": "object", "properties": { "action_key": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 120 }, { "type": "null" } ] }, "funnel_key": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 120 }, { "type": "null" } ] }, "step_key": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 120 }, { "type": "null" } ] }, "conversion_key": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 120 }, { "type": "null" } ] }, "marker_key": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 120 }, { "type": "null" } ] } }, "additionalProperties": false }, { "type": "null" } ] }, "trace_id": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 128 }, { "type": "null" } ] }, "deploy_id": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 128 }, { "type": "null" } ] }, "dimensions": { "type": "object", "additionalProperties": { "anyOf": [ { "type": "string", "maxLength": 256 }, { "type": "number" }, { "type": "boolean" }, { "type": "null" } ] }, "propertyNames": { "minLength": 1, "maxLength": 64 } }, "custom_dimensions": { "type": "object", "additionalProperties": { "anyOf": [ { "type": "string", "maxLength": 256 }, { "type": "number" }, { "type": "boolean" }, { "type": "null" } ] }, "propertyNames": { "minLength": 1, "maxLength": 64 } } }, "required": [ "event_id", "occurred_at", "kind", "route", "previous_route", "signal", "trace_id", "deploy_id", "dimensions", "custom_dimensions" ], "additionalProperties": false }, "maxItems": 100 } }, "required": [ "schema_version", "sample_id", "project_id", "service", "environment", "session_id_hash", "visitor_id_hash", "first_seen_at", "last_seen_at", "analysis_tags", "dimensions_summary", "events" ], "additionalProperties": false } }, "required": [ "sample", "journey" ], "additionalProperties": false }, "AnalyticsUsageSummaryResponse": { "type": "object", "properties": { "summary": { "type": "object", "properties": { "project_id": { "type": "string", "format": "uuid" }, "from": { "type": "string", "format": "date-time" }, "to": { "type": "string", "format": "date-time" }, "granularity": { "type": "string", "enum": [ "hour", "day" ] }, "service": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 120 }, { "type": "null" } ] }, "environment": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 120 }, { "type": "null" } ] }, "sessions": { "type": "integer", "minimum": 0 }, "pageviews": { "type": "integer", "minimum": 0 }, "active_visitors": { "type": "integer", "minimum": 0 }, "new_visitors": { "type": "integer", "minimum": 0 }, "returning_visitors": { "type": "integer", "minimum": 0 }, "exits": { "type": "integer", "minimum": 0 }, "conversions": { "type": "integer", "minimum": 0 } }, "required": [ "project_id", "from", "to", "granularity", "service", "environment", "sessions", "pageviews", "active_visitors", "new_visitors", "returning_visitors", "exits", "conversions" ], "additionalProperties": false }, "breakdowns": { "type": "object", "properties": { "device_types": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string", "minLength": 1, "maxLength": 255 }, "sessions": { "type": "integer", "minimum": 0 }, "pageviews": { "type": "integer", "minimum": 0 } }, "required": [ "value", "sessions", "pageviews" ], "additionalProperties": false }, "maxItems": 100 }, "browsers": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string", "minLength": 1, "maxLength": 255 }, "sessions": { "type": "integer", "minimum": 0 }, "pageviews": { "type": "integer", "minimum": 0 } }, "required": [ "value", "sessions", "pageviews" ], "additionalProperties": false }, "maxItems": 100 }, "os": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string", "minLength": 1, "maxLength": 255 }, "sessions": { "type": "integer", "minimum": 0 }, "pageviews": { "type": "integer", "minimum": 0 } }, "required": [ "value", "sessions", "pageviews" ], "additionalProperties": false }, "maxItems": 100 }, "languages": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string", "minLength": 1, "maxLength": 255 }, "sessions": { "type": "integer", "minimum": 0 }, "pageviews": { "type": "integer", "minimum": 0 } }, "required": [ "value", "sessions", "pageviews" ], "additionalProperties": false }, "maxItems": 100 }, "referrers": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string", "minLength": 1, "maxLength": 255 }, "sessions": { "type": "integer", "minimum": 0 }, "pageviews": { "type": "integer", "minimum": 0 } }, "required": [ "value", "sessions", "pageviews" ], "additionalProperties": false }, "maxItems": 100 }, "auth_states": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string", "minLength": 1, "maxLength": 255 }, "sessions": { "type": "integer", "minimum": 0 }, "pageviews": { "type": "integer", "minimum": 0 } }, "required": [ "value", "sessions", "pageviews" ], "additionalProperties": false }, "maxItems": 100 } }, "required": [ "device_types", "browsers", "os", "languages", "referrers", "auth_states" ], "additionalProperties": false } }, "required": [ "summary", "breakdowns" ], "additionalProperties": false }, "AnalyticsRouteMetricsResponse": { "type": "object", "properties": { "window": { "type": "object", "properties": { "project_id": { "type": "string", "format": "uuid" }, "from": { "type": "string", "format": "date-time" }, "to": { "type": "string", "format": "date-time" }, "granularity": { "type": "string", "enum": [ "hour", "day" ] }, "service": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 120 }, { "type": "null" } ] }, "environment": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 120 }, { "type": "null" } ] } }, "required": [ "project_id", "from", "to", "granularity", "service", "environment" ], "additionalProperties": false }, "routes": { "type": "array", "items": { "type": "object", "properties": { "route_key": { "type": "string", "minLength": 1, "maxLength": 2048 }, "pageviews": { "type": "integer", "minimum": 0 }, "unique_sessions": { "type": "integer", "minimum": 0 }, "entrances": { "type": "integer", "minimum": 0 }, "exits": { "type": "integer", "minimum": 0 }, "bounces": { "type": "integer", "minimum": 0 }, "linked_incident_sessions": { "type": "integer", "minimum": 0 } }, "required": [ "route_key", "pageviews", "unique_sessions", "entrances", "exits", "bounces", "linked_incident_sessions" ], "additionalProperties": false }, "maxItems": 100 } }, "required": [ "window", "routes" ], "additionalProperties": false }, "AnalyticsDeviceBreakdownResponse": { "type": "object", "properties": { "window": { "type": "object", "properties": { "project_id": { "type": "string", "format": "uuid" }, "from": { "type": "string", "format": "date-time" }, "to": { "type": "string", "format": "date-time" }, "granularity": { "type": "string", "enum": [ "hour", "day" ] }, "service": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 120 }, { "type": "null" } ] }, "environment": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 120 }, { "type": "null" } ] } }, "required": [ "project_id", "from", "to", "granularity", "service", "environment" ], "additionalProperties": false }, "device_types": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string", "minLength": 1, "maxLength": 255 }, "sessions": { "type": "integer", "minimum": 0 }, "pageviews": { "type": "integer", "minimum": 0 } }, "required": [ "value", "sessions", "pageviews" ], "additionalProperties": false }, "maxItems": 100 }, "browsers": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string", "minLength": 1, "maxLength": 255 }, "sessions": { "type": "integer", "minimum": 0 }, "pageviews": { "type": "integer", "minimum": 0 } }, "required": [ "value", "sessions", "pageviews" ], "additionalProperties": false }, "maxItems": 100 }, "os": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string", "minLength": 1, "maxLength": 255 }, "sessions": { "type": "integer", "minimum": 0 }, "pageviews": { "type": "integer", "minimum": 0 } }, "required": [ "value", "sessions", "pageviews" ], "additionalProperties": false }, "maxItems": 100 }, "languages": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string", "minLength": 1, "maxLength": 255 }, "sessions": { "type": "integer", "minimum": 0 }, "pageviews": { "type": "integer", "minimum": 0 } }, "required": [ "value", "sessions", "pageviews" ], "additionalProperties": false }, "maxItems": 100 } }, "required": [ "window", "device_types", "browsers", "os", "languages" ], "additionalProperties": false }, "AnalyticsJourneyPatternsResponse": { "type": "object", "properties": { "window": { "type": "object", "properties": { "project_id": { "type": "string", "format": "uuid" }, "from": { "type": "string", "format": "date-time" }, "to": { "type": "string", "format": "date-time" }, "granularity": { "type": "string", "enum": [ "hour", "day" ] }, "service": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 120 }, { "type": "null" } ] }, "environment": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 120 }, { "type": "null" } ] } }, "required": [ "project_id", "from", "to", "granularity", "service", "environment" ], "additionalProperties": false }, "patterns": { "type": "array", "items": { "type": "object", "properties": { "from_route_key": { "type": "string", "minLength": 1, "maxLength": 2048 }, "to_route_key": { "type": "string", "minLength": 1, "maxLength": 2048 }, "transition_count": { "type": "integer", "minimum": 0 }, "unique_sessions": { "type": "integer", "minimum": 0 }, "transition_share": { "type": "number", "minimum": 0, "maximum": 1 }, "sample_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "maxItems": 3, "default": [] } }, "required": [ "from_route_key", "to_route_key", "transition_count", "unique_sessions", "transition_share" ], "additionalProperties": false }, "maxItems": 100 } }, "required": [ "window", "patterns" ], "additionalProperties": false }, "AnalyticsReferrerMetricsResponse": { "type": "object", "properties": { "window": { "type": "object", "properties": { "project_id": { "type": "string", "format": "uuid" }, "from": { "type": "string", "format": "date-time" }, "to": { "type": "string", "format": "date-time" }, "granularity": { "type": "string", "enum": [ "hour", "day" ] }, "service": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 120 }, { "type": "null" } ] }, "environment": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 120 }, { "type": "null" } ] } }, "required": [ "project_id", "from", "to", "granularity", "service", "environment" ], "additionalProperties": false }, "referrers": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string", "minLength": 1, "maxLength": 255 }, "sessions": { "type": "integer", "minimum": 0 }, "pageviews": { "type": "integer", "minimum": 0 } }, "required": [ "value", "sessions", "pageviews" ], "additionalProperties": false }, "maxItems": 100 }, "utm_sources": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string", "minLength": 1, "maxLength": 255 }, "sessions": { "type": "integer", "minimum": 0 }, "pageviews": { "type": "integer", "minimum": 0 } }, "required": [ "value", "sessions", "pageviews" ], "additionalProperties": false }, "maxItems": 100 }, "utm_mediums": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string", "minLength": 1, "maxLength": 255 }, "sessions": { "type": "integer", "minimum": 0 }, "pageviews": { "type": "integer", "minimum": 0 } }, "required": [ "value", "sessions", "pageviews" ], "additionalProperties": false }, "maxItems": 100 }, "utm_campaigns": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string", "minLength": 1, "maxLength": 255 }, "sessions": { "type": "integer", "minimum": 0 }, "pageviews": { "type": "integer", "minimum": 0 } }, "required": [ "value", "sessions", "pageviews" ], "additionalProperties": false }, "maxItems": 100 } }, "required": [ "window", "referrers", "utm_sources", "utm_mediums", "utm_campaigns" ], "additionalProperties": false }, "AnalyticsActionMetricsResponse": { "type": "object", "properties": { "window": { "type": "object", "properties": { "project_id": { "type": "string", "format": "uuid" }, "from": { "type": "string", "format": "date-time" }, "to": { "type": "string", "format": "date-time" }, "granularity": { "type": "string", "enum": [ "hour", "day" ] }, "service": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 120 }, { "type": "null" } ] }, "environment": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 120 }, { "type": "null" } ] } }, "required": [ "project_id", "from", "to", "granularity", "service", "environment" ], "additionalProperties": false }, "actions": { "type": "array", "items": { "type": "object", "properties": { "action_key": { "type": "string", "minLength": 1, "maxLength": 160 }, "kind": { "type": "string", "enum": [ "action", "conversion", "marker" ] }, "event_count": { "type": "integer", "minimum": 0 }, "unique_sessions": { "type": "integer", "minimum": 0 } }, "required": [ "action_key", "kind", "event_count", "unique_sessions" ], "additionalProperties": false }, "maxItems": 100 } }, "required": [ "window", "actions" ], "additionalProperties": false }, "AnalyticsFunnelsResponse": { "type": "object", "properties": { "window": { "type": "object", "properties": { "project_id": { "type": "string", "format": "uuid" }, "from": { "type": "string", "format": "date-time" }, "to": { "type": "string", "format": "date-time" }, "granularity": { "type": "string", "enum": [ "hour", "day" ] }, "service": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 120 }, { "type": "null" } ] }, "environment": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 120 }, { "type": "null" } ] } }, "required": [ "project_id", "from", "to", "granularity", "service", "environment" ], "additionalProperties": false }, "funnels": { "type": "array", "items": { "type": "object", "properties": { "funnel_key": { "type": "string", "minLength": 1, "maxLength": 120 }, "sessions_entered": { "type": "integer", "minimum": 0 }, "sessions_completed": { "type": "integer", "minimum": 0 }, "dropoffs": { "type": "integer", "minimum": 0 }, "conversion_rate": { "type": "number", "minimum": 0, "maximum": 1 } }, "required": [ "funnel_key", "sessions_entered", "sessions_completed", "dropoffs", "conversion_rate" ], "additionalProperties": false }, "maxItems": 100 } }, "required": [ "window", "funnels" ], "additionalProperties": false }, "AnalyticsFunnelAnalysisResponse": { "type": "object", "properties": { "funnel": { "type": "object", "properties": { "project_id": { "type": "string", "format": "uuid" }, "funnel_key": { "type": "string", "minLength": 1, "maxLength": 120 }, "from": { "type": "string", "format": "date-time" }, "to": { "type": "string", "format": "date-time" }, "granularity": { "type": "string", "enum": [ "hour", "day" ] }, "service": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 120 }, { "type": "null" } ] }, "environment": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 120 }, { "type": "null" } ] }, "sessions_entered": { "type": "integer", "minimum": 0 }, "sessions_completed": { "type": "integer", "minimum": 0 }, "dropoffs": { "type": "integer", "minimum": 0 }, "conversion_rate": { "type": "number", "minimum": 0, "maximum": 1 } }, "required": [ "project_id", "funnel_key", "from", "to", "granularity", "service", "environment", "sessions_entered", "sessions_completed", "dropoffs", "conversion_rate" ], "additionalProperties": false }, "steps": { "type": "array", "items": { "type": "object", "properties": { "step_key": { "type": "string", "minLength": 1, "maxLength": 120 }, "step_order": { "type": "integer", "minimum": 0 }, "sessions_entered": { "type": "integer", "minimum": 0 }, "sessions_completed": { "type": "integer", "minimum": 0 }, "dropoffs": { "type": "integer", "minimum": 0 }, "conversion_rate": { "type": "number", "minimum": 0, "maximum": 1 } }, "required": [ "step_key", "step_order", "sessions_entered", "sessions_completed", "dropoffs", "conversion_rate" ], "additionalProperties": false }, "maxItems": 100 } }, "required": [ "funnel", "steps" ], "additionalProperties": false }, "AnalyticsIncidentImpactResponse": { "type": "object", "properties": { "incident_id": { "type": "string", "format": "uuid" }, "window": { "type": "object", "properties": { "project_id": { "type": "string", "format": "uuid" }, "from": { "type": "string", "format": "date-time" }, "to": { "type": "string", "format": "date-time" }, "granularity": { "type": "string", "enum": [ "hour", "day" ] }, "service": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 120 }, { "type": "null" } ] }, "environment": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 120 }, { "type": "null" } ] } }, "required": [ "project_id", "from", "to", "granularity", "service", "environment" ], "additionalProperties": false }, "affected_sessions": { "type": "integer", "minimum": 0 }, "affected_routes": { "type": "array", "items": { "type": "object", "properties": { "route_key": { "type": "string", "minLength": 1, "maxLength": 2048 }, "affected_sessions": { "type": "integer", "minimum": 0 } }, "required": [ "route_key", "affected_sessions" ], "additionalProperties": false }, "maxItems": 100 }, "affected_funnels": { "type": "array", "items": { "type": "object", "properties": { "funnel_key": { "type": "string", "minLength": 1, "maxLength": 120 }, "affected_sessions": { "type": "integer", "minimum": 0 } }, "required": [ "funnel_key", "affected_sessions" ], "additionalProperties": false }, "maxItems": 100 }, "top_device_types": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string", "minLength": 1, "maxLength": 255 }, "affected_sessions": { "type": "integer", "minimum": 0 } }, "required": [ "value", "affected_sessions" ], "additionalProperties": false }, "maxItems": 100 }, "top_browsers": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string", "minLength": 1, "maxLength": 255 }, "affected_sessions": { "type": "integer", "minimum": 0 } }, "required": [ "value", "affected_sessions" ], "additionalProperties": false }, "maxItems": 100 }, "journey_patterns": { "type": "array", "items": { "type": "object", "properties": { "from_route_key": { "type": "string", "minLength": 1, "maxLength": 2048 }, "to_route_key": { "type": "string", "minLength": 1, "maxLength": 2048 }, "affected_sessions": { "type": "integer", "minimum": 0 }, "sample_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "maxItems": 3 } }, "required": [ "from_route_key", "to_route_key", "affected_sessions", "sample_ids" ], "additionalProperties": false }, "maxItems": 100 }, "conversion_delta": { "type": "object", "properties": { "availability": { "type": "string", "enum": [ "available", "unavailable" ] }, "value": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "unit": { "type": "string", "const": "percentage_points" } }, "required": [ "availability", "value", "unit" ], "additionalProperties": false }, "analytics_bundle": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "not_requested", "pending", "running", "completed", "failed" ] }, "generation_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "failure_reason": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 240 }, { "type": "null" } ] } }, "required": [ "status", "generation_id", "failure_reason" ], "additionalProperties": false } }, "required": [ "incident_id", "window", "affected_sessions", "affected_routes", "affected_funnels", "top_device_types", "top_browsers", "journey_patterns", "conversion_delta", "analytics_bundle" ], "additionalProperties": false }, "AnalyticsSettingsResponse": { "type": "object", "properties": { "access_mode": { "type": "string", "enum": [ "manage", "preview" ] }, "analytics_available": { "type": "boolean" }, "settings": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "privacy_mode": { "type": "string", "enum": [ "strict", "standard", "custom" ] }, "consent_required": { "type": "boolean" }, "capture_page_views": { "type": "boolean" }, "capture_route_changes": { "type": "boolean" }, "capture_actions": { "type": "boolean" }, "capture_friction_signals": { "type": "boolean" }, "journey_sample_rate": { "type": "number", "minimum": 0, "maximum": 1 }, "raw_retention_days": { "type": "integer", "minimum": 1, "maximum": 30 }, "sample_retention_days": { "type": "integer", "minimum": 1, "maximum": 365 }, "hourly_retention_days": { "type": "integer", "minimum": 1, "maximum": 365 }, "aggregate_retention_months": { "type": "integer", "minimum": 1, "maximum": 120 }, "max_saved_funnels": { "type": "integer", "minimum": 0, "maximum": 100 }, "max_custom_dimensions": { "type": "integer", "minimum": 0, "maximum": 20 }, "approved_custom_dimensions": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z][A-Za-z0-9_.-]*$" }, "maxItems": 20 } }, "required": [ "enabled", "privacy_mode", "consent_required", "capture_page_views", "capture_route_changes", "capture_actions", "capture_friction_signals", "journey_sample_rate", "raw_retention_days", "sample_retention_days", "hourly_retention_days", "aggregate_retention_months", "max_saved_funnels", "max_custom_dimensions", "approved_custom_dimensions" ], "additionalProperties": false } }, "required": [ "access_mode", "analytics_available", "settings" ], "additionalProperties": false }, "AnalyticsSettingsUpdate": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "privacy_mode": { "type": "string", "enum": [ "strict", "standard", "custom" ] }, "consent_required": { "type": "boolean" }, "capture_page_views": { "type": "boolean" }, "capture_route_changes": { "type": "boolean" }, "capture_actions": { "type": "boolean" }, "capture_friction_signals": { "type": "boolean" }, "journey_sample_rate": { "type": "number", "minimum": 0, "maximum": 1 }, "raw_retention_days": { "type": "integer", "minimum": 1, "maximum": 30 }, "sample_retention_days": { "type": "integer", "minimum": 1, "maximum": 365 }, "hourly_retention_days": { "type": "integer", "minimum": 1, "maximum": 365 }, "aggregate_retention_months": { "type": "integer", "minimum": 1, "maximum": 120 }, "max_saved_funnels": { "type": "integer", "minimum": 0, "maximum": 100 }, "max_custom_dimensions": { "type": "integer", "minimum": 0, "maximum": 20 }, "approved_custom_dimensions": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z][A-Za-z0-9_.-]*$" }, "maxItems": 20 } }, "additionalProperties": false }, "SdkConfigResponse": { "type": "object", "properties": { "probes_enabled": { "type": "boolean" }, "remote_probes_enabled": { "type": "boolean" }, "active_probes": { "type": "array", "items": { "type": "object", "properties": { "activation_id": { "type": "string", "format": "uuid" }, "label_pattern": { "type": "string" }, "service": { "type": "string" }, "environment": { "type": "string" }, "expires_at": { "type": "string", "format": "date-time" }, "trigger_expires_at": { "type": "string", "format": "date-time" } }, "required": [ "activation_id", "label_pattern", "service", "environment", "expires_at", "trigger_expires_at" ], "additionalProperties": false } }, "poll_interval_ms": { "type": "integer", "minimum": 0 }, "analytics": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "privacy_mode": { "type": "string", "enum": [ "strict", "standard", "custom" ] }, "consent_required": { "type": "boolean" }, "capture_page_views": { "type": "boolean" }, "capture_route_changes": { "type": "boolean" }, "capture_actions": { "type": "boolean" }, "capture_friction_signals": { "type": "boolean" } }, "required": [ "enabled", "privacy_mode", "consent_required", "capture_page_views", "capture_route_changes", "capture_actions", "capture_friction_signals" ], "additionalProperties": false }, "capture_policy": { "type": "object", "properties": { "preset": { "type": "string", "enum": [ "minimal", "balanced", "investigative" ] }, "capture_logs": { "type": "string", "enum": [ "off", "error", "warning", "info" ] }, "capture_request_events": { "type": "string", "enum": [ "off", "failures_only", "filtered", "all" ] }, "capture_breadcrumbs": { "type": "string", "enum": [ "local_only", "exception_only", "standalone" ] }, "capture_probe_events": { "type": "string", "enum": [ "buffer_only", "standalone_when_activated" ] }, "immediate_client_error_statuses": { "type": "array", "items": { "type": "integer", "minimum": 400, "maximum": 499 }, "maxItems": 12 }, "immediate_client_error_path_rules": { "type": "array", "items": { "type": "object", "properties": { "status_code": { "type": "integer", "minimum": 400, "maximum": 499 }, "path_pattern": { "type": "string", "minLength": 1, "maxLength": 256 }, "methods": { "type": "array", "items": { "type": "string", "enum": [ "GET", "POST", "PUT", "PATCH", "DELETE", "HEAD", "OPTIONS" ] }, "maxItems": 7, "default": [] } }, "required": [ "status_code", "path_pattern" ], "additionalProperties": false }, "maxItems": 25, "default": [] } }, "required": [ "preset", "capture_logs", "capture_request_events", "capture_breadcrumbs", "capture_probe_events", "immediate_client_error_statuses" ], "additionalProperties": false }, "capture_rules": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 120 }, "description": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ] }, "enabled": { "type": "boolean" }, "action": { "type": "string", "enum": [ "demote", "sample", "drop" ] }, "matcher": { "type": "object", "properties": { "event_types": { "type": "array", "items": { "type": "string", "enum": [ "backend_exception", "request_event", "log_event", "frontend_breadcrumb", "frontend_exception", "deploy_metadata", "error_suppressed", "probe_event" ] }, "minItems": 1 }, "services": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 120 }, "minItems": 1 }, "environments": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 120 }, "minItems": 1 }, "runtime": { "type": "array", "items": { "type": "string", "enum": [ "browser", "node", "python", "php", "java", "go", "ruby", "unknown" ] }, "minItems": 1 }, "first_party": { "type": "boolean" }, "error_name": { "type": "string", "minLength": 1, "maxLength": 120 }, "message_contains": { "type": "string", "minLength": 1, "maxLength": 500 }, "message_equals": { "type": "string", "minLength": 1, "maxLength": 500 }, "browser_event_kind": { "type": "string", "enum": [ "window_error", "resource_error" ] }, "browser_event_opaque": { "type": "boolean" }, "client_kind": { "type": "string", "enum": [ "human", "bot", "unknown" ] }, "bot_family": { "type": "string", "minLength": 1, "maxLength": 120 }, "resource_url": { "type": "object", "properties": { "host": { "type": "string", "minLength": 1, "maxLength": 255 }, "host_suffix": { "type": "string", "minLength": 1, "maxLength": 255 }, "path_prefix": { "type": "string", "minLength": 1, "maxLength": 1024 }, "path_equals": { "type": "string", "minLength": 1, "maxLength": 1024 } }, "additionalProperties": false }, "request_url": { "type": "object", "properties": { "host": { "type": "string", "minLength": 1, "maxLength": 255 }, "host_suffix": { "type": "string", "minLength": 1, "maxLength": 255 }, "path_prefix": { "type": "string", "minLength": 1, "maxLength": 1024 }, "path_equals": { "type": "string", "minLength": 1, "maxLength": 1024 } }, "additionalProperties": false }, "status_codes": { "type": "array", "items": { "type": "integer", "minimum": 100, "maximum": 599 }, "minItems": 1 }, "status_ranges": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 100, "maximum": 599 }, "end": { "type": "integer", "minimum": 100, "maximum": 599 } }, "required": [ "start", "end" ], "additionalProperties": false }, "minItems": 1 }, "fingerprint": { "type": "object", "properties": { "version": { "type": "string", "minLength": 1, "maxLength": 32 }, "value": { "type": "string", "minLength": 1, "maxLength": 256 } }, "required": [ "version", "value" ], "additionalProperties": false } }, "additionalProperties": false }, "sample_rate": { "anyOf": [ { "type": "number", "minimum": 0, "maximum": 1 }, { "type": "null" } ] }, "sample_event_class": { "anyOf": [ { "type": "string", "enum": [ "preserve", "context" ] }, { "type": "null" } ] }, "created_by_user_id": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 120 }, { "type": "null" } ] }, "created_from_incident_id": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 120 }, { "type": "null" } ] }, "created_from_event_id": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 120 }, { "type": "null" } ] }, "expires_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] }, "id": { "type": "string", "format": "uuid" }, "project_id": { "type": "string", "minLength": 1, "maxLength": 120 }, "hit_count": { "type": "integer", "minimum": 0 }, "last_matched_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } }, "required": [ "name", "description", "enabled", "action", "matcher", "sample_rate", "sample_event_class", "created_by_user_id", "created_from_incident_id", "created_from_event_id", "expires_at", "id", "project_id", "hit_count", "last_matched_at", "created_at", "updated_at" ], "additionalProperties": false } }, "trigger_token_key": { "type": "string" } }, "required": [ "probes_enabled", "remote_probes_enabled", "active_probes", "poll_interval_ms", "capture_policy", "capture_rules" ], "additionalProperties": false } } } }