{"openapi":"3.1.0","info":{"title":"Bitly Group Analytics (BYOK) API","version":"0.1.0","description":"Bitly Group Analytics (BYOK) lets an AI assistant read your own Bitly Group Analytics data through the Bitly Group Analytics API with a key you supply (Bitly access token). Read-only: 9 tools (get_group_link_clicks_over_time, get_group_link_clicks_by_country, get_group_link_clicks_by_city, get_group_link_clicks_by_device, get_group_link_clicks_by_referrer, get_group_top_links_by_clicks,...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-bitly-group-analytics.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-bitly-group-analytics/docs"},"termsOfService":"https://connectorbay.com/byok-bitly-group-analytics/terms"},"servers":[{"url":"https://byok-bitly-group-analytics.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-bitly-group-analytics/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_group_link_clicks_over_time":{"post":{"operationId":"get_group_link_clicks_over_time","summary":"Get total clicks on all links of a Bitly group per time bucket for a period. Use for \"How many clicks did my Bitly links","description":"Get total clicks on all links of a Bitly group per time bucket for a period. Use for \"How many clicks did my Bitly links get per day this month\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"group_guid":{"description":"Bitly group GUID, from the bitly connector's list_groups.","maxLength":64,"title":"Group Guid","type":"string"},"unit":{"anyOf":[{"enum":["minute","hour","day","week","month"],"type":"string"},{"type":"null"}],"default":"day","description":"Time unit for the period: minute, hour, day (default), week or month.","title":"Unit"},"units":{"anyOf":[{"maximum":100000,"minimum":-1,"type":"integer"},{"type":"null"}],"default":-1,"description":"How many time units back to include; -1 (default) means all time.","title":"Units"},"unit_reference":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"ISO 8601 time that ends the period, for example 2026-10-01T00:00:00+0000; default now.","title":"Unit Reference"}},"required":["group_guid"],"title":"get_group_link_clicks_over_timeArguments","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_group_link_clicks_by_country":{"post":{"operationId":"get_group_link_clicks_by_country","summary":"Get clicks on all links of a group grouped by visitor country. Use for \"Which countries click my Bitly links most\".","description":"Get clicks on all links of a group grouped by visitor country. Use for \"Which countries click my Bitly links most\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"group_guid":{"description":"Bitly group GUID, from the bitly connector's list_groups.","maxLength":64,"title":"Group Guid","type":"string"},"unit":{"anyOf":[{"enum":["minute","hour","day","week","month"],"type":"string"},{"type":"null"}],"default":"day","description":"Time unit for the period: minute, hour, day (default), week or month.","title":"Unit"},"units":{"anyOf":[{"maximum":100000,"minimum":-1,"type":"integer"},{"type":"null"}],"default":-1,"description":"How many time units back to include; -1 (default) means all time.","title":"Units"},"unit_reference":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"ISO 8601 time that ends the period, for example 2026-10-01T00:00:00+0000; default now.","title":"Unit Reference"},"size":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":50,"description":"How many rows to return (default 50).","title":"Size"}},"required":["group_guid"],"title":"get_group_link_clicks_by_countryArguments","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_group_link_clicks_by_city":{"post":{"operationId":"get_group_link_clicks_by_city","summary":"Get clicks on all links of a group grouped by city with region and country. Use for \"Which cities click my Bitly links m","description":"Get clicks on all links of a group grouped by city with region and country. Use for \"Which cities click my Bitly links most\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"group_guid":{"description":"Bitly group GUID, from the bitly connector's list_groups.","maxLength":64,"title":"Group Guid","type":"string"},"unit":{"anyOf":[{"enum":["minute","hour","day","week","month"],"type":"string"},{"type":"null"}],"default":"day","description":"Time unit for the period: minute, hour, day (default), week or month.","title":"Unit"},"units":{"anyOf":[{"maximum":100000,"minimum":-1,"type":"integer"},{"type":"null"}],"default":-1,"description":"How many time units back to include; -1 (default) means all time.","title":"Units"},"unit_reference":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"ISO 8601 time that ends the period, for example 2026-10-01T00:00:00+0000; default now.","title":"Unit Reference"},"size":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":50,"description":"How many rows to return (default 50).","title":"Size"}},"required":["group_guid"],"title":"get_group_link_clicks_by_cityArguments","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_group_link_clicks_by_device":{"post":{"operationId":"get_group_link_clicks_by_device","summary":"Get clicks on all links of a group grouped by device type. Use for \"Do my Bitly clicks come from phones or desktops\".","description":"Get clicks on all links of a group grouped by device type. Use for \"Do my Bitly clicks come from phones or desktops\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"group_guid":{"description":"Bitly group GUID, from the bitly connector's list_groups.","maxLength":64,"title":"Group Guid","type":"string"},"unit":{"anyOf":[{"enum":["minute","hour","day","week","month"],"type":"string"},{"type":"null"}],"default":"day","description":"Time unit for the period: minute, hour, day (default), week or month.","title":"Unit"},"units":{"anyOf":[{"maximum":100000,"minimum":-1,"type":"integer"},{"type":"null"}],"default":-1,"description":"How many time units back to include; -1 (default) means all time.","title":"Units"},"unit_reference":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"ISO 8601 time that ends the period, for example 2026-10-01T00:00:00+0000; default now.","title":"Unit Reference"},"size":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":50,"description":"How many rows to return (default 50).","title":"Size"}},"required":["group_guid"],"title":"get_group_link_clicks_by_deviceArguments","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_group_link_clicks_by_referrer":{"post":{"operationId":"get_group_link_clicks_by_referrer","summary":"Get clicks on all links of a group grouped by referrer. Use for \"Where do my Bitly link clicks come from\".","description":"Get clicks on all links of a group grouped by referrer. Use for \"Where do my Bitly link clicks come from\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"group_guid":{"description":"Bitly group GUID, from the bitly connector's list_groups.","maxLength":64,"title":"Group Guid","type":"string"},"unit":{"anyOf":[{"enum":["minute","hour","day","week","month"],"type":"string"},{"type":"null"}],"default":"day","description":"Time unit for the period: minute, hour, day (default), week or month.","title":"Unit"},"units":{"anyOf":[{"maximum":100000,"minimum":-1,"type":"integer"},{"type":"null"}],"default":-1,"description":"How many time units back to include; -1 (default) means all time.","title":"Units"},"unit_reference":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"ISO 8601 time that ends the period, for example 2026-10-01T00:00:00+0000; default now.","title":"Unit Reference"},"size":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":50,"description":"How many rows to return (default 50).","title":"Size"}},"required":["group_guid"],"title":"get_group_link_clicks_by_referrerArguments","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_group_top_links_by_clicks":{"post":{"operationId":"get_group_top_links_by_clicks","summary":"Get the best performing links of a group by clicks in a period, with titles and destinations. Use for \"Which of my Bitly","description":"Get the best performing links of a group by clicks in a period, with titles and destinations. Use for \"Which of my Bitly links got the most clicks lately\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"group_guid":{"description":"Bitly group GUID, from the bitly connector's list_groups.","maxLength":64,"title":"Group Guid","type":"string"},"unit":{"anyOf":[{"enum":["minute","hour","day","week","month"],"type":"string"},{"type":"null"}],"default":"day","description":"Time unit for the period: minute, hour, day (default), week or month.","title":"Unit"},"units":{"anyOf":[{"maximum":100000,"minimum":-1,"type":"integer"},{"type":"null"}],"default":-1,"description":"How many time units back to include; -1 (default) means all time.","title":"Units"},"unit_reference":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"ISO 8601 time that ends the period, for example 2026-10-01T00:00:00+0000; default now.","title":"Unit Reference"},"size":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":50,"description":"How many rows to return (default 50).","title":"Size"}},"required":["group_guid"],"title":"get_group_top_links_by_clicksArguments","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_group_top_links_by_engagement":{"post":{"operationId":"get_group_top_links_by_engagement","summary":"Get the best performing links of a group by engagement (clicks plus scans) in a period. Use for \"Which Bitly links engag","description":"Get the best performing links of a group by engagement (clicks plus scans) in a period. Use for \"Which Bitly links engage people the most\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"group_guid":{"description":"Bitly group GUID, from the bitly connector's list_groups.","maxLength":64,"title":"Group Guid","type":"string"},"unit":{"anyOf":[{"enum":["minute","hour","day","week","month"],"type":"string"},{"type":"null"}],"default":"day","description":"Time unit for the period: minute, hour, day (default), week or month.","title":"Unit"},"units":{"anyOf":[{"maximum":100000,"minimum":-1,"type":"integer"},{"type":"null"}],"default":-1,"description":"How many time units back to include; -1 (default) means all time.","title":"Units"},"unit_reference":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"ISO 8601 time that ends the period, for example 2026-10-01T00:00:00+0000; default now.","title":"Unit Reference"},"size":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":50,"description":"How many rows to return (default 50).","title":"Size"}},"required":["group_guid"],"title":"get_group_top_links_by_engagementArguments","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_group_engagements_over_time":{"post":{"operationId":"get_group_engagements_over_time","summary":"Get total engagements (clicks and QR scans) of a group per time bucket. Use for \"How did engagement with my Bitly links ","description":"Get total engagements (clicks and QR scans) of a group per time bucket. Use for \"How did engagement with my Bitly links change this month\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"group_guid":{"description":"Bitly group GUID, from the bitly connector's list_groups.","maxLength":64,"title":"Group Guid","type":"string"},"unit":{"anyOf":[{"enum":["minute","hour","day","week","month"],"type":"string"},{"type":"null"}],"default":"day","description":"Time unit for the period: minute, hour, day (default), week or month.","title":"Unit"},"units":{"anyOf":[{"maximum":100000,"minimum":-1,"type":"integer"},{"type":"null"}],"default":-1,"description":"How many time units back to include; -1 (default) means all time.","title":"Units"},"unit_reference":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"ISO 8601 time that ends the period, for example 2026-10-01T00:00:00+0000; default now.","title":"Unit Reference"}},"required":["group_guid"],"title":"get_group_engagements_over_timeArguments","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_group_agentic_traffic":{"post":{"operationId":"get_group_agentic_traffic","summary":"Get the total number of clicks that came from AI agents for a Bitly group. Use for \"How much of my Bitly traffic comes f","description":"Get the total number of clicks that came from AI agents for a Bitly group. Use for \"How much of my Bitly traffic comes from AI agents\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"group_guid":{"description":"Bitly group GUID, from the bitly connector's list_groups.","maxLength":64,"title":"Group Guid","type":"string"}},"required":["group_guid"],"title":"get_group_agentic_trafficArguments","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}}}}