{ "openapi": "3.1.0", "info": { "title": "CheckoutBeat API", "version": "1.0.0", "summary": "Know the moment your checkout breaks.", "description": "CheckoutBeat walks your online store’s buy path with a real browser every 30 or 60 minutes: product page, add to cart, cart, checkout page, stopping before any payment. When a step fails twice in a row you get an email, a Slack message or a text with the step, the error and a screenshot. It also watches uptime, SSL expiry and theme changes.\n\n## Authentication\nSend an API key as `Authorization: Bearer ` (or `X-API-Key`). Keys are created on the account page (https://checkoutbeat.com/app/api-keys). Signed-in browser sessions work too.\n\n## What a check does\nA real browser opens the product page, adds the product to the cart, opens the cart and opens the checkout page, then stops. Nothing is typed into the checkout and no payment is ever made. A failed step comes back with the error, the HTTP status and a screenshot URL. When a store's bot protection challenges the checkout page, the step is marked `skipped` and `stoppedAt` is `cart`: the cart check is the evidence, checkout itself was not verified.\n\n## Metering and pricing\nEvery completed on-demand `store-check` call records one `store-check` usage event (scheduled checks of monitored stores are part of the plan and are not metered). Plans: Starter: 1 store checked every 60 min, 100 on-demand checks, $49/month; Growth: 5 stores checked every 30 min, 500 on-demand checks, $99/month; Agency: 20 stores checked every 30 min, 2,000 on-demand checks, $149/month; the free tier gets 1 on-demand check per month. API and agent callers past a paid plan's allowance pay $0.25 per check.\nAgents should send `x-usage-source: agent` so their usage is attributed correctly; it does not change the price. Send `Idempotency-Key` to make a retried request run one check, not two.\n\n## Rate limits\nPer key or IP, published in the `X-RateLimit-*` response headers. A 429 carries `Retry-After`.\n\nSupport: support@tenhatch.com. Machine-readable product summary: https://checkoutbeat.com/.well-known/product.json", "contact": { "name": "CheckoutBeat support", "email": "support@tenhatch.com", "url": "https://checkoutbeat.com" }, "termsOfService": "https://checkoutbeat.com/legal/terms", "x-pricing": { "currency": "usd", "perResultCents": 25, "eventName": "store-check", "freeResultsPerMonth": 1, "plans": [ { "planId": "starter", "name": "Starter", "monthly": "$49/month", "annual": "$490/year", "annualPerMonth": "$40.83/month", "savingsPercent": 17, "savings": "$98", "resultsPerMonth": 100, "stores": 1, "checkIntervalMinutes": 60 }, { "planId": "growth", "name": "Growth", "monthly": "$99/month", "annual": "$990/year", "annualPerMonth": "$82.50/month", "savingsPercent": 17, "savings": "$198", "resultsPerMonth": 500, "stores": 5, "checkIntervalMinutes": 30 }, { "planId": "agency", "name": "Agency", "monthly": "$149/month", "annual": "$1,490/year", "annualPerMonth": "$124.17/month", "savingsPercent": 17, "savings": "$298", "resultsPerMonth": 2000, "stores": 20, "checkIntervalMinutes": 30 } ], "refundWindowDays": 14 } }, "servers": [ { "url": "https://checkoutbeat.com", "description": "Production" } ], "security": [ { "bearerAuth": [] }, { "apiKeyHeader": [] } ], "tags": [ { "name": "feature", "description": "Store check" }, { "name": "stores", "description": "Monitored stores and their results" }, { "name": "account", "description": "Account, usage, alerts and API keys" }, { "name": "meta", "description": "Documents about the API itself" } ], "paths": { "/api/v1/store-check": { "post": { "tags": [ "feature" ], "operationId": "store-check", "summary": "Store check", "description": "Walks a store’s buy path (product page, add to cart, cart, checkout page) with a real browser, stops before payment, and reports each step with timing, the first error and a screenshot of the failure.\n\nInput: A JSON object with a `storeUrl` (the store’s home page or a product page) and optionally `productUrl` and `flowType` (`auto`, `shopify` or `woocommerce`).\n\nOutput: A JSON object with the run result: `ok`, `steps` (name, ok, ms, error, screenshot), `checks` (HTTP status, time to first byte, SSL days left, theme fingerprint) and `stoppedAt`.\n\nThe call waits for the result (about a minute at most). With `wait: false`, or when the result is not ready in time, it answers 202 with a job to poll at GET /api/v1/jobs/{jobId}.", "parameters": [ { "name": "x-usage-source", "in": "header", "required": false, "description": "Set to `agent` when the caller is an AI agent or MCP client.", "schema": { "type": "string", "enum": [ "agent", "api" ] } }, { "name": "Idempotency-Key", "in": "header", "required": false, "description": "Any unique string; a retry with the same key returns the same check instead of running another.", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FeatureInput" } } } }, "responses": { "200": { "description": "The result and how it was metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StoreCheckResponse" } } } }, "202": { "description": "Queued; poll the job.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StoreCheckQueued" } } } }, "400": { "description": "Invalid input, or the store could not be walked automatically (see `error.message`).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid API key / session.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Plan allowance exhausted and pay-as-you-go not available for this account.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected error; retry with backoff.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-price-per-result-cents": 25, "x-usage-event": "store-check" } }, "/api/v1/jobs/{jobId}": { "get": { "tags": [ "feature" ], "operationId": "getCheckJob", "summary": "Status of a queued check", "parameters": [ { "name": "jobId", "in": "path", "required": true, "description": "The job id from a 202 response.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The job and, once finished, its result.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StoreCheckStatus" } } } }, "401": { "description": "Missing or invalid API key / session.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such job on this account.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected error; retry with backoff.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/stores": { "get": { "tags": [ "stores" ], "operationId": "listStores", "summary": "Monitored stores with status, last check and 30-day uptime", "responses": { "200": { "description": "Stores.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Store" } } } } }, "401": { "description": "Missing or invalid API key / session.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected error; retry with backoff.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "post": { "tags": [ "stores" ], "operationId": "createStore", "summary": "Add a store to the schedule", "description": "Detects the platform, finds a product and saves the buy path. Plan limits apply (stores per account, buy paths per store).", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateStoreInput" } } } }, "responses": { "201": { "description": "The store.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Store" } } } }, "400": { "description": "Invalid input or the store could not be walked automatically.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid API key / session.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Plan limit reached or monitoring needs a plan.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected error; retry with backoff.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/stores/{id}": { "get": { "tags": [ "stores" ], "operationId": "getStore", "summary": "A store with its last 48 results, timeline and incidents", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Store id.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Store and results.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StoreResults" } } } }, "401": { "description": "Missing or invalid API key / session.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such store on this account.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected error; retry with backoff.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "patch": { "tags": [ "stores" ], "operationId": "updateStore", "summary": "Rename, pause or resume a store", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Store id.", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateStoreInput" } } } }, "responses": { "200": { "description": "The store.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Store" } } } }, "400": { "description": "Invalid input.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid API key / session.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such store on this account.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected error; retry with backoff.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "delete": { "tags": [ "stores" ], "operationId": "deleteStore", "summary": "Stop monitoring a store", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Store id.", "schema": { "type": "string" } } ], "responses": { "204": { "description": "Removed." }, "401": { "description": "Missing or invalid API key / session.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such store on this account.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected error; retry with backoff.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/stores/{id}/results": { "get": { "tags": [ "stores" ], "operationId": "listStoreResults", "summary": "The last results of a store (newest first, at most 48)", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Store id.", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 48 } } ], "responses": { "200": { "description": "Results.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CheckRun" } } } } }, "401": { "description": "Missing or invalid API key / session.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such store on this account.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected error; retry with backoff.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/stores/{id}/check": { "post": { "tags": [ "stores" ], "operationId": "checkStoreNow", "summary": "Run a monitored store’s buy path now", "description": "Metered like /api/v1/store-check. The result also feeds the store's incident state.", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Store id.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The result.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StoreCheckResponse" } } } }, "202": { "description": "Queued; poll the job.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StoreCheckQueued" } } } }, "401": { "description": "Missing or invalid API key / session.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Allowance exhausted.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such store on this account.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected error; retry with backoff.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/alerts": { "get": { "tags": [ "account" ], "operationId": "getAlertSettings", "summary": "Where alerts go", "responses": { "200": { "description": "Alert settings.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlertSettings" } } } }, "401": { "description": "Missing or invalid API key / session.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected error; retry with backoff.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "put": { "tags": [ "account" ], "operationId": "updateAlertSettings", "summary": "Change where alerts go (session only)", "security": [ { "session": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlertSettingsInput" } } } }, "responses": { "200": { "description": "Alert settings.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlertSettings" } } } }, "400": { "description": "Invalid input.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid API key / session.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected error; retry with backoff.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/usage": { "get": { "tags": [ "account" ], "operationId": "getUsage", "summary": "Current-period usage meter (on-demand checks)", "responses": { "200": { "description": "Usage this calendar month.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UsageMeter" } } } }, "401": { "description": "Missing or invalid API key / session.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected error; retry with backoff.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/me": { "get": { "tags": [ "account" ], "operationId": "getAccount", "summary": "The calling account, its plan and limits", "responses": { "200": { "description": "Account.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Account" } } } }, "401": { "description": "Missing or invalid API key / session.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected error; retry with backoff.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/keys": { "get": { "tags": [ "account" ], "operationId": "listApiKeys", "summary": "List API keys (session only)", "security": [ { "session": [] } ], "responses": { "200": { "description": "Keys without secrets.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ApiKeySummary" } } } } }, "401": { "description": "Missing or invalid API key / session.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected error; retry with backoff.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "post": { "tags": [ "account" ], "operationId": "createApiKey", "summary": "Create an API key (session only)", "security": [ { "session": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateApiKeyInput" } } } }, "responses": { "201": { "description": "The new key; the secret is shown once.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateApiKeyResponse" } } } }, "400": { "description": "Invalid input.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid API key / session.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Key limit for the plan reached.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected error; retry with backoff.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/keys/{id}": { "delete": { "tags": [ "account" ], "operationId": "revokeApiKey", "summary": "Revoke an API key (session only)", "security": [ { "session": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "Revoked." }, "401": { "description": "Missing or invalid API key / session.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such key on this account.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected error; retry with backoff.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/openapi.json": { "get": { "tags": [ "meta" ], "operationId": "getOpenApi", "summary": "This document", "security": [], "responses": { "200": { "description": "OpenAPI 3.1 document.", "content": { "application/json": { "schema": { "type": "object" } } } } } } } }, "components": { "securitySchemes": { "bearerAuth": { "type": "http", "scheme": "bearer", "description": "API key as a bearer token." }, "apiKeyHeader": { "type": "apiKey", "in": "header", "name": "X-API-Key" }, "session": { "type": "apiKey", "in": "cookie", "name": "session", "description": "Browser session of a signed-in user." } }, "schemas": { "FeatureInput": { "type": "object", "properties": { "storeUrl": { "type": "string", "minLength": 1, "maxLength": 2048, "description": "The store’s home page or a product page, e.g. https://shop.example or https://shop.example/products/blue-mug." }, "productUrl": { "description": "The product page to walk. Found automatically when omitted (Shopify /products.json, first WooCommerce product link).", "type": "string", "minLength": 1, "maxLength": 2048 }, "flowType": { "type": "string", "enum": [ "auto", "shopify", "woocommerce" ], "description": "Which buy path to walk. `auto` (default) detects Shopify or WooCommerce from the store’s HTML." }, "wait": { "description": "Wait for the result (default true, up to about 60 seconds). With false the call returns a job to poll.", "type": "boolean" } }, "required": [ "storeUrl" ], "description": "Input of a store check." }, "StoreCheckResponse": { "type": "object", "properties": { "result": { "type": "object", "properties": { "id": { "type": "string" }, "storeId": { "type": [ "string", "null" ] }, "kind": { "type": "string", "enum": [ "scheduled", "on_demand", "instant" ] }, "flowType": { "type": "string", "enum": [ "shopify", "woocommerce", "generic" ] }, "storeUrl": { "type": "string" }, "ok": { "type": "boolean" }, "stoppedAt": { "type": "string", "enum": [ "checkout", "cart", "failed" ], "description": "`cart` means checkout could not be verified because of a bot challenge." }, "failedStep": { "type": [ "string", "null" ] }, "error": { "type": [ "string", "null" ] }, "summary": { "type": "string", "description": "e.g. \"checked at 14:05 UTC, step Checkout page failed with HTTP 500\"." }, "startedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "finishedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "totalMs": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "steps": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "ok": { "type": "boolean" }, "ms": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "error": { "type": "string" }, "status": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "url": { "type": "string" }, "skipped": { "description": "True when the checkout page answered with a bot challenge and the step was not verified.", "type": "boolean" }, "note": { "type": "string" }, "screenshotUrl": { "description": "Screenshot of the failing step, when the step failed.", "type": [ "string", "null" ] } }, "required": [ "name", "ok", "ms" ], "additionalProperties": false, "description": "One step of the walk." } }, "checks": { "type": "object", "properties": { "httpStatus": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "ttfbMs": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Time to first byte of the store URL, milliseconds." }, "sslDaysLeft": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "themeFingerprint": { "description": "Hash of the theme’s stylesheet/script names; changes when the theme changes.", "type": [ "string", "null" ] }, "themeName": { "type": [ "string", "null" ] }, "checkoutChallenged": { "type": "boolean" } }, "required": [ "httpStatus", "ttfbMs", "sslDaysLeft", "themeFingerprint", "themeName", "checkoutChallenged" ], "additionalProperties": false, "description": "Plain-HTTP checks run alongside the walk." }, "screenshotUrl": { "type": [ "string", "null" ] } }, "required": [ "id", "storeId", "kind", "flowType", "storeUrl", "ok", "stoppedAt", "failedStep", "error", "summary", "startedAt", "finishedAt", "totalMs", "steps", "checks", "screenshotUrl" ], "additionalProperties": false, "description": "The result of one store check." }, "usage": { "type": "object", "properties": { "source": { "type": "string", "enum": [ "human", "agent", "api" ], "description": "Which door a request came through: human (web app), agent (MCP / agent frameworks), api (plain API calls)." }, "chargedCents": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "remaining": { "type": "integer", "minimum": 0, "maximum": 9007199254740991, "description": "On-demand checks left in the current period after this call." } }, "required": [ "source", "chargedCents", "remaining" ], "additionalProperties": false } }, "required": [ "result", "usage" ], "additionalProperties": false, "description": "The check result plus how it was metered." }, "StoreCheckQueued": { "type": "object", "properties": { "job": { "type": "object", "properties": { "id": { "type": "string" }, "status": { "type": "string", "enum": [ "queued", "running", "done", "failed" ] }, "kind": { "type": "string", "enum": [ "scheduled", "on_demand", "instant" ] }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "finishedAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] }, "error": { "type": [ "string", "null" ] }, "runId": { "type": [ "string", "null" ] } }, "required": [ "id", "status", "kind", "createdAt", "finishedAt", "error", "runId" ], "additionalProperties": false, "description": "A queued or finished check job." }, "usage": { "type": "object", "properties": { "source": { "type": "string", "enum": [ "human", "agent", "api" ], "description": "Which door a request came through: human (web app), agent (MCP / agent frameworks), api (plain API calls)." }, "chargedCents": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "remaining": { "type": "integer", "minimum": 0, "maximum": 9007199254740991, "description": "On-demand checks left in the current period after this call." } }, "required": [ "source", "chargedCents", "remaining" ], "additionalProperties": false } }, "required": [ "job", "usage" ], "additionalProperties": false, "description": "The check was queued; poll GET /api/v1/jobs/{jobId}." }, "StoreCheckStatus": { "type": "object", "properties": { "job": { "type": "object", "properties": { "id": { "type": "string" }, "status": { "type": "string", "enum": [ "queued", "running", "done", "failed" ] }, "kind": { "type": "string", "enum": [ "scheduled", "on_demand", "instant" ] }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "finishedAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] }, "error": { "type": [ "string", "null" ] }, "runId": { "type": [ "string", "null" ] } }, "required": [ "id", "status", "kind", "createdAt", "finishedAt", "error", "runId" ], "additionalProperties": false, "description": "A queued or finished check job." }, "result": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string" }, "storeId": { "type": [ "string", "null" ] }, "kind": { "type": "string", "enum": [ "scheduled", "on_demand", "instant" ] }, "flowType": { "type": "string", "enum": [ "shopify", "woocommerce", "generic" ] }, "storeUrl": { "type": "string" }, "ok": { "type": "boolean" }, "stoppedAt": { "type": "string", "enum": [ "checkout", "cart", "failed" ], "description": "`cart` means checkout could not be verified because of a bot challenge." }, "failedStep": { "type": [ "string", "null" ] }, "error": { "type": [ "string", "null" ] }, "summary": { "type": "string", "description": "e.g. \"checked at 14:05 UTC, step Checkout page failed with HTTP 500\"." }, "startedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "finishedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "totalMs": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "steps": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "ok": { "type": "boolean" }, "ms": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "error": { "type": "string" }, "status": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "url": { "type": "string" }, "skipped": { "description": "True when the checkout page answered with a bot challenge and the step was not verified.", "type": "boolean" }, "note": { "type": "string" }, "screenshotUrl": { "description": "Screenshot of the failing step, when the step failed.", "type": [ "string", "null" ] } }, "required": [ "name", "ok", "ms" ], "additionalProperties": false, "description": "One step of the walk." } }, "checks": { "type": "object", "properties": { "httpStatus": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "ttfbMs": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Time to first byte of the store URL, milliseconds." }, "sslDaysLeft": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "themeFingerprint": { "description": "Hash of the theme’s stylesheet/script names; changes when the theme changes.", "type": [ "string", "null" ] }, "themeName": { "type": [ "string", "null" ] }, "checkoutChallenged": { "type": "boolean" } }, "required": [ "httpStatus", "ttfbMs", "sslDaysLeft", "themeFingerprint", "themeName", "checkoutChallenged" ], "additionalProperties": false, "description": "Plain-HTTP checks run alongside the walk." }, "screenshotUrl": { "type": [ "string", "null" ] } }, "required": [ "id", "storeId", "kind", "flowType", "storeUrl", "ok", "stoppedAt", "failedStep", "error", "summary", "startedAt", "finishedAt", "totalMs", "steps", "checks", "screenshotUrl" ], "additionalProperties": false, "description": "The result of one store check." }, { "type": "null" } ] } }, "required": [ "job", "result" ], "additionalProperties": false, "description": "A queued check’s status, with the result once it finished." }, "CheckRun": { "type": "object", "properties": { "id": { "type": "string" }, "storeId": { "type": [ "string", "null" ] }, "kind": { "type": "string", "enum": [ "scheduled", "on_demand", "instant" ] }, "flowType": { "type": "string", "enum": [ "shopify", "woocommerce", "generic" ] }, "storeUrl": { "type": "string" }, "ok": { "type": "boolean" }, "stoppedAt": { "type": "string", "enum": [ "checkout", "cart", "failed" ], "description": "`cart` means checkout could not be verified because of a bot challenge." }, "failedStep": { "type": [ "string", "null" ] }, "error": { "type": [ "string", "null" ] }, "summary": { "type": "string", "description": "e.g. \"checked at 14:05 UTC, step Checkout page failed with HTTP 500\"." }, "startedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "finishedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "totalMs": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "steps": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "ok": { "type": "boolean" }, "ms": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "error": { "type": "string" }, "status": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "url": { "type": "string" }, "skipped": { "description": "True when the checkout page answered with a bot challenge and the step was not verified.", "type": "boolean" }, "note": { "type": "string" }, "screenshotUrl": { "description": "Screenshot of the failing step, when the step failed.", "type": [ "string", "null" ] } }, "required": [ "name", "ok", "ms" ], "additionalProperties": false, "description": "One step of the walk." } }, "checks": { "type": "object", "properties": { "httpStatus": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "ttfbMs": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Time to first byte of the store URL, milliseconds." }, "sslDaysLeft": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "themeFingerprint": { "description": "Hash of the theme’s stylesheet/script names; changes when the theme changes.", "type": [ "string", "null" ] }, "themeName": { "type": [ "string", "null" ] }, "checkoutChallenged": { "type": "boolean" } }, "required": [ "httpStatus", "ttfbMs", "sslDaysLeft", "themeFingerprint", "themeName", "checkoutChallenged" ], "additionalProperties": false, "description": "Plain-HTTP checks run alongside the walk." }, "screenshotUrl": { "type": [ "string", "null" ] } }, "required": [ "id", "storeId", "kind", "flowType", "storeUrl", "ok", "stoppedAt", "failedStep", "error", "summary", "startedAt", "finishedAt", "totalMs", "steps", "checks", "screenshotUrl" ], "additionalProperties": false, "description": "The result of one store check." }, "Store": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "url": { "type": "string" }, "flowType": { "type": "string", "enum": [ "shopify", "woocommerce", "generic" ] }, "productUrl": { "type": [ "string", "null" ] }, "status": { "type": "string", "enum": [ "unknown", "ok", "failing", "paused" ] }, "lastCheckedAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] }, "checkIntervalMinutes": { "type": "integer", "minimum": 0, "maximum": 9007199254740991, "description": "From the plan: 60 (Starter) or 30 (Growth, Agency); 0 when paused or unplanned." }, "uptime30d": { "description": "Percent of passed checks in the last 30 days.", "type": [ "number", "null" ] }, "flows": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "openIncident": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string" }, "storeId": { "type": "string" }, "step": { "type": "string" }, "error": { "type": "string" }, "status": { "type": "string", "enum": [ "open", "resolved" ] }, "openedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "confirmedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "closedAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] }, "durationMs": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "failedRuns": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "lastStep": { "type": "string" }, "lastError": { "type": "string" }, "screenshotUrl": { "type": [ "string", "null" ] } }, "required": [ "id", "storeId", "step", "error", "status", "openedAt", "confirmedAt", "closedAt", "durationMs", "failedRuns", "lastStep", "lastError", "screenshotUrl" ], "additionalProperties": false, "description": "An incident: a step that failed at least twice in a row, until it recovered." }, { "type": "null" } ] }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" } }, "required": [ "id", "name", "url", "flowType", "productUrl", "status", "lastCheckedAt", "checkIntervalMinutes", "uptime30d", "flows", "openIncident", "createdAt" ], "additionalProperties": false, "description": "A monitored store." }, "StoreResults": { "type": "object", "properties": { "store": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "url": { "type": "string" }, "flowType": { "type": "string", "enum": [ "shopify", "woocommerce", "generic" ] }, "productUrl": { "type": [ "string", "null" ] }, "status": { "type": "string", "enum": [ "unknown", "ok", "failing", "paused" ] }, "lastCheckedAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] }, "checkIntervalMinutes": { "type": "integer", "minimum": 0, "maximum": 9007199254740991, "description": "From the plan: 60 (Starter) or 30 (Growth, Agency); 0 when paused or unplanned." }, "uptime30d": { "description": "Percent of passed checks in the last 30 days.", "type": [ "number", "null" ] }, "flows": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "openIncident": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string" }, "storeId": { "type": "string" }, "step": { "type": "string" }, "error": { "type": "string" }, "status": { "type": "string", "enum": [ "open", "resolved" ] }, "openedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "confirmedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "closedAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] }, "durationMs": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "failedRuns": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "lastStep": { "type": "string" }, "lastError": { "type": "string" }, "screenshotUrl": { "type": [ "string", "null" ] } }, "required": [ "id", "storeId", "step", "error", "status", "openedAt", "confirmedAt", "closedAt", "durationMs", "failedRuns", "lastStep", "lastError", "screenshotUrl" ], "additionalProperties": false, "description": "An incident: a step that failed at least twice in a row, until it recovered." }, { "type": "null" } ] }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" } }, "required": [ "id", "name", "url", "flowType", "productUrl", "status", "lastCheckedAt", "checkIntervalMinutes", "uptime30d", "flows", "openIncident", "createdAt" ], "additionalProperties": false, "description": "A monitored store." }, "results": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "storeId": { "type": [ "string", "null" ] }, "kind": { "type": "string", "enum": [ "scheduled", "on_demand", "instant" ] }, "flowType": { "type": "string", "enum": [ "shopify", "woocommerce", "generic" ] }, "storeUrl": { "type": "string" }, "ok": { "type": "boolean" }, "stoppedAt": { "type": "string", "enum": [ "checkout", "cart", "failed" ], "description": "`cart` means checkout could not be verified because of a bot challenge." }, "failedStep": { "type": [ "string", "null" ] }, "error": { "type": [ "string", "null" ] }, "summary": { "type": "string", "description": "e.g. \"checked at 14:05 UTC, step Checkout page failed with HTTP 500\"." }, "startedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "finishedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "totalMs": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "steps": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "ok": { "type": "boolean" }, "ms": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "error": { "type": "string" }, "status": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "url": { "type": "string" }, "skipped": { "description": "True when the checkout page answered with a bot challenge and the step was not verified.", "type": "boolean" }, "note": { "type": "string" }, "screenshotUrl": { "description": "Screenshot of the failing step, when the step failed.", "type": [ "string", "null" ] } }, "required": [ "name", "ok", "ms" ], "additionalProperties": false, "description": "One step of the walk." } }, "checks": { "type": "object", "properties": { "httpStatus": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "ttfbMs": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "Time to first byte of the store URL, milliseconds." }, "sslDaysLeft": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "themeFingerprint": { "description": "Hash of the theme’s stylesheet/script names; changes when the theme changes.", "type": [ "string", "null" ] }, "themeName": { "type": [ "string", "null" ] }, "checkoutChallenged": { "type": "boolean" } }, "required": [ "httpStatus", "ttfbMs", "sslDaysLeft", "themeFingerprint", "themeName", "checkoutChallenged" ], "additionalProperties": false, "description": "Plain-HTTP checks run alongside the walk." }, "screenshotUrl": { "type": [ "string", "null" ] } }, "required": [ "id", "storeId", "kind", "flowType", "storeUrl", "ok", "stoppedAt", "failedStep", "error", "summary", "startedAt", "finishedAt", "totalMs", "steps", "checks", "screenshotUrl" ], "additionalProperties": false, "description": "The result of one store check." }, "description": "Newest first, at most 48." }, "timeline": { "type": "array", "items": { "type": "object", "properties": { "at": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "state": { "type": "string", "enum": [ "ok", "partial", "failed", "empty" ] }, "runs": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "failed": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "error": { "type": [ "string", "null" ] } }, "required": [ "at", "state", "runs", "failed", "error" ], "additionalProperties": false }, "description": "48 schedule slots, oldest first." }, "incidents": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "storeId": { "type": "string" }, "step": { "type": "string" }, "error": { "type": "string" }, "status": { "type": "string", "enum": [ "open", "resolved" ] }, "openedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "confirmedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "closedAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] }, "durationMs": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "failedRuns": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "lastStep": { "type": "string" }, "lastError": { "type": "string" }, "screenshotUrl": { "type": [ "string", "null" ] } }, "required": [ "id", "storeId", "step", "error", "status", "openedAt", "confirmedAt", "closedAt", "durationMs", "failedRuns", "lastStep", "lastError", "screenshotUrl" ], "additionalProperties": false, "description": "An incident: a step that failed at least twice in a row, until it recovered." }, "description": "Newest first." } }, "required": [ "store", "results", "timeline", "incidents" ], "additionalProperties": false, "description": "A store with its last 48 results." }, "CreateStoreInput": { "type": "object", "properties": { "name": { "description": "Display name (default: the host).", "type": "string", "minLength": 1, "maxLength": 80 }, "storeUrl": { "type": "string", "minLength": 1, "maxLength": 2048 }, "productUrl": { "type": "string", "minLength": 1, "maxLength": 2048 }, "flowType": { "type": "string", "enum": [ "auto", "shopify", "woocommerce" ], "description": "Which buy path to walk. `auto` (default) detects Shopify or WooCommerce from the store’s HTML." } }, "required": [ "storeUrl" ], "description": "Input for adding a store to the schedule." }, "UpdateStoreInput": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 80 }, "paused": { "type": "boolean" } }, "description": "Fields of a store that can be changed." }, "AlertSettings": { "type": "object", "properties": { "email": { "anyOf": [ { "type": "string", "format": "email", "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$" }, { "type": "null" } ], "description": "Where incident emails go (default: the account email)." }, "emailEnabled": { "type": "boolean" }, "slackWebhookUrl": { "description": "A Slack incoming webhook URL (https://hooks.slack.com/services/…).", "type": [ "string", "null" ] }, "smsNumber": { "description": "E.164 number, e.g. +15551234567.", "type": [ "string", "null" ] }, "dailyDigest": { "type": "boolean" } }, "required": [ "email", "emailEnabled", "slackWebhookUrl", "smsNumber", "dailyDigest" ], "additionalProperties": false, "description": "Where alerts are sent." }, "AlertSettingsInput": { "type": "object", "properties": { "email": { "anyOf": [ { "type": "string", "format": "email", "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$" }, { "type": "null" } ] }, "emailEnabled": { "type": "boolean" }, "slackWebhookUrl": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ] }, "smsNumber": { "anyOf": [ { "type": "string", "maxLength": 20 }, { "type": "null" } ] }, "dailyDigest": { "type": "boolean" } }, "description": "Alert settings to change." }, "UsageMeter": { "type": "object", "properties": { "used": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "limit": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "remaining": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "percent": { "type": "integer", "minimum": 0, "maximum": 100 }, "exhausted": { "type": "boolean" }, "period": { "type": "object", "properties": { "start": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "end": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" } }, "required": [ "start", "end" ], "additionalProperties": false }, "bySource": { "type": "object", "properties": { "human": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "agent": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "api": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "human", "agent", "api" ], "additionalProperties": false } }, "required": [ "used", "limit", "remaining", "percent", "exhausted", "period", "bySource" ], "additionalProperties": false, "description": "On-demand checks used in the current calendar month (UTC) against the plan limit, split by door." }, "Account": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "email": { "type": "string", "format": "email", "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$" }, "plan": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false, "description": "The free tier has id \"free\"." }, "limits": { "type": "object", "properties": { "resultsPerMonth": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "apiKeys": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "seats": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "stores": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "flowsPerStore": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "checkIntervalMinutes": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "resultsPerMonth", "apiKeys", "seats", "stores", "flowsPerStore", "checkIntervalMinutes" ], "additionalProperties": false }, "subscription": { "anyOf": [ { "type": "object", "properties": { "status": { "type": "string" }, "interval": { "type": "string", "enum": [ "monthly", "annual" ] }, "currentPeriodEnd": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] }, "cancelAtPeriodEnd": { "type": "boolean" } }, "required": [ "status", "interval", "currentPeriodEnd", "cancelAtPeriodEnd" ], "additionalProperties": false }, { "type": "null" } ] } }, "required": [ "id", "email", "plan", "limits", "subscription" ], "additionalProperties": false, "description": "The calling account." }, "ApiKeySummary": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "prefix": { "type": "string", "description": "First characters of the key, for recognising it. The full key is only returned once, on creation." }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "lastUsedAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] }, "revokedAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] } }, "required": [ "id", "name", "prefix", "createdAt", "lastUsedAt", "revokedAt" ], "additionalProperties": false, "description": "An API key without its secret." }, "CreateApiKeyInput": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 60, "description": "A label such as \"CI\" or \"Claude Desktop\"." } }, "required": [ "name" ], "description": "Input for creating an API key." }, "CreateApiKeyResponse": { "type": "object", "properties": { "key": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "prefix": { "type": "string", "description": "First characters of the key, for recognising it. The full key is only returned once, on creation." }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "lastUsedAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] }, "revokedAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] } }, "required": [ "id", "name", "prefix", "createdAt", "lastUsedAt", "revokedAt" ], "additionalProperties": false, "description": "An API key without its secret." }, "secret": { "type": "string", "description": "The full API key. Shown once; store it now." } }, "required": [ "key", "secret" ], "additionalProperties": false, "description": "A freshly created API key." }, "Error": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "unauthorized", "forbidden", "not_found", "invalid_input", "quota_exhausted", "rate_limited", "payment_required", "not_open", "internal" ] }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "error" ], "additionalProperties": false, "description": "Error envelope returned with every non-2xx status." } } } }