Source
Analytics, data export & integrations — found from sitemap — OptiMonk
Checked for OptiMonk on 16 Nov 2026
- Page
- https://support.optimonk.com/en/articles/api-keys-and-the-mcp-endpoint
- Checked
- 16 Nov 2026, 14:19 UTC
- How we may use it
- Public page, crawling permitted
Technical details
- type
- page
- http status
- 200
- content hash
- sha256:4f1cd2b2a1f5dd0cec0b8c10a4d962912563ab5114ecb421e07333b2f77c1e66
- permission
- robots_ok
- screenshot
- Screenshot on file (internal exhibit, not published)
Cited by
Facts read from this source
-
Mcp server Report an error
“The builder exposes an MCP (Model Context Protocol) server, so an AI agent — Claude, Cursor, ChatGPT/Codex, or your own client — can drive it: start a build from a reference image, iterate on the popup, and turn the result into a campaign.”
-
Mcp endpoint URL Report an error
“POST https://<your-host>/mcp Authorization: Bearer omk_live_…”
-
Mcp transport Report an error
“Transport is streamable HTTP and stateless — the server creates a fresh session per request, so GET /mcp and DELETE /mcp both answer 405 method not allowed (stateless).”
-
Mcp server identity Report an error
“The server identifies itself as optimonk-popup-builder version 1.0.0.”
-
Mcp auth prefix Report an error
“The bearer must start with omk_. An omk_at_… prefix is treated as an OAuth access token, anything else as an API key.”
-
Mcp auth errors Report an error
“A missing, malformed, revoked or expired credential gets 401 with a WWW-Authenticate header.”
-
Mcp oauth challenge Report an error
“When OAuth is enabled that challenge carries a resource_metadata pointer (RFC 9728), which is what lets a capable client start the consent flow itself instead of asking you for a key.”
-
Mcp origin allowlist Report an error
“Requests from a browser origin outside the allow-list get 403.”
-
Mcp request body limit Report an error
“Request bodies are capped at 1 MB; larger ones get 413.”
-
Mcp disable behavior Report an error
“If both the API-key and OAuth doors are switched off server-side, /mcp answers 404 mcp disabled.”
-
Mcp tool build popup Report an error
“build_popup takes a publicly fetchable PNG/JPG/WEBP plus the target store hostname and returns a runId.”
-
Mcp build tools Report an error
“Builds are asynchronous: prefer watch_build (it waits and emits progress notifications) over a polling loop, and use get_build_status for a single read or from a client that cannot hold a request open.”
-
Mcp interrupted status Report an error
“interrupted is not a terminal status — the run resumes; treating it as a failure is the most common mistake on this surface.”
-
Mcp tool create campaign Report an error
“create_campaign makes a DRAFT campaign and needs a designer-session-backed build: start_design_thread creates one, a standalone build_popup run does not.”
-
Mcp tool publish campaign Report an error
“publish_campaign publishes to OptiMonk and activates the campaign.”
-
Mcp no analytics tools Report an error
“It is not the analytics or subscriber API. There is no tool for reports, leads or submits — the tools in the MCP tool reference are the whole surface.”
-
Mcp no integration config Report an error
“It cannot configure ESP/CRM integrations. No tool connects Klaviyo, Mailchimp or a webhook; that is UI-only, in the campaign hub.”
-
Mcp no account management Report an error
“It cannot manage the account. No user, domain, billing or API-key administration; key and connected-app endpoints are cookie-authenticated on purpose, so a credential can never enumerate or revoke its siblings.”
-
Mcp error envelope Report an error
“MCP tool refusals — including scope errors and exhausted budgets — come back as isError: true with prose in content, inside a JSON-RPC HTTP 200 response.”
-
Mcp idempotency Report an error
“Pass idempotencyKey to build_popup (the REST equivalent is an Idempotency-Key header, honoured for 24 hours per account); a retry with the same key returns the first run instead of paying for a second generation.”
-
Rest API Report an error
“The same credentials work against a REST surface described by an OpenAPI 3.1 document.”
-
Openapi public Report an error
“Both GET /.well-known/openapi.json and GET /llms.txt are readable without a credential.”
-
Rest error format Report an error
“REST errors are typed (type + code + request_id; branch on those, not on message)”
-
Rest rate limit headers Report an error
“rate-limited responses carry X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset, and a budget refusal is a 429 with Retry-After.”
Scores citing this record
- The CRO Consultant Analytics, data export & integrations
- The CRO Consultant Analytics, data export & integrations
- The CRO Consultant Analytics, data export & integrations
- The CRO Consultant Analytics, data export & integrations
- The CRO Consultant Analytics, data export & integrations
- The Data Protection Officer Analytics, data export & integrations
- The Data Protection Officer Analytics, data export & integrations
- The Data Protection Officer Analytics, data export & integrations
- The Data Protection Officer Analytics, data export & integrations
- The Data Protection Officer Analytics, data export & integrations
- The E-Commerce Manager Analytics, data export & integrations
- The E-Commerce Manager Analytics, data export & integrations
- The E-Commerce Manager Analytics, data export & integrations
- The E-Commerce Manager Analytics, data export & integrations
- The E-Commerce Manager Analytics, data export & integrations
- The Growth Lead Analytics, data export & integrations
- The Growth Lead Analytics, data export & integrations
- The Growth Lead Analytics, data export & integrations
- The Growth Lead Analytics, data export & integrations
- The Growth Lead Analytics, data export & integrations
- The Product Engineer Analytics, data export & integrations
- The Product Engineer Analytics, data export & integrations
- The Product Engineer Analytics, data export & integrations
- The Product Engineer Analytics, data export & integrations
- The Product Engineer Analytics, data export & integrations
- The Skeptic Analytics, data export & integrations
- The Skeptic Analytics, data export & integrations
- The Skeptic Analytics, data export & integrations
- The Skeptic Analytics, data export & integrations
- The Skeptic Analytics, data export & integrations