{"openapi":"3.1.0","info":{"title":"Bitly QR Codes (BYOK) API","version":"0.1.0","description":"Bitly QR Codes (BYOK) lets an AI assistant read your own Bitly QR Codes data through the Bitly QR Codes API with a key you supply (Bitly access token). Read-only: 10 tools (list_group_qr_codes, get_qr_code, get_qr_scans_summary, get_qr_scans_over_time, get_qr_scans_by_country, get_qr_scans_by_device_os, get_qr_scans_by_browser, get_qr_scans_by_city, get_group_qr_scans_over_time,...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-bitly-qr-codes.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-bitly-qr-codes/docs"},"termsOfService":"https://connectorbay.com/byok-bitly-qr-codes/terms"},"servers":[{"url":"https://byok-bitly-qr-codes.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-bitly-qr-codes/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/list_group_qr_codes":{"post":{"operationId":"list_group_qr_codes","summary":"List the QR codes of a Bitly group with title, type, linked Bitlink, destination content, archive flag and dates. Pass s","description":"List the QR codes of a Bitly group with title, type, linked Bitlink, destination content, archive flag and dates. Pass search_after from the previous answer's pagination for the next page. Use for \"Which QR codes do I have in Bitly\".","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"},"size":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":50,"description":"How many QR codes to return (default 50).","title":"Size"},"search_after":{"anyOf":[{"maxLength":300,"type":"string"},{"type":"null"}],"default":null,"description":"Paging token copied from the previous answer's pagination.search_after.","title":"Search After"},"query":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Only QR codes matching this search text.","title":"Query"},"archived":{"anyOf":[{"enum":["on","off","both"],"type":"string"},{"type":"null"}],"default":null,"description":"Archived QR codes: off (default, exclude them), on or both.","title":"Archived"},"created_after":{"anyOf":[{"minimum":0,"type":"integer"},{"type":"null"}],"default":null,"description":"Only QR codes created after this Unix time in seconds.","title":"Created After"},"created_before":{"anyOf":[{"minimum":0,"type":"integer"},{"type":"null"}],"default":null,"description":"Only QR codes created before this Unix time in seconds.","title":"Created Before"}},"required":["group_guid"],"title":"list_group_qr_codesArguments","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_qr_code":{"post":{"operationId":"get_qr_code","summary":"Get one QR code: title, type, linked Bitlink, destination content, archive flag and dates; the drawing customizations ar","description":"Get one QR code: title, type, linked Bitlink, destination content, archive flag and dates; the drawing customizations are left out. Use for \"Show the details of this Bitly QR code\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"qrcode_id":{"description":"QR code ID, from list_group_qr_codes.","maxLength":64,"title":"Qrcode Id","type":"string"}},"required":["qrcode_id"],"title":"get_qr_codeArguments","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_qr_scans_summary":{"post":{"operationId":"get_qr_scans_summary","summary":"Get the total number of scans of one QR code for a period. Use for \"How many times was this Bitly QR code scanned\".","description":"Get the total number of scans of one QR code for a period. Use for \"How many times was this Bitly QR code scanned\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"qrcode_id":{"description":"QR code ID, from list_group_qr_codes.","maxLength":64,"title":"Qrcode Id","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":["qrcode_id"],"title":"get_qr_scans_summaryArguments","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_qr_scans_over_time":{"post":{"operationId":"get_qr_scans_over_time","summary":"Get scans of one QR code per time unit, each with a date and count. Use for \"How did scans of my Bitly QR code develop o","description":"Get scans of one QR code per time unit, each with a date and count. Use for \"How did scans of my Bitly QR code develop over time\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"qrcode_id":{"description":"QR code ID, from list_group_qr_codes.","maxLength":64,"title":"Qrcode Id","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":["qrcode_id"],"title":"get_qr_scans_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_qr_scans_by_country":{"post":{"operationId":"get_qr_scans_by_country","summary":"Get scans of one QR code grouped by country. Use for \"Which countries scan my Bitly QR code\".","description":"Get scans of one QR code grouped by country. Use for \"Which countries scan my Bitly QR code\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"qrcode_id":{"description":"QR code ID, from list_group_qr_codes.","maxLength":64,"title":"Qrcode Id","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":["qrcode_id"],"title":"get_qr_scans_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_qr_scans_by_device_os":{"post":{"operationId":"get_qr_scans_by_device_os","summary":"Get scans of one QR code grouped by device operating system. Use for \"Which phone systems scan my Bitly QR code\".","description":"Get scans of one QR code grouped by device operating system. Use for \"Which phone systems scan my Bitly QR code\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"qrcode_id":{"description":"QR code ID, from list_group_qr_codes.","maxLength":64,"title":"Qrcode Id","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":["qrcode_id"],"title":"get_qr_scans_by_device_osArguments","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_qr_scans_by_browser":{"post":{"operationId":"get_qr_scans_by_browser","summary":"Get scans of one QR code grouped by browser. Use for \"Which browsers open my Bitly QR code\".","description":"Get scans of one QR code grouped by browser. Use for \"Which browsers open my Bitly QR code\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"qrcode_id":{"description":"QR code ID, from list_group_qr_codes.","maxLength":64,"title":"Qrcode Id","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":["qrcode_id"],"title":"get_qr_scans_by_browserArguments","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_qr_scans_by_city":{"post":{"operationId":"get_qr_scans_by_city","summary":"Get scans of one QR code grouped by city with region and country. Use for \"Which cities scan my Bitly QR code\".","description":"Get scans of one QR code grouped by city with region and country. Use for \"Which cities scan my Bitly QR code\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"qrcode_id":{"description":"QR code ID, from list_group_qr_codes.","maxLength":64,"title":"Qrcode Id","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":["qrcode_id"],"title":"get_qr_scans_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_qr_scans_over_time":{"post":{"operationId":"get_group_qr_scans_over_time","summary":"Get scans of all QR codes in a Bitly group per time bucket. Use for \"How many QR code scans did my Bitly group get over ","description":"Get scans of all QR codes in a Bitly group per time bucket. Use for \"How many QR code scans did my Bitly group get over time\".","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_qr_scans_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_qr_scans_by_country":{"post":{"operationId":"get_group_qr_scans_by_country","summary":"Get scans of all QR codes in a Bitly group grouped by country. Use for \"Which countries scan the QR codes of my Bitly gr","description":"Get scans of all QR codes in a Bitly group grouped by country. Use for \"Which countries scan the QR codes of my Bitly group\".","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_qr_scans_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}}}}