{"openapi":"3.1.0","info":{"title":"OpenPanel (BYOK) API","version":"0.1.0","description":"OpenPanel (BYOK) lets an AI assistant read your own OpenPanel data through the OpenPanel API with a key you supply (client id of a read or root client (the default write client cannot read)). Read-only: 10 tools (get_metrics, get_live_visitors, get_top_pages, get_referrers, get_countries, get_devices, get_browsers, get_operating_systems, get_utm_sources, get_utm_campaigns). The BYOK key travels...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-openpanel.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-openpanel/docs"},"termsOfService":"https://connectorbay.com/byok-openpanel/terms"},"servers":[{"url":"https://byok-openpanel.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-openpanel/docs"},"security":[{"upstreamKey":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","description":"Optional. A Pro API key raises rate limits; no credentials are required."},"upstreamKey":{"type":"apiKey","in":"header","name":"X-Upstream-Key","description":"Your own key for the service this connector wraps (bring your own key). Used for that one call only; never stored, logged or cached."}},"schemas":{"Error":{"type":"object","properties":{"ok":{"const":false},"error":{"type":"object"}}}}},"paths":{"/v1/tools/get_metrics":{"post":{"operationId":"get_metrics","summary":"Get headline metrics for a project over a period: visitors, sessions, bounce rate and engagement (aggregate). Needs a re","description":"Get headline metrics for a project over a period: visitors, sessions, bounce rate and engagement (aggregate). Needs a read-mode client. Rate limit 100 calls per 10 seconds. Use for \"How many visitors did my OpenPanel project get this month\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"project_id":{"description":"Id of the OpenPanel project (shown in the project settings).","maxLength":200,"title":"Project Id","type":"string"},"start_date":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Start of the period as an ISO date such as 2026-10-01. Use together with end_date.","title":"Start Date"},"end_date":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"End of the period as an ISO date such as 2026-10-16.","title":"End Date"},"range":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Named period instead of explicit dates; use a value listed in the OpenPanel API reference. Leave out to use the service default.","title":"Range"}},"required":["project_id"],"title":"get_metricsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_live_visitors":{"post":{"operationId":"get_live_visitors","summary":"Get the number of visitors currently active on a project (a count only). Use for \"How many people are on my site right n","description":"Get the number of visitors currently active on a project (a count only). Use for \"How many people are on my site right now according to OpenPanel\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"project_id":{"description":"Id of the OpenPanel project (shown in the project settings).","maxLength":200,"title":"Project Id","type":"string"}},"required":["project_id"],"title":"get_live_visitorsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_top_pages":{"post":{"operationId":"get_top_pages","summary":"Get top pages by sessions for a project over a period (aggregate counts only, no individual visitors). Needs a read-mode","description":"Get top pages by sessions for a project over a period (aggregate counts only, no individual visitors). Needs a read-mode client. Rate limit 100 calls per 10 seconds. Use for \"Which pages get the most sessions in OpenPanel\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"project_id":{"description":"Id of the OpenPanel project (shown in the project settings).","maxLength":200,"title":"Project Id","type":"string"},"start_date":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Start of the period as an ISO date such as 2026-10-01. Use together with end_date.","title":"Start Date"},"end_date":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"End of the period as an ISO date such as 2026-10-16.","title":"End Date"},"range":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Named period instead of explicit dates; use a value listed in the OpenPanel API reference. Leave out to use the service default.","title":"Range"},"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":null,"description":"How many rows to return.","title":"Limit"}},"required":["project_id"],"title":"get_top_pagesArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_referrers":{"post":{"operationId":"get_referrers","summary":"Get traffic sources (referrers) for a project over a period (aggregate counts only, no individual visitors). Needs a rea","description":"Get traffic sources (referrers) for a project over a period (aggregate counts only, no individual visitors). Needs a read-mode client. Rate limit 100 calls per 10 seconds. Use for \"Where does my OpenPanel traffic come from\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"project_id":{"description":"Id of the OpenPanel project (shown in the project settings).","maxLength":200,"title":"Project Id","type":"string"},"start_date":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Start of the period as an ISO date such as 2026-10-01. Use together with end_date.","title":"Start Date"},"end_date":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"End of the period as an ISO date such as 2026-10-16.","title":"End Date"},"range":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Named period instead of explicit dates; use a value listed in the OpenPanel API reference. Leave out to use the service default.","title":"Range"},"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":null,"description":"How many rows to return.","title":"Limit"}},"required":["project_id"],"title":"get_referrersArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_countries":{"post":{"operationId":"get_countries","summary":"Get a breakdown of traffic by country for a project over a period (aggregate counts only, no individual visitors). Needs","description":"Get a breakdown of traffic by country for a project over a period (aggregate counts only, no individual visitors). Needs a read-mode client. Rate limit 100 calls per 10 seconds. Use for \"Which countries visit my site according to OpenPanel\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"project_id":{"description":"Id of the OpenPanel project (shown in the project settings).","maxLength":200,"title":"Project Id","type":"string"},"start_date":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Start of the period as an ISO date such as 2026-10-01. Use together with end_date.","title":"Start Date"},"end_date":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"End of the period as an ISO date such as 2026-10-16.","title":"End Date"},"range":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Named period instead of explicit dates; use a value listed in the OpenPanel API reference. Leave out to use the service default.","title":"Range"},"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":null,"description":"How many rows to return.","title":"Limit"}},"required":["project_id"],"title":"get_countriesArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_devices":{"post":{"operationId":"get_devices","summary":"Get a breakdown of traffic by device type for a project over a period (aggregate counts only, no individual visitors). N","description":"Get a breakdown of traffic by device type for a project over a period (aggregate counts only, no individual visitors). Needs a read-mode client. Rate limit 100 calls per 10 seconds. Use for \"How does my OpenPanel traffic split by device\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"project_id":{"description":"Id of the OpenPanel project (shown in the project settings).","maxLength":200,"title":"Project Id","type":"string"},"start_date":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Start of the period as an ISO date such as 2026-10-01. Use together with end_date.","title":"Start Date"},"end_date":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"End of the period as an ISO date such as 2026-10-16.","title":"End Date"},"range":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Named period instead of explicit dates; use a value listed in the OpenPanel API reference. Leave out to use the service default.","title":"Range"},"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":null,"description":"How many rows to return.","title":"Limit"}},"required":["project_id"],"title":"get_devicesArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_browsers":{"post":{"operationId":"get_browsers","summary":"Get a breakdown of traffic by browser for a project over a period (aggregate counts only, no individual visitors). Needs","description":"Get a breakdown of traffic by browser for a project over a period (aggregate counts only, no individual visitors). Needs a read-mode client. Rate limit 100 calls per 10 seconds. Use for \"Which browsers do my OpenPanel visitors use\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"project_id":{"description":"Id of the OpenPanel project (shown in the project settings).","maxLength":200,"title":"Project Id","type":"string"},"start_date":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Start of the period as an ISO date such as 2026-10-01. Use together with end_date.","title":"Start Date"},"end_date":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"End of the period as an ISO date such as 2026-10-16.","title":"End Date"},"range":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Named period instead of explicit dates; use a value listed in the OpenPanel API reference. Leave out to use the service default.","title":"Range"},"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":null,"description":"How many rows to return.","title":"Limit"}},"required":["project_id"],"title":"get_browsersArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_operating_systems":{"post":{"operationId":"get_operating_systems","summary":"Get a breakdown of traffic by operating system for a project over a period (aggregate counts only, no individual visitor","description":"Get a breakdown of traffic by operating system for a project over a period (aggregate counts only, no individual visitors). Needs a read-mode client. Rate limit 100 calls per 10 seconds. Use for \"Which operating systems do my OpenPanel visitors use\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"project_id":{"description":"Id of the OpenPanel project (shown in the project settings).","maxLength":200,"title":"Project Id","type":"string"},"start_date":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Start of the period as an ISO date such as 2026-10-01. Use together with end_date.","title":"Start Date"},"end_date":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"End of the period as an ISO date such as 2026-10-16.","title":"End Date"},"range":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Named period instead of explicit dates; use a value listed in the OpenPanel API reference. Leave out to use the service default.","title":"Range"},"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":null,"description":"How many rows to return.","title":"Limit"}},"required":["project_id"],"title":"get_operating_systemsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_utm_sources":{"post":{"operationId":"get_utm_sources","summary":"Get a breakdown of traffic by utm_source for a project over a period (aggregate counts only, no individual visitors). Ne","description":"Get a breakdown of traffic by utm_source for a project over a period (aggregate counts only, no individual visitors). Needs a read-mode client. Rate limit 100 calls per 10 seconds. Use for \"Which UTM sources drive OpenPanel traffic\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"project_id":{"description":"Id of the OpenPanel project (shown in the project settings).","maxLength":200,"title":"Project Id","type":"string"},"start_date":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Start of the period as an ISO date such as 2026-10-01. Use together with end_date.","title":"Start Date"},"end_date":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"End of the period as an ISO date such as 2026-10-16.","title":"End Date"},"range":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Named period instead of explicit dates; use a value listed in the OpenPanel API reference. Leave out to use the service default.","title":"Range"},"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":null,"description":"How many rows to return.","title":"Limit"}},"required":["project_id"],"title":"get_utm_sourcesArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_utm_campaigns":{"post":{"operationId":"get_utm_campaigns","summary":"Get a breakdown of traffic by utm_campaign for a project over a period (aggregate counts only, no individual visitors). ","description":"Get a breakdown of traffic by utm_campaign for a project over a period (aggregate counts only, no individual visitors). Needs a read-mode client. Rate limit 100 calls per 10 seconds. Use for \"Which UTM campaigns drive OpenPanel traffic\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"project_id":{"description":"Id of the OpenPanel project (shown in the project settings).","maxLength":200,"title":"Project Id","type":"string"},"start_date":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Start of the period as an ISO date such as 2026-10-01. Use together with end_date.","title":"Start Date"},"end_date":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"End of the period as an ISO date such as 2026-10-16.","title":"End Date"},"range":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Named period instead of explicit dates; use a value listed in the OpenPanel API reference. Leave out to use the service default.","title":"Range"},"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":null,"description":"How many rows to return.","title":"Limit"}},"required":["project_id"],"title":"get_utm_campaignsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}}}}