{ "item": [ { "id": "13547f0e-7f29-4754-b1d0-3714a13cb895", "name": "QR Codes", "description": { "content": "QR codes can be created and customized with different dot patterns, corner shapes, colors, and more. They can contain bitlinks, links to microsites, or several kinds of static data.\n", "type": "text/plain" }, "item": [ { "id": "dfd877e7-5d06-45d7-bf46-0955a0d7fb2a", "name": "Create a QR Code", "request": { "name": "Create a QR Code", "description": { "content": "Create a new QR Code and return its metadata", "type": "text/plain" }, "url": { "path": [ "qr-codes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"group_guid\": \"\",\n \"destination\": {\n \"bitlink_id\": \"\",\n \"long_url\": \"\",\n \"site_id\": \"\"\n },\n \"title\": \"\",\n \"render_customizations\": {\n \"background_color\": \"\",\n \"dot_pattern_color\": \"\",\n \"dot_pattern_type\": \"standard\",\n \"corners\": {\n \"corner_1\": {\n \"inner_color\": \"\",\n \"outer_color\": \"\",\n \"shape\": \"standard\"\n },\n \"corner_2\": {\n \"inner_color\": \"\",\n \"outer_color\": \"\",\n \"shape\": \"standard\"\n },\n \"corner_3\": {\n \"inner_color\": \"\",\n \"outer_color\": \"\",\n \"shape\": \"standard\"\n }\n },\n \"gradient\": {\n \"style\": \"no_gradient\",\n \"angle\": \"\",\n \"colors\": [\n {\n \"color\": \"\",\n \"offset\": 0\n },\n {\n \"color\": \"\",\n \"offset\": 0\n }\n ],\n \"exclude_corners\": \"\"\n },\n \"background_gradient\": {\n \"style\": \"no_gradient\",\n \"angle\": \"\",\n \"colors\": [\n {\n \"color\": \"\",\n \"offset\": 0\n },\n {\n \"color\": \"\",\n \"offset\": 0\n }\n ],\n \"exclude_corners\": \"\"\n },\n \"logo\": {\n \"image_guid\": \"\"\n },\n \"frame\": {\n \"id\": \"none\",\n \"colors\": {\n \"primary\": \"\",\n \"secondary\": \"\",\n \"background\": \"\"\n },\n \"text\": {\n \"primary\": {\n \"content\": \"\",\n \"color\": \"#ffffff\"\n },\n \"secondary\": {\n \"content\": \"\",\n \"color\": \"#ffffff\"\n }\n }\n },\n \"text\": {\n \"center\": {\n \"content\": \"\",\n \"color\": \"#ffffff\"\n },\n \"top\": {\n \"content\": \"\",\n \"color\": \"#ffffff\"\n },\n \"bottom\": {\n \"content\": \"\",\n \"color\": \"#ffffff\"\n }\n },\n \"branding\": {\n \"bitly_brand\": \"\"\n },\n \"spec_settings\": {\n \"error_correction\": \"\"\n }\n },\n \"archived\": \"\",\n \"gs1\": {\n \"values\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n },\n \"expiration_at\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"dynamic_routing\": [\n {\n \"long_url\": \"\",\n \"country_match\": [\n \"\",\n \"\"\n ],\n \"country_exclude\": [\n \"\",\n \"\"\n ],\n \"region_match\": [\n \"\",\n \"\"\n ],\n \"region_exclude\": [\n \"\",\n \"\"\n ],\n \"device_match\": [\n \"\",\n \"\"\n ],\n \"device_exclude\": [\n \"\",\n \"\"\n ],\n \"os_match\": [\n \"\",\n \"\"\n ],\n \"os_exclude\": [\n \"\",\n \"\"\n ]\n },\n {\n \"long_url\": \"\",\n \"country_match\": [\n \"\",\n \"\"\n ],\n \"country_exclude\": [\n \"\",\n \"\"\n ],\n \"region_match\": [\n \"\",\n \"\"\n ],\n \"region_exclude\": [\n \"\",\n \"\"\n ],\n \"device_match\": [\n \"\",\n \"\"\n ],\n \"device_exclude\": [\n \"\",\n \"\"\n ],\n \"os_match\": [\n \"\",\n \"\"\n ],\n \"os_exclude\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"domain\": \"bit.ly\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "1445f191-a3a1-48a8-a839-be0f72a12b5f", "name": "CREATED", "originalRequest": { "url": { "path": [ "qr-codes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"title\": \"Minimal QR Code\",\n \"group_guid\": \"Ba1bc23dE4F\",\n \"destination\": {\n \"bitlink_id\": \"bit.ly/abc123\"\n },\n \"tags\": [\n \"tag1\",\n \"tag2\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"qrcode_id\": \"string\",\n \"group_guid\": \"string\",\n \"title\": \"string\",\n \"is_customized\": false,\n \"serialized_content\": \"string\",\n \"qr_code_type\": \"link_in_bio\",\n \"long_urls\": [\n \"string\",\n \"string\"\n ],\n \"bitlink_id\": \"string\",\n \"is_gs1\": false,\n \"created_by\": \"string\",\n \"tags\": [\n \"string\",\n \"string\"\n ],\n \"archived\": true,\n \"expiration_at\": \"string\",\n \"dynamic_routing\": [\n {\n \"long_url\": \"\",\n \"country_match\": [\n \"\",\n \"\"\n ],\n \"country_exclude\": [\n \"\",\n \"\"\n ],\n \"region_match\": [\n \"\",\n \"\"\n ],\n \"region_exclude\": [\n \"\",\n \"\"\n ],\n \"device_match\": [\n \"\",\n \"\"\n ],\n \"device_exclude\": [\n \"\",\n \"\"\n ],\n \"os_match\": [\n \"\",\n \"\"\n ],\n \"os_exclude\": [\n \"\",\n \"\"\n ]\n },\n {\n \"long_url\": \"\",\n \"country_match\": [\n \"\",\n \"\"\n ],\n \"country_exclude\": [\n \"\",\n \"\"\n ],\n \"region_match\": [\n \"\",\n \"\"\n ],\n \"region_exclude\": [\n \"\",\n \"\"\n ],\n \"device_match\": [\n \"\",\n \"\"\n ],\n \"device_exclude\": [\n \"\",\n \"\"\n ],\n \"os_match\": [\n \"\",\n \"\"\n ],\n \"os_exclude\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"created\": \"string\",\n \"modified\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5c7c3cc7-b403-4dc0-9090-8d7492ff6377", "name": "BAD_REQUEST", "originalRequest": { "url": { "path": [ "qr-codes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"title\": \"Minimal QR Code\",\n \"group_guid\": \"Ba1bc23dE4F\",\n \"destination\": {\n \"bitlink_id\": \"bit.ly/abc123\"\n },\n \"tags\": [\n \"tag1\",\n \"tag2\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "070c8e13-37ba-432d-b34b-4c886020b4c5", "name": "UPGRADE_REQUIRED", "originalRequest": { "url": { "path": [ "qr-codes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"title\": \"Minimal QR Code\",\n \"group_guid\": \"Ba1bc23dE4F\",\n \"destination\": {\n \"bitlink_id\": \"bit.ly/abc123\"\n },\n \"tags\": [\n \"tag1\",\n \"tag2\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Payment Required", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d8f60c26-4312-49d2-98cb-2d2382c0faf4", "name": "FORBIDDEN", "originalRequest": { "url": { "path": [ "qr-codes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"title\": \"Minimal QR Code\",\n \"group_guid\": \"Ba1bc23dE4F\",\n \"destination\": {\n \"bitlink_id\": \"bit.ly/abc123\"\n },\n \"tags\": [\n \"tag1\",\n \"tag2\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a004d33e-dc4b-4549-9d54-7191b5d3c5c4", "name": "NOT_FOUND", "originalRequest": { "url": { "path": [ "qr-codes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"title\": \"Minimal QR Code\",\n \"group_guid\": \"Ba1bc23dE4F\",\n \"destination\": {\n \"bitlink_id\": \"bit.ly/abc123\"\n },\n \"tags\": [\n \"tag1\",\n \"tag2\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3ad4554a-db38-41ac-9580-a3e0d516fe03", "name": "GONE", "originalRequest": { "url": { "path": [ "qr-codes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"title\": \"Minimal QR Code\",\n \"group_guid\": \"Ba1bc23dE4F\",\n \"destination\": {\n \"bitlink_id\": \"bit.ly/abc123\"\n },\n \"tags\": [\n \"tag1\",\n \"tag2\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Gone", "code": 410, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f0bdaee7-784a-4890-801c-8b3c22524476", "name": "MONTHLY_LIMIT_EXCEEDED", "originalRequest": { "url": { "path": [ "qr-codes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"title\": \"Minimal QR Code\",\n \"group_guid\": \"Ba1bc23dE4F\",\n \"destination\": {\n \"bitlink_id\": \"bit.ly/abc123\"\n },\n \"tags\": [\n \"tag1\",\n \"tag2\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"API_USAGE_LIMIT_EXCEEDED\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d58ff750-21f9-4445-893d-70674aa08bcc", "name": "INTERNAL_ERROR", "originalRequest": { "url": { "path": [ "qr-codes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"title\": \"Minimal QR Code\",\n \"group_guid\": \"Ba1bc23dE4F\",\n \"destination\": {\n \"bitlink_id\": \"bit.ly/abc123\"\n },\n \"tags\": [\n \"tag1\",\n \"tag2\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "beb1985f-5eca-48f7-ba23-da647717adbe", "name": "Generate a static QR Code image", "request": { "name": "Generate a static QR Code image", "description": { "content": "Generate a static QR code image without creating or saving a QR code resource. SVG and PNG output are supported via the Accept header\nContact your Account Manager to discuss enabling this feature for your account.\n\nThe `render_customizations` field supports basic appearance options. Customizations that require the rasterize API are not supported: `gradient`, `background_gradient`, `frame`, `text`, and `logo`.\n\nThe Accept header controls the response format:\n- `application/json` (default): Returns a JSON object with the image as a base64-encoded byte string.\n- `image/svg+xml`: Returns the raw SVG image.\n- `image/png`: Returns the raw PNG image.\n", "type": "text/plain" }, "url": { "path": [ "qr-codes", "static" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "format", "value": "svg", "description": "The image format. Supports `svg` and `png`. Ignored if the Accept header specifies an image type." } ], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"content\": \"\",\n \"group_guid\": \"\",\n \"render_customizations\": {\n \"background_color\": \"\",\n \"dot_pattern_color\": \"\",\n \"dot_pattern_type\": \"standard\",\n \"corners\": {\n \"corner_1\": {\n \"inner_color\": \"\",\n \"outer_color\": \"\",\n \"shape\": \"standard\"\n },\n \"corner_2\": {\n \"inner_color\": \"\",\n \"outer_color\": \"\",\n \"shape\": \"standard\"\n },\n \"corner_3\": {\n \"inner_color\": \"\",\n \"outer_color\": \"\",\n \"shape\": \"standard\"\n }\n },\n \"branding\": {\n \"bitly_brand\": \"\"\n },\n \"spec_settings\": {\n \"error_correction\": \"\"\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "f5bc6851-fb2f-492e-a0b3-135d5e919a6c", "name": "SUCCESS", "originalRequest": { "url": { "path": [ "qr-codes", "static" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "format", "value": "svg" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Controls the response format. Use `application/json` (default) to receive a JSON-wrapped base64 image, `image/svg+xml` to receive the raw SVG, or `image/png` to receive the raw PNG.", "key": "Accept", "value": "image/svg+xml" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"content\": \"https://bitly.com\",\n \"group_guid\": \"Ba1bc23dE4F\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"image\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "90af2636-6c09-4cb8-b4ee-b0788d47b4a0", "name": "BAD_REQUEST", "originalRequest": { "url": { "path": [ "qr-codes", "static" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "format", "value": "svg" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Controls the response format. Use `application/json` (default) to receive a JSON-wrapped base64 image, `image/svg+xml` to receive the raw SVG, or `image/png` to receive the raw PNG.", "key": "Accept", "value": "image/svg+xml" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"content\": \"https://bitly.com\",\n \"group_guid\": \"Ba1bc23dE4F\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ba49dac9-ae0c-44a3-b020-096f7d294a1b", "name": "FORBIDDEN", "originalRequest": { "url": { "path": [ "qr-codes", "static" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "format", "value": "svg" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Controls the response format. Use `application/json` (default) to receive a JSON-wrapped base64 image, `image/svg+xml` to receive the raw SVG, or `image/png` to receive the raw PNG.", "key": "Accept", "value": "image/svg+xml" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"content\": \"https://bitly.com\",\n \"group_guid\": \"Ba1bc23dE4F\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4540288e-ce72-41ce-b2a8-2242f34ff408", "name": "NOT_ACCEPTABLE", "originalRequest": { "url": { "path": [ "qr-codes", "static" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "format", "value": "svg" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Controls the response format. Use `application/json` (default) to receive a JSON-wrapped base64 image, `image/svg+xml` to receive the raw SVG, or `image/png` to receive the raw PNG.", "key": "Accept", "value": "image/svg+xml" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"content\": \"https://bitly.com\",\n \"group_guid\": \"Ba1bc23dE4F\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Acceptable", "code": 406, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "00f0e687-e58b-4a44-8bfe-e009173a3907", "name": "UNPROCESSABLE_ENTITY", "originalRequest": { "url": { "path": [ "qr-codes", "static" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "format", "value": "svg" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Controls the response format. Use `application/json` (default) to receive a JSON-wrapped base64 image, `image/svg+xml` to receive the raw SVG, or `image/png` to receive the raw PNG.", "key": "Accept", "value": "image/svg+xml" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"content\": \"https://bitly.com\",\n \"group_guid\": \"Ba1bc23dE4F\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6801447b-25e2-4549-8e0c-de899681b16e", "name": "MONTHLY_LIMIT_EXCEEDED", "originalRequest": { "url": { "path": [ "qr-codes", "static" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "format", "value": "svg" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Controls the response format. Use `application/json` (default) to receive a JSON-wrapped base64 image, `image/svg+xml` to receive the raw SVG, or `image/png` to receive the raw PNG.", "key": "Accept", "value": "image/svg+xml" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"content\": \"https://bitly.com\",\n \"group_guid\": \"Ba1bc23dE4F\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"API_USAGE_LIMIT_EXCEEDED\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "de815c48-f241-4c4f-92b7-507ad5db1b08", "name": "INTERNAL_ERROR", "originalRequest": { "url": { "path": [ "qr-codes", "static" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "format", "value": "svg" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Controls the response format. Use `application/json` (default) to receive a JSON-wrapped base64 image, `image/svg+xml` to receive the raw SVG, or `image/png` to receive the raw PNG.", "key": "Accept", "value": "image/svg+xml" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"content\": \"https://bitly.com\",\n \"group_guid\": \"Ba1bc23dE4F\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ff97eb52-1994-4a60-a98b-58aaccdf0c53", "name": "Retrieve a QR Code image", "request": { "name": "Retrieve a QR Code image", "description": { "content": "Get the image of a given QR Code. The Accept header controls how this is returned (options are \"application/json\", \"image/svg+xml\", and \"image/png\").\nIf the Accept header is \"application/json\" the format query parameter will determine the image format inside of the json (which will be base64 encoded and prefixed with its mime type as would be suitable for a HTML image src tag).\nTo Return the QR Code image itself, set the Accept header to \"image/svg+xml\" or \"image/png\", or remove the Accept header and set the format query parameter to “svg” or “png” (if no format is specified the default will be “svg”).\n", "type": "text/plain" }, "url": { "path": [ "qr-codes", ":qrcode_id", "image" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "format", "value": "svg", "description": "The format type of the image. If there is an image format in the header it takes precedence." } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "qrcode_id", "description": "(Required) The QR Code ID" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "7db31752-8863-49f2-96c3-b5489d525957", "name": "SUCCESS", "originalRequest": { "url": { "path": [ "qr-codes", ":qrcode_id", "image" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "format", "value": "svg" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "qrcode_id", "description": "(Required) The QR Code ID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "The file format for the QR code's image. If the accept header is application/json the image data will be wrapped in a json object, base64 encoded and prefixed with its mime type as would be suitable for a HTML image src tag.", "key": "Accept", "value": "image/svg+xml" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"qr_code_image\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c170d79e-5dfe-4a0b-b170-154f7f55377a", "name": "BAD_REQUEST", "originalRequest": { "url": { "path": [ "qr-codes", ":qrcode_id", "image" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "format", "value": "svg" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "qrcode_id", "description": "(Required) The QR Code ID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "The file format for the QR code's image. If the accept header is application/json the image data will be wrapped in a json object, base64 encoded and prefixed with its mime type as would be suitable for a HTML image src tag.", "key": "Accept", "value": "image/svg+xml" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5e66281c-0f94-4a11-a84b-f05e15060139", "name": "FORBIDDEN", "originalRequest": { "url": { "path": [ "qr-codes", ":qrcode_id", "image" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "format", "value": "svg" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "qrcode_id", "description": "(Required) The QR Code ID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "The file format for the QR code's image. If the accept header is application/json the image data will be wrapped in a json object, base64 encoded and prefixed with its mime type as would be suitable for a HTML image src tag.", "key": "Accept", "value": "image/svg+xml" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "95de581a-d585-42a9-b4f4-62f26c7bfaf3", "name": "NOT_FOUND", "originalRequest": { "url": { "path": [ "qr-codes", ":qrcode_id", "image" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "format", "value": "svg" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "qrcode_id", "description": "(Required) The QR Code ID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "The file format for the QR code's image. If the accept header is application/json the image data will be wrapped in a json object, base64 encoded and prefixed with its mime type as would be suitable for a HTML image src tag.", "key": "Accept", "value": "image/svg+xml" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f9bf24df-c32a-4c1c-b136-b3c1c290aaeb", "name": "GONE", "originalRequest": { "url": { "path": [ "qr-codes", ":qrcode_id", "image" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "format", "value": "svg" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "qrcode_id", "description": "(Required) The QR Code ID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "The file format for the QR code's image. If the accept header is application/json the image data will be wrapped in a json object, base64 encoded and prefixed with its mime type as would be suitable for a HTML image src tag.", "key": "Accept", "value": "image/svg+xml" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Gone", "code": 410, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "297caeba-3b80-4687-9675-9bafb2709b17", "name": "INTERNAL_ERROR", "originalRequest": { "url": { "path": [ "qr-codes", ":qrcode_id", "image" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "format", "value": "svg" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "qrcode_id", "description": "(Required) The QR Code ID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "The file format for the QR code's image. If the accept header is application/json the image data will be wrapped in a json object, base64 encoded and prefixed with its mime type as would be suitable for a HTML image src tag.", "key": "Accept", "value": "image/svg+xml" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8ae4afab-74f5-4d34-a63f-66b03991bb65", "name": "Update a QR Code", "request": { "name": "Update a QR Code", "description": { "content": "Updates the QR code with a matching id and returns it.", "type": "text/plain" }, "url": { "path": [ "qr-codes", ":qrcode_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "qrcode_id", "description": "(Required) The QR code ID" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": null, "body": { "mode": "raw", "raw": "{\n \"title\": \"\",\n \"render_customizations\": {\n \"background_color\": \"\",\n \"dot_pattern_color\": \"\",\n \"dot_pattern_type\": \"standard\",\n \"corners\": {\n \"corner_1\": {\n \"inner_color\": \"\",\n \"outer_color\": \"\",\n \"shape\": \"standard\"\n },\n \"corner_2\": {\n \"inner_color\": \"\",\n \"outer_color\": \"\",\n \"shape\": \"standard\"\n },\n \"corner_3\": {\n \"inner_color\": \"\",\n \"outer_color\": \"\",\n \"shape\": \"standard\"\n }\n },\n \"gradient\": {\n \"style\": \"no_gradient\",\n \"angle\": \"\",\n \"colors\": [\n {\n \"color\": \"\",\n \"offset\": 0\n },\n {\n \"color\": \"\",\n \"offset\": 0\n }\n ],\n \"exclude_corners\": \"\"\n },\n \"background_gradient\": {\n \"style\": \"no_gradient\",\n \"angle\": \"\",\n \"colors\": [\n {\n \"color\": \"\",\n \"offset\": 0\n },\n {\n \"color\": \"\",\n \"offset\": 0\n }\n ],\n \"exclude_corners\": \"\"\n },\n \"logo\": {\n \"image_guid\": \"\"\n },\n \"frame\": {\n \"id\": \"none\",\n \"colors\": {\n \"primary\": \"\",\n \"secondary\": \"\",\n \"background\": \"\"\n },\n \"text\": {\n \"primary\": {\n \"content\": \"\",\n \"color\": \"#ffffff\"\n },\n \"secondary\": {\n \"content\": \"\",\n \"color\": \"#ffffff\"\n }\n }\n },\n \"text\": {\n \"center\": {\n \"content\": \"\",\n \"color\": \"#ffffff\"\n },\n \"top\": {\n \"content\": \"\",\n \"color\": \"#ffffff\"\n },\n \"bottom\": {\n \"content\": \"\",\n \"color\": \"#ffffff\"\n }\n },\n \"branding\": {\n \"bitly_brand\": \"\"\n },\n \"spec_settings\": {\n \"error_correction\": \"\"\n }\n },\n \"archived\": \"\",\n \"expiration_at\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"dynamic_routing\": [\n {\n \"long_url\": \"\",\n \"country_match\": [\n \"\",\n \"\"\n ],\n \"country_exclude\": [\n \"\",\n \"\"\n ],\n \"region_match\": [\n \"\",\n \"\"\n ],\n \"region_exclude\": [\n \"\",\n \"\"\n ],\n \"device_match\": [\n \"\",\n \"\"\n ],\n \"device_exclude\": [\n \"\",\n \"\"\n ],\n \"os_match\": [\n \"\",\n \"\"\n ],\n \"os_exclude\": [\n \"\",\n \"\"\n ]\n },\n {\n \"long_url\": \"\",\n \"country_match\": [\n \"\",\n \"\"\n ],\n \"country_exclude\": [\n \"\",\n \"\"\n ],\n \"region_match\": [\n \"\",\n \"\"\n ],\n \"region_exclude\": [\n \"\",\n \"\"\n ],\n \"device_match\": [\n \"\",\n \"\"\n ],\n \"device_exclude\": [\n \"\",\n \"\"\n ],\n \"os_match\": [\n \"\",\n \"\"\n ],\n \"os_exclude\": [\n \"\",\n \"\"\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "76b3326d-c6bd-458e-9b80-350c9b760635", "name": "SUCCESS", "originalRequest": { "url": { "path": [ "qr-codes", ":qrcode_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "qrcode_id", "description": "(Required) The QR code ID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"title\": \"Minimal QR Code Updated\",\n \"tags\": [\n \"tag1\",\n \"tag2\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"qrcode_id\": \"string\",\n \"group_guid\": \"string\",\n \"title\": \"string\",\n \"is_customized\": false,\n \"serialized_content\": \"string\",\n \"qr_code_type\": \"v_card\",\n \"long_urls\": [\n \"string\",\n \"string\"\n ],\n \"bitlink_id\": \"string\",\n \"is_gs1\": true,\n \"created_by\": \"string\",\n \"tags\": [\n \"string\",\n \"string\"\n ],\n \"archived\": false,\n \"expiration_at\": \"string\",\n \"dynamic_routing\": [\n {\n \"long_url\": \"\",\n \"country_match\": [\n \"\",\n \"\"\n ],\n \"country_exclude\": [\n \"\",\n \"\"\n ],\n \"region_match\": [\n \"\",\n \"\"\n ],\n \"region_exclude\": [\n \"\",\n \"\"\n ],\n \"device_match\": [\n \"\",\n \"\"\n ],\n \"device_exclude\": [\n \"\",\n \"\"\n ],\n \"os_match\": [\n \"\",\n \"\"\n ],\n \"os_exclude\": [\n \"\",\n \"\"\n ]\n },\n {\n \"long_url\": \"\",\n \"country_match\": [\n \"\",\n \"\"\n ],\n \"country_exclude\": [\n \"\",\n \"\"\n ],\n \"region_match\": [\n \"\",\n \"\"\n ],\n \"region_exclude\": [\n \"\",\n \"\"\n ],\n \"device_match\": [\n \"\",\n \"\"\n ],\n \"device_exclude\": [\n \"\",\n \"\"\n ],\n \"os_match\": [\n \"\",\n \"\"\n ],\n \"os_exclude\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"created\": \"string\",\n \"modified\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a3b2f820-bb5a-4afc-a838-1fb2b75a261d", "name": "BAD_REQUEST", "originalRequest": { "url": { "path": [ "qr-codes", ":qrcode_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "qrcode_id", "description": "(Required) The QR code ID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"title\": \"Minimal QR Code Updated\",\n \"tags\": [\n \"tag1\",\n \"tag2\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eda5f45a-2682-4907-ad6c-98e69637a8b3", "name": "FORBIDDEN", "originalRequest": { "url": { "path": [ "qr-codes", ":qrcode_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "qrcode_id", "description": "(Required) The QR code ID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"title\": \"Minimal QR Code Updated\",\n \"tags\": [\n \"tag1\",\n \"tag2\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d7e555e9-e247-48c0-9e97-caf33ad8a7e9", "name": "NOT_FOUND", "originalRequest": { "url": { "path": [ "qr-codes", ":qrcode_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "qrcode_id", "description": "(Required) The QR code ID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"title\": \"Minimal QR Code Updated\",\n \"tags\": [\n \"tag1\",\n \"tag2\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bdf77dfc-242a-4294-acb8-d26aa092fb09", "name": "GONE", "originalRequest": { "url": { "path": [ "qr-codes", ":qrcode_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "qrcode_id", "description": "(Required) The QR code ID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"title\": \"Minimal QR Code Updated\",\n \"tags\": [\n \"tag1\",\n \"tag2\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Gone", "code": 410, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7dad926f-ffd7-4bfc-adf6-1c7ea7b15d6d", "name": "INTERNAL_ERROR", "originalRequest": { "url": { "path": [ "qr-codes", ":qrcode_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "qrcode_id", "description": "(Required) The QR code ID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"title\": \"Minimal QR Code Updated\",\n \"tags\": [\n \"tag1\",\n \"tag2\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e569310f-ac01-43f0-a845-a5d4eee5cc06", "name": "Retrieve a QR Code", "request": { "name": "Retrieve a QR Code", "description": { "content": "Gets the QR code with a matching id.", "type": "text/plain" }, "url": { "path": [ "qr-codes", ":qrcode_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "qrcode_id", "description": "(Required) The QR Code ID" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "47ff5aef-c170-4136-9192-c5e52e3d3c4a", "name": "SUCCESS", "originalRequest": { "url": { "path": [ "qr-codes", ":qrcode_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "qrcode_id", "description": "(Required) The QR Code ID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"qrcode_id\": \"string\",\n \"group_guid\": \"string\",\n \"title\": \"string\",\n \"gs1\": {\n \"values\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n },\n \"render_customizations\": {\n \"background_color\": \"#ff07d280\",\n \"dot_pattern_color\": \"#ff07d2\",\n \"dot_pattern_type\": \"standard\",\n \"corners\": {\n \"corner_1\": {\n \"inner_color\": \"\",\n \"outer_color\": \"\",\n \"shape\": \"standard\"\n },\n \"corner_2\": {\n \"inner_color\": \"\",\n \"outer_color\": \"\",\n \"shape\": \"standard\"\n },\n \"corner_3\": {\n \"inner_color\": \"\",\n \"outer_color\": \"\",\n \"shape\": \"standard\"\n }\n },\n \"gradient\": {\n \"style\": \"no_gradient\",\n \"angle\": \"\",\n \"colors\": [\n {\n \"color\": \"#ff0098\",\n \"offset\": 0\n },\n {\n \"color\": \"#ff0098\",\n \"offset\": 0\n }\n ],\n \"exclude_corners\": \"\"\n },\n \"background_gradient\": {\n \"style\": \"no_gradient\",\n \"angle\": \"\",\n \"colors\": [\n {\n \"color\": \"#ff0098\",\n \"offset\": 0\n },\n {\n \"color\": \"#ff0098\",\n \"offset\": 0\n }\n ],\n \"exclude_corners\": \"\"\n },\n \"logo\": {\n \"image_guid\": \"\"\n },\n \"frame\": {\n \"id\": \"none\",\n \"colors\": {\n \"primary\": \"\",\n \"secondary\": \"\",\n \"background\": \"\"\n },\n \"text\": {\n \"primary\": {\n \"content\": \"\",\n \"color\": \"#ffffff\"\n },\n \"secondary\": {\n \"content\": \"\",\n \"color\": \"#ffffff\"\n }\n }\n },\n \"text\": {\n \"center\": {\n \"content\": \"Some example center text!\",\n \"color\": \"#ff0098\",\n \"font\": \"Helvetica\"\n },\n \"top\": {\n \"content\": \"Some example bottom text!\",\n \"color\": \"#00ff00\",\n \"font\": \"Helvetica\"\n },\n \"bottom\": {\n \"content\": \"Some example bottom text!\",\n \"color\": \"#000000\",\n \"font\": \"Helvetica\"\n }\n },\n \"branding\": {\n \"bitly_brand\": \"\"\n },\n \"spec_settings\": {\n \"error_correction\": \"\"\n }\n },\n \"qr_code_type\": \"phone\",\n \"bitlink_id\": \"string\",\n \"long_urls\": [\n \"string\",\n \"string\"\n ],\n \"serialized_content\": \"string\",\n \"archived\": false,\n \"created\": \"string\",\n \"modified\": \"string\",\n \"expiration_at\": \"string\",\n \"tags\": [\n \"string\",\n \"string\"\n ],\n \"dynamic_routing\": [\n {\n \"long_url\": \"\",\n \"country_match\": [\n \"\",\n \"\"\n ],\n \"country_exclude\": [\n \"\",\n \"\"\n ],\n \"region_match\": [\n \"\",\n \"\"\n ],\n \"region_exclude\": [\n \"\",\n \"\"\n ],\n \"device_match\": [\n \"\",\n \"\"\n ],\n \"device_exclude\": [\n \"\",\n \"\"\n ],\n \"os_match\": [\n \"\",\n \"\"\n ],\n \"os_exclude\": [\n \"\",\n \"\"\n ]\n },\n {\n \"long_url\": \"\",\n \"country_match\": [\n \"\",\n \"\"\n ],\n \"country_exclude\": [\n \"\",\n \"\"\n ],\n \"region_match\": [\n \"\",\n \"\"\n ],\n \"region_exclude\": [\n \"\",\n \"\"\n ],\n \"device_match\": [\n \"\",\n \"\"\n ],\n \"device_exclude\": [\n \"\",\n \"\"\n ],\n \"os_match\": [\n \"\",\n \"\"\n ],\n \"os_exclude\": [\n \"\",\n \"\"\n ]\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aabae1e6-0dca-4b42-9cc1-c60266e8be8a", "name": "BAD_REQUEST", "originalRequest": { "url": { "path": [ "qr-codes", ":qrcode_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "qrcode_id", "description": "(Required) The QR Code ID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "04184480-3fc8-4249-bf12-976c4d9c67cc", "name": "FORBIDDEN", "originalRequest": { "url": { "path": [ "qr-codes", ":qrcode_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "qrcode_id", "description": "(Required) The QR Code ID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c1e9b24f-add0-46eb-8cfd-3502a8660e42", "name": "NOT_FOUND", "originalRequest": { "url": { "path": [ "qr-codes", ":qrcode_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "qrcode_id", "description": "(Required) The QR Code ID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1cd00b35-b563-4eb0-b0e0-516c9e670230", "name": "GONE", "originalRequest": { "url": { "path": [ "qr-codes", ":qrcode_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "qrcode_id", "description": "(Required) The QR Code ID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Gone", "code": 410, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ce401684-2397-461e-b6a8-9ea549c7dd13", "name": "INTERNAL_ERROR", "originalRequest": { "url": { "path": [ "qr-codes", ":qrcode_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "qrcode_id", "description": "(Required) The QR Code ID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "abcf191d-5e8b-4e35-a5bb-ba1df98e1f50", "name": "Delete a QR Code", "request": { "name": "Delete a QR Code", "description": { "content": "Delete a QR Code that has not been redirected and is not for a custom link. Also deletes the associated link (if applicable).", "type": "text/plain" }, "url": { "path": [ "qr-codes", ":qrcode_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "qrcode_id", "description": "(Required) The QR Code ID" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "fe18706d-2793-4943-b049-85441b09bfab", "name": "SUCCESS", "originalRequest": { "url": { "path": [ "qr-codes", ":qrcode_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "qrcode_id", "description": "(Required) The QR Code ID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"qrcodes_deleted\": [\n {\n \"id\": \"string\"\n },\n {\n \"id\": \"string\"\n }\n ],\n \"links_deleted\": [\n {\n \"id\": \"string\"\n },\n {\n \"id\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "43d429d6-0d1d-4d03-9b08-acb5fbf1aaf0", "name": "BAD_REQUEST", "originalRequest": { "url": { "path": [ "qr-codes", ":qrcode_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "qrcode_id", "description": "(Required) The QR Code ID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ff083c4d-a51c-4f59-ac63-b8a89299f3aa", "name": "FORBIDDEN", "originalRequest": { "url": { "path": [ "qr-codes", ":qrcode_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "qrcode_id", "description": "(Required) The QR Code ID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "05449328-9b33-485e-80a9-e9c043ca8efd", "name": "NOT_FOUND", "originalRequest": { "url": { "path": [ "qr-codes", ":qrcode_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "qrcode_id", "description": "(Required) The QR Code ID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7ece01fc-106d-4a41-93c3-154be8a4f204", "name": "GONE", "originalRequest": { "url": { "path": [ "qr-codes", ":qrcode_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "qrcode_id", "description": "(Required) The QR Code ID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Gone", "code": 410, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "63174550-32d6-4079-84a1-a557a70fe5ad", "name": "MONTHLY_LIMIT_EXCEEDED", "originalRequest": { "url": { "path": [ "qr-codes", ":qrcode_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "qrcode_id", "description": "(Required) The QR Code ID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"API_USAGE_LIMIT_EXCEEDED\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d24b3763-42a5-4fd5-8ef3-88f635c809e2", "name": "INTERNAL_ERROR", "originalRequest": { "url": { "path": [ "qr-codes", ":qrcode_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "qrcode_id", "description": "(Required) The QR Code ID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8d7a5b15-14cf-4b9e-914d-25ae62309005", "name": "Retrieve QR Codes by Group", "request": { "name": "Retrieve QR Codes by Group", "description": { "content": "Retrieves a list of QR codes matching the filter settings. Values are in reverse chronological order.\nThe pagination occurs by calling the next link in the pagination response object.\n", "type": "text/plain" }, "url": { "path": [ "groups", ":group_guid", "qr-codes" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "has_render_customizations", "value": "both", "description": "Whether or not QRCode has any render customizations (like color or shape changes)" }, { "disabled": false, "key": "size", "value": "50", "description": "The quantity of items to be be returned" }, { "disabled": false, "key": "search_after", "value": "", "description": "Token used to search next batch of qr codes, only use response from API as input value." }, { "disabled": false, "key": "query", "value": "", "description": "The value that you would like to search" }, { "disabled": false, "key": "hostname_path_query", "value": "", "description": "The hostname and/or path you would like to search (case-insensitive). Subdomains included; query params and fragment ignored." }, { "disabled": false, "key": "created_before", "value": "", "description": "Timestamp as an integer unix epoch (seconds only)" }, { "disabled": false, "key": "created_after", "value": "", "description": "Timestamp as an integer unix epoch (seconds only)" }, { "disabled": false, "key": "archived", "value": "off", "description": "Whether or not to include archived resources" }, { "disabled": false, "key": "creating_login", "value": "", "description": "Filter by the login of the authenticated user that created the QR Code" }, { "disabled": false, "key": "creating_login", "value": "", "description": "Filter by the login of the authenticated user that created the QR Code" }, { "disabled": false, "key": "qrc_type", "value": "bitlink" }, { "disabled": false, "key": "qrc_type", "value": "long_url" }, { "disabled": false, "key": "is_gs1", "value": "both", "description": "a filter value if the resource is a GS1 QR code" }, { "disabled": false, "key": "is_expired", "value": "both", "description": "filter bitlinks by expiration status" }, { "disabled": false, "key": "has_expiration", "value": "both", "description": "filter bitlinks by presence of expiration" }, { "disabled": false, "key": "has_dynamic_routing", "value": "both", "description": "filter bitlinks by presence of dynamic routing rules" }, { "disabled": false, "key": "tags", "value": "", "description": "Filter by given tags" }, { "disabled": false, "key": "tags", "value": "", "description": "Filter by given tags" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "group_guid", "description": "(Required) A GUID for a Bitly group" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "cbd996c3-cdb9-487d-a020-765e3b91422a", "name": "SUCCESS", "originalRequest": { "url": { "path": [ "groups", ":group_guid", "qr-codes" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "has_render_customizations", "value": "both" }, { "key": "size", "value": "10" }, { "key": "search_after", "value": "" }, { "key": "query", "value": "api" }, { "key": "hostname_path_query", "value": "dev.bitly.com/api-reference" }, { "key": "created_before", "value": "1694529902" }, { "key": "created_after", "value": "1694529902" }, { "key": "archived", "value": "both" }, { "key": "creating_login", "value": "chauncey" }, { "key": "qrc_type", "value": "bitlink" }, { "key": "is_gs1", "value": "both" }, { "key": "is_expired", "value": "both" }, { "key": "has_expiration", "value": "both" }, { "key": "has_dynamic_routing", "value": "both" }, { "key": "tags", "value": "bitly" }, { "key": "tags", "value": "api" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "group_guid", "description": "(Required) A GUID for a Bitly group" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"qr_codes\": [\n {\n \"qrcode_id\": \"string\",\n \"group_guid\": \"string\",\n \"title\": \"string\",\n \"is_customized\": true,\n \"serialized_content\": \"string\",\n \"qr_code_type\": \"link_in_bio\",\n \"long_urls\": [\n \"string\",\n \"string\"\n ],\n \"bitlink_id\": \"string\",\n \"is_gs1\": true,\n \"created_by\": \"string\",\n \"tags\": [\n \"string\",\n \"string\"\n ],\n \"archived\": false,\n \"expiration_at\": \"string\",\n \"dynamic_routing\": [\n {\n \"long_url\": \"\",\n \"country_match\": [\n \"\",\n \"\"\n ],\n \"country_exclude\": [\n \"\",\n \"\"\n ],\n \"region_match\": [\n \"\",\n \"\"\n ],\n \"region_exclude\": [\n \"\",\n \"\"\n ],\n \"device_match\": [\n \"\",\n \"\"\n ],\n \"device_exclude\": [\n \"\",\n \"\"\n ],\n \"os_match\": [\n \"\",\n \"\"\n ],\n \"os_exclude\": [\n \"\",\n \"\"\n ]\n },\n {\n \"long_url\": \"\",\n \"country_match\": [\n \"\",\n \"\"\n ],\n \"country_exclude\": [\n \"\",\n \"\"\n ],\n \"region_match\": [\n \"\",\n \"\"\n ],\n \"region_exclude\": [\n \"\",\n \"\"\n ],\n \"device_match\": [\n \"\",\n \"\"\n ],\n \"device_exclude\": [\n \"\",\n \"\"\n ],\n \"os_match\": [\n \"\",\n \"\"\n ],\n \"os_exclude\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"created\": \"string\",\n \"modified\": \"string\"\n },\n {\n \"qrcode_id\": \"string\",\n \"group_guid\": \"string\",\n \"title\": \"string\",\n \"is_customized\": true,\n \"serialized_content\": \"string\",\n \"qr_code_type\": \"link_in_bio\",\n \"long_urls\": [\n \"string\",\n \"string\"\n ],\n \"bitlink_id\": \"string\",\n \"is_gs1\": true,\n \"created_by\": \"string\",\n \"tags\": [\n \"string\",\n \"string\"\n ],\n \"archived\": true,\n \"expiration_at\": \"string\",\n \"dynamic_routing\": [\n {\n \"long_url\": \"\",\n \"country_match\": [\n \"\",\n \"\"\n ],\n \"country_exclude\": [\n \"\",\n \"\"\n ],\n \"region_match\": [\n \"\",\n \"\"\n ],\n \"region_exclude\": [\n \"\",\n \"\"\n ],\n \"device_match\": [\n \"\",\n \"\"\n ],\n \"device_exclude\": [\n \"\",\n \"\"\n ],\n \"os_match\": [\n \"\",\n \"\"\n ],\n \"os_exclude\": [\n \"\",\n \"\"\n ]\n },\n {\n \"long_url\": \"\",\n \"country_match\": [\n \"\",\n \"\"\n ],\n \"country_exclude\": [\n \"\",\n \"\"\n ],\n \"region_match\": [\n \"\",\n \"\"\n ],\n \"region_exclude\": [\n \"\",\n \"\"\n ],\n \"device_match\": [\n \"\",\n \"\"\n ],\n \"device_exclude\": [\n \"\",\n \"\"\n ],\n \"os_match\": [\n \"\",\n \"\"\n ],\n \"os_exclude\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"created\": \"string\",\n \"modified\": \"string\"\n }\n ],\n \"pagination\": {\n \"next\": \"string\",\n \"search_after\": \"Qn8sfFRC2tm\",\n \"size\": 50\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1965ca32-dbf1-406f-aa03-85867ed4b3a7", "name": "FORBIDDEN", "originalRequest": { "url": { "path": [ "groups", ":group_guid", "qr-codes" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "has_render_customizations", "value": "both" }, { "key": "size", "value": "10" }, { "key": "search_after", "value": "" }, { "key": "query", "value": "api" }, { "key": "hostname_path_query", "value": "dev.bitly.com/api-reference" }, { "key": "created_before", "value": "1694529902" }, { "key": "created_after", "value": "1694529902" }, { "key": "archived", "value": "both" }, { "key": "creating_login", "value": "chauncey" }, { "key": "qrc_type", "value": "bitlink" }, { "key": "is_gs1", "value": "both" }, { "key": "is_expired", "value": "both" }, { "key": "has_expiration", "value": "both" }, { "key": "has_dynamic_routing", "value": "both" }, { "key": "tags", "value": "bitly" }, { "key": "tags", "value": "api" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "group_guid", "description": "(Required) A GUID for a Bitly group" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "74ac153b-d8a7-4586-a8e4-5b3b05d9a549", "name": "MONTHLY_LIMIT_EXCEEDED", "originalRequest": { "url": { "path": [ "groups", ":group_guid", "qr-codes" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "has_render_customizations", "value": "both" }, { "key": "size", "value": "10" }, { "key": "search_after", "value": "" }, { "key": "query", "value": "api" }, { "key": "hostname_path_query", "value": "dev.bitly.com/api-reference" }, { "key": "created_before", "value": "1694529902" }, { "key": "created_after", "value": "1694529902" }, { "key": "archived", "value": "both" }, { "key": "creating_login", "value": "chauncey" }, { "key": "qrc_type", "value": "bitlink" }, { "key": "is_gs1", "value": "both" }, { "key": "is_expired", "value": "both" }, { "key": "has_expiration", "value": "both" }, { "key": "has_dynamic_routing", "value": "both" }, { "key": "tags", "value": "bitly" }, { "key": "tags", "value": "api" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "group_guid", "description": "(Required) A GUID for a Bitly group" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"API_USAGE_LIMIT_EXCEEDED\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "713ce626-49bc-4db3-8842-a7fb85e4dc27", "name": "INTERNAL_ERROR", "originalRequest": { "url": { "path": [ "groups", ":group_guid", "qr-codes" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "has_render_customizations", "value": "both" }, { "key": "size", "value": "10" }, { "key": "search_after", "value": "" }, { "key": "query", "value": "api" }, { "key": "hostname_path_query", "value": "dev.bitly.com/api-reference" }, { "key": "created_before", "value": "1694529902" }, { "key": "created_after", "value": "1694529902" }, { "key": "archived", "value": "both" }, { "key": "creating_login", "value": "chauncey" }, { "key": "qrc_type", "value": "bitlink" }, { "key": "is_gs1", "value": "both" }, { "key": "is_expired", "value": "both" }, { "key": "has_expiration", "value": "both" }, { "key": "has_dynamic_routing", "value": "both" }, { "key": "tags", "value": "bitly" }, { "key": "tags", "value": "api" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "group_guid", "description": "(Required) A GUID for a Bitly group" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "96df697f-e9f5-4513-ae8b-a30b41697b26", "name": "Bulk update QR codes", "request": { "name": "Bulk update QR codes", "description": { "content": "Bulk update can add or remove tags, or archive/un-archive, up to 100 QR codes at a time.\nPages QR codes cannot be updated with this endpoint.\nThe response includes a list of QR code ids that were updated.\n", "type": "text/plain" }, "url": { "path": [ "groups", ":group_guid", "qr-codes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "group_guid", "description": "(Required) A GUID for a Bitly group" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": null, "body": { "mode": "raw", "raw": "{\n \"action\": \"\",\n \"archive\": \"\",\n \"add_tags\": [\n \"\",\n \"\"\n ],\n \"remove_tags\": [\n \"\",\n \"\"\n ],\n \"qr_code_ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "a79187f2-116a-4180-a5a8-798a1e0a2864", "name": "SUCCESS", "originalRequest": { "url": { "path": [ "groups", ":group_guid", "qr-codes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "group_guid", "description": "(Required) A GUID for a Bitly group" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"action\": \"edit_tags\",\n \"add_tags\": [\n \"tag1\",\n \"tag2\"\n ],\n \"qr_code_ids\": [\n \"Qo9id25UxtOcnns\",\n \"Qb1a2c3d4e5f6g7\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"qr_code_ids\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1031a052-e9c9-4e12-b76d-350f8c8466bb", "name": "BAD_REQUEST", "originalRequest": { "url": { "path": [ "groups", ":group_guid", "qr-codes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "group_guid", "description": "(Required) A GUID for a Bitly group" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"action\": \"edit_tags\",\n \"add_tags\": [\n \"tag1\",\n \"tag2\"\n ],\n \"qr_code_ids\": [\n \"Qo9id25UxtOcnns\",\n \"Qb1a2c3d4e5f6g7\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "83d9a8b6-5326-4ce0-a025-20ec73a42740", "name": "FORBIDDEN", "originalRequest": { "url": { "path": [ "groups", ":group_guid", "qr-codes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "group_guid", "description": "(Required) A GUID for a Bitly group" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"action\": \"edit_tags\",\n \"add_tags\": [\n \"tag1\",\n \"tag2\"\n ],\n \"qr_code_ids\": [\n \"Qo9id25UxtOcnns\",\n \"Qb1a2c3d4e5f6g7\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "37def79a-2778-4aae-b682-23feef8d4e05", "name": "NOT_FOUND", "originalRequest": { "url": { "path": [ "groups", ":group_guid", "qr-codes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "group_guid", "description": "(Required) A GUID for a Bitly group" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"action\": \"edit_tags\",\n \"add_tags\": [\n \"tag1\",\n \"tag2\"\n ],\n \"qr_code_ids\": [\n \"Qo9id25UxtOcnns\",\n \"Qb1a2c3d4e5f6g7\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ee00e746-7ffe-4afb-8f78-e520871ca37b", "name": "GONE", "originalRequest": { "url": { "path": [ "groups", ":group_guid", "qr-codes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "group_guid", "description": "(Required) A GUID for a Bitly group" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"action\": \"edit_tags\",\n \"add_tags\": [\n \"tag1\",\n \"tag2\"\n ],\n \"qr_code_ids\": [\n \"Qo9id25UxtOcnns\",\n \"Qb1a2c3d4e5f6g7\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Gone", "code": 410, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "456e0b1c-3c6e-4a02-87e8-ff53c72fbde1", "name": "UNPROCESSABLE_ENTITY", "originalRequest": { "url": { "path": [ "groups", ":group_guid", "qr-codes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "group_guid", "description": "(Required) A GUID for a Bitly group" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"action\": \"edit_tags\",\n \"add_tags\": [\n \"tag1\",\n \"tag2\"\n ],\n \"qr_code_ids\": [\n \"Qo9id25UxtOcnns\",\n \"Qb1a2c3d4e5f6g7\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8fe8272d-ef96-4816-b0d9-acda5191dabf", "name": "MONTHLY_LIMIT_EXCEEDED", "originalRequest": { "url": { "path": [ "groups", ":group_guid", "qr-codes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "group_guid", "description": "(Required) A GUID for a Bitly group" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"action\": \"edit_tags\",\n \"add_tags\": [\n \"tag1\",\n \"tag2\"\n ],\n \"qr_code_ids\": [\n \"Qo9id25UxtOcnns\",\n \"Qb1a2c3d4e5f6g7\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"API_USAGE_LIMIT_EXCEEDED\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d915e748-e3be-4f23-a341-a44fdec76091", "name": "INTERNAL_ERROR", "originalRequest": { "url": { "path": [ "groups", ":group_guid", "qr-codes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "group_guid", "description": "(Required) A GUID for a Bitly group" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"action\": \"edit_tags\",\n \"add_tags\": [\n \"tag1\",\n \"tag2\"\n ],\n \"qr_code_ids\": [\n \"Qo9id25UxtOcnns\",\n \"Qb1a2c3d4e5f6g7\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7518741d-51d6-4a81-8ffb-feb0504c08aa", "name": "TEMPORARILY_UNAVAILABLE", "originalRequest": { "url": { "path": [ "groups", ":group_guid", "qr-codes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "group_guid", "description": "(Required) A GUID for a Bitly group" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"action\": \"edit_tags\",\n \"add_tags\": [\n \"tag1\",\n \"tag2\"\n ],\n \"qr_code_ids\": [\n \"Qo9id25UxtOcnns\",\n \"Qb1a2c3d4e5f6g7\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3c3bbce2-33ba-49b1-b74e-04ab60f3892e", "name": "Get Scans for a QR Code", "request": { "name": "Get Scans for a QR Code", "description": { "content": "Returns an array of scan counts for the specified QR code. The array is comprised of scan counts for each time window, where the window is based on the provided unit.", "type": "text/plain" }, "url": { "path": [ "qr-codes", ":qrcode_id", "scans" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "unit", "value": "day", "description": "(Required) A unit of time" }, { "disabled": false, "key": "units", "value": "-1", "description": "(Required) An integer representing the time units to query data for. pass -1 to return all units of time" }, { "disabled": false, "key": "unit_reference", "value": "", "description": "An ISO-8601 timestamp, indicating the most recent time for which to pull metrics. Will default to current time. Timestamp values should be url encoded (i.e. replace '+' with '%2B' and ':' with '%3A'; 2022-02-02T15:53:02+0000 becomes 2022-02-02T15%3A53%3A02%2B0000)" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "qrcode_id", "description": "(Required) The QR Code ID" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "c82b696c-0ca9-40f6-9b82-1b62ca778b09", "name": "SUCCESS", "originalRequest": { "url": { "path": [ "qr-codes", ":qrcode_id", "scans" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "unit", "value": "month" }, { "key": "units", "value": "1" }, { "key": "unit_reference", "value": "2006-01-02T15:04:05-0700" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "qrcode_id", "description": "(Required) The QR Code ID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"scans\": [\n {\n \"scans\": 8133,\n \"date\": \"string\"\n },\n {\n \"scans\": 5800,\n \"date\": \"string\"\n }\n ],\n \"units\": 7836,\n \"unit\": \"hour\",\n \"unit_reference\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dd704e16-0322-4d33-9753-03d86e58a3ea", "name": "BAD_REQUEST", "originalRequest": { "url": { "path": [ "qr-codes", ":qrcode_id", "scans" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "unit", "value": "month" }, { "key": "units", "value": "1" }, { "key": "unit_reference", "value": "2006-01-02T15:04:05-0700" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "qrcode_id", "description": "(Required) The QR Code ID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "72b5d44e-81a5-4e38-993d-3c54185bdb99", "name": "FORBIDDEN", "originalRequest": { "url": { "path": [ "qr-codes", ":qrcode_id", "scans" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "unit", "value": "month" }, { "key": "units", "value": "1" }, { "key": "unit_reference", "value": "2006-01-02T15:04:05-0700" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "qrcode_id", "description": "(Required) The QR Code ID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c203c800-0dd0-4066-bad3-8bbb3838ef77", "name": "NOT_FOUND", "originalRequest": { "url": { "path": [ "qr-codes", ":qrcode_id", "scans" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "unit", "value": "month" }, { "key": "units", "value": "1" }, { "key": "unit_reference", "value": "2006-01-02T15:04:05-0700" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "qrcode_id", "description": "(Required) The QR Code ID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e6c27c25-46e0-40da-8915-4cbd61dfcf2f", "name": "GONE", "originalRequest": { "url": { "path": [ "qr-codes", ":qrcode_id", "scans" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "unit", "value": "month" }, { "key": "units", "value": "1" }, { "key": "unit_reference", "value": "2006-01-02T15:04:05-0700" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "qrcode_id", "description": "(Required) The QR Code ID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Gone", "code": 410, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cc747d4e-e61f-486e-8d78-c752b24307b0", "name": "INTERNAL_ERROR", "originalRequest": { "url": { "path": [ "qr-codes", ":qrcode_id", "scans" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "unit", "value": "month" }, { "key": "units", "value": "1" }, { "key": "unit_reference", "value": "2006-01-02T15:04:05-0700" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "qrcode_id", "description": "(Required) The QR Code ID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3141b98a-984e-4932-863f-7ec0b7394b7f", "name": "TEMPORARILY_UNAVAILABLE", "originalRequest": { "url": { "path": [ "qr-codes", ":qrcode_id", "scans" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "unit", "value": "month" }, { "key": "units", "value": "1" }, { "key": "unit_reference", "value": "2006-01-02T15:04:05-0700" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "qrcode_id", "description": "(Required) The QR Code ID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "09a78e8b-f762-43b0-97c0-e94a17ee4d14", "name": "Get Scans Summary for a QR Code", "request": { "name": "Get Scans Summary for a QR Code", "description": { "content": "Returns the scan counts for a QR Code rolled up into a single field for a specified time window, where the window is based on the provided unit.", "type": "text/plain" }, "url": { "path": [ "qr-codes", ":qrcode_id", "scans", "summary" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "unit", "value": "day", "description": "(Required) A unit of time" }, { "disabled": false, "key": "units", "value": "-1", "description": "(Required) An integer representing the time units to query data for. pass -1 to return all units of time" }, { "disabled": false, "key": "unit_reference", "value": "", "description": "An ISO-8601 timestamp, indicating the most recent time for which to pull metrics. Will default to current time. Timestamp values should be url encoded (i.e. replace '+' with '%2B' and ':' with '%3A'; 2022-02-02T15:53:02+0000 becomes 2022-02-02T15%3A53%3A02%2B0000)" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "qrcode_id", "description": "(Required) The QR Code ID" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "57c8ca1e-6e2d-413a-ac9c-36af4ef441e7", "name": "SUCCESS", "originalRequest": { "url": { "path": [ "qr-codes", ":qrcode_id", "scans", "summary" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "unit", "value": "month" }, { "key": "units", "value": "1" }, { "key": "unit_reference", "value": "2006-01-02T15:04:05-0700" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "qrcode_id", "description": "(Required) The QR Code ID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"total_scans\": 4572,\n \"units\": 7647,\n \"unit\": \"minute\",\n \"unit_reference\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "42301afb-539d-4e87-84d3-23549bf63f2e", "name": "BAD_REQUEST", "originalRequest": { "url": { "path": [ "qr-codes", ":qrcode_id", "scans", "summary" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "unit", "value": "month" }, { "key": "units", "value": "1" }, { "key": "unit_reference", "value": "2006-01-02T15:04:05-0700" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "qrcode_id", "description": "(Required) The QR Code ID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "190b2584-5b30-494b-9e68-c2ed0c1dd654", "name": "FORBIDDEN", "originalRequest": { "url": { "path": [ "qr-codes", ":qrcode_id", "scans", "summary" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "unit", "value": "month" }, { "key": "units", "value": "1" }, { "key": "unit_reference", "value": "2006-01-02T15:04:05-0700" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "qrcode_id", "description": "(Required) The QR Code ID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fb09dd0d-ac8f-4294-88b3-428df16332cc", "name": "NOT_FOUND", "originalRequest": { "url": { "path": [ "qr-codes", ":qrcode_id", "scans", "summary" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "unit", "value": "month" }, { "key": "units", "value": "1" }, { "key": "unit_reference", "value": "2006-01-02T15:04:05-0700" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "qrcode_id", "description": "(Required) The QR Code ID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5978d912-6fee-48b8-9d95-ed9ebe090c5a", "name": "GONE", "originalRequest": { "url": { "path": [ "qr-codes", ":qrcode_id", "scans", "summary" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "unit", "value": "month" }, { "key": "units", "value": "1" }, { "key": "unit_reference", "value": "2006-01-02T15:04:05-0700" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "qrcode_id", "description": "(Required) The QR Code ID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Gone", "code": 410, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7874f962-e438-47d4-aaa8-b678a69687be", "name": "INTERNAL_ERROR", "originalRequest": { "url": { "path": [ "qr-codes", ":qrcode_id", "scans", "summary" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "unit", "value": "month" }, { "key": "units", "value": "1" }, { "key": "unit_reference", "value": "2006-01-02T15:04:05-0700" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "qrcode_id", "description": "(Required) The QR Code ID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fb04fed6-b969-4690-96b6-5fdeade713f4", "name": "TEMPORARILY_UNAVAILABLE", "originalRequest": { "url": { "path": [ "qr-codes", ":qrcode_id", "scans", "summary" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "unit", "value": "month" }, { "key": "units", "value": "1" }, { "key": "unit_reference", "value": "2006-01-02T15:04:05-0700" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "qrcode_id", "description": "(Required) The QR Code ID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d54653d2-7119-4bd5-8970-09768a99c33d", "name": "Get Scans for a QR Code by Country", "request": { "name": "Get Scans for a QR Code by Country", "description": { "content": "Returns the country origins of scan traffic for the specified QR Code.", "type": "text/plain" }, "url": { "path": [ "qr-codes", ":qrcode_id", "scans", "countries" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "unit", "value": "day", "description": "(Required) A unit of time" }, { "disabled": false, "key": "units", "value": "-1", "description": "(Required) An integer representing the time units to query data for. pass -1 to return all units of time" }, { "disabled": false, "key": "size", "value": "50", "description": "The quantity of items to be be returned" }, { "disabled": false, "key": "unit_reference", "value": "", "description": "An ISO-8601 timestamp, indicating the most recent time for which to pull metrics. Will default to current time. Timestamp values should be url encoded (i.e. replace '+' with '%2B' and ':' with '%3A'; 2022-02-02T15:53:02+0000 becomes 2022-02-02T15%3A53%3A02%2B0000)" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "qrcode_id", "description": "(Required) The QR Code ID" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "f05b331c-00d9-47c6-a596-027312d5a089", "name": "SUCCESS", "originalRequest": { "url": { "path": [ "qr-codes", ":qrcode_id", "scans", "countries" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "unit", "value": "month" }, { "key": "units", "value": "1" }, { "key": "size", "value": "10" }, { "key": "unit_reference", "value": "2006-01-02T15:04:05-0700" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "qrcode_id", "description": "(Required) The QR Code ID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"unit\": \"string\",\n \"units\": 9153,\n \"facet\": \"cities\",\n \"unit_reference\": \"string\",\n \"metrics\": [\n {\n \"scans\": 7598,\n \"value\": \"string\"\n },\n {\n \"scans\": 1930,\n \"value\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "27aaae9d-2d15-4b9a-abb5-667032b75ac3", "name": "BAD_REQUEST", "originalRequest": { "url": { "path": [ "qr-codes", ":qrcode_id", "scans", "countries" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "unit", "value": "month" }, { "key": "units", "value": "1" }, { "key": "size", "value": "10" }, { "key": "unit_reference", "value": "2006-01-02T15:04:05-0700" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "qrcode_id", "description": "(Required) The QR Code ID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fe45e6b8-d519-4b2f-82e0-17fa51c32d1d", "name": "FORBIDDEN", "originalRequest": { "url": { "path": [ "qr-codes", ":qrcode_id", "scans", "countries" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "unit", "value": "month" }, { "key": "units", "value": "1" }, { "key": "size", "value": "10" }, { "key": "unit_reference", "value": "2006-01-02T15:04:05-0700" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "qrcode_id", "description": "(Required) The QR Code ID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "281124ff-4cb0-43e1-b932-e9f4cdd11bfb", "name": "NOT_FOUND", "originalRequest": { "url": { "path": [ "qr-codes", ":qrcode_id", "scans", "countries" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "unit", "value": "month" }, { "key": "units", "value": "1" }, { "key": "size", "value": "10" }, { "key": "unit_reference", "value": "2006-01-02T15:04:05-0700" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "qrcode_id", "description": "(Required) The QR Code ID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f33aba2f-e7d5-4f72-982d-8b4ab62698e2", "name": "GONE", "originalRequest": { "url": { "path": [ "qr-codes", ":qrcode_id", "scans", "countries" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "unit", "value": "month" }, { "key": "units", "value": "1" }, { "key": "size", "value": "10" }, { "key": "unit_reference", "value": "2006-01-02T15:04:05-0700" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "qrcode_id", "description": "(Required) The QR Code ID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Gone", "code": 410, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a1ac1ee5-5ef1-4342-8fba-7406e140d466", "name": "INTERNAL_ERROR", "originalRequest": { "url": { "path": [ "qr-codes", ":qrcode_id", "scans", "countries" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "unit", "value": "month" }, { "key": "units", "value": "1" }, { "key": "size", "value": "10" }, { "key": "unit_reference", "value": "2006-01-02T15:04:05-0700" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "qrcode_id", "description": "(Required) The QR Code ID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "62376afd-865f-4a54-b9f8-83283847339e", "name": "TEMPORARILY_UNAVAILABLE", "originalRequest": { "url": { "path": [ "qr-codes", ":qrcode_id", "scans", "countries" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "unit", "value": "month" }, { "key": "units", "value": "1" }, { "key": "size", "value": "10" }, { "key": "unit_reference", "value": "2006-01-02T15:04:05-0700" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "qrcode_id", "description": "(Required) The QR Code ID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5278f529-363c-4518-8a2a-eba7bbed9d13", "name": "Get Metrics for a QR Code by City", "request": { "name": "Get Metrics for a QR Code by City", "description": { "content": "Returns the city origins of scan traffic for the specified QR Code.", "type": "text/plain" }, "url": { "path": [ "qr-codes", ":qrcode_id", "scans", "cities" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "unit", "value": "day", "description": "(Required) A unit of time" }, { "disabled": false, "key": "units", "value": "-1", "description": "(Required) An integer representing the time units to query data for. pass -1 to return all units of time" }, { "disabled": false, "key": "size", "value": "50", "description": "The quantity of items to be be returned" }, { "disabled": false, "key": "unit_reference", "value": "", "description": "An ISO-8601 timestamp, indicating the most recent time for which to pull metrics. Will default to current time. Timestamp values should be url encoded (i.e. replace '+' with '%2B' and ':' with '%3A'; 2022-02-02T15:53:02+0000 becomes 2022-02-02T15%3A53%3A02%2B0000)" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "qrcode_id", "description": "(Required) The QR Code ID" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "b17d3b01-8d43-4267-a52e-33c5e727e344", "name": "SUCCESS", "originalRequest": { "url": { "path": [ "qr-codes", ":qrcode_id", "scans", "cities" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "unit", "value": "month" }, { "key": "units", "value": "1" }, { "key": "size", "value": "10" }, { "key": "unit_reference", "value": "2006-01-02T15:04:05-0700" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "qrcode_id", "description": "(Required) The QR Code ID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"unit\": \"string\",\n \"units\": 1219,\n \"facet\": \"device_os\",\n \"unit_reference\": \"string\",\n \"metrics\": [\n {\n \"scans\": 4067,\n \"city\": \"string\",\n \"subregion\": \"string\",\n \"region\": \"string\",\n \"country\": \"string\"\n },\n {\n \"scans\": 7749,\n \"city\": \"string\",\n \"subregion\": \"string\",\n \"region\": \"string\",\n \"country\": \"string\"\n }\n ],\n \"other_metrics\": {\n \"other_city_scans\": 441,\n \"no_city_scans\": 1563\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3c5623c6-5080-4109-9913-e9680daf5274", "name": "BAD_REQUEST", "originalRequest": { "url": { "path": [ "qr-codes", ":qrcode_id", "scans", "cities" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "unit", "value": "month" }, { "key": "units", "value": "1" }, { "key": "size", "value": "10" }, { "key": "unit_reference", "value": "2006-01-02T15:04:05-0700" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "qrcode_id", "description": "(Required) The QR Code ID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6210cd57-a8e4-43ed-aa0f-8cc858bf6d53", "name": "UPGRADE_REQUIRED", "originalRequest": { "url": { "path": [ "qr-codes", ":qrcode_id", "scans", "cities" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "unit", "value": "month" }, { "key": "units", "value": "1" }, { "key": "size", "value": "10" }, { "key": "unit_reference", "value": "2006-01-02T15:04:05-0700" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "qrcode_id", "description": "(Required) The QR Code ID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Payment Required", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "759181a2-9a79-4e66-8ef7-0339529d5d75", "name": "FORBIDDEN", "originalRequest": { "url": { "path": [ "qr-codes", ":qrcode_id", "scans", "cities" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "unit", "value": "month" }, { "key": "units", "value": "1" }, { "key": "size", "value": "10" }, { "key": "unit_reference", "value": "2006-01-02T15:04:05-0700" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "qrcode_id", "description": "(Required) The QR Code ID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ea47092f-fbca-4f69-a7ff-0ae5347ef685", "name": "NOT_FOUND", "originalRequest": { "url": { "path": [ "qr-codes", ":qrcode_id", "scans", "cities" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "unit", "value": "month" }, { "key": "units", "value": "1" }, { "key": "size", "value": "10" }, { "key": "unit_reference", "value": "2006-01-02T15:04:05-0700" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "qrcode_id", "description": "(Required) The QR Code ID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "93a0afeb-b920-440d-b313-8201f5e73441", "name": "GONE", "originalRequest": { "url": { "path": [ "qr-codes", ":qrcode_id", "scans", "cities" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "unit", "value": "month" }, { "key": "units", "value": "1" }, { "key": "size", "value": "10" }, { "key": "unit_reference", "value": "2006-01-02T15:04:05-0700" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "qrcode_id", "description": "(Required) The QR Code ID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Gone", "code": 410, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4b6e91c7-6f99-48f8-9b2f-1c80805c5fb6", "name": "INTERNAL_ERROR", "originalRequest": { "url": { "path": [ "qr-codes", ":qrcode_id", "scans", "cities" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "unit", "value": "month" }, { "key": "units", "value": "1" }, { "key": "size", "value": "10" }, { "key": "unit_reference", "value": "2006-01-02T15:04:05-0700" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "qrcode_id", "description": "(Required) The QR Code ID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "24d97985-a1c1-4124-b127-d82b35083378", "name": "TEMPORARILY_UNAVAILABLE", "originalRequest": { "url": { "path": [ "qr-codes", ":qrcode_id", "scans", "cities" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "unit", "value": "month" }, { "key": "units", "value": "1" }, { "key": "size", "value": "10" }, { "key": "unit_reference", "value": "2006-01-02T15:04:05-0700" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "qrcode_id", "description": "(Required) The QR Code ID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4095c91f-9da5-4efe-8b62-7a29a5e19589", "name": "Get Scans for a QR Code by Device OS", "request": { "name": "Get Scans for a QR Code by Device OS", "description": { "content": "Returns the device os generating scan traffic for the specified QR Code.", "type": "text/plain" }, "url": { "path": [ "qr-codes", ":qrcode_id", "scans", "device_os" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "unit", "value": "day", "description": "(Required) A unit of time" }, { "disabled": false, "key": "units", "value": "-1", "description": "(Required) An integer representing the time units to query data for. pass -1 to return all units of time" }, { "disabled": false, "key": "size", "value": "50", "description": "The quantity of items to be be returned" }, { "disabled": false, "key": "unit_reference", "value": "", "description": "An ISO-8601 timestamp, indicating the most recent time for which to pull metrics. Will default to current time. Timestamp values should be url encoded (i.e. replace '+' with '%2B' and ':' with '%3A'; 2022-02-02T15:53:02+0000 becomes 2022-02-02T15%3A53%3A02%2B0000)" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "qrcode_id", "description": "(Required) The QR Code ID" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "d5c09f36-0512-4d8a-a6ab-9fa85ff0786f", "name": "SUCCESS", "originalRequest": { "url": { "path": [ "qr-codes", ":qrcode_id", "scans", "device_os" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "unit", "value": "month" }, { "key": "units", "value": "1" }, { "key": "size", "value": "10" }, { "key": "unit_reference", "value": "2006-01-02T15:04:05-0700" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "qrcode_id", "description": "(Required) The QR Code ID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"unit\": \"string\",\n \"units\": 999,\n \"facet\": \"countries\",\n \"unit_reference\": \"string\",\n \"metrics\": [\n {\n \"scans\": 4744,\n \"value\": \"string\"\n },\n {\n \"scans\": 6272,\n \"value\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1b0a56da-6c96-4f8a-832e-932d5aa857b5", "name": "BAD_REQUEST", "originalRequest": { "url": { "path": [ "qr-codes", ":qrcode_id", "scans", "device_os" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "unit", "value": "month" }, { "key": "units", "value": "1" }, { "key": "size", "value": "10" }, { "key": "unit_reference", "value": "2006-01-02T15:04:05-0700" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "qrcode_id", "description": "(Required) The QR Code ID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "343a8658-c875-46b6-b10e-746905e50f34", "name": "UPGRADE_REQUIRED", "originalRequest": { "url": { "path": [ "qr-codes", ":qrcode_id", "scans", "device_os" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "unit", "value": "month" }, { "key": "units", "value": "1" }, { "key": "size", "value": "10" }, { "key": "unit_reference", "value": "2006-01-02T15:04:05-0700" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "qrcode_id", "description": "(Required) The QR Code ID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Payment Required", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d7f0845e-210c-494c-8cc2-43ba778d4618", "name": "FORBIDDEN", "originalRequest": { "url": { "path": [ "qr-codes", ":qrcode_id", "scans", "device_os" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "unit", "value": "month" }, { "key": "units", "value": "1" }, { "key": "size", "value": "10" }, { "key": "unit_reference", "value": "2006-01-02T15:04:05-0700" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "qrcode_id", "description": "(Required) The QR Code ID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4c534636-17fa-472f-9c07-26d66d159382", "name": "NOT_FOUND", "originalRequest": { "url": { "path": [ "qr-codes", ":qrcode_id", "scans", "device_os" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "unit", "value": "month" }, { "key": "units", "value": "1" }, { "key": "size", "value": "10" }, { "key": "unit_reference", "value": "2006-01-02T15:04:05-0700" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "qrcode_id", "description": "(Required) The QR Code ID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "be4a6e2c-1c71-4247-b9cd-3860f8c6f3d1", "name": "GONE", "originalRequest": { "url": { "path": [ "qr-codes", ":qrcode_id", "scans", "device_os" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "unit", "value": "month" }, { "key": "units", "value": "1" }, { "key": "size", "value": "10" }, { "key": "unit_reference", "value": "2006-01-02T15:04:05-0700" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "qrcode_id", "description": "(Required) The QR Code ID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Gone", "code": 410, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2c2e3fe2-ea10-4621-bb09-851d3cc06857", "name": "INTERNAL_ERROR", "originalRequest": { "url": { "path": [ "qr-codes", ":qrcode_id", "scans", "device_os" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "unit", "value": "month" }, { "key": "units", "value": "1" }, { "key": "size", "value": "10" }, { "key": "unit_reference", "value": "2006-01-02T15:04:05-0700" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "qrcode_id", "description": "(Required) The QR Code ID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a4b07912-4a10-453c-bf0e-76e4a3b8824f", "name": "TEMPORARILY_UNAVAILABLE", "originalRequest": { "url": { "path": [ "qr-codes", ":qrcode_id", "scans", "device_os" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "unit", "value": "month" }, { "key": "units", "value": "1" }, { "key": "size", "value": "10" }, { "key": "unit_reference", "value": "2006-01-02T15:04:05-0700" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "qrcode_id", "description": "(Required) The QR Code ID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b43d5e3e-6bfb-4e0b-bb56-dd9581f319f4", "name": "Get Scans for a QR Code by Browser", "request": { "name": "Get Scans for a QR Code by Browser", "description": { "content": "Returns the browsers generating scan traffic to the specified QR Code.", "type": "text/plain" }, "url": { "path": [ "qr-codes", ":qrcode_id", "scans", "browsers" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "unit", "value": "day", "description": "(Required) A unit of time" }, { "disabled": false, "key": "units", "value": "-1", "description": "(Required) An integer representing the time units to query data for. pass -1 to return all units of time" }, { "disabled": false, "key": "size", "value": "50", "description": "The quantity of items to be be returned" }, { "disabled": false, "key": "unit_reference", "value": "", "description": "An ISO-8601 timestamp, indicating the most recent time for which to pull metrics. Will default to current time. Timestamp values should be url encoded (i.e. replace '+' with '%2B' and ':' with '%3A'; 2022-02-02T15:53:02+0000 becomes 2022-02-02T15%3A53%3A02%2B0000)" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "qrcode_id", "description": "(Required) The QR Code ID" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "5255af4a-9972-464d-968e-656380cb542b", "name": "SUCCESS", "originalRequest": { "url": { "path": [ "qr-codes", ":qrcode_id", "scans", "browsers" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "unit", "value": "month" }, { "key": "units", "value": "1" }, { "key": "size", "value": "10" }, { "key": "unit_reference", "value": "2006-01-02T15:04:05-0700" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "qrcode_id", "description": "(Required) The QR Code ID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"unit\": \"string\",\n \"units\": 999,\n \"facet\": \"countries\",\n \"unit_reference\": \"string\",\n \"metrics\": [\n {\n \"scans\": 4744,\n \"value\": \"string\"\n },\n {\n \"scans\": 6272,\n \"value\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5154341d-cc68-48dd-89fc-c98a61a0fb67", "name": "BAD_REQUEST", "originalRequest": { "url": { "path": [ "qr-codes", ":qrcode_id", "scans", "browsers" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "unit", "value": "month" }, { "key": "units", "value": "1" }, { "key": "size", "value": "10" }, { "key": "unit_reference", "value": "2006-01-02T15:04:05-0700" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "qrcode_id", "description": "(Required) The QR Code ID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3c11812e-5d6c-45ca-946b-e2316bd1aa72", "name": "UPGRADE_REQUIRED", "originalRequest": { "url": { "path": [ "qr-codes", ":qrcode_id", "scans", "browsers" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "unit", "value": "month" }, { "key": "units", "value": "1" }, { "key": "size", "value": "10" }, { "key": "unit_reference", "value": "2006-01-02T15:04:05-0700" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "qrcode_id", "description": "(Required) The QR Code ID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Payment Required", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "19afacd9-da47-46c1-ae23-006f687b06e0", "name": "FORBIDDEN", "originalRequest": { "url": { "path": [ "qr-codes", ":qrcode_id", "scans", "browsers" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "unit", "value": "month" }, { "key": "units", "value": "1" }, { "key": "size", "value": "10" }, { "key": "unit_reference", "value": "2006-01-02T15:04:05-0700" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "qrcode_id", "description": "(Required) The QR Code ID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a3d36fdd-56ea-40a7-9889-c720fca09b1a", "name": "NOT_FOUND", "originalRequest": { "url": { "path": [ "qr-codes", ":qrcode_id", "scans", "browsers" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "unit", "value": "month" }, { "key": "units", "value": "1" }, { "key": "size", "value": "10" }, { "key": "unit_reference", "value": "2006-01-02T15:04:05-0700" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "qrcode_id", "description": "(Required) The QR Code ID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "418bcd4e-5671-4f2c-80c1-96c1985891e5", "name": "GONE", "originalRequest": { "url": { "path": [ "qr-codes", ":qrcode_id", "scans", "browsers" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "unit", "value": "month" }, { "key": "units", "value": "1" }, { "key": "size", "value": "10" }, { "key": "unit_reference", "value": "2006-01-02T15:04:05-0700" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "qrcode_id", "description": "(Required) The QR Code ID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Gone", "code": 410, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "844bdcb6-1007-4925-9d03-d79160205892", "name": "INTERNAL_ERROR", "originalRequest": { "url": { "path": [ "qr-codes", ":qrcode_id", "scans", "browsers" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "unit", "value": "month" }, { "key": "units", "value": "1" }, { "key": "size", "value": "10" }, { "key": "unit_reference", "value": "2006-01-02T15:04:05-0700" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "qrcode_id", "description": "(Required) The QR Code ID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9aacecee-92e6-443b-925a-19deda9eb139", "name": "TEMPORARILY_UNAVAILABLE", "originalRequest": { "url": { "path": [ "qr-codes", ":qrcode_id", "scans", "browsers" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "unit", "value": "month" }, { "key": "units", "value": "1" }, { "key": "size", "value": "10" }, { "key": "unit_reference", "value": "2006-01-02T15:04:05-0700" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "qrcode_id", "description": "(Required) The QR Code ID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b1d4759d-b24f-4005-80d2-6f94e7727f32", "name": "Upgrade a QR Code to a bitlink", "request": { "name": "Upgrade a QR Code to a bitlink", "description": { "content": "Upgrades a stand alone (decoupled) QR Code to a coupled QR Code by associating it with its underlying Bitly short link. This operation consumes one encode from the organization's monthly Link limit. If the QR Code is already coupled, no encode is consumed.", "type": "text/plain" }, "url": { "path": [ "qr-codes", ":qrcode_id", "to-bitlink" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "qrcode_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": null }, "response": [ { "id": "c8e455da-0bbb-4419-8bed-71554c0644ee", "name": "SUCCESS", "originalRequest": { "url": { "path": [ "qr-codes", ":qrcode_id", "to-bitlink" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "qrcode_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"link\": \"https://bit.ly/abc123\",\n \"id\": \"bit.ly/abc123\",\n \"long_url\": \"https://example.com/page\",\n \"title\": \"My Stand Alone QR Code\",\n \"archived\": false,\n \"created_at\": \"2024-01-15T10:00:00+0000\",\n \"created_by\": \"jane\",\n \"custom_bitlinks\": [],\n \"tags\": [],\n \"qr_code_ids\": [\n \"Ab1Cd2Ef3G4\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c9ffbb14-fef3-4855-bbb6-ba81da2517db", "name": "BAD_REQUEST", "originalRequest": { "url": { "path": [ "qr-codes", ":qrcode_id", "to-bitlink" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "qrcode_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6e465658-07fd-44ff-8b42-971cfd70eaaf", "name": "FORBIDDEN", "originalRequest": { "url": { "path": [ "qr-codes", ":qrcode_id", "to-bitlink" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "qrcode_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f9596b2e-b418-4456-a785-c42c298386e8", "name": "NOT_FOUND", "originalRequest": { "url": { "path": [ "qr-codes", ":qrcode_id", "to-bitlink" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "qrcode_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4442a9a0-b44c-4f04-b98a-aabd0bab25a9", "name": "MONTHLY_LIMIT_EXCEEDED", "originalRequest": { "url": { "path": [ "qr-codes", ":qrcode_id", "to-bitlink" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "qrcode_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"API_USAGE_LIMIT_EXCEEDED\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "60fc5252-e0a5-459a-aacc-a176d5229d55", "name": "INTERNAL_ERROR", "originalRequest": { "url": { "path": [ "qr-codes", ":qrcode_id", "to-bitlink" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "qrcode_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "62d2c0f8-1b2a-42fe-a98d-b3d550a107b2", "name": "Redirect a QR Code", "request": { "name": "Redirect a QR Code", "description": { "content": "Changes the destination URL that a stand alone QR Code redirects to. This only works for stand alone QR Codes; a QR Code already associated with a bitlink must be updated via the Bitlinks API.", "type": "text/plain" }, "url": { "path": [ "qr-codes", ":qrcode_id", "redirect" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "qrcode_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": null, "body": { "mode": "raw", "raw": "{\n \"long_url\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "55844140-6b4d-4712-b5fb-478f2baca276", "name": "SUCCESS", "originalRequest": { "url": { "path": [ "qr-codes", ":qrcode_id", "redirect" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "qrcode_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"long_url\": \"https://www.google.com\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"qrcode_id\": \"Ab1Cd2Ef3G4\",\n \"group_guid\": \"Ba1bc23dE4F\",\n \"title\": \"My Stand Alone QR Code\",\n \"is_customized\": false,\n \"qr_code_type\": \"long_url\",\n \"long_urls\": [\n \"https://example.com/new-page\"\n ],\n \"is_gs1\": false,\n \"tags\": [],\n \"archived\": false,\n \"created\": \"2024-01-15T10:00:00+0000\",\n \"updated\": \"2024-01-16T09:30:00+0000\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8c9abc4c-26f8-4ef4-9529-591f39b578ff", "name": "BAD_REQUEST", "originalRequest": { "url": { "path": [ "qr-codes", ":qrcode_id", "redirect" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "qrcode_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"long_url\": \"https://www.google.com\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "78734215-b5a7-4dc4-b112-134d17497b97", "name": "UPGRADE_REQUIRED", "originalRequest": { "url": { "path": [ "qr-codes", ":qrcode_id", "redirect" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "qrcode_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"long_url\": \"https://www.google.com\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Payment Required", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c74f12b1-2524-488a-bbf4-aaaaef2b393d", "name": "FORBIDDEN", "originalRequest": { "url": { "path": [ "qr-codes", ":qrcode_id", "redirect" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "qrcode_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"long_url\": \"https://www.google.com\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b3f7fbd9-526c-4efd-b7cf-8b2c3891a1d4", "name": "NOT_FOUND", "originalRequest": { "url": { "path": [ "qr-codes", ":qrcode_id", "redirect" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "qrcode_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"long_url\": \"https://www.google.com\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "94298553-c2ff-4a81-9dfc-0b8b40b767ae", "name": "GONE", "originalRequest": { "url": { "path": [ "qr-codes", ":qrcode_id", "redirect" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "qrcode_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"long_url\": \"https://www.google.com\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Gone", "code": 410, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f140f0fe-528e-4fe8-b5f1-f611e0ec869b", "name": "UNPROCESSABLE_ENTITY", "originalRequest": { "url": { "path": [ "qr-codes", ":qrcode_id", "redirect" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "qrcode_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"long_url\": \"https://www.google.com\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "87b46731-e3c0-482d-a257-6397e5b4e0a8", "name": "MONTHLY_LIMIT_EXCEEDED", "originalRequest": { "url": { "path": [ "qr-codes", ":qrcode_id", "redirect" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "qrcode_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"long_url\": \"https://www.google.com\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"API_USAGE_LIMIT_EXCEEDED\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0a86bddd-bafd-4d76-ba85-8a6c3593f161", "name": "INTERNAL_ERROR", "originalRequest": { "url": { "path": [ "qr-codes", ":qrcode_id", "redirect" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "qrcode_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"long_url\": \"https://www.google.com\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] } ], "event": [], "variable": [ { "type": "string", "value": "https://api-ssl.bitly.com/v4", "key": "baseUrl" } ], "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "info": { "_postman_id": "eea54fda-1e77-42e6-a45a-f1c9d754eff1", "name": "Bitly QR Codes API", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": { "content": "The QR Codes surface of the Bitly v4 REST API. Extracted verbatim, operation-for-operation, from the authoritative OpenAPI Bitly publishes at https://dev.bitly.com/v4/v4.json — no operation, parameter or schema was authored by API Evangelist.", "type": "text/plain" } } }