{ "item": [ { "id": "80774ae5-d9b7-4088-b454-6234a4f120c0", "name": "Custom Bitlinks", "description": { "content": "These endpoints are for updating custom Bitlinks only. Custom Bitlinks have both a BSD and a customized back-half (e.g., yourcompany.com/yourcampaign). If a link begins with the bit.ly domain or ends with an auto-generated random string it is not a custom Bitlink.\n", "type": "text/plain" }, "item": [ { "id": "6d7d00f4-cb5b-462c-909c-6fdc9bbfc1a5", "name": "Add Custom Bitlink", "request": { "name": "Add Custom Bitlink", "description": { "content": "Add a keyword (or \"custom back-half\") to a Bitlink with a Custom Domain (domains must match). This endpoint can also be used for initial redirects to a link.", "type": "text/plain" }, "url": { "path": [ "custom_bitlinks" ], "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 \"custom_bitlink\": \"\",\n \"bitlink_id\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "f5029e95-675b-45a4-b578-bc3520717c75", "name": "SUCCESS", "originalRequest": { "url": { "path": [ "custom_bitlinks" ], "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 \"custom_bitlink\": \"chauncey.ly/documentation\",\n \"bitlink_id\": \"chauncey.ly/1234abcd\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"custom_bitlink\": \"string\",\n \"bitlink\": {\n \"references\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n },\n \"link\": \"string\",\n \"id\": \"string\",\n \"long_url\": \"string\",\n \"title\": \"string\",\n \"archived\": false,\n \"created_at\": \"string\",\n \"created_by\": \"string\",\n \"client_id\": \"string\",\n \"custom_bitlinks\": [\n \"string\",\n \"string\"\n ],\n \"tags\": [\n \"string\",\n \"string\"\n ],\n \"launchpad_ids\": [\n \"string\",\n \"string\"\n ],\n \"qr_code_ids\": [\n \"string\",\n \"string\"\n ],\n \"deeplinks\": [\n {\n \"guid\": \"string\",\n \"bitlink\": \"string\",\n \"app_uri_path\": \"string\",\n \"install_url\": \"string\",\n \"app_guid\": \"string\",\n \"os\": \"ios\",\n \"install_type\": \"promote_install\",\n \"created\": \"string\",\n \"modified\": \"string\",\n \"brand_guid\": \"string\"\n },\n {\n \"guid\": \"string\",\n \"bitlink\": \"string\",\n \"app_uri_path\": \"string\",\n \"install_url\": \"string\",\n \"app_guid\": \"string\",\n \"os\": \"ios\",\n \"install_type\": \"promote_install\",\n \"created\": \"string\",\n \"modified\": \"string\",\n \"brand_guid\": \"string\"\n }\n ],\n \"is_deleted\": true,\n \"campaign_ids\": [\n \"string\",\n \"string\"\n ],\n \"expiration_at\": \"string\",\n \"dynamic_routing\": [\n {\n \"long_url\": \"string\",\n \"country_match\": [\n \"string\",\n \"string\"\n ],\n \"country_exclude\": [\n \"string\",\n \"string\"\n ],\n \"region_match\": [\n \"string\",\n \"string\"\n ],\n \"region_exclude\": [\n \"string\",\n \"string\"\n ],\n \"device_match\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"device_exclude\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"os_match\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"os_exclude\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n },\n {\n \"long_url\": \"string\",\n \"country_match\": [\n \"string\",\n \"string\"\n ],\n \"country_exclude\": [\n \"string\",\n \"string\"\n ],\n \"region_match\": [\n \"string\",\n \"string\"\n ],\n \"region_exclude\": [\n \"string\",\n \"string\"\n ],\n \"device_match\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"device_exclude\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"os_match\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"os_exclude\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n ]\n },\n \"bitlink_history\": [\n {\n \"group_guid\": \"string\",\n \"keyword\": \"string\",\n \"bsd\": \"string\",\n \"hash\": \"string\",\n \"login\": \"string\",\n \"long_url\": \"string\",\n \"created\": \"string\",\n \"first_created\": \"string\",\n \"deactivated\": \"string\",\n \"is_active\": false\n },\n {\n \"group_guid\": \"string\",\n \"keyword\": \"string\",\n \"bsd\": \"string\",\n \"hash\": \"string\",\n \"login\": \"string\",\n \"long_url\": \"string\",\n \"created\": \"string\",\n \"first_created\": \"string\",\n \"deactivated\": \"string\",\n \"is_active\": false\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bcb22587-3fac-451a-bb5c-03a9959c38f9", "name": "BAD_REQUEST", "originalRequest": { "url": { "path": [ "custom_bitlinks" ], "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 \"custom_bitlink\": \"chauncey.ly/documentation\",\n \"bitlink_id\": \"chauncey.ly/1234abcd\"\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": "3f903190-d0dc-4296-8d27-f7dbfe9a8093", "name": "UPGRADE_REQUIRED", "originalRequest": { "url": { "path": [ "custom_bitlinks" ], "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 \"custom_bitlink\": \"chauncey.ly/documentation\",\n \"bitlink_id\": \"chauncey.ly/1234abcd\"\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": "66f10f18-be22-49f4-a158-e9e9e3f9b060", "name": "FORBIDDEN", "originalRequest": { "url": { "path": [ "custom_bitlinks" ], "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 \"custom_bitlink\": \"chauncey.ly/documentation\",\n \"bitlink_id\": \"chauncey.ly/1234abcd\"\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": "4aaa5b36-527d-47e5-bb3e-5e344723aa2f", "name": "NOT_FOUND", "originalRequest": { "url": { "path": [ "custom_bitlinks" ], "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 \"custom_bitlink\": \"chauncey.ly/documentation\",\n \"bitlink_id\": \"chauncey.ly/1234abcd\"\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": "71b3a004-4655-456e-862a-056eddfe3861", "name": "Conflict", "originalRequest": { "url": { "path": [ "custom_bitlinks" ], "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 \"custom_bitlink\": \"chauncey.ly/documentation\",\n \"bitlink_id\": \"chauncey.ly/1234abcd\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "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": "0fd57ba6-0701-4c45-994a-e68aa5b8851f", "name": "UNPROCESSABLE_ENTITY", "originalRequest": { "url": { "path": [ "custom_bitlinks" ], "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 \"custom_bitlink\": \"chauncey.ly/documentation\",\n \"bitlink_id\": \"chauncey.ly/1234abcd\"\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": "b50e545b-4248-44f3-8cf1-8a8dace985b1", "name": "MONTHLY_LIMIT_EXCEEDED", "originalRequest": { "url": { "path": [ "custom_bitlinks" ], "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 \"custom_bitlink\": \"chauncey.ly/documentation\",\n \"bitlink_id\": \"chauncey.ly/1234abcd\"\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": "4c0e9eb3-e6f9-4260-9757-a64cbe7e4a84", "name": "INTERNAL_ERROR", "originalRequest": { "url": { "path": [ "custom_bitlinks" ], "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 \"custom_bitlink\": \"chauncey.ly/documentation\",\n \"bitlink_id\": \"chauncey.ly/1234abcd\"\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": "effd3e1c-51eb-4dbf-a759-fdaecbede146", "name": "TEMPORARILY_UNAVAILABLE", "originalRequest": { "url": { "path": [ "custom_bitlinks" ], "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 \"custom_bitlink\": \"chauncey.ly/documentation\",\n \"bitlink_id\": \"chauncey.ly/1234abcd\"\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": "735bb29f-dcd0-4c90-b641-500ee501953f", "name": "Update Custom Bitlink", "request": { "name": "Update Custom Bitlink", "description": { "content": "Move a keyword (or custom back-half) to a different Bitlink (domains must match).", "type": "text/plain" }, "url": { "path": [ "custom_bitlinks", ":custom_bitlink" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "custom_bitlink", "description": "(Required) A Custom Bitlink made of the domain and keyword" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": null, "body": { "mode": "raw", "raw": "{\n \"bitlink_id\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "bbce31f6-d054-4027-97b8-f2b79ad4b44b", "name": "SUCCESS", "originalRequest": { "url": { "path": [ "custom_bitlinks", ":custom_bitlink" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "custom_bitlink", "description": "(Required) A Custom Bitlink made of the domain and keyword" } ] }, "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 \"bitlink_id\": \"chauncey.ly/1234abcd\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"custom_bitlink\": \"string\",\n \"bitlink\": {\n \"references\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": \"string\"\n },\n \"link\": \"string\",\n \"id\": \"string\",\n \"long_url\": \"string\",\n \"title\": \"string\",\n \"archived\": false,\n \"created_at\": \"string\",\n \"created_by\": \"string\",\n \"client_id\": \"string\",\n \"custom_bitlinks\": [\n \"string\",\n \"string\"\n ],\n \"tags\": [\n \"string\",\n \"string\"\n ],\n \"launchpad_ids\": [\n \"string\",\n \"string\"\n ],\n \"qr_code_ids\": [\n \"string\",\n \"string\"\n ],\n \"deeplinks\": [\n {\n \"guid\": \"string\",\n \"bitlink\": \"string\",\n \"app_uri_path\": \"string\",\n \"install_url\": \"string\",\n \"app_guid\": \"string\",\n \"os\": \"ios\",\n \"install_type\": \"promote_install\",\n \"created\": \"string\",\n \"modified\": \"string\",\n \"brand_guid\": \"string\"\n },\n {\n \"guid\": \"string\",\n \"bitlink\": \"string\",\n \"app_uri_path\": \"string\",\n \"install_url\": \"string\",\n \"app_guid\": \"string\",\n \"os\": \"android\",\n \"install_type\": \"auto_install\",\n \"created\": \"string\",\n \"modified\": \"string\",\n \"brand_guid\": \"string\"\n }\n ],\n \"is_deleted\": false,\n \"campaign_ids\": [\n \"string\",\n \"string\"\n ],\n \"expiration_at\": \"string\",\n \"dynamic_routing\": [\n {\n \"long_url\": \"string\",\n \"country_match\": [\n \"string\",\n \"string\"\n ],\n \"country_exclude\": [\n \"string\",\n \"string\"\n ],\n \"region_match\": [\n \"string\",\n \"string\"\n ],\n \"region_exclude\": [\n \"string\",\n \"string\"\n ],\n \"device_match\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"device_exclude\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"os_match\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"os_exclude\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n },\n {\n \"long_url\": \"string\",\n \"country_match\": [\n \"string\",\n \"string\"\n ],\n \"country_exclude\": [\n \"string\",\n \"string\"\n ],\n \"region_match\": [\n \"string\",\n \"string\"\n ],\n \"region_exclude\": [\n \"string\",\n \"string\"\n ],\n \"device_match\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"device_exclude\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"os_match\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"os_exclude\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n ]\n },\n \"bitlink_history\": [\n {\n \"group_guid\": \"string\",\n \"keyword\": \"string\",\n \"bsd\": \"string\",\n \"hash\": \"string\",\n \"login\": \"string\",\n \"long_url\": \"string\",\n \"created\": \"string\",\n \"first_created\": \"string\",\n \"deactivated\": \"string\",\n \"is_active\": true\n },\n {\n \"group_guid\": \"string\",\n \"keyword\": \"string\",\n \"bsd\": \"string\",\n \"hash\": \"string\",\n \"login\": \"string\",\n \"long_url\": \"string\",\n \"created\": \"string\",\n \"first_created\": \"string\",\n \"deactivated\": \"string\",\n \"is_active\": false\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f3d214b5-4584-4640-97ee-947f675aec17", "name": "BAD_REQUEST", "originalRequest": { "url": { "path": [ "custom_bitlinks", ":custom_bitlink" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "custom_bitlink", "description": "(Required) A Custom Bitlink made of the domain and keyword" } ] }, "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 \"bitlink_id\": \"chauncey.ly/1234abcd\"\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": "f1453740-b7e8-4c76-b23e-2764b6538f56", "name": "UPGRADE_REQUIRED", "originalRequest": { "url": { "path": [ "custom_bitlinks", ":custom_bitlink" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "custom_bitlink", "description": "(Required) A Custom Bitlink made of the domain and keyword" } ] }, "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 \"bitlink_id\": \"chauncey.ly/1234abcd\"\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": "6a4a222e-61fe-4911-a69f-cd4f92daa436", "name": "FORBIDDEN", "originalRequest": { "url": { "path": [ "custom_bitlinks", ":custom_bitlink" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "custom_bitlink", "description": "(Required) A Custom Bitlink made of the domain and keyword" } ] }, "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 \"bitlink_id\": \"chauncey.ly/1234abcd\"\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": "c15f396a-74cb-4322-b7ea-13bc0b0867f9", "name": "NOT_FOUND", "originalRequest": { "url": { "path": [ "custom_bitlinks", ":custom_bitlink" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "custom_bitlink", "description": "(Required) A Custom Bitlink made of the domain and keyword" } ] }, "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 \"bitlink_id\": \"chauncey.ly/1234abcd\"\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": "1d9e5104-56a8-42d9-bcdd-52914ec0fef4", "name": "UNPROCESSABLE_ENTITY", "originalRequest": { "url": { "path": [ "custom_bitlinks", ":custom_bitlink" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "custom_bitlink", "description": "(Required) A Custom Bitlink made of the domain and keyword" } ] }, "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 \"bitlink_id\": \"chauncey.ly/1234abcd\"\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": "711b2f9a-e3fa-450f-8056-054b2b35cadc", "name": "MONTHLY_LIMIT_EXCEEDED", "originalRequest": { "url": { "path": [ "custom_bitlinks", ":custom_bitlink" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "custom_bitlink", "description": "(Required) A Custom Bitlink made of the domain and keyword" } ] }, "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 \"bitlink_id\": \"chauncey.ly/1234abcd\"\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": "43306dfe-755a-4f4d-9b85-1dc1c1b04c10", "name": "INTERNAL_ERROR", "originalRequest": { "url": { "path": [ "custom_bitlinks", ":custom_bitlink" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "custom_bitlink", "description": "(Required) A Custom Bitlink made of the domain and keyword" } ] }, "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 \"bitlink_id\": \"chauncey.ly/1234abcd\"\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": "e5a118f7-4f21-4e1b-9fd1-09f1e5dd65a8", "name": "TEMPORARILY_UNAVAILABLE", "originalRequest": { "url": { "path": [ "custom_bitlinks", ":custom_bitlink" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "custom_bitlink", "description": "(Required) A Custom Bitlink made of the domain and keyword" } ] }, "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 \"bitlink_id\": \"chauncey.ly/1234abcd\"\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": "7ffc3641-9603-4a82-93a1-c744f2f11cc5", "name": "Retrieve Custom Bitlink", "request": { "name": "Retrieve Custom Bitlink", "description": { "content": "Returns the details and history of the specified link.", "type": "text/plain" }, "url": { "path": [ "custom_bitlinks", ":custom_bitlink" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "custom_bitlink", "description": "(Required) A Custom Bitlink made of the domain and keyword" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "4ca22bac-9d66-46c1-a306-9db145a7845b", "name": "SUCCESS", "originalRequest": { "url": { "path": [ "custom_bitlinks", ":custom_bitlink" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "custom_bitlink", "description": "(Required) A Custom Bitlink made of the domain and keyword" } ] }, "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 \"custom_bitlink\": \"string\",\n \"bitlink\": {\n \"references\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": \"string\"\n },\n \"link\": \"string\",\n \"id\": \"string\",\n \"long_url\": \"string\",\n \"title\": \"string\",\n \"archived\": false,\n \"created_at\": \"string\",\n \"created_by\": \"string\",\n \"client_id\": \"string\",\n \"custom_bitlinks\": [\n \"string\",\n \"string\"\n ],\n \"tags\": [\n \"string\",\n \"string\"\n ],\n \"launchpad_ids\": [\n \"string\",\n \"string\"\n ],\n \"qr_code_ids\": [\n \"string\",\n \"string\"\n ],\n \"deeplinks\": [\n {\n \"guid\": \"string\",\n \"bitlink\": \"string\",\n \"app_uri_path\": \"string\",\n \"install_url\": \"string\",\n \"app_guid\": \"string\",\n \"os\": \"ios\",\n \"install_type\": \"promote_install\",\n \"created\": \"string\",\n \"modified\": \"string\",\n \"brand_guid\": \"string\"\n },\n {\n \"guid\": \"string\",\n \"bitlink\": \"string\",\n \"app_uri_path\": \"string\",\n \"install_url\": \"string\",\n \"app_guid\": \"string\",\n \"os\": \"android\",\n \"install_type\": \"auto_install\",\n \"created\": \"string\",\n \"modified\": \"string\",\n \"brand_guid\": \"string\"\n }\n ],\n \"is_deleted\": false,\n \"campaign_ids\": [\n \"string\",\n \"string\"\n ],\n \"expiration_at\": \"string\",\n \"dynamic_routing\": [\n {\n \"long_url\": \"string\",\n \"country_match\": [\n \"string\",\n \"string\"\n ],\n \"country_exclude\": [\n \"string\",\n \"string\"\n ],\n \"region_match\": [\n \"string\",\n \"string\"\n ],\n \"region_exclude\": [\n \"string\",\n \"string\"\n ],\n \"device_match\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"device_exclude\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"os_match\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"os_exclude\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n },\n {\n \"long_url\": \"string\",\n \"country_match\": [\n \"string\",\n \"string\"\n ],\n \"country_exclude\": [\n \"string\",\n \"string\"\n ],\n \"region_match\": [\n \"string\",\n \"string\"\n ],\n \"region_exclude\": [\n \"string\",\n \"string\"\n ],\n \"device_match\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"device_exclude\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"os_match\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"os_exclude\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n ]\n },\n \"bitlink_history\": [\n {\n \"group_guid\": \"string\",\n \"keyword\": \"string\",\n \"bsd\": \"string\",\n \"hash\": \"string\",\n \"login\": \"string\",\n \"long_url\": \"string\",\n \"created\": \"string\",\n \"first_created\": \"string\",\n \"deactivated\": \"string\",\n \"is_active\": true\n },\n {\n \"group_guid\": \"string\",\n \"keyword\": \"string\",\n \"bsd\": \"string\",\n \"hash\": \"string\",\n \"login\": \"string\",\n \"long_url\": \"string\",\n \"created\": \"string\",\n \"first_created\": \"string\",\n \"deactivated\": \"string\",\n \"is_active\": false\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "32123158-a311-4e4b-afc2-93bdee19479a", "name": "UPGRADE_REQUIRED", "originalRequest": { "url": { "path": [ "custom_bitlinks", ":custom_bitlink" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "custom_bitlink", "description": "(Required) A Custom Bitlink made of the domain and keyword" } ] }, "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": "10d7b0c7-3951-473b-a6fb-8e67b7e47fcc", "name": "FORBIDDEN", "originalRequest": { "url": { "path": [ "custom_bitlinks", ":custom_bitlink" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "custom_bitlink", "description": "(Required) A Custom Bitlink made of the domain and keyword" } ] }, "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": "cf1fc5c2-0233-48da-9863-37b20eec042e", "name": "NOT_FOUND", "originalRequest": { "url": { "path": [ "custom_bitlinks", ":custom_bitlink" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "custom_bitlink", "description": "(Required) A Custom Bitlink made of the domain and keyword" } ] }, "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": "26747284-f13a-469b-8fe4-2e842942e326", "name": "GONE", "originalRequest": { "url": { "path": [ "custom_bitlinks", ":custom_bitlink" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "custom_bitlink", "description": "(Required) A Custom Bitlink made of the domain and keyword" } ] }, "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": "9ff26c47-4cc9-4ed1-97c6-fb421db73b43", "name": "MONTHLY_LIMIT_EXCEEDED", "originalRequest": { "url": { "path": [ "custom_bitlinks", ":custom_bitlink" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "custom_bitlink", "description": "(Required) A Custom Bitlink made of the domain and keyword" } ] }, "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": "47b9cde8-9481-4210-8ac4-f2e59ee0d0f3", "name": "INTERNAL_ERROR", "originalRequest": { "url": { "path": [ "custom_bitlinks", ":custom_bitlink" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "custom_bitlink", "description": "(Required) A Custom Bitlink made of the domain and keyword" } ] }, "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": "8674e403-2a3e-4aa7-8645-9639f63679f4", "name": "TEMPORARILY_UNAVAILABLE", "originalRequest": { "url": { "path": [ "custom_bitlinks", ":custom_bitlink" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "custom_bitlink", "description": "(Required) A Custom Bitlink made of the domain and keyword" } ] }, "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": "75f058e2-2f95-4aab-8e8f-63315b57add1", "name": "Get Metrics for a Custom Bitlink by Destination", "request": { "name": "Get Metrics for a Custom Bitlink by Destination", "description": { "content": "Returns click metrics for the specified link by its historical destinations.", "type": "text/plain" }, "url": { "path": [ "custom_bitlinks", ":custom_bitlink", "clicks_by_destination" ], "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": "custom_bitlink", "description": "(Required) A Custom Bitlink made of the domain and keyword" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "70398f03-0869-4364-b032-2554b9079799", "name": "SUCCESS", "originalRequest": { "url": { "path": [ "custom_bitlinks", ":custom_bitlink", "clicks_by_destination" ], "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": "custom_bitlink", "description": "(Required) A Custom Bitlink made of the domain and keyword" } ] }, "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\": 7544,\n \"facet\": \"referring_domains\",\n \"unit_reference\": \"string\",\n \"metrics\": [\n {\n \"clicks\": 123,\n \"value\": \"bit.ly\"\n },\n {\n \"clicks\": 123,\n \"value\": \"bit.ly\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e5e045bc-d708-445f-9110-a363f7a0b689", "name": "UPGRADE_REQUIRED", "originalRequest": { "url": { "path": [ "custom_bitlinks", ":custom_bitlink", "clicks_by_destination" ], "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": "custom_bitlink", "description": "(Required) A Custom Bitlink made of the domain and keyword" } ] }, "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": "3611ea0d-59ae-4be4-9601-630dff20d504", "name": "FORBIDDEN", "originalRequest": { "url": { "path": [ "custom_bitlinks", ":custom_bitlink", "clicks_by_destination" ], "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": "custom_bitlink", "description": "(Required) A Custom Bitlink made of the domain and keyword" } ] }, "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": "9ee06cf3-29f9-4e63-a9e5-c0fbefdd3291", "name": "NOT_FOUND", "originalRequest": { "url": { "path": [ "custom_bitlinks", ":custom_bitlink", "clicks_by_destination" ], "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": "custom_bitlink", "description": "(Required) A Custom Bitlink made of the domain and keyword" } ] }, "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": "7c63087b-1dbd-4738-8a03-b60be7038780", "name": "GONE", "originalRequest": { "url": { "path": [ "custom_bitlinks", ":custom_bitlink", "clicks_by_destination" ], "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": "custom_bitlink", "description": "(Required) A Custom Bitlink made of the domain and keyword" } ] }, "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": "c5adbc2f-b377-4cff-90c6-bfd8ac6bec0e", "name": "MONTHLY_LIMIT_EXCEEDED", "originalRequest": { "url": { "path": [ "custom_bitlinks", ":custom_bitlink", "clicks_by_destination" ], "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": "custom_bitlink", "description": "(Required) A Custom Bitlink made of the domain and keyword" } ] }, "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": "f15d6bf9-6b59-428f-be8b-dd6af3daad3f", "name": "INTERNAL_ERROR", "originalRequest": { "url": { "path": [ "custom_bitlinks", ":custom_bitlink", "clicks_by_destination" ], "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": "custom_bitlink", "description": "(Required) A Custom Bitlink made of the domain and keyword" } ] }, "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": "221fc51d-e381-497c-bd00-d13d1ff138cc", "name": "TEMPORARILY_UNAVAILABLE", "originalRequest": { "url": { "path": [ "custom_bitlinks", ":custom_bitlink", "clicks_by_destination" ], "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": "custom_bitlink", "description": "(Required) A Custom Bitlink made of the domain and keyword" } ] }, "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": "7b1e79ea-14f8-45a0-ae78-58d3557b7dee", "name": "Get Clicks for a Custom Bitlink's Entire History", "request": { "name": "Get Clicks for a Custom Bitlink's Entire History", "description": { "content": "Returns the click counts for the specified link. This returns an array with clicks based on a date.", "type": "text/plain" }, "url": { "path": [ "custom_bitlinks", ":custom_bitlink", "clicks" ], "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": "custom_bitlink", "description": "(Required) A Custom Bitlink made of the domain and keyword" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "0ba40f09-8923-4146-9d86-f14f70100cee", "name": "SUCCESS", "originalRequest": { "url": { "path": [ "custom_bitlinks", ":custom_bitlink", "clicks" ], "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": "custom_bitlink", "description": "(Required) A Custom Bitlink made of the domain and keyword" } ] }, "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 \"link_clicks\": [\n {\n \"clicks\": 3018,\n \"date\": \"string\"\n },\n {\n \"clicks\": 7160,\n \"date\": \"string\"\n }\n ],\n \"units\": 2339,\n \"unit\": \"month\",\n \"unit_reference\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8684a060-af90-4125-86bf-9041e953c64e", "name": "BAD_REQUEST", "originalRequest": { "url": { "path": [ "custom_bitlinks", ":custom_bitlink", "clicks" ], "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": "custom_bitlink", "description": "(Required) A Custom Bitlink made of the domain and keyword" } ] }, "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": "ecb00bb0-7508-449d-8b8c-6b290b8efa5d", "name": "UPGRADE_REQUIRED", "originalRequest": { "url": { "path": [ "custom_bitlinks", ":custom_bitlink", "clicks" ], "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": "custom_bitlink", "description": "(Required) A Custom Bitlink made of the domain and keyword" } ] }, "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": "b3be657a-70ef-46e4-82cf-97c6f8e3f960", "name": "FORBIDDEN", "originalRequest": { "url": { "path": [ "custom_bitlinks", ":custom_bitlink", "clicks" ], "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": "custom_bitlink", "description": "(Required) A Custom Bitlink made of the domain and keyword" } ] }, "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": "01afd54a-5da7-488e-994c-1a349c93de18", "name": "NOT_FOUND", "originalRequest": { "url": { "path": [ "custom_bitlinks", ":custom_bitlink", "clicks" ], "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": "custom_bitlink", "description": "(Required) A Custom Bitlink made of the domain and keyword" } ] }, "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": "5d788b05-876c-45da-816f-7332ce6c7c0b", "name": "GONE", "originalRequest": { "url": { "path": [ "custom_bitlinks", ":custom_bitlink", "clicks" ], "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": "custom_bitlink", "description": "(Required) A Custom Bitlink made of the domain and keyword" } ] }, "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": "404c91c1-d81b-4868-9e17-c2a7992a33f8", "name": "MONTHLY_LIMIT_EXCEEDED", "originalRequest": { "url": { "path": [ "custom_bitlinks", ":custom_bitlink", "clicks" ], "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": "custom_bitlink", "description": "(Required) A Custom Bitlink made of the domain and keyword" } ] }, "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": "a2b0cbc0-b0e1-44bb-ad4a-43268f31f13b", "name": "INTERNAL_ERROR", "originalRequest": { "url": { "path": [ "custom_bitlinks", ":custom_bitlink", "clicks" ], "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": "custom_bitlink", "description": "(Required) A Custom Bitlink made of the domain and keyword" } ] }, "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": "4bc55924-449f-40e4-9845-9acc09bbb719", "name": "TEMPORARILY_UNAVAILABLE", "originalRequest": { "url": { "path": [ "custom_bitlinks", ":custom_bitlink", "clicks" ], "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": "custom_bitlink", "description": "(Required) A Custom Bitlink made of the domain and keyword" } ] }, "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 } } ], "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": "d9906891-4669-4463-b363-96be2ffa0ad2", "name": "Bitly Custom Bitlinks API", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": { "content": "The Custom Bitlinks 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" } } }