{"openapi":"3.1.0","info":{"title":"Cometly API","version":"1.0.0","summary":"Branded short links, QR codes, domains and conversion tracking.","description":"Authenticate with `Authorization: Bearer cmt_live_…`. Errors are RFC 9457 problem details (`application/problem+json`). The HTML reference is at /docs.","contact":{"name":"Cometly support","url":"https://app.cometly.site"}},"servers":[{"url":"https://api.cometly.site"}],"tags":[{"name":"Account","description":"Who you are, your plan, limits and usage."},{"name":"Links","description":"Create, list, edit, pause, delete and restore short links. Deleted links can be restored for 30 days; their slugs are then quarantined for 30 more days so old posts can’t reach a new page."},{"name":"Link builders & deep links","description":"Build WhatsApp, UPI, Google Maps, Telegram and app-store links from plain fields, and see which apps open automatically."},{"name":"QR codes","description":"Branded QR codes for any link. Every saved design is rendered and decoded before it’s accepted, and scans are counted separately from clicks (`clicks.qr_scans`)."},{"name":"A/B tests","description":"Split traffic between destinations and pick a winner on conversions (Bayesian chance to win, with a sample-ratio check)."},{"name":"Link health & traffic quality","description":"Broken-destination monitoring and the bot/fraud breakdown of a link’s clicks."},{"name":"Link safety","description":"Every destination and redirect hop is checked against phishing/malware feeds, Google Safe Browsing and heuristics. Malicious destinations are refused (`422 destination-blocked`) or disabled."},{"name":"Conversions & integrations","description":"Report leads and sales against a click (`cmt_id`) and forward them to Meta Conversions API and GA4."},{"name":"Domains","description":"Bring your own (sub)domain. Add it, create the DNS records shown, then verify. HTTPS is issued automatically."},{"name":"Domain reputation","description":"Is your short domain blocked on Facebook/Instagram, by Chrome/Gmail, on email blocklists or by security vendors? Checked daily and on demand."},{"name":"Team","description":"Invite people to your workspace with a role: `owner`, `admin`, `member` or `viewer`."},{"name":"API keys & jobs","description":"Create scoped keys (optionally limited to some domains) and poll long-running jobs."},{"name":"Dashboard sign-in","description":"Cookie sessions used by the dashboard (app.cometly.site). Writes need the `X-CSRF-Token` from `/auth/me`. Integrations should use API keys instead."},{"name":"Master panel (platform staff)","description":"Platform-owner endpoints. Require a staff account with 2FA proven in this session; others get 404."},{"name":"Public & short-domain endpoints","description":"Served on api.cometly.site without a key, or on every short domain."}],"paths":{"/v1/me":{"get":{"operationId":"get_v1_me","summary":"Get your workspace, plan and usage","tags":["Account"],"security":[{"apiKey":["account:read"]},{"session":[]}],"responses":{"200":{"description":"OK","content":{"application/json":{"example":{"workspace":{"id":"ws_tg5pvg2u7mwj","name":"Kesari Foods","status":"active","default_domain_id":"dom_kd292xv8n8tg"},"plan":{"id":"pro","name":"Pro"},"limits":{"max_domains":10,"max_links_month":50000,"api_rate_limit":600},"usage":{"domains":2,"links_this_month":318},"credits":{"balance":4820},"api_key":{"id":"key_wnvafcpj2ppr","scopes":["links:read","links:write"],"allowed_domains":null},"member":null}}}},"401":{"description":"`unauthorized` — Missing or invalid API key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"`insufficient-scope` — Key lacks `account:read`","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-scope":"account:read"}},"/v1/links":{"post":{"operationId":"post_v1_links","summary":"Create a link","tags":["Links"],"description":"Send `Idempotency-Key` to retry safely. The response carries an `ETag` for conditional updates. Destinations are safety-checked before anything is saved.","parameters":[{"name":"Idempotency-Key","in":"header","required":false,"schema":{"type":"string"},"description":"Up to 255 chars; replays return the first response for 24 h."}],"security":[{"apiKey":["links:write"]},{"session":[]}],"responses":{"201":{"description":"Created","content":{"application/json":{"example":{"id":"lnk_594ufv74rqre","short_url":"https://go.kesari.shop/diwali","qr_url":"https://api.cometly.site/v1/links/lnk_594ufv74rqre/qr","domain":"go.kesari.shop","slug":"diwali","destination":"https://kesari.shop/diwali?utm_source=instagram&utm_medium=paid&utm_campaign=diwali26","title":"Diwali sale","tags":["instagram"],"utm":{"source":"instagram","medium":"paid","campaign":"diwali26"},"preview":null,"rules":[{"if":{"device":"ios"},"url":"https://apps.apple.com/in/app/kesari/id123"}],"has_password":false,"expires_at":null,"max_clicks":null,"status":"active","disabled_reason":null,"metadata":{},"type":"url","deep_link":{"mode":"off"},"ab_test":null,"conversion_tracking":true,"fallback_url":"https://kesari.shop/","health":{"state":"unknown"},"clicks":{"total":0,"last_24h":0,"suspicious":0,"filtered":0,"qr_scans":0},"safety":{"verdict":"clean","review":null,"reasons":[],"checked_at":"2026-11-03T10:02:10.000Z"},"conversions":{"total":0,"value":0},"etag":"vsd7hv73x8s672m3","created_at":"2026-11-03T10:23:30.000Z","updated_at":"2026-11-03T10:23:30.000Z"}}}},"401":{"description":"`unauthorized` — Missing or invalid API key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"402":{"description":"`link-limit-reached` — Monthly link limit for your plan","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"`insufficient-scope` — Key lacks `links:write`","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"`slug-taken` — The slug is used on that domain\n\n`slug-quarantined` — The slug belonged to a deleted link in the last 30 days","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"422":{"description":"`destination-blocked` — Destination is phishing/malware\n\n`validation-error` — Invalid fields (see `errors`)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-scope":"links:write","requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string","description":"Destination (http/https). Required unless `builder` is used. UTM fields are merged into it."},"domain":{"type":"string","description":"Short domain hostname. Default: the workspace default, else the shared domain."},"slug":{"type":"string","description":"1–60 chars `a-z 0-9 - _`, case-insensitive. Omit for a generated one."},"builder":{"type":"object","description":"Instead of `url`: `{type: \"whatsapp\"|\"upi\"|\"maps\"|\"telegram\"|\"app\", …}` — see Link builders."},"title":{"type":"string","description":"Up to 200 chars, for your own reference."},"tags":{"type":"array","items":{"type":"string"},"description":"Up to 20 tags of ≤ 50 chars."},"utm":{"type":"object","description":"`{source, medium, campaign, term, content}` added to the destination and rule URLs."},"rules":{"type":"array","items":{"type":"object"},"description":"Up to 20 `{if: {device|country|language|city}, url}`; first match wins. Devices: `ios`, `android`, `mobile`, `desktop`."},"deep_link":{"type":"object","description":"`{mode: \"auto\"|\"custom\"|\"off\", ios_url, android_package, escape_in_app}` — open the app instead of the browser."},"ab_test":{"type":"object","description":"`{variants: [{url, weight}…2–4], ends_at, auto_winner, threshold}`. The first variant is the control; weights sum to 100."},"conversion_tracking":{"type":"boolean","description":"Adds `cmt_id=<click id>` to the destination so you can report conversions."},"fallback_url":{"type":"string","description":"Served automatically while the destination is down."},"preview":{"type":"object","description":"`{title, description, image_url}` shown by WhatsApp/Facebook/LinkedIn crawlers."},"password":{"type":"string","description":"4–128 chars; visitors must enter it."},"expires_at":{"type":"string","format":"date-time","description":"Link stops working after this time."},"max_clicks":{"type":"integer","description":"Link stops after this many clicks."},"metadata":{"type":"object","description":"Your own JSON (≤ 4 KB), returned and sent in webhooks."}}},"example":{"url":"https://kesari.shop/diwali","domain":"go.kesari.shop","slug":"diwali","title":"Diwali sale","tags":["instagram"],"utm":{"source":"instagram","medium":"paid","campaign":"diwali26"},"rules":[{"if":{"device":"ios"},"url":"https://apps.apple.com/in/app/kesari/id123"}],"conversion_tracking":true,"fallback_url":"https://kesari.shop/"}}}}},"get":{"operationId":"get_v1_links","summary":"List links","tags":["Links"],"parameters":[{"name":"status","in":"query","required":false,"schema":{"type":"string"},"description":"`active`, `expired`, `disabled` or `deleted` (default: all but deleted)"},{"name":"domain","in":"query","required":false,"schema":{"type":"string"},"description":"Only links on this hostname"},{"name":"tag","in":"query","required":false,"schema":{"type":"string"},"description":"Only links with this tag"},{"name":"q","in":"query","required":false,"schema":{"type":"string"},"description":"Search slug, title and destination"},{"name":"sort","in":"query","required":false,"schema":{"type":"string"},"description":"`created_at` for oldest first (default newest first)"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer"},"description":"1–100, default 50"},{"name":"cursor","in":"query","required":false,"schema":{"type":"string"},"description":"Opaque cursor from the previous page’s `next_cursor`"}],"security":[{"apiKey":["links:read"]},{"session":[]}],"responses":{"200":{"description":"OK","content":{"application/json":{"example":{"data":[{"id":"lnk_594ufv74rqre","short_url":"https://go.kesari.shop/diwali","qr_url":"https://api.cometly.site/v1/links/lnk_594ufv74rqre/qr","domain":"go.kesari.shop","slug":"diwali","destination":"https://kesari.shop/diwali?utm_source=instagram&utm_medium=paid&utm_campaign=diwali26","title":"Diwali sale","tags":["instagram"],"utm":{"source":"instagram","medium":"paid","campaign":"diwali26"},"preview":null,"rules":[{"if":{"device":"ios"},"url":"https://apps.apple.com/in/app/kesari/id123"}],"has_password":false,"expires_at":null,"max_clicks":null,"status":"active","disabled_reason":null,"metadata":{},"type":"url","deep_link":{"mode":"off"},"ab_test":null,"conversion_tracking":true,"fallback_url":"https://kesari.shop/","health":{"state":"unknown"},"clicks":{"total":0,"last_24h":0,"suspicious":0,"filtered":0,"qr_scans":0},"safety":{"verdict":"clean","review":null,"reasons":[],"checked_at":"2026-11-03T10:02:10.000Z"},"conversions":{"total":0,"value":0},"etag":"vsd7hv73x8s672m3","created_at":"2026-11-03T10:23:30.000Z","updated_at":"2026-11-03T10:23:30.000Z"}],"next_cursor":"MjAyNi0xMS0wM1QxMDoyMzozMC4wMDBafGxua181OTR1Znw"}}}},"401":{"description":"`unauthorized` — Missing or invalid API key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"`insufficient-scope` — Key lacks `links:read`","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-scope":"links:read"}},"/v1/links/bulk":{"post":{"operationId":"post_v1_links_bulk","summary":"Create up to 1,000 links","tags":["Links"],"description":"Each item is validated and created independently; the response lists a result per index.","security":[{"apiKey":["links:write"]},{"session":[]}],"responses":{"200":{"description":"OK","content":{"application/json":{"example":{"results":[{"index":0,"ok":true,"link":{"id":"lnk_nzuj43fupycy","short_url":"https://s.cometly.site/8uyuxe"}},{"index":1,"ok":false,"error":{"type":"validation-error","title":"Unprocessable Entity","status":422,"detail":"Request validation failed","errors":[{"field":"url","message":"Only http and https URLs are allowed, not javascript"}]}}],"created":1,"failed":1}}}},"401":{"description":"`unauthorized` — Missing or invalid API key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"`insufficient-scope` — Key lacks `links:write`","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"422":{"description":"`validation-error` — Invalid fields (see `errors`)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-scope":"links:write","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"links":{"type":"array","items":{"type":"object"},"description":"Same fields as Create a link."}},"required":["links"]},"example":{"links":[{"url":"https://kesari.shop/a"},{"url":"javascript:alert(1)"}]}}}}}},"/v1/links/by-url":{"get":{"operationId":"get_v1_links_by_url","summary":"Look up a link by its short URL","tags":["Links"],"parameters":[{"name":"short_url","in":"query","required":false,"schema":{"type":"string"},"description":"e.g. https://go.kesari.shop/diwali"},{"name":"domain","in":"query","required":false,"schema":{"type":"string"},"description":"Instead of short_url, with slug"},{"name":"slug","in":"query","required":false,"schema":{"type":"string"},"description":"With domain"}],"security":[{"apiKey":["links:read"]},{"session":[]}],"responses":{"200":{"description":"OK","content":{"application/json":{"example":{"id":"lnk_594ufv74rqre","short_url":"https://go.kesari.shop/diwali","qr_url":"https://api.cometly.site/v1/links/lnk_594ufv74rqre/qr","domain":"go.kesari.shop","slug":"diwali","destination":"https://kesari.shop/diwali?utm_source=instagram&utm_medium=paid&utm_campaign=diwali26","title":"Diwali sale","tags":["instagram"],"utm":{"source":"instagram","medium":"paid","campaign":"diwali26"},"preview":null,"rules":[{"if":{"device":"ios"},"url":"https://apps.apple.com/in/app/kesari/id123"}],"has_password":false,"expires_at":null,"max_clicks":null,"status":"active","disabled_reason":null,"metadata":{},"type":"url","deep_link":{"mode":"off"},"ab_test":null,"conversion_tracking":true,"fallback_url":"https://kesari.shop/","health":{"state":"unknown"},"clicks":{"total":0,"last_24h":0,"suspicious":0,"filtered":0,"qr_scans":0},"safety":{"verdict":"clean","review":null,"reasons":[],"checked_at":"2026-11-03T10:02:10.000Z"},"conversions":{"total":0,"value":0},"etag":"vsd7hv73x8s672m3","created_at":"2026-11-03T10:23:30.000Z","updated_at":"2026-11-03T10:23:30.000Z"}}}},"401":{"description":"`unauthorized` — Missing or invalid API key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"`insufficient-scope` — Key lacks `links:read`","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-scope":"links:read"}},"/v1/links/{id}":{"get":{"operationId":"get_v1_links_by_id","summary":"Get a link","tags":["Links"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"},"description":"Link ID"}],"security":[{"apiKey":["links:read"]},{"session":[]}],"responses":{"200":{"description":"OK","content":{"application/json":{"example":{"id":"lnk_594ufv74rqre","short_url":"https://go.kesari.shop/diwali","qr_url":"https://api.cometly.site/v1/links/lnk_594ufv74rqre/qr","domain":"go.kesari.shop","slug":"diwali","destination":"https://kesari.shop/diwali?utm_source=instagram&utm_medium=paid&utm_campaign=diwali26","title":"Diwali sale","tags":["instagram"],"utm":{"source":"instagram","medium":"paid","campaign":"diwali26"},"preview":null,"rules":[{"if":{"device":"ios"},"url":"https://apps.apple.com/in/app/kesari/id123"}],"has_password":false,"expires_at":null,"max_clicks":null,"status":"active","disabled_reason":null,"metadata":{},"type":"url","deep_link":{"mode":"off"},"ab_test":null,"conversion_tracking":true,"fallback_url":"https://kesari.shop/","health":{"state":"unknown"},"clicks":{"total":0,"last_24h":0,"suspicious":0,"filtered":0,"qr_scans":0},"safety":{"verdict":"clean","review":null,"reasons":[],"checked_at":"2026-11-03T10:02:10.000Z"},"conversions":{"total":0,"value":0},"etag":"vsd7hv73x8s672m3","created_at":"2026-11-03T10:23:30.000Z","updated_at":"2026-11-03T10:23:30.000Z"}}}},"401":{"description":"`unauthorized` — Missing or invalid API key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"`insufficient-scope` — Key lacks `links:read`","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-scope":"links:read"},"patch":{"operationId":"patch_v1_links_by_id","summary":"Update a link","tags":["Links"],"description":"Send only the fields to change. Use `If-Match: \"<etag>\"` to avoid overwriting someone else’s edit (412 on mismatch). Changing the slug quarantines the old one for 30 days.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"},"description":"Link ID"},{"name":"If-Match","in":"header","required":false,"schema":{"type":"string"},"description":"ETag from a previous read"}],"security":[{"apiKey":["links:write"]},{"session":[]}],"responses":{"200":{"description":"OK","content":{"application/json":{"example":{"id":"lnk_594ufv74rqre","short_url":"https://go.kesari.shop/diwali","qr_url":"https://api.cometly.site/v1/links/lnk_594ufv74rqre/qr","domain":"go.kesari.shop","slug":"diwali","destination":"https://kesari.shop/diwali?utm_source=instagram&utm_medium=paid&utm_campaign=diwali26","title":"Diwali sale – Instagram","tags":["instagram"],"utm":{"source":"instagram","medium":"paid","campaign":"diwali26"},"preview":null,"rules":[{"if":{"device":"ios"},"url":"https://apps.apple.com/in/app/kesari/id123"}],"has_password":false,"expires_at":null,"max_clicks":null,"status":"active","disabled_reason":null,"metadata":{},"type":"url","deep_link":{"mode":"off"},"ab_test":null,"conversion_tracking":true,"fallback_url":"https://kesari.shop/","health":{"state":"unknown"},"clicks":{"total":0,"last_24h":0,"suspicious":0,"filtered":0,"qr_scans":0},"safety":{"verdict":"clean","review":null,"reasons":[],"checked_at":"2026-11-03T10:02:10.000Z"},"conversions":{"total":0,"value":0},"etag":"vsd7hv73x8s672m3","created_at":"2026-11-03T10:23:30.000Z","updated_at":"2026-11-03T10:23:30.000Z"}}}},"401":{"description":"`unauthorized` — Missing or invalid API key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"`insufficient-scope` — Key lacks `links:write`","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"412":{"description":"`etag-mismatch` — The link changed since you read it","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"422":{"description":"`validation-error` — Invalid fields (see `errors`)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-scope":"links:write","requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string","description":"Destination (http/https). Required unless `builder` is used. UTM fields are merged into it."},"slug":{"type":"string","description":"1–60 chars `a-z 0-9 - _`, case-insensitive. Omit for a generated one."},"title":{"type":"string","description":"Up to 200 chars, for your own reference."},"tags":{"type":"array","items":{"type":"string"},"description":"Up to 20 tags of ≤ 50 chars."},"utm":{"type":"object","description":"`{source, medium, campaign, term, content}` added to the destination and rule URLs."},"rules":{"type":"array","items":{"type":"object"},"description":"Up to 20 `{if: {device|country|language|city}, url}`; first match wins. Devices: `ios`, `android`, `mobile`, `desktop`."},"deep_link":{"type":"object","description":"`{mode: \"auto\"|\"custom\"|\"off\", ios_url, android_package, escape_in_app}` — open the app instead of the browser."},"ab_test":{"type":"object","description":"`{variants: [{url, weight}…2–4], ends_at, auto_winner, threshold}`. The first variant is the control; weights sum to 100."},"conversion_tracking":{"type":"boolean","description":"Adds `cmt_id=<click id>` to the destination so you can report conversions."},"fallback_url":{"type":"string","description":"Served automatically while the destination is down."},"preview":{"type":"object","description":"`{title, description, image_url}` shown by WhatsApp/Facebook/LinkedIn crawlers."},"password":{"type":"string","description":"4–128 chars; visitors must enter it."},"expires_at":{"type":"string","format":"date-time","description":"Link stops working after this time."},"max_clicks":{"type":"integer","description":"Link stops after this many clicks."},"metadata":{"type":"object","description":"Your own JSON (≤ 4 KB), returned and sent in webhooks."}}},"example":{"title":"Diwali sale – Instagram","expires_at":"2026-11-15T23:59:00+05:30"}}}}},"delete":{"operationId":"delete_v1_links_by_id","summary":"Delete a link","tags":["Links"],"description":"Soft delete: the link stops redirecting and can be restored for 30 days. `purge=true` deletes it permanently now.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"},"description":"Link ID"},{"name":"purge","in":"query","required":false,"schema":{"type":"boolean"},"description":"Delete permanently"}],"security":[{"apiKey":["links:delete"]},{"session":[]}],"responses":{"202":{"description":"Accepted","content":{"application/json":{"example":{"id":"lnk_594ufv74rqre","short_url":"https://go.kesari.shop/diwali","qr_url":"https://api.cometly.site/v1/links/lnk_594ufv74rqre/qr","domain":"go.kesari.shop","slug":"diwali","destination":"https://kesari.shop/diwali?utm_source=instagram&utm_medium=paid&utm_campaign=diwali26","title":"Diwali sale","tags":["instagram"],"utm":{"source":"instagram","medium":"paid","campaign":"diwali26"},"preview":null,"rules":[{"if":{"device":"ios"},"url":"https://apps.apple.com/in/app/kesari/id123"}],"has_password":false,"expires_at":null,"max_clicks":null,"status":"deleted","disabled_reason":null,"metadata":{},"type":"url","deep_link":{"mode":"off"},"ab_test":null,"conversion_tracking":true,"fallback_url":"https://kesari.shop/","health":{"state":"unknown"},"clicks":{"total":0,"last_24h":0,"suspicious":0,"filtered":0,"qr_scans":0},"safety":{"verdict":"clean","review":null,"reasons":[],"checked_at":"2026-11-03T10:02:10.000Z"},"conversions":{"total":0,"value":0},"etag":"vsd7hv73x8s672m3","created_at":"2026-11-03T10:23:30.000Z","updated_at":"2026-11-03T10:23:30.000Z","deleted_at":"2026-11-03T10:30:00.000Z","purge_at":"2026-12-03T10:30:00.000Z"}}}},"401":{"description":"`unauthorized` — Missing or invalid API key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"`insufficient-scope` — Key lacks `links:delete`","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-scope":"links:delete"}},"/v1/links/{id}/disable":{"post":{"operationId":"post_v1_links_by_id_disable","summary":"Pause a link","tags":["Links"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"},"description":"Link ID"}],"security":[{"apiKey":["links:write"]},{"session":[]}],"responses":{"200":{"description":"OK","content":{"application/json":{"example":{"id":"lnk_594ufv74rqre","short_url":"https://go.kesari.shop/diwali","qr_url":"https://api.cometly.site/v1/links/lnk_594ufv74rqre/qr","domain":"go.kesari.shop","slug":"diwali","destination":"https://kesari.shop/diwali?utm_source=instagram&utm_medium=paid&utm_campaign=diwali26","title":"Diwali sale","tags":["instagram"],"utm":{"source":"instagram","medium":"paid","campaign":"diwali26"},"preview":null,"rules":[{"if":{"device":"ios"},"url":"https://apps.apple.com/in/app/kesari/id123"}],"has_password":false,"expires_at":null,"max_clicks":null,"status":"disabled","disabled_reason":"user","metadata":{},"type":"url","deep_link":{"mode":"off"},"ab_test":null,"conversion_tracking":true,"fallback_url":"https://kesari.shop/","health":{"state":"unknown"},"clicks":{"total":0,"last_24h":0,"suspicious":0,"filtered":0,"qr_scans":0},"safety":{"verdict":"clean","review":null,"reasons":[],"checked_at":"2026-11-03T10:02:10.000Z"},"conversions":{"total":0,"value":0},"etag":"vsd7hv73x8s672m3","created_at":"2026-11-03T10:23:30.000Z","updated_at":"2026-11-03T10:23:30.000Z"}}}},"401":{"description":"`unauthorized` — Missing or invalid API key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"`insufficient-scope` — Key lacks `links:write`","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-scope":"links:write"}},"/v1/links/{id}/enable":{"post":{"operationId":"post_v1_links_by_id_enable","summary":"Resume a paused link","tags":["Links"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"},"description":"Link ID"}],"security":[{"apiKey":["links:write"]},{"session":[]}],"responses":{"200":{"description":"OK","content":{"application/json":{"example":{"id":"lnk_594ufv74rqre","short_url":"https://go.kesari.shop/diwali","qr_url":"https://api.cometly.site/v1/links/lnk_594ufv74rqre/qr","domain":"go.kesari.shop","slug":"diwali","destination":"https://kesari.shop/diwali?utm_source=instagram&utm_medium=paid&utm_campaign=diwali26","title":"Diwali sale","tags":["instagram"],"utm":{"source":"instagram","medium":"paid","campaign":"diwali26"},"preview":null,"rules":[{"if":{"device":"ios"},"url":"https://apps.apple.com/in/app/kesari/id123"}],"has_password":false,"expires_at":null,"max_clicks":null,"status":"active","disabled_reason":null,"metadata":{},"type":"url","deep_link":{"mode":"off"},"ab_test":null,"conversion_tracking":true,"fallback_url":"https://kesari.shop/","health":{"state":"unknown"},"clicks":{"total":0,"last_24h":0,"suspicious":0,"filtered":0,"qr_scans":0},"safety":{"verdict":"clean","review":null,"reasons":[],"checked_at":"2026-11-03T10:02:10.000Z"},"conversions":{"total":0,"value":0},"etag":"vsd7hv73x8s672m3","created_at":"2026-11-03T10:23:30.000Z","updated_at":"2026-11-03T10:23:30.000Z"}}}},"401":{"description":"`unauthorized` — Missing or invalid API key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"`insufficient-scope` — Key lacks `links:write`","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"`link-locked` — Disabled for abuse or domain deletion","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-scope":"links:write"}},"/v1/links/{id}/restore":{"post":{"operationId":"post_v1_links_by_id_restore","summary":"Restore a deleted link","tags":["Links"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"},"description":"Link ID"}],"security":[{"apiKey":["links:write"]},{"session":[]}],"responses":{"200":{"description":"OK","content":{"application/json":{"example":{"id":"lnk_594ufv74rqre","short_url":"https://go.kesari.shop/diwali","qr_url":"https://api.cometly.site/v1/links/lnk_594ufv74rqre/qr","domain":"go.kesari.shop","slug":"diwali","destination":"https://kesari.shop/diwali?utm_source=instagram&utm_medium=paid&utm_campaign=diwali26","title":"Diwali sale","tags":["instagram"],"utm":{"source":"instagram","medium":"paid","campaign":"diwali26"},"preview":null,"rules":[{"if":{"device":"ios"},"url":"https://apps.apple.com/in/app/kesari/id123"}],"has_password":false,"expires_at":null,"max_clicks":null,"status":"active","disabled_reason":null,"metadata":{},"type":"url","deep_link":{"mode":"off"},"ab_test":null,"conversion_tracking":true,"fallback_url":"https://kesari.shop/","health":{"state":"unknown"},"clicks":{"total":0,"last_24h":0,"suspicious":0,"filtered":0,"qr_scans":0},"safety":{"verdict":"clean","review":null,"reasons":[],"checked_at":"2026-11-03T10:02:10.000Z"},"conversions":{"total":0,"value":0},"etag":"vsd7hv73x8s672m3","created_at":"2026-11-03T10:23:30.000Z","updated_at":"2026-11-03T10:23:30.000Z"}}}},"401":{"description":"`unauthorized` — Missing or invalid API key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"`insufficient-scope` — Key lacks `links:write`","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-scope":"links:write"}},"/v1/slug-quarantine/release":{"post":{"operationId":"post_v1_slug_quarantine_release","summary":"Release a quarantined slug early","tags":["Links"],"security":[{"apiKey":["links:write"]},{"session":[]}],"responses":{"200":{"description":"OK","content":{"application/json":{"example":{"released":true,"domain":"go.kesari.shop","slug":"old-offer"}}}},"401":{"description":"`unauthorized` — Missing or invalid API key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"`insufficient-scope` — Key lacks `links:write`","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"422":{"description":"`validation-error` — Invalid fields (see `errors`)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-scope":"links:write","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"domain":{"type":"string","description":"Hostname"},"slug":{"type":"string","description":"The slug to free"}},"required":["domain","slug"]},"example":{"domain":"go.kesari.shop","slug":"old-offer"}}}}}},"/v1/builders/{type}":{"post":{"operationId":"post_v1_builders_by_type","summary":"Preview a WhatsApp, UPI, Maps, Telegram or app-store link","tags":["Link builders & deep links"],"description":"Returns the built URL and a ready `link_request` to POST to /v1/links. Fields by type — whatsapp: `phone`, `text`, `country` (default IN). upi: `pa` (VPA), `pn` (payee), `am`, `tn`, `tr`, `mc`. maps: `mode` (search|directions|review), `query`, `place_id`. telegram: `username`, `start`. app: `ios_url`, `android_url`, `web_url`.","parameters":[{"name":"type","in":"path","required":true,"schema":{"type":"string"},"description":"`whatsapp`, `upi`, `maps`, `telegram` or `app`"}],"security":[{"apiKey":["links:write"]},{"session":[]}],"responses":{"200":{"description":"OK","content":{"application/json":{"example":{"url":"https://wa.me/919876543210?text=Hi!%20I%20saw%20your%20Diwali%20offer","link_type":"url","warnings":[],"summary":"WhatsApp chat with +919876543210","link_request":{"builder":{"type":"whatsapp","phone":"098765 43210","text":"Hi! I saw your Diwali offer"}}}}}},"401":{"description":"`unauthorized` — Missing or invalid API key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"`insufficient-scope` — Key lacks `links:write`","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-scope":"links:write"}},"/v1/deep-link/apps":{"get":{"operationId":"get_v1_deep_link_apps","summary":"Apps opened automatically by deep links","tags":["Link builders & deep links"],"security":[{"apiKey":["links:read"]},{"session":[]}],"responses":{"200":{"description":"OK","content":{"application/json":{"example":{"data":[{"id":"youtube","name":"YouTube","hosts":["youtube.com","youtu.be"],"ios":true,"android":true},{"id":"instagram","name":"Instagram","hosts":["instagram.com"],"ios":true,"android":true}]}}}},"401":{"description":"`unauthorized` — Missing or invalid API key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"`insufficient-scope` — Key lacks `links:read`","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-scope":"links:read"}},"/v1/links/{id}/qr":{"get":{"operationId":"get_v1_links_by_id_qr","summary":"Download a QR code","tags":["QR codes"],"description":"SVG by default, or PNG. Uses the link’s saved design, else the workspace style; any style field can be overridden on the query string. The code encodes `<short url>?qr=1` (header `X-QR-Content`). Supports `If-None-Match`.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"},"description":"Link ID"},{"name":"format","in":"query","required":false,"schema":{"type":"string"},"description":"`svg` (default) or `png`"},{"name":"size","in":"query","required":false,"schema":{"type":"integer"},"description":"Pixels, 64–4096 (default 600)"},{"name":"download","in":"query","required":false,"schema":{"type":"boolean"},"description":"Send as an attachment"},{"name":"fg","in":"query","required":false,"schema":{"type":"string"},"description":"Hex colours (`1E1847` or `#1E1847`)"},{"name":"bg","in":"query","required":false,"schema":{"type":"string"},"description":"Hex colours (`1E1847` or `#1E1847`)"},{"name":"corner_color","in":"query","required":false,"schema":{"type":"string"},"description":"Hex colours (`1E1847` or `#1E1847`)"},{"name":"dots","in":"query","required":false,"schema":{"type":"string"},"description":"`square`, `rounded`, `dots`, `classy`"},{"name":"corners","in":"query","required":false,"schema":{"type":"string"},"description":"`square`, `rounded`, `dot`"},{"name":"corner_dots","in":"query","required":false,"schema":{"type":"string"},"description":"`square`, `dot`"},{"name":"margin","in":"query","required":false,"schema":{"type":"integer"},"description":"Quiet zone in modules, 0–10 (default 4)"},{"name":"ecl","in":"query","required":false,"schema":{"type":"string"},"description":"Error correction `L|M|Q|H` (forced to H with a logo)"},{"name":"logo","in":"query","required":false,"schema":{"type":"boolean"},"description":"`0` to hide the workspace logo"}],"security":[{"apiKey":["qr:read"]},{"session":[]}],"responses":{"200":{"description":"OK","content":{"image/svg+xml":{"schema":{"type":"string"}},"image/png":{"schema":{"type":"string","contentMediaType":"image/png"}}}},"401":{"description":"`unauthorized` — Missing or invalid API key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"`insufficient-scope` — Key lacks `qr:read`","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"422":{"description":"`validation-error` — Colours too close to scan (contrast < 3:1)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-scope":"qr:read"},"put":{"operationId":"put_v1_links_by_id_qr","summary":"Save a link’s QR design","tags":["QR codes"],"description":"The design is rendered and decoded with a QR reader first; if it doesn’t return the exact URL it’s rejected. Send `{\"reset\": true}` to go back to the workspace style.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"},"description":"Link ID"}],"security":[{"apiKey":["links:write"]},{"session":[]}],"responses":{"200":{"description":"OK","content":{"application/json":{"example":{"style":{"fg":"#1E1847","bg":"#FFFFFF","dots":"rounded","corners":"dot","corner_dots":"dot","corner_color":"#E8572A","margin":4,"ecl":"M","logo":true,"logo_size":0.22},"inherited":false,"warnings":[],"scannable":true,"version":4,"error_correction":"M"}}}},"401":{"description":"`unauthorized` — Missing or invalid API key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"`insufficient-scope` — Key lacks `links:write`","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"422":{"description":"`qr-not-scannable` — A reader couldn’t decode the rendered design\n\n`validation-error` — Invalid fields (see `errors`)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-scope":"links:write","requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"fg":{"type":"string","description":"Hex colours"},"bg":{"type":"string","description":"Hex colours"},"corner_color":{"type":"string","description":"Hex colours"},"dots":{"type":"string","description":"Styles (see Download)"},"corners":{"type":"string","description":"Styles (see Download)"},"corner_dots":{"type":"string","description":"Styles (see Download)"},"margin":{"type":"integer","description":"0–10"},"ecl":{"type":"string","description":"L|M|Q|H"},"logo":{"type":"boolean","description":"Show the workspace logo"},"logo_size":{"type":"number","description":"0.1–0.3 of the width"},"reset":{"type":"boolean","description":"Remove the per-link design"}}},"example":{"dots":"rounded","corners":"dot","corner_dots":"dot","fg":"#1E1847","corner_color":"#E8572A"}}}}}},"/v1/qr/settings":{"get":{"operationId":"get_v1_qr_settings","summary":"Get the workspace QR style","tags":["QR codes"],"security":[{"apiKey":["qr:read"]},{"session":[]}],"responses":{"200":{"description":"OK","content":{"application/json":{"example":{"style":{"fg":"#1E1847","bg":"#FFFFFF","dots":"square","corners":"square","corner_dots":"square","margin":4,"ecl":"M","logo":true,"logo_size":0.22},"has_logo":true,"logo_sha256":"9c1f…"}}}},"401":{"description":"`unauthorized` — Missing or invalid API key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"`insufficient-scope` — Key lacks `qr:read`","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-scope":"qr:read"},"put":{"operationId":"put_v1_qr_settings","summary":"Set the workspace QR style and logo","tags":["QR codes"],"description":"Logo: a PNG, JPEG or WebP data URI up to 512 KB (SVG refused). It’s re-encoded to ≤ 512 px. `logo: null` removes it.","security":[{"apiKey":["links:write"]},{"session":[]}],"responses":{"200":{"description":"OK","content":{"application/json":{"example":{"style":{"fg":"#1E1847","bg":"#FFFFFF","dots":"square","corners":"rounded","corner_dots":"square","margin":4,"ecl":"M","logo":true,"logo_size":0.22},"has_logo":true,"logo_sha256":"9c1f…","warnings":[]}}}},"401":{"description":"`unauthorized` — Missing or invalid API key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"`insufficient-scope` — Key lacks `links:write`","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"422":{"description":"`validation-error` — Invalid fields (see `errors`)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-scope":"links:write","requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"style":{"type":"object","description":"Same fields as a link design"},"logo":{"type":["string","null"],"description":"`data:image/png;base64,…`"}}},"example":{"style":{"fg":"#1E1847","corners":"rounded"},"logo":"data:image/png;base64,iVBORw0KGgo…"}}}}}},"/v1/links/{id}/ab-results":{"get":{"operationId":"get_v1_links_by_id_ab_results","summary":"A/B test results","tags":["A/B tests"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"},"description":"Link ID"}],"security":[{"apiKey":["links:read"]},{"session":[]}],"responses":{"200":{"description":"OK","content":{"application/json":{"example":{"link_id":"lnk_an2khheekdnb","status":"running","started_at":"2026-11-01T10:02:10.000Z","ends_at":null,"winner_id":null,"threshold":0.95,"variants":[{"id":"a","url":"https://kesari.shop/v1","weight":50,"clicks":9210,"conversions":412,"revenue":0,"rate":0.0447,"uplift":null,"ci95":null,"chance_to_win":0.01},{"id":"b","url":"https://kesari.shop/v2","weight":50,"clicks":9222,"conversions":503,"revenue":0,"rate":0.0545,"uplift":0.219,"ci95":[0.08,0.36],"chance_to_win":0.99}],"srm":{"p_value":0.93,"warning":false},"recommendation":{"done":true,"winner":"b","reason":"Variant b has a 99 % chance to beat the control."},"method":"Bayesian chance to win on relative uplift (flat prior, delta-method SE), with SRM check"}}}},"401":{"description":"`unauthorized` — Missing or invalid API key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"`insufficient-scope` — Key lacks `links:read`","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-scope":"links:read"}},"/v1/links/{id}/ab-test/complete":{"post":{"operationId":"post_v1_links_by_id_ab_test_complete","summary":"Finish a test and keep the winner","tags":["A/B tests"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"},"description":"Link ID"}],"security":[{"apiKey":["links:write"]},{"session":[]}],"responses":{"200":{"description":"OK","content":{"application/json":{"example":{"id":"lnk_594ufv74rqre","short_url":"https://go.kesari.shop/diwali","qr_url":"https://api.cometly.site/v1/links/lnk_594ufv74rqre/qr","domain":"go.kesari.shop","slug":"diwali","destination":"https://kesari.shop/v2","title":"Diwali sale","tags":["instagram"],"utm":{"source":"instagram","medium":"paid","campaign":"diwali26"},"preview":null,"rules":[{"if":{"device":"ios"},"url":"https://apps.apple.com/in/app/kesari/id123"}],"has_password":false,"expires_at":null,"max_clicks":null,"status":"active","disabled_reason":null,"metadata":{},"type":"url","deep_link":{"mode":"off"},"ab_test":null,"conversion_tracking":true,"fallback_url":"https://kesari.shop/","health":{"state":"unknown"},"clicks":{"total":0,"last_24h":0,"suspicious":0,"filtered":0,"qr_scans":0},"safety":{"verdict":"clean","review":null,"reasons":[],"checked_at":"2026-11-03T10:02:10.000Z"},"conversions":{"total":0,"value":0},"etag":"vsd7hv73x8s672m3","created_at":"2026-11-03T10:23:30.000Z","updated_at":"2026-11-03T10:23:30.000Z"}}}},"401":{"description":"`unauthorized` — Missing or invalid API key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"`insufficient-scope` — Key lacks `links:write`","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"422":{"description":"`validation-error` — Invalid fields (see `errors`)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-scope":"links:write","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"winner_id":{"type":"string","description":"Variant id, e.g. `b`"}},"required":["winner_id"]},"example":{"winner_id":"b"}}}}}},"/v1/links/{id}/health":{"get":{"operationId":"get_v1_links_by_id_health","summary":"Destination health","tags":["Link health & traffic quality"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"},"description":"Link ID"}],"security":[{"apiKey":["links:read"]},{"session":[]}],"responses":{"200":{"description":"OK","content":{"application/json":{"example":{"link_id":"lnk_594ufv74rqre","health":{"state":"up","destination_down":false,"last_checked_at":"2026-11-03T10:30:00.000Z"},"next_check_at":"2026-11-03T11:00:00.000Z","fallback_url":"https://kesari.shop/","recent_checks":[{"url":"https://kesari.shop/diwali","outcome":"up","status_code":200,"checked_at":"2026-11-03T10:30:00.000Z"}]}}}},"401":{"description":"`unauthorized` — Missing or invalid API key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"`insufficient-scope` — Key lacks `links:read`","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-scope":"links:read"}},"/v1/links/{id}/health/check":{"post":{"operationId":"post_v1_links_by_id_health_check","summary":"Check the destination now","tags":["Link health & traffic quality"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"},"description":"Link ID"}],"security":[{"apiKey":["links:write"]},{"session":[]}],"responses":{"200":{"description":"OK","content":{"application/json":{"example":{"link_id":"lnk_594ufv74rqre","health":{"state":"up","destination_down":false}}}}},"401":{"description":"`unauthorized` — Missing or invalid API key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"`insufficient-scope` — Key lacks `links:write`","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-scope":"links:write"}},"/v1/links/{id}/traffic-quality":{"get":{"operationId":"get_v1_links_by_id_traffic_quality","summary":"Bot and fraud breakdown","tags":["Link health & traffic quality"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"},"description":"Link ID"},{"name":"days","in":"query","required":false,"schema":{"type":"integer"},"description":"1–90, default 30"}],"security":[{"apiKey":["stats:read"]},{"session":[]}],"responses":{"200":{"description":"OK","content":{"application/json":{"example":{"link_id":"lnk_594ufv74rqre","days":30,"counts":{"valid":41210,"suspicious":1874,"invalid":963,"bot":2402},"total":46449,"counted_clicks":43084,"filtered_share":0.072,"top_reasons":[{"reason":"bot_user_agent","count":1310},{"reason":"datacenter_ip","count":611}]}}}},"401":{"description":"`unauthorized` — Missing or invalid API key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"`insufficient-scope` — Key lacks `stats:read`","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-scope":"stats:read"}},"/v1/links/{id}/safety":{"get":{"operationId":"get_v1_links_by_id_safety","summary":"Safety verdict for a link","tags":["Link safety"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"},"description":"Link ID"}],"security":[{"apiKey":["links:read"]},{"session":[]}],"responses":{"200":{"description":"OK","content":{"application/json":{"example":{"verdict":"clean","review":null,"reasons":[],"checked_at":"2026-11-03T10:02:10.000Z","chain":["https://kesari.shop/diwali"]}}}},"401":{"description":"`unauthorized` — Missing or invalid API key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"`insufficient-scope` — Key lacks `links:read`","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-scope":"links:read"}},"/v1/links/{id}/safety/check":{"post":{"operationId":"post_v1_links_by_id_safety_check","summary":"Re-check now (follows redirects)","tags":["Link safety"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"},"description":"Link ID"}],"security":[{"apiKey":["links:write"]},{"session":[]}],"responses":{"200":{"description":"OK","content":{"application/json":{"example":{"verdict":"malicious","review":"blocked","reasons":["Listed by openphish as phishing (host phish.example)"],"checked_at":"2026-11-03T10:40:00.000Z","chain":["https://bit.ly/3x","https://phish.example/login"],"status":"disabled"}}}},"401":{"description":"`unauthorized` — Missing or invalid API key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"`insufficient-scope` — Key lacks `links:write`","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-scope":"links:write"}},"/v1/conversions":{"post":{"operationId":"post_v1_conversions","summary":"Report a lead or sale","tags":["Conversions & integrations"],"description":"Send the `cmt_id` your landing page received as `click_id` (or set `external_id` to attribute repeat purchases to the customer’s first click). `event_id` makes it idempotent (a repeat returns the first conversion with 200) and is passed to Meta for deduplication.","security":[{"apiKey":["conversions:write"]},{"session":[]}],"responses":{"201":{"description":"Created","content":{"application/json":{"example":{"id":"cnv_8hq2m5x7tz3c","link_id":"lnk_594ufv74rqre","click_id":"clk_7m2xq9kd4hfa8pne","variant_id":null,"event_type":"sale","event_name":"sale","value":1499,"currency":"INR","event_id":"order-1182","occurred_at":"2026-11-03T10:45:00.000Z","forwarding":{"meta_capi":"queued","ga4":"queued"}}}}},"401":{"description":"`unauthorized` — Missing or invalid API key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"`insufficient-scope` — Key lacks `conversions:write`","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"404":{"description":"`click-not-found` — Unknown click_id (clicks are kept 13 months)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"422":{"description":"`validation-error` — Invalid fields (see `errors`)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-scope":"conversions:write","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"click_id":{"type":"string","description":"`clk_…` from the `cmt_id` URL parameter"},"event":{"type":"string","description":"`lead`, `sale` or a custom name"},"value":{"type":"number","description":"Order value"},"currency":{"type":"string","description":"ISO 4217, e.g. INR"},"event_id":{"type":"string","description":"Your order/lead id (dedupe)"},"external_id":{"type":"string","description":"Your customer id"},"occurred_at":{"type":"string","format":"date-time","description":"Default now"},"user_data":{"type":"object","description":"`{email, phone, client_ip_address, client_user_agent, fbp, ga_client_id}` — hashed before forwarding"},"metadata":{"type":"object","description":"≤ 4 KB"}},"required":["event"]},"example":{"click_id":"clk_7m2xq9kd4hfa8pne","event":"sale","value":1499,"currency":"INR","event_id":"order-1182","external_id":"cust_42","user_data":{"email":"asha@example.com"}}}}}},"get":{"operationId":"get_v1_conversions","summary":"List conversions","tags":["Conversions & integrations"],"parameters":[{"name":"link_id","in":"query","required":false,"schema":{"type":"string"},"description":"Filter by link"},{"name":"event","in":"query","required":false,"schema":{"type":"string"},"description":"Filter by event name"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer"},"description":"1–200, default 50, newest first"}],"security":[{"apiKey":["conversions:read"]},{"session":[]}],"responses":{"200":{"description":"OK","content":{"application/json":{"example":{"data":[{"id":"cnv_8hq2m5x7tz3c","event_name":"sale","value":1499,"currency":"INR","link_id":"lnk_594ufv74rqre","occurred_at":"2026-11-03T10:45:00.000Z"}]}}}},"401":{"description":"`unauthorized` — Missing or invalid API key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"`insufficient-scope` — Key lacks `conversions:read`","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-scope":"conversions:read"}},"/v1/integrations":{"get":{"operationId":"get_v1_integrations","summary":"List integrations","tags":["Conversions & integrations"],"security":[{"apiKey":["account:read"]},{"session":[]}],"responses":{"200":{"description":"OK","content":{"application/json":{"example":{"data":[{"kind":"ga4","enabled":true,"config":{"measurement_id":"G-ABC1234"},"last_error":null,"updated_at":"2026-11-03T10:50:00.000Z"}]}}}},"401":{"description":"`unauthorized` — Missing or invalid API key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"`insufficient-scope` — Key lacks `account:read`","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-scope":"account:read"}},"/v1/integrations/{kind}":{"put":{"operationId":"put_v1_integrations_by_kind","summary":"Connect Meta CAPI or GA4","tags":["Conversions & integrations"],"description":"meta_capi: `pixel_id`, `access_token`, `api_version`, `test_event_code`, `enabled`. ga4: `measurement_id`, `api_secret`, `enabled`. Secrets are encrypted and never returned.","parameters":[{"name":"kind","in":"path","required":true,"schema":{"type":"string"},"description":"`meta_capi` or `ga4`"}],"security":[{"apiKey":["integrations:write"]},{"session":[]}],"responses":{"200":{"description":"OK","content":{"application/json":{"example":{"kind":"ga4","enabled":true,"config":{"measurement_id":"G-ABC1234"}}}}},"401":{"description":"`unauthorized` — Missing or invalid API key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"`insufficient-scope` — Key lacks `integrations:write`","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-scope":"integrations:write"},"delete":{"operationId":"delete_v1_integrations_by_kind","summary":"Disconnect an integration","tags":["Conversions & integrations"],"parameters":[{"name":"kind","in":"path","required":true,"schema":{"type":"string"},"description":"`meta_capi` or `ga4`"}],"security":[{"apiKey":["integrations:write"]},{"session":[]}],"responses":{"200":{"description":"OK","content":{"application/json":{"example":{"deleted":true}}}},"401":{"description":"`unauthorized` — Missing or invalid API key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"`insufficient-scope` — Key lacks `integrations:write`","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-scope":"integrations:write"}},"/v1/domains":{"post":{"operationId":"post_v1_domains","summary":"Add a domain","tags":["Domains"],"description":"Returns the DNS records to create: a TXT record proving ownership and a CNAME (subdomain) or A/AAAA (root domain) for routing.","security":[{"apiKey":["domains:write"]},{"session":[]}],"responses":{"201":{"description":"Created","content":{"application/json":{"example":{"id":"dom_kd292xv8n8tg","hostname":"go.kesari.shop","hostname_unicode":"go.kesari.shop","type":"subdomain","status":"pending_dns","is_default":false,"dns_records":[{"purpose":"ownership","type":"TXT","name":"_cometly-verify.go.kesari.shop","value":"cometly-verify=4b13de118bc0f44036cd","ttl":300,"required":true},{"purpose":"routing","type":"CNAME","name":"go.kesari.shop","value":"edge.cometly.site","ttl":300,"required":true}],"checks":{"ownership":"pending","routing":"pending","https":"pending"},"notes":["If you use Cloudflare, set the routing record to 'DNS only' (grey cloud).","If your domain has CAA records, allow letsencrypt.org."],"homepage_url":null,"not_found_url":null,"failure_reason":null,"disabled_reason":null,"verify_url":"https://api.cometly.site/v1/domains/dom_kd292xv8n8tg/verify","last_checked_at":null,"next_check_at":"2026-11-03T10:00:00.000Z","verified_at":null,"tls_issued_at":null,"misconfigured_since":null,"created_at":"2026-11-03T10:00:00.000Z"}}}},"401":{"description":"`unauthorized` — Missing or invalid API key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"402":{"description":"`domain-limit-reached` — Plan limit","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"`insufficient-scope` — Key lacks `domains:write`","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"`domain-in-use` — Connected to another workspace","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"422":{"description":"`invalid-hostname` — Not under a public suffix, reserved or a look-alike of a brand\n\n`validation-error` — Invalid fields (see `errors`)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-scope":"domains:write","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"hostname":{"type":"string","description":"e.g. go.yourbrand.com (Unicode allowed)"},"homepage_url":{"type":"string","description":"Where the bare domain redirects"},"not_found_url":{"type":"string","description":"Where unknown slugs redirect"}},"required":["hostname"]},"example":{"hostname":"go.kesari.shop"}}}}},"get":{"operationId":"get_v1_domains","summary":"List domains","tags":["Domains"],"parameters":[{"name":"status","in":"query","required":false,"schema":{"type":"string"},"description":"`pending_dns`, `verifying`, `active`, `misconfigured`, `disabled`, `pending_deletion`…"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer"},"description":"1–100, default 50"},{"name":"cursor","in":"query","required":false,"schema":{"type":"string"},"description":"Opaque cursor from the previous page’s `next_cursor`"}],"security":[{"apiKey":["domains:read"]},{"session":[]}],"responses":{"200":{"description":"OK","content":{"application/json":{"example":{"data":[{"id":"dom_kd292xv8n8tg","hostname":"go.kesari.shop","hostname_unicode":"go.kesari.shop","type":"subdomain","status":"active","is_default":false,"dns_records":[{"purpose":"ownership","type":"TXT","name":"_cometly-verify.go.kesari.shop","value":"cometly-verify=4b13de118bc0f44036cd","ttl":300,"required":true},{"purpose":"routing","type":"CNAME","name":"go.kesari.shop","value":"edge.cometly.site","ttl":300,"required":true}],"checks":{"ownership":"pending","routing":"pending","https":"pending"},"notes":["If you use Cloudflare, set the routing record to 'DNS only' (grey cloud).","If your domain has CAA records, allow letsencrypt.org."],"homepage_url":null,"not_found_url":null,"failure_reason":null,"disabled_reason":null,"verify_url":"https://api.cometly.site/v1/domains/dom_kd292xv8n8tg/verify","last_checked_at":null,"next_check_at":"2026-11-03T10:00:00.000Z","verified_at":null,"tls_issued_at":null,"misconfigured_since":null,"created_at":"2026-11-03T10:00:00.000Z"}],"next_cursor":null}}}},"401":{"description":"`unauthorized` — Missing or invalid API key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"`insufficient-scope` — Key lacks `domains:read`","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-scope":"domains:read"}},"/v1/domains/{id}":{"get":{"operationId":"get_v1_domains_by_id","summary":"Get a domain","tags":["Domains"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"},"description":"Domain ID"}],"security":[{"apiKey":["domains:read"]},{"session":[]}],"responses":{"200":{"description":"OK","content":{"application/json":{"example":{"id":"dom_kd292xv8n8tg","hostname":"go.kesari.shop","hostname_unicode":"go.kesari.shop","type":"subdomain","status":"pending_dns","is_default":false,"dns_records":[{"purpose":"ownership","type":"TXT","name":"_cometly-verify.go.kesari.shop","value":"cometly-verify=4b13de118bc0f44036cd","ttl":300,"required":true},{"purpose":"routing","type":"CNAME","name":"go.kesari.shop","value":"edge.cometly.site","ttl":300,"required":true}],"checks":{"ownership":"pending","routing":"pending","https":"pending"},"notes":["If you use Cloudflare, set the routing record to 'DNS only' (grey cloud).","If your domain has CAA records, allow letsencrypt.org."],"homepage_url":null,"not_found_url":null,"failure_reason":null,"disabled_reason":null,"verify_url":"https://api.cometly.site/v1/domains/dom_kd292xv8n8tg/verify","last_checked_at":null,"next_check_at":"2026-11-03T10:00:00.000Z","verified_at":null,"tls_issued_at":null,"misconfigured_since":null,"created_at":"2026-11-03T10:00:00.000Z"}}}},"401":{"description":"`unauthorized` — Missing or invalid API key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"`insufficient-scope` — Key lacks `domains:read`","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-scope":"domains:read"},"patch":{"operationId":"patch_v1_domains_by_id","summary":"Update a domain","tags":["Domains"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"},"description":"Domain ID"}],"security":[{"apiKey":["domains:write"]},{"session":[]}],"responses":{"200":{"description":"OK","content":{"application/json":{"example":{"id":"dom_kd292xv8n8tg","hostname":"go.kesari.shop","hostname_unicode":"go.kesari.shop","type":"subdomain","status":"active","is_default":true,"dns_records":[{"purpose":"ownership","type":"TXT","name":"_cometly-verify.go.kesari.shop","value":"cometly-verify=4b13de118bc0f44036cd","ttl":300,"required":true},{"purpose":"routing","type":"CNAME","name":"go.kesari.shop","value":"edge.cometly.site","ttl":300,"required":true}],"checks":{"ownership":"pending","routing":"pending","https":"pending"},"notes":["If you use Cloudflare, set the routing record to 'DNS only' (grey cloud).","If your domain has CAA records, allow letsencrypt.org."],"homepage_url":null,"not_found_url":"https://kesari.shop/","failure_reason":null,"disabled_reason":null,"verify_url":"https://api.cometly.site/v1/domains/dom_kd292xv8n8tg/verify","last_checked_at":null,"next_check_at":"2026-11-03T10:00:00.000Z","verified_at":null,"tls_issued_at":null,"misconfigured_since":null,"created_at":"2026-11-03T10:00:00.000Z"}}}},"401":{"description":"`unauthorized` — Missing or invalid API key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"`insufficient-scope` — Key lacks `domains:write`","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"422":{"description":"`validation-error` — Invalid fields (see `errors`)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-scope":"domains:write","requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"homepage_url":{"type":["string","null"],"description":"Bare-domain redirect"},"not_found_url":{"type":["string","null"],"description":"Unknown-slug redirect"},"is_default":{"type":"boolean","description":"Make it the workspace default"}}},"example":{"is_default":true,"not_found_url":"https://kesari.shop/"}}}}},"delete":{"operationId":"delete_v1_domains_by_id","summary":"Delete a domain","tags":["Domains"],"description":"Choose what happens to its links. Restorable for 7 days. Domains with links need `X-Confirm-Hostname`. Returns a job to poll.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"},"description":"Domain ID"},{"name":"on_links","in":"query","required":true,"schema":{"type":"string"},"description":"`disable`, `move` or `delete`"},{"name":"move_to","in":"query","required":false,"schema":{"type":"string"},"description":"Target domain hostname for `move`"},{"name":"on_conflict","in":"query","required":false,"schema":{"type":"string"},"description":"`fail` (default) or `suffix` (adds -2, -3)"},{"name":"purge","in":"query","required":false,"schema":{"type":"boolean"},"description":"Skip the 7-day restore window"},{"name":"X-Confirm-Hostname","in":"header","required":false,"schema":{"type":"string"},"description":"Must equal the hostname when links exist"}],"security":[{"apiKey":["domains:delete"]},{"session":[]}],"responses":{"202":{"description":"Accepted","content":{"application/json":{"example":{"id":"dom_kd292xv8n8tg","status":"pending_deletion","job":{"id":"job_q8m2x7","status":"queued","url":"/v1/jobs/job_q8m2x7"},"purge_at":"2026-11-10T10:00:00.000Z"}}}},"401":{"description":"`unauthorized` — Missing or invalid API key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"`insufficient-scope` — Key lacks `domains:delete`","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-scope":"domains:delete"}},"/v1/domains/{id}/verify":{"post":{"operationId":"post_v1_domains_by_id_verify","summary":"Check DNS now","tags":["Domains"],"description":"DNS is checked through two resolvers; a domain goes `verifying` on the first agreeing check and `active` once DNS still agrees ≥ 2 minutes later and HTTPS is live. Checks also run automatically.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"},"description":"Domain ID"}],"security":[{"apiKey":["domains:write"]},{"session":[]}],"responses":{"200":{"description":"OK","content":{"application/json":{"example":{"id":"dom_kd292xv8n8tg","hostname":"go.kesari.shop","hostname_unicode":"go.kesari.shop","type":"subdomain","status":"active","is_default":false,"dns_records":[{"purpose":"ownership","type":"TXT","name":"_cometly-verify.go.kesari.shop","value":"cometly-verify=4b13de118bc0f44036cd","ttl":300,"required":true},{"purpose":"routing","type":"CNAME","name":"go.kesari.shop","value":"edge.cometly.site","ttl":300,"required":true}],"checks":{"ownership":"ok","routing":"ok","https":"ok","caa":"ok"},"notes":["If you use Cloudflare, set the routing record to 'DNS only' (grey cloud).","If your domain has CAA records, allow letsencrypt.org."],"homepage_url":null,"not_found_url":null,"failure_reason":null,"disabled_reason":null,"verify_url":"https://api.cometly.site/v1/domains/dom_kd292xv8n8tg/verify","last_checked_at":null,"next_check_at":"2026-11-03T10:00:00.000Z","verified_at":null,"tls_issued_at":null,"misconfigured_since":null,"created_at":"2026-11-03T10:00:00.000Z"}}}},"401":{"description":"`unauthorized` — Missing or invalid API key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"`insufficient-scope` — Key lacks `domains:write`","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-scope":"domains:write"}},"/v1/domains/{id}/dns-instructions":{"get":{"operationId":"get_v1_domains_by_id_dns_instructions","summary":"Step-by-step DNS guide","tags":["Domains"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"},"description":"Domain ID"},{"name":"provider","in":"query","required":false,"schema":{"type":"string"},"description":"`cloudflare`, `godaddy`, `namecheap`, `hostinger`, `google`, `route53`"}],"security":[{"apiKey":["domains:read"]},{"session":[]}],"responses":{"200":{"description":"OK","content":{"application/json":{"example":{"domain_id":"dom_kd292xv8n8tg","hostname":"go.kesari.shop","provider":"cloudflare","provider_name":"Cloudflare","supported_providers":["cloudflare","godaddy","namecheap","hostinger","google","route53"],"steps":["Open dash.cloudflare.com, pick the domain, then go to DNS → Records."],"records":[{"purpose":"ownership","type":"TXT","name":"_cometly-verify.go.kesari.shop","value":"cometly-verify=4b13de118bc0f44036cd","ttl":300,"required":true},{"purpose":"routing","type":"CNAME","name":"go.kesari.shop","value":"edge.cometly.site","ttl":300,"required":true}],"notes":["If you use Cloudflare, set the routing record to 'DNS only' (grey cloud).","If your domain has CAA records, allow letsencrypt.org."]}}}},"401":{"description":"`unauthorized` — Missing or invalid API key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"`insufficient-scope` — Key lacks `domains:read`","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-scope":"domains:read"}},"/v1/domains/{id}/health":{"get":{"operationId":"get_v1_domains_by_id_health","summary":"Last DNS/HTTPS check","tags":["Domains"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"},"description":"Domain ID"}],"security":[{"apiKey":["domains:read"]},{"session":[]}],"responses":{"200":{"description":"OK","content":{"application/json":{"example":{"domain_id":"dom_kd292xv8n8tg","hostname":"go.kesari.shop","status":"active","last_check":{"checked_at":"2026-11-03T10:02:10.000Z","ownership_ok":true,"routing_ok":true,"https_ok":true,"caa_ok":true,"proxied":false},"certificate":{"issued_at":"2026-11-03T10:02:10.000Z"},"reputation":{"status":"ok","checked_at":"2026-11-03T10:05:00.000Z","details":"/v1/domains/dom_kd292xv8n8tg/reputation"}}}}},"401":{"description":"`unauthorized` — Missing or invalid API key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"`insufficient-scope` — Key lacks `domains:read`","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-scope":"domains:read"}},"/v1/domains/{id}/deletion-preview":{"get":{"operationId":"get_v1_domains_by_id_deletion_preview","summary":"What deleting would affect","tags":["Domains"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"},"description":"Domain ID"}],"security":[{"apiKey":["domains:read"]},{"session":[]}],"responses":{"200":{"description":"OK","content":{"application/json":{"example":{"domain_id":"dom_kd292xv8n8tg","hostname":"go.kesari.shop","status":"active","link_count":128,"clicks_last_30_days":18432,"is_default":true,"api_keys_limited_to_domain":[],"on_links_options":["disable","move","delete"],"restore_window_days":7}}}},"401":{"description":"`unauthorized` — Missing or invalid API key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"`insufficient-scope` — Key lacks `domains:read`","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-scope":"domains:read"}},"/v1/domains/{id}/restore":{"post":{"operationId":"post_v1_domains_by_id_restore","summary":"Restore a deleted domain","tags":["Domains"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"},"description":"Domain ID"}],"security":[{"apiKey":["domains:write"]},{"session":[]}],"responses":{"200":{"description":"OK","content":{"application/json":{"example":{"id":"dom_kd292xv8n8tg","hostname":"go.kesari.shop","hostname_unicode":"go.kesari.shop","type":"subdomain","status":"active","is_default":false,"dns_records":[{"purpose":"ownership","type":"TXT","name":"_cometly-verify.go.kesari.shop","value":"cometly-verify=4b13de118bc0f44036cd","ttl":300,"required":true},{"purpose":"routing","type":"CNAME","name":"go.kesari.shop","value":"edge.cometly.site","ttl":300,"required":true}],"checks":{"ownership":"pending","routing":"pending","https":"pending"},"notes":["If you use Cloudflare, set the routing record to 'DNS only' (grey cloud).","If your domain has CAA records, allow letsencrypt.org."],"homepage_url":null,"not_found_url":null,"failure_reason":null,"disabled_reason":null,"verify_url":"https://api.cometly.site/v1/domains/dom_kd292xv8n8tg/verify","last_checked_at":null,"next_check_at":"2026-11-03T10:00:00.000Z","verified_at":null,"tls_issued_at":null,"misconfigured_since":null,"created_at":"2026-11-03T10:00:00.000Z"}}}},"401":{"description":"`unauthorized` — Missing or invalid API key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"`insufficient-scope` — Key lacks `domains:write`","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-scope":"domains:write"}},"/v1/domains/{id}/cancel":{"post":{"operationId":"post_v1_domains_by_id_cancel","summary":"Cancel a domain that never verified","tags":["Domains"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"},"description":"Domain ID"}],"security":[{"apiKey":["domains:delete"]},{"session":[]}],"responses":{"200":{"description":"OK","content":{"application/json":{"example":{"id":"dom_kd292xv8n8tg","status":"deleted"}}}},"401":{"description":"`unauthorized` — Missing or invalid API key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"`insufficient-scope` — Key lacks `domains:delete`","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-scope":"domains:delete"}},"/v1/domains/{id}/reputation":{"get":{"operationId":"get_v1_domains_by_id_reputation","summary":"Reputation and blocklist status","tags":["Domain reputation"],"description":"Checks: `meta` (Facebook, Messenger, Instagram), `safe_browsing` (Chrome/Safari/Gmail), `spamhaus_dbl`, `surbl`, `uribl`, `virustotal`, `urlhaus`, `local_feeds`, `own_abuse`, `domain_age`, `tls`. Status per check: `ok`, `warning`, `listed`, `error` (couldn’t check), `skipped` (not configured). Platforms without an API are listed under `manual_checks`.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"},"description":"Domain ID"}],"security":[{"apiKey":["domains:read"]},{"session":[]}],"responses":{"200":{"description":"OK","content":{"application/json":{"example":{"domain":"go.kesari.shop","status":"listed","checked_at":"2026-11-03T10:05:00.000Z","results":[{"id":"meta","name":"Meta link safety","affects":"Facebook, Messenger, Instagram","status":"listed","detail":"Meta blocks this domain: The action attempted has been deemed abusive or is otherwise disallowed"},{"id":"spamhaus_dbl","name":"Spamhaus DBL","affects":"Email filters (Gmail, Outlook, ISPs), firewalls","status":"listed","detail":"Listed: abused legit redirector / URL shortener"},{"id":"tls","name":"HTTPS certificate","affects":"Every browser and in-app browser","status":"ok","detail":"Valid for 61 more days (Let’s Encrypt)"}],"manual_checks":[{"platform":"LinkedIn","url":"https://www.linkedin.com/post-inspector/inspect/https%3A%2F%2Fgo.kesari.shop%2F"},{"platform":"X, WhatsApp, Telegram, TikTok","url":null,"note":"No public check exists"}],"history":[{"status":"listed","at":"2026-11-03T10:05:00.000Z"},{"status":"ok","at":"2026-11-02T10:05:00.000Z"}]}}}},"401":{"description":"`unauthorized` — Missing or invalid API key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"`insufficient-scope` — Key lacks `domains:read`","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-scope":"domains:read"}},"/v1/domains/{id}/reputation/check":{"post":{"operationId":"post_v1_domains_by_id_reputation_check","summary":"Re-check reputation now","tags":["Domain reputation"],"description":"Once per 10 minutes per domain. Fires `domain.blocklisted` / `domain.reputation_recovered` webhooks on change.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"},"description":"Domain ID"}],"security":[{"apiKey":["domains:write"]},{"session":[]}],"responses":{"200":{"description":"OK","content":{"application/json":{"example":{"domain":"go.kesari.shop","status":"ok","checked_at":"2026-11-03T10:06:00.000Z","results":[]}}}},"401":{"description":"`unauthorized` — Missing or invalid API key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"`insufficient-scope` — Key lacks `domains:write`","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"`checked-recently` — Checked in the last 10 minutes","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-scope":"domains:write"}},"/v1/team":{"get":{"operationId":"get_v1_team","summary":"Members and pending invites","tags":["Team"],"security":[{"apiKey":["account:read"]},{"session":[]}],"responses":{"200":{"description":"OK","content":{"application/json":{"example":{"members":[{"id":"usr_5fxw9tcypgsq","email":"ananya@kesari.shop","name":"Ananya Kapoor","role":"owner","status":"active","last_login_at":"2026-11-03T09:00:00.000Z","mfa_enabled":true}],"invites":[{"id":"a1b2c3d4e5f6a7b8","email":"ravi@kesari.shop","role":"member","created_at":"2026-11-03T10:00:00.000Z","expires_at":"2026-11-10T10:00:00.000Z"}]}}}},"401":{"description":"`unauthorized` — Missing or invalid API key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"`insufficient-scope` — Key lacks `account:read`","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-scope":"account:read"}},"/v1/team/invites":{"post":{"operationId":"post_v1_team_invites","summary":"Invite someone","tags":["Team"],"description":"They get an email link valid for 7 days. Only the owner can invite admins. Seats: Free 2, Pro 10, Business 100.","security":[{"apiKey":["team:write"]},{"session":[]}],"responses":{"201":{"description":"Created","content":{"application/json":{"example":{"email":"ravi@kesari.shop","role":"member","expires_in_days":7}}}},"401":{"description":"`unauthorized` — Missing or invalid API key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"402":{"description":"`plan-limit` — No seats left","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"`insufficient-scope` — Key lacks `team:write`","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"409":{"description":"`already-member` — Already in the workspace","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"422":{"description":"`validation-error` — Invalid fields (see `errors`)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-scope":"team:write","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"email":{"type":"string","description":"Their email"},"role":{"type":"string","description":"`admin`, `member` (default) or `viewer`"}},"required":["email"]},"example":{"email":"ravi@kesari.shop","role":"member"}}}}}},"/v1/team/invites/{id}":{"delete":{"operationId":"delete_v1_team_invites_by_id","summary":"Cancel an invite","tags":["Team"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"},"description":"Invite ID"}],"security":[{"apiKey":["team:write"]},{"session":[]}],"responses":{"200":{"description":"OK","content":{"application/json":{"example":{"cancelled":true}}}},"401":{"description":"`unauthorized` — Missing or invalid API key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"`insufficient-scope` — Key lacks `team:write`","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-scope":"team:write"}},"/v1/team/members/{id}":{"patch":{"operationId":"patch_v1_team_members_by_id","summary":"Change a member’s role","tags":["Team"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"},"description":"User ID"}],"security":[{"apiKey":["team:write"]},{"session":[]}],"responses":{"200":{"description":"OK","content":{"application/json":{"example":{"user_id":"usr_5fxw9tcypgsq","role":"viewer"}}}},"401":{"description":"`unauthorized` — Missing or invalid API key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"`insufficient-scope` — Key lacks `team:write`","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"422":{"description":"`validation-error` — Invalid fields (see `errors`)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-scope":"team:write","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"role":{"type":"string","description":"`admin`, `member` or `viewer`"}},"required":["role"]},"example":{"role":"viewer"}}}}},"delete":{"operationId":"delete_v1_team_members_by_id","summary":"Remove a member (or leave)","tags":["Team"],"description":"Removing yourself only needs `account:read`.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"},"description":"User ID"}],"security":[{"apiKey":["team:write"]},{"session":[]}],"responses":{"200":{"description":"OK","content":{"application/json":{"example":{"removed":true}}}},"401":{"description":"`unauthorized` — Missing or invalid API key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"`insufficient-scope` — Key lacks `team:write`","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-scope":"team:write"}},"/v1/api-keys":{"get":{"operationId":"get_v1_api_keys","summary":"List API keys","tags":["API keys & jobs"],"security":[{"apiKey":["keys:write"]},{"session":[]}],"responses":{"200":{"description":"OK","content":{"application/json":{"example":{"data":[{"id":"key_ywd3cyggdwe3","name":"Zapier","prefix":"cmt_live_q1a7Tv","scopes":["links:read","links:write"],"allowed_domain_ids":null,"last_used_at":"2026-11-03T10:00:00.000Z","expires_at":null,"created_at":"2026-10-01T10:00:00.000Z","created_by":"ananya@kesari.shop"}]}}}},"401":{"description":"`unauthorized` — Missing or invalid API key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"`insufficient-scope` — Key lacks `keys:write`","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-scope":"keys:write"},"post":{"operationId":"post_v1_api_keys","summary":"Create an API key","tags":["API keys & jobs"],"description":"The secret is returned once. A key can’t be given scopes or domains its creator doesn’t have.","security":[{"apiKey":["keys:write"]},{"session":[]}],"responses":{"201":{"description":"Created","content":{"application/json":{"example":{"id":"key_ywd3cyggdwe3","name":"Zapier","prefix":"cmt_live_q1a7Tv","scopes":["links:read","links:write"],"secret":"cmt_live_q1a7Tv0ZBQURv2Z7LWr3oxl9GDkX6t3sgHgIK8Yz","note":"Copy this key now — it won’t be shown again."}}}},"401":{"description":"`unauthorized` — Missing or invalid API key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"`scope-escalation` — More scopes than you have\n\n`insufficient-scope` — Key lacks `keys:write`","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"422":{"description":"`validation-error` — Invalid fields (see `errors`)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-scope":"keys:write","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"1–80 chars"},"scopes":{"type":"array","items":{"type":"string"},"description":"See Scopes"},"allowed_domain_ids":{"type":["array","null"],"items":{"type":"string"},"description":"Limit the key to these domains"},"expires_in_days":{"type":"integer","description":"1–3650"}},"required":["name","scopes"]},"example":{"name":"Zapier","scopes":["links:read","links:write"],"expires_in_days":365}}}}}},"/v1/api-keys/{id}":{"delete":{"operationId":"delete_v1_api_keys_by_id","summary":"Revoke an API key","tags":["API keys & jobs"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"},"description":"API key ID"}],"security":[{"apiKey":["keys:write"]},{"session":[]}],"responses":{"200":{"description":"OK","content":{"application/json":{"example":{"revoked":true}}}},"401":{"description":"`unauthorized` — Missing or invalid API key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"`insufficient-scope` — Key lacks `keys:write`","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-scope":"keys:write"}},"/v1/jobs/{id}":{"get":{"operationId":"get_v1_jobs_by_id","summary":"Poll a job","tags":["API keys & jobs"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"},"description":"Job ID"}],"security":[{"apiKey":["account:read"]},{"session":[]}],"responses":{"200":{"description":"OK","content":{"application/json":{"example":{"id":"job_q8m2x7","type":"domain_deletion","status":"completed","progress":128,"total":128,"result":{"links_disabled":128},"created_at":"2026-11-03T10:00:00.000Z","finished_at":"2026-11-03T10:00:04.000Z"}}}},"401":{"description":"`unauthorized` — Missing or invalid API key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"`insufficient-scope` — Key lacks `account:read`","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"x-scope":"account:read"}},"/auth/config":{"get":{"operationId":"get_auth_config","summary":"Sign-up mode and password rules","tags":["Dashboard sign-in"],"security":[],"responses":{"200":{"description":"OK","content":{"application/json":{"example":{"signup_mode":"invite","password_min_length":10}}}}}}},"/auth/signup":{"post":{"operationId":"post_auth_signup","summary":"Sign up (when open)","tags":["Dashboard sign-in"],"description":"Same answer whether or not the email exists. Sends a verification email.","security":[],"responses":{"202":{"description":"Accepted","content":{"application/json":{"example":{"status":"check-your-email"}}}},"403":{"description":"`signup-invite-only` — Sign-up is invite-only","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"422":{"description":"`validation-error` — Invalid fields (see `errors`)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"email":{"type":"string"},"password":{"type":"string","description":"≥ 10 chars, not a common password"},"name":{"type":"string"},"workspace_name":{"type":"string"}},"required":["email","password"]},"example":{"email":"asha@example.com","password":"monsoon chai on the terrace","name":"Asha","workspace_name":"Asha Foods"}}}}}},"/auth/verify-email":{"post":{"operationId":"post_auth_verify_email","summary":"Confirm an email address","tags":["Dashboard sign-in"],"security":[],"responses":{"200":{"description":"OK","content":{"application/json":{"example":{"status":"verified"}}}},"422":{"description":"`validation-error` — Invalid fields (see `errors`)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"token":{"type":"string","description":"From the email link"}},"required":["token"]},"example":{"token":"TOKEN_FROM_EMAIL"}}}}}},"/auth/verify-email/resend":{"post":{"operationId":"post_auth_verify_email_resend","summary":"Resend the verification email","tags":["Dashboard sign-in"],"security":[],"responses":{"202":{"description":"Accepted","content":{"application/json":{"example":{"status":"check-your-email"}}}},"422":{"description":"`validation-error` — Invalid fields (see `errors`)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"email":{"type":"string"}},"required":["email"]},"example":{"email":"asha@example.com"}}}}}},"/auth/login":{"post":{"operationId":"post_auth_login","summary":"Sign in","tags":["Dashboard sign-in"],"description":"Sets the `__Host-cmt_session` cookie. If 2FA is on, returns `{mfa_required: true, mfa_token}` instead — finish with /auth/login/mfa. 5 wrong passwords pause the account for 1–60 minutes.","security":[],"responses":{"200":{"description":"OK","content":{"application/json":{"example":{"mfa_required":true,"mfa_token":"pY3…"}}}},"401":{"description":"`invalid-credentials` — Wrong email or password","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"`email-not-verified` — Confirm your email first","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"422":{"description":"`validation-error` — Invalid fields (see `errors`)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"`too-many-attempts` — Temporarily locked","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"email":{"type":"string"},"password":{"type":"string"}},"required":["email","password"]},"example":{"email":"ananya@kesari.shop","password":"••••••••••"}}}}}},"/auth/login/mfa":{"post":{"operationId":"post_auth_login_mfa","summary":"Finish sign-in with a 2FA code","tags":["Dashboard sign-in"],"security":[],"responses":{"200":{"description":"OK","content":{"application/json":{"example":{"user":{"id":"usr_5fxw9tcypgsq","email":"ananya@kesari.shop","platform_role":"user","mfa_enabled":true},"workspaces":[{"id":"ws_tg5pvg2u7mwj","name":"Kesari Foods","role":"owner"}],"csrf_token":"Xq1…"}}}},"422":{"description":"`validation-error` — Invalid fields (see `errors`)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"mfa_token":{"type":"string","description":"From /auth/login (valid 5 min)"},"code":{"type":"string","description":"6-digit TOTP"},"recovery_code":{"type":"string","description":"Instead of code"}},"required":["mfa_token"]},"example":{"mfa_token":"pY3…","code":"482913"}}}}}},"/auth/logout":{"post":{"operationId":"post_auth_logout","summary":"Sign out","tags":["Dashboard sign-in"],"security":[{"session":[]}],"responses":{"204":{"description":"No content"}}}},"/auth/logout-all":{"post":{"operationId":"post_auth_logout_all","summary":"Sign out everywhere","tags":["Dashboard sign-in"],"security":[{"session":[]}],"responses":{"200":{"description":"OK","content":{"application/json":{"example":{"signed_out_sessions":3}}}}}}},"/auth/me":{"get":{"operationId":"get_auth_me","summary":"Current user, workspaces and CSRF token","tags":["Dashboard sign-in"],"security":[{"session":[]}],"responses":{"200":{"description":"OK","content":{"application/json":{"example":{"user":{"id":"usr_5fxw9tcypgsq","email":"ananya@kesari.shop","name":"Ananya Kapoor","platform_role":"user","mfa_enabled":true,"email_verified":true},"workspaces":[{"id":"ws_tg5pvg2u7mwj","name":"Kesari Foods","status":"active","plan_id":"pro","role":"owner"}],"session":{"id":"ses_nx5tk9z6n7cm","expires_at":"2026-12-03T10:00:00.000Z","read_only":false,"impersonated_by":null},"csrf_token":"Xq1…","mfa_setup_required":false}}}}}}},"/auth/password/forgot":{"post":{"operationId":"post_auth_password_forgot","summary":"Email a reset link","tags":["Dashboard sign-in"],"security":[],"responses":{"202":{"description":"Accepted","content":{"application/json":{"example":{"status":"check-your-email"}}}},"422":{"description":"`validation-error` — Invalid fields (see `errors`)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"email":{"type":"string"}},"required":["email"]},"example":{"email":"ananya@kesari.shop"}}}}}},"/auth/password/reset":{"post":{"operationId":"post_auth_password_reset","summary":"Set a new password from the link","tags":["Dashboard sign-in"],"description":"Signs out every session.","security":[],"responses":{"200":{"description":"OK","content":{"application/json":{"example":{"status":"password-updated"}}}},"422":{"description":"`validation-error` — Invalid fields (see `errors`)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"token":{"type":"string","description":"Valid 30 min, single use"},"password":{"type":"string"}},"required":["token","password"]},"example":{"token":"TOKEN_FROM_EMAIL","password":"a brand new passphrase"}}}}}},"/auth/password/change":{"post":{"operationId":"post_auth_password_change","summary":"Change password","tags":["Dashboard sign-in"],"security":[{"session":[]}],"responses":{"200":{"description":"OK","content":{"application/json":{"example":{"status":"password-updated","other_sessions_signed_out":2}}}},"422":{"description":"`validation-error` — Invalid fields (see `errors`)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"current_password":{"type":"string"},"new_password":{"type":"string"}},"required":["current_password","new_password"]},"example":{"current_password":"••••","new_password":"a brand new passphrase"}}}}}},"/auth/mfa/setup":{"post":{"operationId":"post_auth_mfa_setup","summary":"Start 2FA setup","tags":["Dashboard sign-in"],"security":[{"session":[]}],"responses":{"200":{"description":"OK","content":{"application/json":{"example":{"secret":"JBSWY3DPEHPK3PXP…","otpauth_url":"otpauth://totp/Cometly:ananya%40kesari.shop?secret=…&issuer=Cometly"}}}}}}},"/auth/mfa/enable":{"post":{"operationId":"post_auth_mfa_enable","summary":"Confirm a code and turn 2FA on","tags":["Dashboard sign-in"],"security":[{"session":[]}],"responses":{"200":{"description":"OK","content":{"application/json":{"example":{"enabled":true,"recovery_codes":["k7q2-m9xd-4hfa","…"]}}}},"422":{"description":"`validation-error` — Invalid fields (see `errors`)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","description":"6 digits"}},"required":["code"]},"example":{"code":"482913"}}}}}},"/auth/mfa/disable":{"post":{"operationId":"post_auth_mfa_disable","summary":"Turn 2FA off","tags":["Dashboard sign-in"],"description":"Not allowed for platform staff.","security":[{"session":[]}],"responses":{"200":{"description":"OK","content":{"application/json":{"example":{"enabled":false}}}},"422":{"description":"`validation-error` — Invalid fields (see `errors`)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"password":{"type":"string"},"code":{"type":"string"}},"required":["password","code"]},"example":{"password":"••••","code":"482913"}}}}}},"/auth/mfa/recovery-codes":{"post":{"operationId":"post_auth_mfa_recovery_codes","summary":"Make new recovery codes","tags":["Dashboard sign-in"],"security":[{"session":[]}],"responses":{"200":{"description":"OK","content":{"application/json":{"example":{"recovery_codes":["p3vn-8tqe-2wrk","…"]}}}},"422":{"description":"`validation-error` — Invalid fields (see `errors`)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","description":"Current TOTP code"}},"required":["code"]},"example":{"code":"482913"}}}}}},"/auth/invite":{"get":{"operationId":"get_auth_invite","summary":"Look at an invite","tags":["Dashboard sign-in"],"parameters":[{"name":"token","in":"query","required":true,"schema":{"type":"string"},"description":"From the invite email"}],"security":[],"responses":{"200":{"description":"OK","content":{"application/json":{"example":{"email":"ravi@kesari.shop","workspace":"Kesari Foods","role":"member","invited_by":"Ananya Kapoor","needs_password":true,"name":""}}}}}}},"/auth/invite/accept":{"post":{"operationId":"post_auth_invite_accept","summary":"Accept an invite","tags":["Dashboard sign-in"],"security":[],"responses":{"200":{"description":"OK","content":{"application/json":{"example":{"user":{"id":"usr_r4v1…","email":"ravi@kesari.shop"},"workspaces":[{"name":"Kesari Foods","role":"member"}],"csrf_token":"…"}}}},"422":{"description":"`validation-error` — Invalid fields (see `errors`)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"token":{"type":"string"},"name":{"type":"string"},"password":{"type":"string","description":"Required for new accounts"}},"required":["token"]},"example":{"token":"INVITE_TOKEN","name":"Ravi","password":"teammate passphrase 9"}}}}}},"/auth/sessions":{"get":{"operationId":"get_auth_sessions","summary":"Signed-in devices","tags":["Dashboard sign-in"],"security":[{"session":[]}],"responses":{"200":{"description":"OK","content":{"application/json":{"example":{"data":[{"id":"ses_nx5tk9z6n7cm","ip":"103.21.58.4","user_agent":"Mozilla/5.0 (Macintosh…)","created_at":"2026-11-01T09:00:00.000Z","last_seen_at":"2026-11-03T10:00:00.000Z","expires_at":"2026-12-01T09:00:00.000Z","impersonation":false,"current":true}]}}}}}}},"/auth/sessions/{id}":{"delete":{"operationId":"delete_auth_sessions_by_id","summary":"Sign out one device","tags":["Dashboard sign-in"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"},"description":"Session ID"}],"security":[{"session":[]}],"responses":{"200":{"description":"OK","content":{"application/json":{"example":{"revoked":true}}}}}}},"/auth/impersonation/stop":{"post":{"operationId":"post_auth_impersonation_stop","summary":"End a support “view as” session","tags":["Dashboard sign-in"],"security":[{"session":[]}],"responses":{"200":{"description":"OK","content":{"application/json":{"example":{"status":"stopped"}}}}}}},"/admin/overview":{"get":{"operationId":"get_admin_overview","summary":"Platform overview","tags":["Master panel (platform staff)"],"security":[{"session":["staff"]}],"responses":{"200":{"description":"OK","content":{"application/json":{"example":{"users":{"active":812,"invited":14,"suspended":3,"staff":3,"with_mfa":402,"new_30d":61},"workspaces":{"total":790,"suspended":2,"free":512,"pro":241,"business":37},"clicks_24h":{"valid":1204331,"filtered":88102},"security_24h":{"failed_logins":41,"lockouts":2,"auto_bans":3,"csrf_rejected":1,"critical":0},"traffic":{"minutes":["…"],"series":{"req_api":[],"req_gw":[],"rate_limited":[],"blocked":[]}}}}}}}}},"/admin/users":{"get":{"operationId":"get_admin_users","summary":"List admins & accounts","tags":["Master panel (platform staff)"],"parameters":[{"name":"q","in":"query","required":false,"schema":{"type":"string"},"description":"Email, name or id"},{"name":"status","in":"query","required":false,"schema":{"type":"string"},"description":"invited|active|suspended|deleted"},{"name":"role","in":"query","required":false,"schema":{"type":"string"},"description":"user|support|admin"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer"},"description":"≤ 200"},{"name":"offset","in":"query","required":false,"schema":{"type":"integer"}}],"security":[{"session":["staff"]}],"responses":{"200":{"description":"OK"}}}},"/admin/users/invite":{"post":{"operationId":"post_admin_users_invite","summary":"Invite a customer admin (optionally with a workspace)","tags":["Master panel (platform staff)"],"security":[{"session":["staff"]}],"responses":{"201":{"description":"Created","content":{"application/json":{"example":{"user_id":"usr_…","invite_url":"https://app.cometly.site/accept-invite?token=…","expires_in_days":7,"workspace_id":"ws_…"}}}},"422":{"description":"`validation-error` — Invalid fields (see `errors`)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"email":{"type":"string"},"name":{"type":"string"},"workspace_name":{"type":"string","description":"Creates their workspace with them as owner"},"plan_id":{"type":"string","description":"free|pro|business"},"platform_role":{"type":"string","description":"user (default), support, admin — staff need an admin"}},"required":["email"]},"example":{"email":"founder@brand.in","name":"Priya","workspace_name":"Brand","plan_id":"pro"}}}}}},"/admin/users/{id}":{"get":{"operationId":"get_admin_users_by_id","summary":"Account detail, sessions, events and audit","tags":["Master panel (platform staff)"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"},"description":"User ID"}],"security":[{"session":["staff"]}],"responses":{"200":{"description":"OK"}}},"patch":{"operationId":"patch_admin_users_by_id","summary":"Change name, platform role or status","tags":["Master panel (platform staff)"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"},"description":"User ID"}],"security":[{"session":["staff"]}],"responses":{"200":{"description":"OK"},"422":{"description":"`validation-error` — Invalid fields (see `errors`)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"platform_role":{"type":"string","description":"user|support|admin (admin only)"},"status":{"type":"string","description":"active|suspended — suspending signs them out"},"reason":{"type":"string"}}},"example":{"status":"suspended","reason":"chargeback"}}}}},"delete":{"operationId":"delete_admin_users_by_id","summary":"Delete an account (restorable 14 days)","tags":["Master panel (platform staff)"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"},"description":"User ID"}],"security":[{"session":["staff:admin"]}],"responses":{"200":{"description":"OK","content":{"application/json":{"example":{"deleted":true,"purge_after_days":14,"suspended_workspaces":["ws_…"]}}}}}}},"/admin/users/{id}/revoke-sessions":{"post":{"operationId":"post_admin_users_by_id_revoke_sessions","summary":"Sign out everywhere","tags":["Master panel (platform staff)"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"},"description":"User ID"}],"security":[{"session":["staff"]}],"responses":{"200":{"description":"OK","content":{"application/json":{"example":{"revoked":2}}}}}}},"/admin/users/{id}/reset-mfa":{"post":{"operationId":"post_admin_users_by_id_reset_mfa","summary":"Reset 2FA","tags":["Master panel (platform staff)"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"},"description":"User ID"}],"security":[{"session":["staff"]}],"responses":{"200":{"description":"OK","content":{"application/json":{"example":{"mfa_enabled":false}}}}}}},"/admin/users/{id}/password-reset":{"post":{"operationId":"post_admin_users_by_id_password_reset","summary":"Email a password reset (or re-send an invite)","tags":["Master panel (platform staff)"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"},"description":"User ID"}],"security":[{"session":["staff"]}],"responses":{"200":{"description":"OK","content":{"application/json":{"example":{"sent":"password_reset"}}}}}}},"/admin/users/{id}/unlock":{"post":{"operationId":"post_admin_users_by_id_unlock","summary":"Clear a sign-in lockout","tags":["Master panel (platform staff)"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"},"description":"User ID"}],"security":[{"session":["staff"]}],"responses":{"200":{"description":"OK","content":{"application/json":{"example":{"unlocked":true}}}}}}},"/admin/users/{id}/impersonate":{"post":{"operationId":"post_admin_users_by_id_impersonate","summary":"Start a read-only “view as” session (1 h)","tags":["Master panel (platform staff)"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"},"description":"User ID"}],"security":[{"session":["staff"]}],"responses":{"200":{"description":"OK","content":{"application/json":{"example":{"session_id":"ses_…","expires_at":"…","read_only":true}}}},"422":{"description":"`validation-error` — Invalid fields (see `errors`)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"reason":{"type":"string","description":"e.g. ticket number — audited"}},"required":["reason"]},"example":{"reason":"Ticket #4411"}}}}}},"/admin/users/{id}/restore":{"post":{"operationId":"post_admin_users_by_id_restore","summary":"Restore a deleted account","tags":["Master panel (platform staff)"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"},"description":"User ID"}],"security":[{"session":["staff:admin"]}],"responses":{"200":{"description":"OK"}}}},"/admin/workspaces":{"get":{"operationId":"get_admin_workspaces","summary":"List workspaces","tags":["Master panel (platform staff)"],"parameters":[{"name":"q","in":"query","required":false,"schema":{"type":"string"}},{"name":"status","in":"query","required":false,"schema":{"type":"string"}},{"name":"plan_id","in":"query","required":false,"schema":{"type":"string"}}],"security":[{"session":["staff"]}],"responses":{"200":{"description":"OK"}}}},"/admin/workspaces/{id}":{"patch":{"operationId":"patch_admin_workspaces_by_id","summary":"Change plan, status or name","tags":["Master panel (platform staff)"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"},"description":"Workspace ID"}],"security":[{"session":["staff:admin"]}],"responses":{"200":{"description":"OK"},"422":{"description":"`validation-error` — Invalid fields (see `errors`)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"plan_id":{"type":"string"},"status":{"type":"string","description":"active|suspended"},"name":{"type":"string"},"reason":{"type":"string"}}},"example":{"plan_id":"business"}}}}}},"/admin/workspaces/{id}/credits":{"post":{"operationId":"post_admin_workspaces_by_id_credits","summary":"Add or deduct credits","tags":["Master panel (platform staff)"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"},"description":"Workspace ID"}],"security":[{"session":["staff:admin"]}],"responses":{"200":{"description":"OK","content":{"application/json":{"example":{"balance":5320,"ledger":[]}}}},"422":{"description":"`validation-error` — Invalid fields (see `errors`)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"delta":{"type":"integer","description":"Positive or negative"},"reason":{"type":"string"}},"required":["delta","reason"]},"example":{"delta":500,"reason":"Diwali promo"}}}}}},"/admin/plans":{"get":{"operationId":"get_admin_plans","summary":"List plans","tags":["Master panel (platform staff)"],"security":[{"session":["staff"]}],"responses":{"200":{"description":"OK"}}}},"/admin/plans/{id}":{"patch":{"operationId":"patch_admin_plans_by_id","summary":"Change plan limits","tags":["Master panel (platform staff)"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"},"description":"Plan ID"}],"security":[{"session":["staff:admin"]}],"responses":{"200":{"description":"OK"},"422":{"description":"`validation-error` — Invalid fields (see `errors`)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"max_domains":{},"max_links_month":{},"max_api_rpm":{},"price_inr":{},"name":{}}},"example":{"max_api_rpm":900}}}}}},"/admin/audit":{"get":{"operationId":"get_admin_audit","summary":"Audit log","tags":["Master panel (platform staff)"],"parameters":[{"name":"actor","in":"query","required":false,"schema":{"type":"string"},"description":"e.g. user:usr_…"},{"name":"workspace_id","in":"query","required":false,"schema":{"type":"string"}},{"name":"action","in":"query","required":false,"schema":{"type":"string"},"description":"Prefix, e.g. admin.user"},{"name":"before","in":"query","required":false,"schema":{"type":"integer"},"description":"Cursor"}],"security":[{"session":["staff"]}],"responses":{"200":{"description":"OK"}}}},"/admin/security":{"get":{"operationId":"get_admin_security","summary":"Limits, traffic and staff without 2FA","tags":["Master panel (platform staff)"],"security":[{"session":["staff"]}],"responses":{"200":{"description":"OK"}}}},"/admin/security/events":{"get":{"operationId":"get_admin_security_events","summary":"Security events","tags":["Master panel (platform staff)"],"parameters":[{"name":"type","in":"query","required":false,"schema":{"type":"string"}},{"name":"severity","in":"query","required":false,"schema":{"type":"string"},"description":"info|warning|critical"},{"name":"ip","in":"query","required":false,"schema":{"type":"string"},"description":"IP or CIDR"},{"name":"user_id","in":"query","required":false,"schema":{"type":"string"}},{"name":"before","in":"query","required":false,"schema":{"type":"integer"}}],"security":[{"session":["staff"]}],"responses":{"200":{"description":"OK"}}}},"/admin/security/blocked-ips":{"get":{"operationId":"get_admin_security_blocked_ips","summary":"Blocked IPs and ranges","tags":["Master panel (platform staff)"],"security":[{"session":["staff"]}],"responses":{"200":{"description":"OK"}}},"post":{"operationId":"post_admin_security_blocked_ips","summary":"Block an IP or CIDR","tags":["Master panel (platform staff)"],"security":[{"session":["staff:admin"]}],"responses":{"201":{"description":"Created"},"422":{"description":"`validation-error` — Invalid fields (see `errors`)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"cidr":{"type":"string","description":"IPv4 /8+ or IPv6 /16+"},"reason":{"type":"string"},"expires_in_minutes":{"type":"integer","description":"Omit for permanent"}},"required":["cidr","reason"]},"example":{"cidr":"203.0.113.0/24","reason":"Scraping","expires_in_minutes":1440}}}}}},"/admin/security/blocked-ips/{id}":{"delete":{"operationId":"delete_admin_security_blocked_ips_by_id","summary":"Unblock","tags":["Master panel (platform staff)"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"},"description":"Block ID"}],"security":[{"session":["staff:admin"]}],"responses":{"200":{"description":"OK"}}}},"/admin/abuse":{"get":{"operationId":"get_admin_abuse","summary":"Abuse queue, open reports and feed status","tags":["Master panel (platform staff)"],"parameters":[{"name":"status","in":"query","required":false,"schema":{"type":"string"},"description":"pending (default), blocked, cleared, all"}],"security":[{"session":["staff"]}],"responses":{"200":{"description":"OK"}}}},"/admin/abuse/links/{id}/block":{"post":{"operationId":"post_admin_abuse_links_by_id_block","summary":"Block a link","tags":["Master panel (platform staff)"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"},"description":"Link ID"}],"security":[{"session":["staff"]}],"responses":{"200":{"description":"OK"},"422":{"description":"`validation-error` — Invalid fields (see `errors`)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"note":{"type":"string","description":"Shown to the workspace"}}}}}}}},"/admin/abuse/links/{id}/clear":{"post":{"operationId":"post_admin_abuse_links_by_id_clear","summary":"Mark a link safe (false positive)","tags":["Master panel (platform staff)"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"},"description":"Link ID"}],"security":[{"session":["staff:admin"]}],"responses":{"200":{"description":"OK"},"422":{"description":"`validation-error` — Invalid fields (see `errors`)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"note":{"type":"string"}}}}}}}},"/admin/abuse/reports/{id}/resolve":{"post":{"operationId":"post_admin_abuse_reports_by_id_resolve","summary":"Resolve a report","tags":["Master panel (platform staff)"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"},"description":"Report ID"}],"security":[{"session":["staff"]}],"responses":{"200":{"description":"OK"},"422":{"description":"`validation-error` — Invalid fields (see `errors`)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"resolution":{"type":"string"}}}}}}}},"/admin/abuse/threats":{"post":{"operationId":"post_admin_abuse_threats","summary":"Add a host or URL to the blocklist","tags":["Master panel (platform staff)"],"security":[{"session":["staff:admin"]}],"responses":{"201":{"description":"Created","content":{"application/json":{"example":{"listed":"fake-sbi-rewards.top","scanned":48210,"flagged":0}}}},"422":{"description":"`validation-error` — Invalid fields (see `errors`)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"value":{"type":"string","description":"Host or URL"},"kind":{"type":"string","description":"phishing|malware|spam"}},"required":["value"]},"example":{"value":"fake-sbi-rewards.top","kind":"phishing"}}}}}},"/admin/abuse/rescan":{"post":{"operationId":"post_admin_abuse_rescan","summary":"Re-scan all links now","tags":["Master panel (platform staff)"],"security":[{"session":["staff:admin"]}],"responses":{"200":{"description":"OK","content":{"application/json":{"example":{"scanned":48210,"flagged":1,"deep_checked":50}}}}}}},"/admin/reputation":{"get":{"operationId":"get_admin_reputation","summary":"Reputation of every domain (worst first)","tags":["Master panel (platform staff)"],"security":[{"session":["staff"]}],"responses":{"200":{"description":"OK"}}}},"/admin/reputation/{id}/check":{"post":{"operationId":"post_admin_reputation_by_id_check","summary":"Re-check a domain now","tags":["Master panel (platform staff)"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"},"description":"Domain ID"}],"security":[{"session":["staff"]}],"responses":{"200":{"description":"OK"}}}},"/health":{"get":{"operationId":"get_health","summary":"API health","tags":["Public & short-domain endpoints"],"security":[],"responses":{"200":{"description":"OK","content":{"application/json":{"example":{"ok":true,"db":true,"redis":true}}}}}}},"/sdk/attribution.js":{"get":{"operationId":"get_sdk_attribution_js","summary":"Landing-page snippet for conversion tracking","tags":["Public & short-domain endpoints"],"description":"Stores the `cmt_id` from the URL in a first-party cookie so your checkout can send it to POST /v1/conversions.","security":[],"responses":{"200":{"description":"OK","content":{"application/javascript":{"schema":{"type":"string"}}}}}}},"/openapi.json":{"get":{"operationId":"get_openapi_json","summary":"This reference as OpenAPI 3.1","tags":["Public & short-domain endpoints"],"security":[],"responses":{"200":{"description":"OK"}}}},"/docs":{"get":{"operationId":"get_docs","summary":"This page","tags":["Public & short-domain endpoints"],"security":[],"responses":{"200":{"description":"OK","content":{"text/html":{"schema":{"type":"string"}}}}}}},"/{slug}":{"servers":[{"url":"https://{domain}","variables":{"domain":{"default":"go.yourbrand.com"}},"description":"Any connected short domain"}],"get":{"operationId":"get_short_by_slug","summary":"Follow a short link","tags":["Public & short-domain endpoints"],"description":"On any short domain. Redirects (302), or serves a password, deep-link, UPI or preview page. `?qr=1` marks a QR scan and is removed before redirecting; other query parameters are passed to the destination.","parameters":[{"name":"slug","in":"path","required":true,"schema":{"type":"string"},"description":"Case-insensitive"}],"security":[],"responses":{"302":{"description":"Redirect","content":{"text/html":{"schema":{"type":"string"}}},"headers":{"Location":{"schema":{"type":"string"}}}}}},"post":{"operationId":"post_short_by_slug","summary":"Submit a link password","tags":["Public & short-domain endpoints"],"parameters":[{"name":"slug","in":"path","required":true,"schema":{"type":"string"}}],"security":[],"responses":{"302":{"description":"Redirect","content":{"text/html":{"schema":{"type":"string"}}},"headers":{"Location":{"schema":{"type":"string"}}}},"422":{"description":"`validation-error` — Invalid fields (see `errors`)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"requestBody":{"required":true,"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"password":{"type":"string","description":"Form field"}},"required":["password"]},"example":{"password":"chai2026"}}}}}},"/":{"servers":[{"url":"https://{domain}","variables":{"domain":{"default":"go.yourbrand.com"}},"description":"Any connected short domain"}],"get":{"operationId":"get_short_root","summary":"Bare short domain","tags":["Public & short-domain endpoints"],"description":"Redirects to the domain’s `homepage_url` if set.","security":[],"responses":{"302":{"description":"Redirect","content":{"text/html":{"schema":{"type":"string"}}},"headers":{"Location":{"schema":{"type":"string"}}}}}}},"/report":{"servers":[{"url":"https://{domain}","variables":{"domain":{"default":"go.yourbrand.com"}},"description":"Any connected short domain"}],"get":{"operationId":"get_short_report","summary":"Report a harmful link (form)","tags":["Public & short-domain endpoints"],"security":[],"responses":{"200":{"description":"OK","content":{"text/html":{"schema":{"type":"string"}}}}}},"post":{"operationId":"post_short_report","summary":"Report a harmful link","tags":["Public & short-domain endpoints"],"description":"Form-encoded. 5 per IP per hour. Three reporters in 7 days put the link in the review queue.","security":[],"responses":{"200":{"description":"OK","content":{"text/html":{"schema":{"type":"string"}}}},"422":{"description":"`validation-error` — Invalid fields (see `errors`)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"requestBody":{"required":true,"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"url":{"type":"string","description":"The short link (or send `slug`)"},"slug":{"type":"string","description":"Instead of url"},"category":{"type":"string","description":"`phishing`, `scam`, `malware`, `spam`, `other`"},"reason":{"type":"string","description":"5–2000 chars"},"email":{"type":"string","description":"Optional, for follow-up"}},"required":["reason"]},"example":{"url":"https://go.kesari.shop/diwali","category":"phishing","reason":"Asks for my bank password"}}}}}},"/.well-known/cometly-health":{"servers":[{"url":"https://{domain}","variables":{"domain":{"default":"go.yourbrand.com"}},"description":"Any connected short domain"}],"get":{"operationId":"get_short_well_known_cometly_health","summary":"Edge reachability probe","tags":["Public & short-domain endpoints"],"security":[],"responses":{"200":{"description":"OK","content":{"application/json":{"example":{"ok":true,"host":"go.kesari.shop"}}}}}}},"/robots.txt":{"servers":[{"url":"https://{domain}","variables":{"domain":{"default":"go.yourbrand.com"}},"description":"Any connected short domain"}],"get":{"operationId":"get_short_robots_txt","summary":"robots.txt","tags":["Public & short-domain endpoints"],"security":[],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"type":"string"}}}}}}},"/favicon.ico":{"servers":[{"url":"https://{domain}","variables":{"domain":{"default":"go.yourbrand.com"}},"description":"Any connected short domain"}],"get":{"operationId":"get_short_favicon_ico","summary":"favicon","tags":["Public & short-domain endpoints"],"security":[],"responses":{"204":{"description":"No content"}}}}},"components":{"securitySchemes":{"apiKey":{"type":"http","scheme":"bearer","bearerFormat":"cmt_live_…","description":"Scoped API key. Scopes: `links:read` (Read links, QR codes’ settings, health and safety), `links:write` (Create and edit links, builders, QR designs), `links:delete` (Delete and purge links), `domains:read` (Read domains, DNS guides, reputation), `domains:write` (Add, verify and edit domains), `domains:delete` (Delete or cancel domains), `stats:read` (Traffic quality and analytics), `qr:read` (Download QR codes), `webhooks:write` (Manage webhooks), `keys:write` (Create, list and revoke API keys), `account:read` (Workspace, plan, usage, team, jobs), `conversions:read` (List conversions), `conversions:write` (Report conversions), `integrations:write` (Connect Meta CAPI and GA4), `team:write` (Invite, change and remove members)."},"session":{"type":"apiKey","in":"cookie","name":"__Host-cmt_session","description":"Dashboard session. Writes also need the X-CSRF-Token header from GET /auth/me; pick a workspace with X-Workspace-Id."}},"schemas":{"Problem":{"type":"object","required":["type","title","status"],"properties":{"type":{"type":"string","description":"Stable machine-readable code, e.g. `slug-taken`"},"title":{"type":"string"},"status":{"type":"integer"},"detail":{"type":"string","description":"Human-readable explanation"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"message":{"type":"string"}}}},"findings":{"type":"array","items":{"type":"object"},"description":"For `destination-blocked`: which URL matched which source"},"retry_after":{"type":"integer","description":"Seconds, for 429"}}}}}}