{"openapi":"3.1.0","info":{"title":"Get Response Stats (BYOK) API","version":"0.1.0","description":"Get Response Stats (BYOK) lets an AI assistant read your own Get Response Stats data through the Get Response Stats API with a key you supply (API key (enter the key only; the connector adds the api-key prefix)). Read-only: 6 tools (get_newsletter_statistics, get_autoresponder_statistics, get_transactional_email_statistics, get_list_size_statistics, get_ecommerce_revenue,...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-getresponse-stats.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-getresponse-stats/docs"},"termsOfService":"https://connectorbay.com/byok-getresponse-stats/terms"},"servers":[{"url":"https://byok-getresponse-stats.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-getresponse-stats/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_newsletter_statistics":{"post":{"operationId":"get_newsletter_statistics","summary":"Get aggregate newsletter statistics grouped by hour, day, month or in total: sent, opens, clicks, goals, unsubscribes, b","description":"Get aggregate newsletter statistics grouped by hour, day, month or in total: sent, opens, clicks, goals, unsubscribes, bounces and complaints. Use for \"How did my GetResponse newsletters perform this month\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"group_by":{"anyOf":[{"enum":["total","hour","day","month"],"type":"string"},{"type":"null"}],"default":"total","description":"Group results by time interval: total, hour, day or month.","title":"Group By"},"campaign_id":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Only these list (campaign) ids; several ids may be separated by commas.","title":"Campaign Id"},"from_date":{"anyOf":[{"maxLength":10,"type":"string"},{"type":"null"}],"default":null,"description":"Count data from this date, YYYY-MM-DD.","title":"From Date"},"to_date":{"anyOf":[{"maxLength":10,"type":"string"},{"type":"null"}],"default":null,"description":"Count data to this date, YYYY-MM-DD.","title":"To Date"},"per_page":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":50,"description":"How many results to return (1 to 100).","title":"Per Page"},"page":{"anyOf":[{"maximum":10000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page"}},"title":"get_newsletter_statisticsArguments","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_autoresponder_statistics":{"post":{"operationId":"get_autoresponder_statistics","summary":"Get aggregate autoresponder statistics grouped by hour, day, month or in total: sent, opens, clicks, goals, unsubscribes","description":"Get aggregate autoresponder statistics grouped by hour, day, month or in total: sent, opens, clicks, goals, unsubscribes, bounces and complaints. Use for \"How are my GetResponse autoresponders performing\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"group_by":{"anyOf":[{"enum":["total","hour","day","month"],"type":"string"},{"type":"null"}],"default":"total","description":"Group results by time interval: total, hour, day or month.","title":"Group By"},"campaign_id":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Only these list (campaign) ids; several ids may be separated by commas.","title":"Campaign Id"},"from_date":{"anyOf":[{"maxLength":10,"type":"string"},{"type":"null"}],"default":null,"description":"Count data from this date, YYYY-MM-DD.","title":"From Date"},"to_date":{"anyOf":[{"maxLength":10,"type":"string"},{"type":"null"}],"default":null,"description":"Count data to this date, YYYY-MM-DD.","title":"To Date"},"per_page":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":50,"description":"How many results to return (1 to 100).","title":"Per Page"},"page":{"anyOf":[{"maximum":10000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page"}},"title":"get_autoresponder_statisticsArguments","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_transactional_email_statistics":{"post":{"operationId":"get_transactional_email_statistics","summary":"Get overall transactional email statistics by day or in total: sent, opened, bounced, complaints and clicks. Use for \"Ho","description":"Get overall transactional email statistics by day or in total: sent, opened, bounced, complaints and clicks. Use for \"How many transactional emails did GetResponse send and open\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"group_by":{"description":"Group results by time interval: total or day.","enum":["total","day"],"title":"Group By","type":"string"},"from_date":{"anyOf":[{"maxLength":10,"type":"string"},{"type":"null"}],"default":null,"description":"Count data from this date, YYYY-MM-DD.","title":"From Date"},"to_date":{"anyOf":[{"maxLength":10,"type":"string"},{"type":"null"}],"default":null,"description":"Count data to this date, YYYY-MM-DD.","title":"To Date"}},"required":["group_by"],"title":"get_transactional_email_statisticsArguments","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_list_size_statistics":{"post":{"operationId":"get_list_size_statistics","summary":"Get subscriber list size over time for selected lists (campaigns): total, added and removed subscribers per interval. Us","description":"Get subscriber list size over time for selected lists (campaigns): total, added and removed subscribers per interval. Use for \"How has my GetResponse list size changed\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"campaign_id":{"description":"List (campaign) ids, several separated by commas.","maxLength":200,"title":"Campaign Id","type":"string"},"group_by":{"anyOf":[{"enum":["total","hour","day","month"],"type":"string"},{"type":"null"}],"default":"day","description":"Group results by hour, day, month or total.","title":"Group By"},"from_date":{"anyOf":[{"maxLength":10,"type":"string"},{"type":"null"}],"default":null,"description":"Count data from this date, YYYY-MM-DD.","title":"From Date"},"to_date":{"anyOf":[{"maxLength":10,"type":"string"},{"type":"null"}],"default":null,"description":"Count data to this date, YYYY-MM-DD.","title":"To Date"}},"required":["campaign_id"],"title":"get_list_size_statisticsArguments","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_ecommerce_revenue":{"post":{"operationId":"get_ecommerce_revenue","summary":"Get e-commerce revenue and order counts over time, optionally for one shop, with the currency. Use for \"How much revenue","description":"Get e-commerce revenue and order counts over time, optionally for one shop, with the currency. Use for \"How much revenue did my GetResponse shops make\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"from_date":{"anyOf":[{"maxLength":10,"type":"string"},{"type":"null"}],"default":null,"description":"Count orders from this date, YYYY-MM-DD.","title":"From Date"},"to_date":{"anyOf":[{"maxLength":10,"type":"string"},{"type":"null"}],"default":null,"description":"Count orders to this date, YYYY-MM-DD.","title":"To Date"},"shop_id":{"anyOf":[{"maxLength":60,"type":"string"},{"type":"null"}],"default":null,"description":"Only this shop id (from your shops).","title":"Shop Id"}},"title":"get_ecommerce_revenueArguments","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_ecommerce_performance":{"post":{"operationId":"get_ecommerce_performance","summary":"Get e-commerce performance: order count, average order revenue and revenue with trends versus the previous period. Use f","description":"Get e-commerce performance: order count, average order revenue and revenue with trends versus the previous period. Use for \"How are my GetResponse shop orders trending\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"from_date":{"anyOf":[{"maxLength":10,"type":"string"},{"type":"null"}],"default":null,"description":"Count orders from this date, YYYY-MM-DD.","title":"From Date"},"to_date":{"anyOf":[{"maxLength":10,"type":"string"},{"type":"null"}],"default":null,"description":"Count orders to this date, YYYY-MM-DD.","title":"To Date"},"shop_id":{"anyOf":[{"maxLength":60,"type":"string"},{"type":"null"}],"default":null,"description":"Only this shop id (from your shops).","title":"Shop Id"}},"title":"get_ecommerce_performanceArguments","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}}}}