{"openapi": "3.0.0", "info": {"version": "4.0.0", "title": "Bitly API", "termsOfService": "https://bitly.com/pages/terms-of-service", "contact": {"url": "https://bitly.is/API-support"}, "license": {"name": "Apache 2.0", "url": "http://www.apache.org/licenses/LICENSE-2.0.html"}, "x-logo": {"url": "/v4/header-logo.png"}}, "servers": [{"url": "https://api-ssl.bitly.com/v4"}], "security": [{"bearerAuth": []}], "tags": [{"name": "Groups", "description": "Groups are subdivisions within organizations. Every user will be in at least one group, and every shortened link will be in one group. Most actions on our API will be on behalf of a group. For example, when you shorten a link, it will be on behalf of a user and a group.\n"}, {"name": "Organizations", "description": "Organizations are equivalent to a Bitly account. Every plan limit, group, and user is tied to an organization.\n"}, {"name": "User", "description": "Some subscription plans allow multiple users. Only one user is used for authenticating a call, and these operations apply only to the authenticated user.\n"}, {"name": "BSDs", "description": "Branded short domains (BSDs) are the custom domains used to brand your links. A BSD can be added to a Bitly organization and may be assigned to one or more groups. They can contain up to 32 characters.\n"}, {"name": "Bitlinks", "description": "Bitlinks are shortened links. They could begin with the bit.ly domain or your own custom branded short domain (BSD).\n"}, {"name": "Custom Bitlinks", "description": "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"}, {"name": "Campaigns", "description": "Bitly Campaigns are used to build and organize links and metrics for marketing campaigns.\n"}, {"name": "Webhooks", "description": "Webhooks are a method of sending information from Bitly to an application outside of Bitly. It's a way to automate actions or updates between two different systems. These endpoints are for configuring your webhooks.\n"}, {"name": "Deeplinks", "description": "Deeplinks refers to links that direct a user to a location inside of a mobile application. Bitly allows accounts to configure varying implementations of Deeplinks.\n"}, {"name": "Billing", "description": "All endpoints under this tag are related to accounts subscribing to the Bitly service.\n"}, {"name": "Tiers", "description": "Tiers references what level subscription a Bitly account is under.\n"}, {"name": "SSO", "description": "SSO is an acronym for Single Sign-On. This relates to a method of authentication used by some Bitly accounts.\n"}, {"name": "Invitations", "description": "Invitations allow new users to be invited to a Bitly organization via email or username. These endpoints handle both creation, retrieval, and deletion of invitations tied to an organization.\n"}, {"name": "Bulk Shorten", "description": "Bulk Shorten references the capability for users to upload a csv of links they would like to shorten and optionally customize.\n"}, {"name": "Launchpads", "description": "A link launchpad is a customizable page that contains a collection of links. These endpoints allow for the customization of the links associated with this site and the appearance of the site itself.\n"}, {"name": "Images", "description": "Images can be uploaded to be use in a Bitly QR code. Images can be uploaded, cropped, re-cropped, and fetched via the API. Each image includes an Image GUID and a public URL hosting the image.\n"}, {"name": "QR Codes", "description": "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"}], "paths": {"/shorten": {"post": {"summary": "Shorten a Link", "description": "Converts a long url to a Bitlink. You may see errors returned from this endpoint - \"BRANDED_LINK_MONTHLY_LIMIT_EXCEEDED\" occurs if you have shortened more links than your account is configured for for the month, and \"DNS_CONFIGURATION_ERROR\" occurs if you are attempting to shorten links against a custom domain which doesn't have DNS properly configured.", "tags": ["Bitlinks"], "operationId": "createBitlink", "requestBody": {"required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Shorten"}}}}, "responses": {"200": {"description": "SUCCESS", "headers": {"X-Bsd-Error": {"schema": {"type": "string"}, "description": "An explanation of the DNS error received"}}, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ShortenBitlinkBody"}}}}, "201": {"description": "CREATED", "headers": {"X-Bsd-Error": {"schema": {"type": "string"}, "description": "An explanation of the DNS error received"}}, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ShortenBitlinkBody"}}}}, "400": {"description": "BAD_REQUEST", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/BadRequest"}}}}, "403": {"description": "FORBIDDEN", "headers": {"X-Ratelimit-Reason": {"schema": {"type": "string"}, "description": "An explanation of the ratelimit received."}}, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Forbidden"}}}}, "417": {"description": "EXPECTATION_FAILED", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ExpectationFailed", "example": "DNS_CONFIGURATION_ERROR"}}}}, "422": {"description": "UNPROCESSABLE_ENTITY", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/UnprocessableEntity"}}}}, "429": {"description": "MONTHLY_LIMIT_EXCEEDED", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/MonthlyLimitExceeded", "example": "BRANDED_LINK_MONTHLY_LIMIT_EXCEEDED"}}}}, "500": {"description": "INTERNAL_ERROR", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/InternalError"}}}}, "503": {"description": "TEMPORARILY_UNAVAILABLE", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/TemporarilyUnavailable"}}}}}}}, "/bitlinks": {"post": {"summary": "Create a Bitlink", "description": "Converts a long url to a Bitlink and sets additional parameters. You may see errors returned from this endpoint - \"BRANDED_LINK_MONTHLY_LIMIT_EXCEEDED\" occurs if you have shortened more links than your account is configured for for the month, and \"DNS_CONFIGURATION_ERROR\" occurs if you are attempting to shorten links against a custom domain which doesn't have DNS properly configured.", "tags": ["Bitlinks"], "operationId": "createFullBitlink", "requestBody": {"required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/FullShorten"}}}}, "responses": {"200": {"description": "SUCCESS", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/BitlinkBody"}}}}, "201": {"description": "CREATED", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/BitlinkBody"}}}}, "400": {"description": "BAD_REQUEST", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/BadRequest"}}}}, "402": {"description": "UPGRADE_REQUIRED", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/UpgradeRequired"}}}}, "403": {"description": "FORBIDDEN", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Forbidden"}}}}, "404": {"description": "NOT_FOUND", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/NotFound"}}}}, "417": {"description": "EXPECTATION_FAILED", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ExpectationFailed", "example": "DNS_CONFIGURATION_ERROR"}}}}, "422": {"description": "UNPROCESSABLE_ENTITY", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/UnprocessableEntity"}}}}, "429": {"description": "MONTHLY_LIMIT_EXCEEDED", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/MonthlyLimitExceeded", "example": "BRANDED_LINK_MONTHLY_LIMIT_EXCEEDED"}}}}, "500": {"description": "INTERNAL_ERROR", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/InternalError"}}}}, "503": {"description": "TEMPORARILY_UNAVAILABLE", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/TemporarilyUnavailable"}}}}}}}, "/bitlinks/{bitlink}": {"delete": {"summary": "Delete a Bitlink", "description": "Delete an unedited hash Bitlink.", "tags": ["Bitlinks"], "parameters": [{"$ref": "#/components/parameters/Bitlink"}], "operationId": "deleteBitlink", "responses": {"200": {"description": "SUCCESS", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/LinkDeletionResponse"}}}}, "400": {"description": "BAD_REQUEST", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/BadRequest"}}}}, "403": {"description": "FORBIDDEN", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Forbidden"}}}}, "404": {"description": "NOT_FOUND", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/NotFound"}}}}, "429": {"description": "MONTHLY_LIMIT_EXCEEDED", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/MonthlyLimitExceeded", "example": "API_USAGE_LIMIT_EXCEEDED"}}}}, "500": {"description": "INTERNAL_ERROR", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/InternalError"}}}}, "503": {"description": "TEMPORARILY_UNAVAILABLE", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/TemporarilyUnavailable"}}}}}}, "patch": {"summary": "Update a Bitlink", "description": "Updates fields in the specified link. To redirect the link (i.e. to update the Long URL), use PATCH /v4/custom_bitlinks/{custom_bitlink} (https://dev.bitly.com/api-reference/#updateCustomBitlink)", "tags": ["Bitlinks"], "operationId": "updateBitlink", "parameters": [{"$ref": "#/components/parameters/Bitlink"}], "requestBody": {"required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/BitlinkUpdateBody", "example": {"title": "Bitly API Documentation", "archived": false, "tags": ["bitly", "api"], "deeplinks": [{"guid": "Ra1bcD2eF3h", "bitlink": "bit.ly/documentation", "app_uri_path": "/store?id=123456", "install_url": "https://play.google.com/store/apps/details?id=com.bitly.app&hl=en_US", "app_guid": "Ab1cdE2fG3h", "os": "android", "install_type": "promote_install", "brand_guid": "Ba1bc23dE4F"}]}}}}}, "responses": {"200": {"description": "SUCCESS", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/BitlinkBody"}}}}, "400": {"description": "BAD_REQUEST", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/BadRequest"}}}}, "402": {"description": "UPGRADE_REQUIRED", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/UpgradeRequired"}}}}, "403": {"description": "FORBIDDEN", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Forbidden"}}}}, "404": {"description": "NOT_FOUND", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/NotFound"}}}}, "410": {"description": "GONE", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Gone"}}}}, "422": {"description": "UNPROCESSABLE_ENTITY", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/UnprocessableEntity"}}}}, "429": {"description": "MONTHLY_LIMIT_EXCEEDED", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/MonthlyLimitExceeded", "example": "API_USAGE_LIMIT_EXCEEDED"}}}}, "500": {"description": "INTERNAL_ERROR", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/InternalError"}}}}, "503": {"description": "TEMPORARILY_UNAVAILABLE", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/TemporarilyUnavailable"}}}}}}, "get": {"summary": "Retrieve a Bitlink", "description": "Returns information for the specified link.", "tags": ["Bitlinks"], "parameters": [{"$ref": "#/components/parameters/Bitlink"}], "operationId": "getBitlink", "responses": {"200": {"description": "SUCCESS", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/BitlinkBody"}}}}, "403": {"description": "FORBIDDEN", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Forbidden"}}}}, "404": {"description": "NOT_FOUND", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/NotFound"}}}}, "410": {"description": "GONE", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Gone"}}}}, "429": {"description": "MONTHLY_LIMIT_EXCEEDED", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/MonthlyLimitExceeded", "example": "API_USAGE_LIMIT_EXCEEDED"}}}}, "500": {"description": "INTERNAL_ERROR", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/InternalError"}}}}, "503": {"description": "TEMPORARILY_UNAVAILABLE", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/TemporarilyUnavailable"}}}}}}}, "/bitlinks/{bitlink}/qrc": {}, "/expand": {"post": {"summary": "Expand a Bitlink", "description": "Returns the short link and long URL for the specified link.", "tags": ["Bitlinks"], "requestBody": {"required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ExpandBitlink"}}}}, "operationId": "expandBitlink", "responses": {"200": {"description": "SUCCESS", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ExpandedBitlink"}}}}, "400": {"description": "BAD_REQUEST", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/BadRequest"}}}}, "404": {"description": "NOT_FOUND", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/NotFound"}}}}, "410": {"description": "GONE", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Gone"}}}}, "422": {"description": "UNPROCESSABLE_ENTITY", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/UnprocessableEntity"}}}}, "500": {"description": "INTERNAL_ERROR", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/InternalError"}}}}, "503": {"description": "TEMPORARILY_UNAVAILABLE", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/TemporarilyUnavailable"}}}}}}}, "/clicks": {}, "/bitlinks/{bitlink}/clicks": {"get": {"summary": "Get Clicks for a Bitlink", "description": "Returns the click counts for the specified link in an array based on a date.", "tags": ["Bitlinks"], "operationId": "getClicksForBitlink", "parameters": [{"$ref": "#/components/parameters/Bitlink"}, {"$ref": "#/components/parameters/TimeUnit"}, {"$ref": "#/components/parameters/UnitAmount"}, {"$ref": "#/components/parameters/UnitReferenceTimeStamp"}], "responses": {"200": {"description": "SUCCESS", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Clicks"}}, "text/csv": {"schema": {"$ref": "#/components/schemas/Clicks"}, "example": "Date, Clicks\n2023-07-10T00:00:00+0000, 15\n"}}}, "403": {"description": "FORBIDDEN", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Forbidden"}}}}, "404": {"description": "NOT_FOUND", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/NotFound"}}}}, "429": {"description": "MONTHLY_LIMIT_EXCEEDED", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/MonthlyLimitExceeded", "example": "API_USAGE_LIMIT_EXCEEDED"}}}}, "500": {"description": "INTERNAL_ERROR", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/InternalError"}}}}, "503": {"description": "TEMPORARILY_UNAVAILABLE", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/TemporarilyUnavailable"}}}}}}}, "/bitlinks/{bitlink}/clicks/summary": {"get": {"summary": "Get a Clicks Summary for a Bitlink", "description": "Returns the click counts for the specified link rolled up into a single field.", "tags": ["Bitlinks"], "operationId": "getClicksSummaryForBitlink", "parameters": [{"$ref": "#/components/parameters/Bitlink"}, {"$ref": "#/components/parameters/TimeUnit"}, {"$ref": "#/components/parameters/UnitAmount"}, {"$ref": "#/components/parameters/UnitReferenceTimeStamp"}], "responses": {"200": {"description": "SUCCESS", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ClicksSummary"}}}}, "403": {"description": "FORBIDDEN", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Forbidden"}}}}, "404": {"description": "NOT_FOUND", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/NotFound"}}}}, "429": {"description": "MONTHLY_LIMIT_EXCEEDED", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/MonthlyLimitExceeded", "example": "API_USAGE_LIMIT_EXCEEDED"}}}}, "500": {"description": "INTERNAL_ERROR", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/InternalError"}}}}, "503": {"description": "TEMPORARILY_UNAVAILABLE", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/TemporarilyUnavailable"}}}}}}}, "/bitlinks/{bitlink}/scans": {}, "/bitlinks/{bitlink}/scans/summary": {}, "/bitlinks/{bitlink}/bitlink_clicks": {}, "/bitlinks/{bitlink}/bitlink_clicks/summary": {}, "/bitlinks/{bitlink}/bitlink_clicks/countries": {}, "/bitlinks/{bitlink}/bitlink_clicks/cities": {}, "/bitlinks/{bitlink}/bitlink_clicks/device_os": {}, "/bitlinks/{bitlink}/bitlink_clicks/browsers": {}, "/bitlinks/{bitlink}/button_clicks": {}, "/bitlinks/{bitlink}/button_clicks/summary": {}, "/bitlinks/{bitlink}/engagements": {}, "/bitlinks/{bitlink}/engagements/summary": {}, "/bitlinks/{bitlink}/bitlink_scans": {}, "/bitlinks/{bitlink}/bitlink_scans/summary": {}, "/bitlinks/{bitlink}/countries": {"get": {"summary": "Get Metrics for a Bitlink by Country", "description": "Returns the country origins of click traffic for the specified link.", "tags": ["Bitlinks"], "operationId": "getMetricsForBitlinkByCountries", "parameters": [{"$ref": "#/components/parameters/Bitlink"}, {"$ref": "#/components/parameters/TimeUnit"}, {"$ref": "#/components/parameters/UnitAmount"}, {"$ref": "#/components/parameters/Size"}, {"$ref": "#/components/parameters/UnitReferenceTimeStamp"}], "responses": {"200": {"description": "SUCCESS", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ClickMetrics"}}, "text/csv": {"schema": {"$ref": "#/components/schemas/ClickMetrics"}, "example": "Country, Clicks\nUS, 5\n"}}}, "400": {"description": "BAD_REQUEST", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/BadRequest"}}}}, "403": {"description": "FORBIDDEN", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Forbidden"}}}}, "404": {"description": "NOT_FOUND", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/NotFound"}}}}, "410": {"description": "GONE", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Gone"}}}}, "429": {"description": "MONTHLY_LIMIT_EXCEEDED", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/MonthlyLimitExceeded", "example": "API_USAGE_LIMIT_EXCEEDED"}}}}, "500": {"description": "INTERNAL_ERROR", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/InternalError"}}}}, "503": {"description": "TEMPORARILY_UNAVAILABLE", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/TemporarilyUnavailable"}}}}}}}, "/bitlinks/{bitlink}/cities": {"get": {"summary": "Get Metrics for a Bitlink by City", "description": "Returns the city origins of click traffic for the specified link.", "tags": ["Bitlinks"], "operationId": "getMetricsForBitlinkByCities", "x-premium": true, "parameters": [{"$ref": "#/components/parameters/Bitlink"}, {"$ref": "#/components/parameters/TimeUnit"}, {"$ref": "#/components/parameters/UnitAmount"}, {"$ref": "#/components/parameters/Size"}, {"$ref": "#/components/parameters/UnitReferenceTimeStamp"}], "responses": {"200": {"description": "SUCCESS", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/CityMetrics"}}, "text/csv": {"schema": {"$ref": "#/components/schemas/CityMetrics"}, "example": "City, Subregion, Region, Country, Clicks\nNew York, , NY, US, 5\n"}}}, "400": {"description": "BAD_REQUEST", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/BadRequest"}}}}, "402": {"description": "UPGRADE_REQUIRED", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/UpgradeRequired"}}}}, "403": {"description": "FORBIDDEN", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Forbidden"}}}}, "404": {"description": "NOT_FOUND", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/NotFound"}}}}, "410": {"description": "GONE", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Gone"}}}}, "429": {"description": "MONTHLY_LIMIT_EXCEEDED", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/MonthlyLimitExceeded", "example": "API_USAGE_LIMIT_EXCEEDED"}}}}, "500": {"description": "INTERNAL_ERROR", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/InternalError"}}}}, "503": {"description": "TEMPORARILY_UNAVAILABLE", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/TemporarilyUnavailable"}}}}}}}, "/bitlinks/{bitlink}/devices": {"get": {"summary": "Get Metrics for a Bitlink by Device Type", "description": "Returns the device types generating click traffic to the specified link.", "tags": ["Bitlinks"], "operationId": "getMetricsForBitlinkByDevices", "x-premium": true, "parameters": [{"$ref": "#/components/parameters/Bitlink"}, {"$ref": "#/components/parameters/TimeUnit"}, {"$ref": "#/components/parameters/UnitAmount"}, {"$ref": "#/components/parameters/Size"}, {"$ref": "#/components/parameters/UnitReferenceTimeStamp"}], "responses": {"200": {"description": "SUCCESS", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/DeviceMetrics"}}, "text/csv": {"schema": {"$ref": "#/components/schemas/DeviceMetrics"}, "example": "Device Type, Clicks\nDesktop, 5\n"}}}, "400": {"description": "BAD_REQUEST", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/BadRequest"}}}}, "402": {"description": "UPGRADE_REQUIRED", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/UpgradeRequired"}}}}, "403": {"description": "FORBIDDEN", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Forbidden"}}}}, "404": {"description": "NOT_FOUND", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/NotFound"}}}}, "410": {"description": "GONE", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Gone"}}}}, "429": {"description": "MONTHLY_LIMIT_EXCEEDED", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/MonthlyLimitExceeded", "example": "API_USAGE_LIMIT_EXCEEDED"}}}}, "500": {"description": "INTERNAL_ERROR", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/InternalError"}}}}, "503": {"description": "TEMPORARILY_UNAVAILABLE", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/TemporarilyUnavailable"}}}}}}}, "/bitlinks/{bitlink}/referrers": {"get": {"summary": "Get Metrics for a Bitlink by Referrers", "description": "Returns referrer click counts for the specified link.", "tags": ["Bitlinks"], "operationId": "getMetricsForBitlinkByReferrers", "parameters": [{"$ref": "#/components/parameters/Bitlink"}, {"$ref": "#/components/parameters/TimeUnit"}, {"$ref": "#/components/parameters/UnitAmount"}, {"$ref": "#/components/parameters/Size"}, {"$ref": "#/components/parameters/UnitReferenceTimeStamp"}], "responses": {"200": {"description": "SUCCESS", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ClickMetrics"}}, "text/csv": {"schema": {"$ref": "#/components/schemas/ClickMetrics"}, "example": "Referrers, Domain/Sub-Domain, Clicks\nOther Sites, direct, 5\n"}}}, "400": {"description": "BAD_REQUEST", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/BadRequest"}}}}, "403": {"description": "FORBIDDEN", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Forbidden"}}}}, "404": {"description": "NOT_FOUND", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/NotFound"}}}}, "410": {"description": "GONE", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Gone"}}}}, "429": {"description": "MONTHLY_LIMIT_EXCEEDED", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/MonthlyLimitExceeded", "example": "API_USAGE_LIMIT_EXCEEDED"}}}}, "500": {"description": "INTERNAL_ERROR", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/InternalError"}}}}, "503": {"description": "TEMPORARILY_UNAVAILABLE", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/TemporarilyUnavailable"}}}}}}}, "/bitlinks/{bitlink}/referrer_name": {}, "/bitlinks/{bitlink}/referring_domains": {"get": {"summary": "Get Metrics for a Bitlink by Referring Domains", "description": "Returns the referring domain click counts for the specified link.", "tags": ["Bitlinks"], "operationId": "getMetricsForBitlinkByReferringDomains", "parameters": [{"$ref": "#/components/parameters/Bitlink"}, {"$ref": "#/components/parameters/TimeUnit"}, {"$ref": "#/components/parameters/UnitAmount"}, {"$ref": "#/components/parameters/Size"}, {"$ref": "#/components/parameters/UnitReferenceTimeStamp"}], "responses": {"200": {"description": "SUCCESS", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ClickMetrics"}}}}, "400": {"description": "BAD_REQUEST", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/BadRequest"}}}}, "403": {"description": "FORBIDDEN", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Forbidden"}}}}, "404": {"description": "NOT_FOUND", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/NotFound"}}}}, "410": {"description": "GONE", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Gone"}}}}, "429": {"description": "MONTHLY_LIMIT_EXCEEDED", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/MonthlyLimitExceeded", "example": "API_USAGE_LIMIT_EXCEEDED"}}}}, "500": {"description": "INTERNAL_ERROR", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/InternalError"}}}}, "503": {"description": "TEMPORARILY_UNAVAILABLE", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/TemporarilyUnavailable"}}}}}}}, "/bitlinks/{bitlink}/referrers_by_domains": {"get": {"summary": "Get Metrics for a Bitlink by Referrers by Domain", "description": "Returns click metrics grouped by referrers for the specified link.", "tags": ["Bitlinks"], "operationId": "getMetricsForBitlinkByReferrersByDomains", "parameters": [{"$ref": "#/components/parameters/Bitlink"}, {"$ref": "#/components/parameters/TimeUnit"}, {"$ref": "#/components/parameters/UnitAmount"}, {"$ref": "#/components/parameters/Size"}, {"$ref": "#/components/parameters/UnitReferenceTimeStamp"}], "responses": {"200": {"description": "SUCCESS", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ReferrersByDomains"}}}}, "400": {"description": "BAD_REQUEST", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/BadRequest"}}}}, "403": {"description": "FORBIDDEN", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Forbidden"}}}}, "404": {"description": "NOT_FOUND", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/NotFound"}}}}, "410": {"description": "GONE", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Gone"}}}}, "429": {"description": "MONTHLY_LIMIT_EXCEEDED", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/MonthlyLimitExceeded", "example": "API_USAGE_LIMIT_EXCEEDED"}}}}, "500": {"description": "INTERNAL_ERROR", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/InternalError"}}}}, "503": {"description": "TEMPORARILY_UNAVAILABLE", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/TemporarilyUnavailable"}}}}}}}, "/bitlinks/{bitlink}/scans/countries": {}, "/engagements/scans/sorted": {}, "/bitlinks/{bitlink}/scans/cities": {}, "/bitlinks/{bitlink}/scans/device_os": {}, "/bitlinks/{bitlink}/scans/browsers": {}, "/groups/:groupGUID/scans/sorted": {}, "/engagements/aggregate": {}, "/engagements/cities/aggregate": {}, "/engagements/aggregate/{facet}": {}, "/engagements/sorted": {}, "/engagements/clicks/sorted": {}, "/prototype/aggregate/by_engagement": {}, "/prototype/groups/{group_guid}/by_engagement": {}, "/bitlinks/{bitlink}/overrides": {}, "/bitlinks/{bitlink}/override_history": {}, "/bitlinks/{bitlink}/overrides_clicks_by_version": {}, "/bitlinks/{bitlink}/overrides/clicks_by_destination": {}, "/groups/{group_guid}/overrides": {}, "/custom_bitlinks": {"post": {"summary": "Add Custom Bitlink", "description": "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.", "tags": ["Custom Bitlinks"], "operationId": "addCustomBitlink", "x-premium": true, "requestBody": {"required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/AddCustomBitlink"}}}}, "responses": {"200": {"description": "SUCCESS", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/CustomBitlink"}}}}, "400": {"description": "BAD_REQUEST", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/BadRequest"}}}}, "402": {"description": "UPGRADE_REQUIRED", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/UpgradeRequired"}}}}, "403": {"description": "FORBIDDEN", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Forbidden"}}}}, "404": {"description": "NOT_FOUND", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/NotFound"}}}}, "409": {"description": "Conflict", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "422": {"description": "UNPROCESSABLE_ENTITY", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/UnprocessableEntity"}}}}, "429": {"description": "MONTHLY_LIMIT_EXCEEDED", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/MonthlyLimitExceeded", "example": "API_USAGE_LIMIT_EXCEEDED"}}}}, "500": {"description": "INTERNAL_ERROR", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/InternalError"}}}}, "503": {"description": "TEMPORARILY_UNAVAILABLE", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/TemporarilyUnavailable"}}}}}}}, "/custom_bitlinks/{custom_bitlink}": {"patch": {"x-premium": true, "summary": "Update Custom Bitlink", "description": "Move a keyword (or custom back-half) to a different Bitlink (domains must match).", "tags": ["Custom Bitlinks"], "operationId": "updateCustomBitlink", "parameters": [{"$ref": "#/components/parameters/CustomBitlink"}], "requestBody": {"required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/UpdateCustomBitlink"}}}}, "responses": {"200": {"description": "SUCCESS", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/CustomBitlink"}}}}, "400": {"description": "BAD_REQUEST", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/BadRequest"}}}}, "402": {"description": "UPGRADE_REQUIRED", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/UpgradeRequired"}}}}, "403": {"description": "FORBIDDEN", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Forbidden"}}}}, "404": {"description": "NOT_FOUND", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/NotFound"}}}}, "422": {"description": "UNPROCESSABLE_ENTITY", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/UnprocessableEntity"}}}}, "429": {"description": "MONTHLY_LIMIT_EXCEEDED", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/MonthlyLimitExceeded", "example": "API_USAGE_LIMIT_EXCEEDED"}}}}, "500": {"description": "INTERNAL_ERROR", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/InternalError"}}}}, "503": {"description": "TEMPORARILY_UNAVAILABLE", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/TemporarilyUnavailable"}}}}}}, "get": {"x-premium": true, "summary": "Retrieve Custom Bitlink", "description": "Returns the details and history of the specified link.", "tags": ["Custom Bitlinks"], "operationId": "getCustomBitlink", "parameters": [{"$ref": "#/components/parameters/CustomBitlink"}], "responses": {"200": {"description": "SUCCESS", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/CustomBitlink"}}}}, "402": {"description": "UPGRADE_REQUIRED", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/UpgradeRequired"}}}}, "403": {"description": "FORBIDDEN", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Forbidden"}}}}, "404": {"description": "NOT_FOUND", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/NotFound"}}}}, "410": {"description": "GONE", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Gone"}}}}, "429": {"description": "MONTHLY_LIMIT_EXCEEDED", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/MonthlyLimitExceeded", "example": "API_USAGE_LIMIT_EXCEEDED"}}}}, "500": {"description": "INTERNAL_ERROR", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/InternalError"}}}}, "503": {"description": "TEMPORARILY_UNAVAILABLE", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/TemporarilyUnavailable"}}}}}}}, "/custom_bitlinks/{custom_bitlink}/clicks_by_destination": {"get": {"x-premium": true, "summary": "Get Metrics for a Custom Bitlink by Destination", "description": "Returns click metrics for the specified link by its historical destinations.", "operationId": "getCustomBitlinkMetricsByDestination", "tags": ["Custom Bitlinks"], "parameters": [{"$ref": "#/components/parameters/CustomBitlink"}, {"$ref": "#/components/parameters/TimeUnit"}, {"$ref": "#/components/parameters/UnitAmount"}, {"$ref": "#/components/parameters/UnitReferenceTimeStamp"}], "responses": {"200": {"description": "SUCCESS", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ClickMetrics"}}}}, "402": {"description": "UPGRADE_REQUIRED", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/UpgradeRequired"}}}}, "403": {"description": "FORBIDDEN", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Forbidden"}}}}, "404": {"description": "NOT_FOUND", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/NotFound"}}}}, "410": {"description": "GONE", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Gone"}}}}, "429": {"description": "MONTHLY_LIMIT_EXCEEDED", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/MonthlyLimitExceeded", "example": "API_USAGE_LIMIT_EXCEEDED"}}}}, "500": {"description": "INTERNAL_ERROR", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/InternalError"}}}}, "503": {"description": "TEMPORARILY_UNAVAILABLE", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/TemporarilyUnavailable"}}}}}}}, "/custom_bitlinks/{custom_bitlink}/clicks": {"get": {"summary": "Get Clicks for a Custom Bitlink's Entire History", "description": "Returns the click counts for the specified link. This returns an array with clicks based on a date.", "tags": ["Custom Bitlinks"], "operationId": "getClicksForCustomBitlink", "parameters": [{"$ref": "#/components/parameters/CustomBitlink"}, {"$ref": "#/components/parameters/TimeUnit"}, {"$ref": "#/components/parameters/UnitAmount"}, {"$ref": "#/components/parameters/UnitReferenceTimeStamp"}], "responses": {"200": {"description": "SUCCESS", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Clicks"}}}}, "400": {"description": "BAD_REQUEST", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/BadRequest"}}}}, "402": {"description": "UPGRADE_REQUIRED", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/UpgradeRequired"}}}}, "403": {"description": "FORBIDDEN", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Forbidden"}}}}, "404": {"description": "NOT_FOUND", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/NotFound"}}}}, "410": {"description": "GONE", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Gone"}}}}, "429": {"description": "MONTHLY_LIMIT_EXCEEDED", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/MonthlyLimitExceeded", "example": "API_USAGE_LIMIT_EXCEEDED"}}}}, "500": {"description": "INTERNAL_ERROR", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/InternalError"}}}}, "503": {"description": "TEMPORARILY_UNAVAILABLE", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/TemporarilyUnavailable"}}}}}}}, "/groups": {"get": {"summary": "Retrieve Groups", "description": "Returns a list of groups in the organization.", "tags": ["Groups"], "operationId": "getGroups", "parameters": [{"$ref": "#/components/parameters/OrganizationGUIDFilter"}], "responses": {"200": {"description": "SUCCESS", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Groups"}}}}, "400": {"description": "BAD_REQUEST", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/BadRequest"}}}}, "403": {"description": "FORBIDDEN", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Forbidden"}}}}, "404": {"description": "NOT_FOUND", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/NotFound"}}}}, "422": {"description": "UNPROCESSABLE_ENTITY", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/UnprocessableEntity"}}}}, "429": {"description": "MONTHLY_LIMIT_EXCEEDED", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/MonthlyLimitExceeded", "example": "API_USAGE_LIMIT_EXCEEDED"}}}}, "500": {"description": "INTERNAL_ERROR", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/InternalError"}}}}, "503": {"description": "TEMPORARILY_UNAVAILABLE", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/TemporarilyUnavailable"}}}}}}}, "/groups/{group_guid}": {"patch": {"summary": "Update a Group", "description": "Updates the details of a group.", "tags": ["Groups"], "operationId": "updateGroup", "parameters": [{"$ref": "#/components/parameters/GroupGUID"}], "requestBody": {"required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/GroupUpdate"}}}}, "responses": {"200": {"description": "SUCCESS", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Group"}}}}, "400": {"description": "BAD_REQUEST", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/BadRequest"}}}}, "403": {"description": "FORBIDDEN", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Forbidden"}}}}, "404": {"description": "NOT_FOUND", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/NotFound"}}}}, "422": {"description": "UNPROCESSABLE_ENTITY", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/UnprocessableEntity"}}}}, "500": {"description": "INTERNAL_ERROR", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/InternalError"}}}}, "503": {"description": "TEMPORARILY_UNAVAILABLE", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/TemporarilyUnavailable"}}}}}}, "get": {"summary": "Retrieve a Group", "description": "Returns details for a group.", "tags": ["Groups"], "operationId": "getGroup", "parameters": [{"$ref": "#/components/parameters/GroupGUID"}], "responses": {"200": {"description": "SUCCESS", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Group"}}}}, "403": {"description": "FORBIDDEN", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Forbidden"}}}}, "404": {"description": "NOT_FOUND", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/NotFound"}}}}, "429": {"description": "MONTHLY_LIMIT_EXCEEDED", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/MonthlyLimitExceeded", "example": "API_USAGE_LIMIT_EXCEEDED"}}}}, "500": {"description": "INTERNAL_ERROR", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/InternalError"}}}}, "503": {"description": "TEMPORARILY_UNAVAILABLE", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/TemporarilyUnavailable"}}}}}}}, "/groups/{group_guid}/tags": {"get": {"summary": "Retrieve Tags by Group", "description": "Returns the tags currently used in the specified group. Maximum 1000.", "tags": ["Groups"], "operationId": "getGroupTags", "parameters": [{"$ref": "#/components/parameters/GroupGUID"}], "responses": {"200": {"description": "SUCCESS", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Tags"}}}}, "403": {"description": "FORBIDDEN", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Forbidden"}}}}, "404": {"description": "NOT_FOUND", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/NotFound"}}}}, "429": {"description": "MONTHLY_LIMIT_EXCEEDED", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/MonthlyLimitExceeded", "example": "API_USAGE_LIMIT_EXCEEDED"}}}}, "500": {"description": "INTERNAL_ERROR", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/InternalError"}}}}, "503": {"description": "TEMPORARILY_UNAVAILABLE", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/TemporarilyUnavailable"}}}}}}}, "/groups/{group_guid}/bitlinks": {"get": {"summary": "Retrieve Bitlinks by Group", "description": "Returns a paginated collection of Bitlinks for a group. The list of custom bitlinks has newest entries first.", "tags": ["Bitlinks"], "operationId": "getBitlinksByGroup", "parameters": [{"$ref": "#/components/parameters/GroupGUID"}, {"$ref": "#/components/parameters/Size"}, {"$ref": "#/components/parameters/SearchAfter"}, {"$ref": "#/components/parameters/Query"}, {"$ref": "#/components/parameters/CreatedBefore"}, {"$ref": "#/components/parameters/CreatedAfter"}, {"$ref": "#/components/parameters/Archived"}, {"$ref": "#/components/parameters/Deeplinks"}, {"$ref": "#/components/parameters/DomainDeeplinks"}, {"$ref": "#/components/parameters/FilterCampaignGUID"}, {"$ref": "#/components/parameters/FilterChannelGUID"}, {"$ref": "#/components/parameters/FilterCustomBitlink"}, {"$ref": "#/components/parameters/Tags"}, {"$ref": "#/components/parameters/LaunchpadIDs"}, {"$ref": "#/components/parameters/EncodingLogin"}], "responses": {"200": {"description": "SUCCESS", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Bitlinks"}}}}, "403": {"description": "FORBIDDEN", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Forbidden"}}}}, "404": {"description": "NOT_FOUND", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/NotFound"}}}}, "500": {"description": "INTERNAL_ERROR", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/InternalError"}}}}, "503": {"description": "TEMPORARILY_UNAVAILABLE", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/TemporarilyUnavailable"}}}}}}, "patch": {"summary": "Bulk update bitlinks", "description": "Bulk update can add or remove tags or archive up to 100 links at a time; The response includes a list of bitlink ids that were updated.", "tags": ["Bitlinks"], "operationId": "updateBitlinksByGroup", "parameters": [{"$ref": "#/components/parameters/GroupGUID"}], "requestBody": {"required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/BulkUpdateRequest"}}}}, "responses": {"200": {"description": "SUCCESS", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/BulkUpdate"}}}}, "400": {"description": "BAD_REQUEST", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/BadRequest"}}}}, "403": {"description": "FORBIDDEN", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Forbidden"}}}}, "404": {"description": "NOT_FOUND", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/NotFound"}}}}, "422": {"description": "UNPROCESSABLE_ENTITY", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/UnprocessableEntity"}}}}, "500": {"description": "INTERNAL_ERROR", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/InternalError"}}}}, "503": {"description": "TEMPORARILY_UNAVAILABLE", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/TemporarilyUnavailable"}}}}}}}, "/groups/{group_guid}/bitlinks_count": {}, "/groups/{group_guid}/qr": {}, "/groups/{group_guid}/qrcodes": {}, "/groups/{group_guid}/qr_templates": {}, "/groups/{group_guid}/qr_templates/{template_id}": {}, "/groups/{group_guid}/bitlinks/{sort}": {"get": {"summary": "Retrieve Sorted Bitlinks for Group", "description": "Returns a list of Bitlinks sorted by group. The list of custom bitlinks has newest entries first.", "operationId": "getSortedBitlinks", "tags": ["Bitlinks"], "parameters": [{"$ref": "#/components/parameters/GroupGUID"}, {"$ref": "#/components/parameters/Sort"}, {"$ref": "#/components/parameters/TimeUnitOptional"}, {"$ref": "#/components/parameters/UnitAmountOptional"}, {"$ref": "#/components/parameters/UnitReferenceTimeStamp"}, {"$ref": "#/components/parameters/Size"}], "responses": {"200": {"description": "SUCCESS", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/SortedLinks"}}}}, "403": {"description": "FORBIDDEN", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Forbidden"}}}}, "404": {"description": "NOT_FOUND", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/NotFound"}}}}, "429": {"description": "MONTHLY_LIMIT_EXCEEDED", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/MonthlyLimitExceeded", "example": "API_USAGE_LIMIT_EXCEEDED"}}}}, "500": {"description": "INTERNAL_ERROR", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/InternalError"}}}}, "503": {"description": "TEMPORARILY_UNAVAILABLE", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/TemporarilyUnavailable"}}}}}}}, "/groups/{group_guid}/preferences": {"get": {"summary": "Retrieve Group Preferences", "description": "Returns preferences for the specified group.", "operationId": "getGroupPreferences", "tags": ["Groups"], "parameters": [{"$ref": "#/components/parameters/GroupGUID"}], "responses": {"200": {"description": "SUCCESS", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/GroupPreferences"}}}}, "403": {"description": "FORBIDDEN", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Forbidden"}}}}, "404": {"description": "NOT_FOUND", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/NotFound"}}}}, "500": {"description": "INTERNAL_ERROR", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/InternalError"}}}}, "503": {"description": "TEMPORARILY_UNAVAILABLE", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/TemporarilyUnavailable"}}}}}}, "patch": {"summary": "Update Group Preferences", "description": "Updates preferences for a group.", "operationId": "updateGroupPreferences", "tags": ["Groups"], "parameters": [{"$ref": "#/components/parameters/GroupGUID"}], "requestBody": {"required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/GroupPreferences", "example": {"group_guid": "Ba1bc23dE4F", "domain_preference": "chauncey.ly"}}}}}, "responses": {"200": {"description": "SUCCESS", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/GroupPreferences"}}}}, "400": {"description": "BAD_REQUEST", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/BadRequest"}}}}, "403": {"description": "FORBIDDEN", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Forbidden"}}}}, "404": {"description": "NOT_FOUND", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/NotFound"}}}}, "422": {"description": "UNPROCESSABLE_ENTITY", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/UnprocessableEntity"}}}}, "429": {"description": "MONTHLY_LIMIT_EXCEEDED", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/MonthlyLimitExceeded", "example": "API_USAGE_LIMIT_EXCEEDED"}}}}, "500": {"description": "INTERNAL_ERROR", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/InternalError"}}}}, "503": {"description": "TEMPORARILY_UNAVAILABLE", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/TemporarilyUnavailable"}}}}}}}, "/groups/{group_guid}/umpreferences": {}, "/groups/{group_guid}/shorten_counts": {"get": {"summary": "Retrieve Group Shorten Counts", "description": "Returns all the shorten counts for a group.", "operationId": "getGroupShortenCounts", "tags": ["Groups"], "parameters": [{"$ref": "#/components/parameters/GroupGUID"}, {"$ref": "#/components/parameters/TimeUnit"}, {"$ref": "#/components/parameters/UnitAmount"}, {"$ref": "#/components/parameters/UnitReferenceTimeStamp"}], "responses": {"200": {"description": "SUCCESS", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Metrics"}}}}, "403": {"description": "FORBIDDEN", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Forbidden"}}}}, "404": {"description": "NOT_FOUND", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/NotFound"}}}}, "429": {"description": "MONTHLY_LIMIT_EXCEEDED", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/MonthlyLimitExceeded", "example": "API_USAGE_LIMIT_EXCEEDED"}}}}, "500": {"description": "INTERNAL_ERROR", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/InternalError"}}}}, "503": {"description": "TEMPORARILY_UNAVAILABLE", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/TemporarilyUnavailable"}}}}}}}, "/groups/{group_guid}/countries": {"get": {"summary": "Get Click Metrics for a Group by Country", "description": "Returns the geographic origins of click traffic by country for the specified group.", "operationId": "getGroupMetricsByCountries", "tags": ["Groups"], "parameters": [{"$ref": "#/components/parameters/GroupGUID"}, {"$ref": "#/components/parameters/TimeUnit"}, {"$ref": "#/components/parameters/UnitAmount"}, {"$ref": "#/components/parameters/Size"}, {"$ref": "#/components/parameters/UnitReferenceTimeStamp"}], "responses": {"200": {"description": "SUCCESS", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ClickMetrics"}}, "text/csv": {"schema": {"$ref": "#/components/schemas/ClickMetrics"}, "example": "Country, Clicks\nUS, 5\n"}}}, "403": {"description": "FORBIDDEN", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Forbidden"}}}}, "404": {"description": "NOT_FOUND", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/NotFound"}}}}, "429": {"description": "MONTHLY_LIMIT_EXCEEDED", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/MonthlyLimitExceeded", "example": "API_USAGE_LIMIT_EXCEEDED"}}}}, "500": {"description": "INTERNAL_ERROR", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/InternalError"}}}}, "503": {"description": "TEMPORARILY_UNAVAILABLE", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/TemporarilyUnavailable"}}}}}}}, "/groups/{group_guid}/cities": {"get": {"summary": "Get Click Metrics for a Group by City", "description": "Returns the geographic origins of click traffic by city for the specified group.", "operationId": "getGroupMetricsByCities", "x-premium": true, "tags": ["Groups"], "parameters": [{"$ref": "#/components/parameters/GroupGUID"}, {"$ref": "#/components/parameters/TimeUnit"}, {"$ref": "#/components/parameters/UnitAmount"}, {"$ref": "#/components/parameters/Size"}, {"$ref": "#/components/parameters/UnitReferenceTimeStamp"}], "responses": {"200": {"description": "SUCCESS", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/CityMetrics"}}, "text/csv": {"schema": {"$ref": "#/components/schemas/CityMetrics"}, "example": "City, Subregion, Region, Country, Clicks\nNew York, , NY, US, 5\n"}}}, "402": {"description": "UPGRADE_REQUIRED", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/UpgradeRequired"}}}}, "403": {"description": "FORBIDDEN", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Forbidden"}}}}, "404": {"description": "NOT_FOUND", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/NotFound"}}}}, "429": {"description": "MONTHLY_LIMIT_EXCEEDED", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/MonthlyLimitExceeded", "example": "API_USAGE_LIMIT_EXCEEDED"}}}}, "500": {"description": "INTERNAL_ERROR", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/InternalError"}}}}, "503": {"description": "TEMPORARILY_UNAVAILABLE", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/TemporarilyUnavailable"}}}}}}}, "/groups/{group_guid}/devices": {"get": {"summary": "Get Click Metrics for a Group by Device Type", "description": "Returns the device types generating click traffic to the specified group's links.", "operationId": "getGroupMetricsByDevices", "x-premium": true, "tags": ["Groups"], "parameters": [{"$ref": "#/components/parameters/GroupGUID"}, {"$ref": "#/components/parameters/TimeUnit"}, {"$ref": "#/components/parameters/UnitAmount"}, {"$ref": "#/components/parameters/Size"}, {"$ref": "#/components/parameters/UnitReferenceTimeStamp"}], "responses": {"200": {"description": "SUCCESS", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/DeviceMetrics"}}, "text/csv": {"schema": {"$ref": "#/components/schemas/DeviceMetrics"}, "example": "Device Type, Clicks\nDesktop, 5\n"}}}, "402": {"description": "UPGRADE_REQUIRED", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/UpgradeRequired"}}}}, "403": {"description": "FORBIDDEN", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Forbidden"}}}}, "404": {"description": "NOT_FOUND", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/NotFound"}}}}, "429": {"description": "MONTHLY_LIMIT_EXCEEDED", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/MonthlyLimitExceeded", "example": "API_USAGE_LIMIT_EXCEEDED"}}}}, "500": {"description": "INTERNAL_ERROR", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/InternalError"}}}}, "503": {"description": "TEMPORARILY_UNAVAILABLE", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/TemporarilyUnavailable"}}}}}}}, "/groups/{group_guid}/referring_networks": {"get": {"summary": "Get Click Metrics for a Group by Referring Networks", "description": "Returns metrics by referring networks for the specified group's links.", "operationId": "GetGroupMetricsByReferringNetworks", "tags": ["Groups"], "parameters": [{"$ref": "#/components/parameters/GroupGUID"}], "responses": {"200": {"description": "SUCCESS", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ClickMetrics"}}}}, "403": {"description": "FORBIDDEN", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Forbidden"}}}}, "404": {"description": "NOT_FOUND", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/NotFound"}}}}, "500": {"description": "INTERNAL_ERROR", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/InternalError"}}}}, "503": {"description": "TEMPORARILY_UNAVAILABLE", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/TemporarilyUnavailable"}}}}}}}, "/groups/{group_guid}/referrers": {}, "/groups/{group_guid}/bitlinks_count/rollup": {}, "/groups/{group_guid}/clicks": {"get": {"operationId": "getGroupClicks", "tags": ["Groups"], "description": "get number of clicks on bitlinks in a group", "summary": "Get clicks by group", "parameters": [{"$ref": "#/components/parameters/GroupGUID"}, {"$ref": "#/components/parameters/TimeUnit"}, {"$ref": "#/components/parameters/UnitAmount"}, {"$ref": "#/components/parameters/UnitReferenceTimeStamp"}], "responses": {"200": {"description": "SUCCESS", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/GroupClicks"}}}}, "400": {"description": "BAD_REQUEST", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/BadRequest"}}}}, "402": {"description": "UPGRADE_REQUIRED", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/UpgradeRequired"}}}}, "403": {"description": "FORBIDDEN", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Forbidden"}}}}, "429": {"description": "MONTHLY_LIMIT_EXCEEDED", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/MonthlyLimitExceeded", "example": "API_USAGE_LIMIT_EXCEEDED"}}}}, "500": {"description": "INTERNAL_ERROR", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/InternalError"}}}}, "503": {"description": "TEMPORARILY_UNAVAILABLE", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/TemporarilyUnavailable"}}}}}}}, "/groups/{group_guid}/clicks/{facet}": {}, "/groups/{group_guid}/clicks/{facet}/rollup": {}, "/groups/{group_guid}/data_export": {}, "/groups/{group_guid}/links_report": {}, "/groups/{group_guid}/qr/images": {"get": {"summary": "Retrieve QR Code Logo Images", "description": "Retrieves logo images associated with QR codes by group", "tags": ["Groups"], "operationId": "getQRLogoImagesByGroup", "parameters": [{"$ref": "#/components/parameters/GroupGUID"}], "responses": {"200": {"description": "SUCCESS", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/QRLogoImagesResponse"}}}}, "400": {"description": "BAD_REQUEST", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/BadRequest"}}}}, "403": {"description": "FORBIDDEN", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Forbidden"}}}}, "500": {"description": "INTERNAL_ERROR", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/InternalError"}}}}}}}, "/form_capture": {}, "/organizations": {"get": {"summary": "Retrieve Organizations", "description": "Retrieve a list of organizations.", "tags": ["Organizations"], "operationId": "getOrganizations", "responses": {"200": {"description": "SUCCESS", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Organizations"}}}}, "403": {"description": "FORBIDDEN", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Forbidden"}}}}, "404": {"description": "NOT_FOUND", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/NotFound"}}}}, "500": {"description": "INTERNAL_ERROR", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/InternalError"}}}}, "503": {"description": "TEMPORARILY_UNAVAILABLE", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/TemporarilyUnavailable"}}}}}}}, "/organizations/{organization_guid}": {"get": {"summary": "Retrieve an Organization", "description": "Retrive details for the specified organization.", "tags": ["Organizations"], "operationId": "getOrganization", "parameters": [{"$ref": "#/components/parameters/OrganizationGUID"}], "responses": {"200": {"description": "SUCCESS", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Organization"}}}}, "403": {"description": "FORBIDDEN", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Forbidden"}}}}, "404": {"description": "NOT_FOUND", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/NotFound"}}}}, "500": {"description": "INTERNAL_ERROR", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/InternalError"}}}}, "503": {"description": "TEMPORARILY_UNAVAILABLE", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/TemporarilyUnavailable"}}}}}}}, "/organizations/{organization_guid}/users/data_export": {}, "/organization_upgrade": {}, "/organizations/{organization_guid}/preferences": {}, "/organization_downgrade": {}, "/org_emails": {}, "/promo_codes/{promo_code}/plan/{TierName}": {}, "/promo_codes/{promo_code}/valid_plans": {}, "/organizations/{organization_guid}/apply_discount": {}, "/organizations/{organization_guid}/add_ons": {}, "/deeplinks/apps": {}, "/deeplinks/apps/{deeplink_app_guid}": {}, "/deeplinks/scrape": {}, "/deeplinks/bitlinks/{bitlink}/rules": {}, "/deeplinks/rules": {}, "/deeplinks/rules/{deeplink_rule_guid}": {}, "/deeplinks/bitlinks/{bitlink}/metrics/rollup": {}, "/shareable_reports": {}, "/organizations/{organization_guid}/shorten_counts": {"get": {"description": "Returns the shorten counts for a specific organization over a specified time period.", "summary": "Get Shorten Counts for an Organization", "operationId": "getOrganizationShortenCounts", "tags": ["Organizations"], "parameters": [{"$ref": "#/components/parameters/OrganizationGUID"}, {"$ref": "#/components/parameters/TimeUnit"}, {"$ref": "#/components/parameters/UnitAmount"}, {"$ref": "#/components/parameters/UnitReferenceTimeStamp"}], "responses": {"200": {"description": "SUCCESS", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Metrics"}}}}, "403": {"description": "FORBIDDEN", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Forbidden"}}}}, "404": {"description": "NOT_FOUND", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/NotFound"}}}}, "500": {"description": "INTERNAL_ERROR", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/InternalError"}}}}, "503": {"description": "TEMPORARILY_UNAVAILABLE", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/TemporarilyUnavailable"}}}}}}}, "/organizations/{organization_guid}/payment_methods/{payment_method_id}/set_default": {}, "/organizations/{organization_guid}/payment_methods": {}, "/organizations/{organization_guid}/payment_invoices": {}, "/organizations/{organization_guid}/payment_invoices/{invoiceID}": {}, "/organizations/{organization_guid}/payment_invoices/{invoiceID}/file": {}, "/payment_failure": {}, "/annual_renewal_reminder": {}, "/organizations/{organization_guid}/billing_info": {}, "/organizations/{organization_guid}/contact_info": {}, "/organizations/{organization_guid}/billing_account": {}, "/organizations/{organization_guid}/billing_account_id": {}, "/organizations/{organization_guid}/schedule_downgrade": {}, "/organizations/{organization_guid}/billing_signature": {}, "/paypal_billing_agreement_token": {}, "/organizations/{organization_guid}/pending_tier": {}, "/organizations/{organization_guid}/cancel_pending_downgrade": {}, "/organizations/{organization_guid}/feature_usage": {}, "/organizations/{organization_guid}/activity_log": {}, "/organizations/{organization_guid}/export/activity_log": {}, "/organizations/{organization_guid}/activity_log/{action}/{timestamp}/{id}": {}, "/tiers": {}, "/tiers/{TierName}": {}, "/custom_domains/{custom_domain}": {}, "/custom_domains": {}, "/custom_domains/{custom_domain}/appassociations": {}, "/sso/organizations/{organization_guid}/settings": {}, "/sso/slugs/{url_slug}": {}, "/two_factor/country_calling_codes": {}, "/user": {"patch": {"summary": "Update a User", "description": "Update fields in the user", "tags": ["User"], "operationId": "updateUser", "requestBody": {"required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/UserUpdate"}}}}, "responses": {"200": {"description": "SUCCESS", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/User"}}}}, "400": {"description": "BAD_REQUEST", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/BadRequest"}}}}, "403": {"description": "FORBIDDEN", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Forbidden"}}}}, "404": {"description": "NOT_FOUND", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/NotFound"}}}}, "422": {"description": "UNPROCESSABLE_ENTITY", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/UnprocessableEntity"}}}}, "500": {"description": "INTERNAL_ERROR", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/InternalError"}}}}, "503": {"description": "TEMPORARILY_UNAVAILABLE", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/TemporarilyUnavailable"}}}}}}, "get": {"summary": "Retrieve a User", "description": "Returns information for the current authenticated user.", "tags": ["User"], "operationId": "getUser", "responses": {"200": {"description": "SUCCESS", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/User"}}}}, "403": {"description": "FORBIDDEN", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Forbidden"}}}}, "404": {"description": "NOT_FOUND", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/NotFound"}}}}, "500": {"description": "INTERNAL_ERROR", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/InternalError"}}}}, "503": {"description": "TEMPORARILY_UNAVAILABLE", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/TemporarilyUnavailable"}}}}}}}, "/user/sar": {}, "/user/forget": {}, "/user/two_factor/sms": {}, "/user/two_factor/sms/code/send": {}, "/user/two_factor/sms/code/verify": {}, "/users/{login}/delete": {}, "/users": {}, "/users/{login}/groups": {}, "/user_preferences": {}, "/user_preferences/{preference}/value/{value}": {}, "/users/{login}/invitations": {}, "/user/activity_log": {}, "/user/password": {}, "/onboarding_survey": {}, "/emails": {}, "/emails/{email}": {}, "/emails/{email}/verify": {}, "/campaigns": {"get": {"x-premium": true, "summary": "Retrieve Campaigns", "description": "Returns the campaigns for the current authenticated user.", "operationId": "getCampaigns", "tags": ["Campaigns"], "parameters": [{"$ref": "#/components/parameters/GroupGUIDFilter"}], "responses": {"200": {"description": "SUCCESS", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Campaigns"}}}}, "400": {"description": "BAD_REQUEST", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/BadRequest"}}}}, "402": {"description": "UPGRADE_REQUIRED", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/UpgradeRequired"}}}}, "403": {"description": "FORBIDDEN", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Forbidden"}}}}, "404": {"description": "NOT_FOUND", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/NotFound"}}}}, "500": {"description": "INTERNAL_ERROR", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/InternalError"}}}}, "502": {"description": "BAD_GATEWAY", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/BadGateway"}}}}, "503": {"description": "TEMPORARILY_UNAVAILABLE", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/TemporarilyUnavailable"}}}}}}, "post": {"x-premium": true, "summary": "Create Campaign", "description": "Creates a new campaign.", "operationId": "createCampaign", "tags": ["Campaigns"], "requestBody": {"required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/CampaignModify"}}}}, "responses": {"200": {"description": "SUCCESS", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Campaign"}}}}, "400": {"description": "BAD_REQUEST", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/BadRequest"}}}}, "402": {"description": "UPGRADE_REQUIRED", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/UpgradeRequired"}}}}, "403": {"description": "FORBIDDEN", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Forbidden"}}}}, "404": {"description": "NOT_FOUND", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/NotFound"}}}}, "422": {"description": "UNPROCESSABLE_ENTITY", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/UnprocessableEntity"}}}}, "429": {"description": "MONTHLY_LIMIT_EXCEEDED", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/MonthlyLimitExceeded", "example": "API_USAGE_LIMIT_EXCEEDED"}}}}, "500": {"description": "INTERNAL_ERROR", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/InternalError"}}}}, "503": {"description": "TEMPORARILY_UNAVAILABLE", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/TemporarilyUnavailable"}}}}}}}, "/campaigns/{campaign_guid}": {"get": {"x-premium": true, "summary": "Retrieve a Campaign", "description": "Returns details for a campaign.", "operationId": "getCampaign", "tags": ["Campaigns"], "parameters": [{"$ref": "#/components/parameters/CampaignGUID"}], "responses": {"200": {"description": "SUCCESS", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Campaign"}}}}, "402": {"description": "UPGRADE_REQUIRED", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/UpgradeRequired"}}}}, "403": {"description": "FORBIDDEN", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Forbidden"}}}}, "404": {"description": "NOT_FOUND", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/NotFound"}}}}, "429": {"description": "MONTHLY_LIMIT_EXCEEDED", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/MonthlyLimitExceeded", "example": "API_USAGE_LIMIT_EXCEEDED"}}}}, "500": {"description": "INTERNAL_ERROR", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/InternalError"}}}}, "503": {"description": "TEMPORARILY_UNAVAILABLE", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/TemporarilyUnavailable"}}}}}}, "patch": {"x-premium": true, "summary": "Update Campaign", "description": "Updates a campaign's details.", "operationId": "updateCampaign", "tags": ["Campaigns"], "parameters": [{"$ref": "#/components/parameters/CampaignGUID"}], "requestBody": {"required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/CampaignModify"}}}}, "responses": {"200": {"description": "SUCCESS", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Campaign"}}}}, "400": {"description": "BAD_REQUEST", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/BadRequest"}}}}, "402": {"description": "UPGRADE_REQUIRED", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/UpgradeRequired"}}}}, "403": {"description": "FORBIDDEN", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Forbidden"}}}}, "404": {"description": "NOT_FOUND", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/NotFound"}}}}, "422": {"description": "UNPROCESSABLE_ENTITY", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/UnprocessableEntity"}}}}, "429": {"description": "MONTHLY_LIMIT_EXCEEDED", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/MonthlyLimitExceeded", "example": "API_USAGE_LIMIT_EXCEEDED"}}}}, "500": {"description": "INTERNAL_ERROR", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/InternalError"}}}}, "503": {"description": "TEMPORARILY_UNAVAILABLE", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/TemporarilyUnavailable"}}}}}}}, "/campaigns/{campaign_guid}/clicks": {}, "/campaigns/{campaign_guid}/addURLs": {}, "/campaigns/{campaign_guid}/addURL": {}, "/channels": {"get": {"x-premium": true, "summary": "Retrieve Channels", "description": "Returns the channels available to a user.", "operationId": "getChannels", "tags": ["Campaigns"], "parameters": [{"$ref": "#/components/parameters/GroupGUIDFilter"}, {"$ref": "#/components/parameters/CampaignGUIDFilter"}], "responses": {"200": {"description": "SUCCESS", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Channels"}}}}, "402": {"description": "UPGRADE_REQUIRED", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/UpgradeRequired"}}}}, "403": {"description": "FORBIDDEN", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Forbidden"}}}}, "404": {"description": "NOT_FOUND", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/NotFound"}}}}, "500": {"description": "INTERNAL_ERROR", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/InternalError"}}}}, "503": {"description": "TEMPORARILY_UNAVAILABLE", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/TemporarilyUnavailable"}}}}}}, "post": {"x-premium": true, "summary": "Create Channel", "description": "Creates a new channel.", "operationId": "createChannel", "tags": ["Campaigns"], "requestBody": {"required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ChannelModify", "example": {"name": "My Channel", "guid": "Ha1bc2DefGh", "group_guid": "Ba1bc23dE4F", "bitlinks": [{"campaign_guid": "Ca1bcd2EFGh", "bitlink_id": "bit.ly/1234abcd"}]}}}}}, "responses": {"200": {"description": "SUCCESS", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Channel"}}}}, "400": {"description": "BAD_REQUEST", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/BadRequest"}}}}, "402": {"description": "UPGRADE_REQUIRED", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/UpgradeRequired"}}}}, "403": {"description": "FORBIDDEN", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Forbidden"}}}}, "404": {"description": "NOT_FOUND", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/NotFound"}}}}, "422": {"description": "UNPROCESSABLE_ENTITY", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/UnprocessableEntity"}}}}, "429": {"description": "MONTHLY_LIMIT_EXCEEDED", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/MonthlyLimitExceeded", "example": "API_USAGE_LIMIT_EXCEEDED"}}}}, "500": {"description": "INTERNAL_ERROR", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/InternalError"}}}}, "503": {"description": "TEMPORARILY_UNAVAILABLE", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/TemporarilyUnavailable"}}}}}}}, "/channels/{channel_guid}": {"get": {"summary": "Get a Channel", "x-premium": true, "description": "Returns a channel's details.", "operationId": "getChannel", "tags": ["Campaigns"], "parameters": [{"$ref": "#/components/parameters/ChannelGUID"}], "responses": {"200": {"description": "SUCCESS", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Channel"}}}}, "402": {"description": "UPGRADE_REQUIRED", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/UpgradeRequired"}}}}, "403": {"description": "FORBIDDEN", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Forbidden"}}}}, "404": {"description": "NOT_FOUND", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/NotFound"}}}}, "429": {"description": "MONTHLY_LIMIT_EXCEEDED", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/MonthlyLimitExceeded", "example": "API_USAGE_LIMIT_EXCEEDED"}}}}, "500": {"description": "INTERNAL_ERROR", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/InternalError"}}}}, "503": {"description": "TEMPORARILY_UNAVAILABLE", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/TemporarilyUnavailable"}}}}}}, "patch": {"summary": "Update a Channel", "x-premium": true, "description": "Updates an existing channel.", "operationId": "updateChannel", "tags": ["Campaigns"], "parameters": [{"$ref": "#/components/parameters/ChannelGUID"}], "requestBody": {"required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ChannelModify", "example": {"name": "My Channel", "guid": "Ha1bc2DefGh", "group_guid": "Ba1bc23dE4F", "bitlinks": [{"campaign_guid": "Ca1bcd2EFGh", "bitlink_id": "bit.ly/1234abcd"}]}}}}}, "responses": {"200": {"description": "SUCCESS", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Channel"}}}}, "400": {"description": "BAD_REQUEST", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/BadRequest"}}}}, "402": {"description": "UPGRADE_REQUIRED", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/UpgradeRequired"}}}}, "403": {"description": "FORBIDDEN", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Forbidden"}}}}, "404": {"description": "NOT_FOUND", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/NotFound"}}}}, "422": {"description": "UNPROCESSABLE_ENTITY", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/UnprocessableEntity"}}}}, "429": {"description": "MONTHLY_LIMIT_EXCEEDED", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/MonthlyLimitExceeded", "example": "API_USAGE_LIMIT_EXCEEDED"}}}}, "500": {"description": "INTERNAL_ERROR", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/InternalError"}}}}, "503": {"description": "TEMPORARILY_UNAVAILABLE", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/TemporarilyUnavailable"}}}}}}}, "/apps/{client_id}": {"get": {"summary": "Retrieve OAuth App", "description": "Retrieve the details for the provided OAuth App client ID", "operationId": "getOAuthApp", "parameters": [{"$ref": "#/components/parameters/ClientID"}], "responses": {"200": {"description": "SUCCESS", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/OAuthApp"}}}}, "403": {"description": "FORBIDDEN", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Forbidden"}}}}, "404": {"description": "NOT_FOUND", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/NotFound"}}}}, "500": {"description": "INTERNAL_ERROR", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/InternalError"}}}}, "503": {"description": "TEMPORARILY_UNAVAILABLE", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/TemporarilyUnavailable"}}}}}}}, "/oauth/apps": {}, "/oauth/authorizations": {}, "/oauth/authorizations/{authorization_id}": {}, "/oauth/apps/{client_id}/secret": {}, "/bsds": {"get": {"summary": "Get BSDs", "description": "Fetch all Branded Short Domains", "operationId": "getBSDs", "tags": ["BSDs"], "responses": {"200": {"description": "SUCCESS", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/BSDsResponse"}}}}, "400": {"description": "BAD_REQUEST", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/BadRequest"}}}}, "403": {"description": "FORBIDDEN", "headers": {"X-Ratelimit-Reason": {"schema": {"type": "string"}, "description": "An explanation of the ratelimit received."}}, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Forbidden"}}}}, "500": {"description": "INTERNAL_ERROR", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/InternalError"}}}}, "503": {"description": "TEMPORARILY_UNAVAILABLE", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/TemporarilyUnavailable"}}}}}}}, "/bsds/search": {}, "/autobranded_domain": {}, "/domains": {}, "/domains/{domain}/registrar_info": {}, "/domains/{domain}/agreements": {}, "/domains/{domain}/check_dns": {}, "/domains/{domain}/register": {}, "/domains/{domain}/status": {}, "/domains/{domain}": {}, "/organizations/{organization_guid}/access_features": {}, "/events": {}, "/organizations/{organization_guid}/consumable_features": {}, "/organizations/{organization_guid}/invitations": {}, "/organizations/{organization_guid}/invitations/{email}/resend": {}, "/organizations/{organization_guid}/invitations/{email}": {}, "/organizations/{organization_guid}/webhooks": {"get": {"summary": "Get Webhooks", "description": "Fetch all webhooks available for an Organization", "x-premium": true, "operationId": "getWebhooks", "parameters": [{"$ref": "#/components/parameters/OrganizationGUID"}], "tags": ["Webhooks"], "responses": {"200": {"description": "SUCCESS", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Webhooks"}}}}, "402": {"description": "UPGRADE_REQUIRED", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/UpgradeRequired"}}}}, "403": {"description": "FORBIDDEN", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Forbidden"}}}}, "404": {"description": "NOT_FOUND", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/NotFound"}}}}, "429": {"description": "MONTHLY_LIMIT_EXCEEDED", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/MonthlyLimitExceeded", "example": "API_USAGE_LIMIT_EXCEEDED"}}}}, "500": {"description": "INTERNAL_ERROR", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/InternalError"}}}}, "503": {"description": "TEMPORARILY_UNAVAILABLE", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/TemporarilyUnavailable"}}}}}}}, "/webhooks": {"post": {"summary": "Create Webhook", "description": "Creates a webhook.", "x-premium": true, "operationId": "createWebhook", "requestBody": {"required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/WebhookCreate"}}}}, "tags": ["Webhooks"], "responses": {"201": {"description": "CREATED", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Webhook"}}}}, "400": {"description": "BAD_REQUEST", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/BadRequest"}}}}, "402": {"description": "UPGRADE_REQUIRED", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/UpgradeRequired"}}}}, "403": {"description": "FORBIDDEN", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Forbidden"}}}}, "404": {"description": "NOT_FOUND", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/NotFound"}}}}, "422": {"description": "UNPROCESSABLE_ENTITY", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/UnprocessableEntity"}}}}, "429": {"description": "MONTHLY_LIMIT_EXCEEDED", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/MonthlyLimitExceeded", "example": "API_USAGE_LIMIT_EXCEEDED"}}}}, "500": {"description": "INTERNAL_ERROR", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/InternalError"}}}}, "503": {"description": "TEMPORARILY_UNAVAILABLE", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/TemporarilyUnavailable"}}}}}}}, "/webhooks/{webhook_guid}": {"get": {"summary": "Retrieve Webhook", "description": "Returns a webhook.", "x-premium": true, "operationId": "getWebhook", "parameters": [{"$ref": "#/components/parameters/WebhookGUID"}], "tags": ["Webhooks"], "responses": {"200": {"description": "SUCCESS", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Webhook"}}}}, "400": {"description": "BAD_REQUEST", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/BadRequest"}}}}, "402": {"description": "UPGRADE_REQUIRED", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/UpgradeRequired"}}}}, "403": {"description": "FORBIDDEN", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Forbidden"}}}}, "404": {"description": "NOT_FOUND", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/NotFound"}}}}, "429": {"description": "MONTHLY_LIMIT_EXCEEDED", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/MonthlyLimitExceeded", "example": "API_USAGE_LIMIT_EXCEEDED"}}}}, "500": {"description": "INTERNAL_ERROR", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/InternalError"}}}}, "503": {"description": "TEMPORARILY_UNAVAILABLE", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/TemporarilyUnavailable"}}}}}}, "patch": {"summary": "Update Webhook", "description": "Update a webhook", "x-premium": true, "operationId": "updateWebhook", "parameters": [{"$ref": "#/components/parameters/WebhookGUID"}], "requestBody": {"required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/WebhookUpdate"}}}}, "tags": ["Webhooks"], "responses": {"200": {"description": "SUCCESS", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Webhook"}}}}, "400": {"description": "BAD_REQUEST", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/BadRequest"}}}}, "402": {"description": "UPGRADE_REQUIRED", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/UpgradeRequired"}}}}, "403": {"description": "FORBIDDEN", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Forbidden"}}}}, "404": {"description": "NOT_FOUND", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/NotFound"}}}}, "422": {"description": "UNPROCESSABLE_ENTITY", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/UnprocessableEntity"}}}}, "429": {"description": "MONTHLY_LIMIT_EXCEEDED", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/MonthlyLimitExceeded", "example": "API_USAGE_LIMIT_EXCEEDED"}}}}, "500": {"description": "INTERNAL_ERROR", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/InternalError"}}}}, "503": {"description": "TEMPORARILY_UNAVAILABLE", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/TemporarilyUnavailable"}}}}}}, "delete": {"summary": "Delete Webhook", "description": "Deletes a webhook.", "x-premium": true, "operationId": "deleteWebhook", "parameters": [{"$ref": "#/components/parameters/WebhookGUID"}], "tags": ["Webhooks"], "responses": {"204": {"description": "SUCCESS"}, "400": {"description": "BAD_REQUEST", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/BadRequest"}}}}, "402": {"description": "UPGRADE_REQUIRED", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/UpgradeRequired"}}}}, "403": {"description": "FORBIDDEN", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Forbidden"}}}}, "404": {"description": "NOT_FOUND", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/NotFound"}}}}, "500": {"description": "INTERNAL_ERROR", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/InternalError"}}}}, "503": {"description": "TEMPORARILY_UNAVAILABLE", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/TemporarilyUnavailable"}}}}}}}, "/webhooks/{webhook_guid}/verify": {"post": {"summary": "Verify Webhook", "description": "Sends ping event to test webhook configuration.", "x-premium": true, "operationId": "verifyWebhook", "parameters": [{"$ref": "#/components/parameters/WebhookGUID"}], "tags": ["Webhooks"], "responses": {"200": {"description": "SUCCESS", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Webhook"}}}}, "400": {"description": "BAD_REQUEST", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/BadRequest"}}}}, "402": {"description": "UPGRADE_REQUIRED", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/UpgradeRequired"}}}}, "403": {"description": "FORBIDDEN", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Forbidden"}}}}, "404": {"description": "NOT_FOUND", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/NotFound"}}}}, "500": {"description": "INTERNAL_ERROR", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/InternalError"}}}}, "503": {"description": "TEMPORARILY_UNAVAILABLE", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/TemporarilyUnavailable"}}}}}}}, "/organizations/{organization_guid}/plan_limits": {"get": {"summary": "Get Plan Limits", "description": "Returns all plan limits and counts available for an organization.", "operationId": "getPlanLimits", "parameters": [{"$ref": "#/components/parameters/OrganizationGUID"}], "tags": ["Organizations"], "responses": {"200": {"description": "SUCCESS", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/PlanLimits"}}}}, "403": {"description": "FORBIDDEN", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Forbidden"}}}}, "500": {"description": "INTERNAL_ERROR", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/InternalError"}}}}, "503": {"description": "TEMPORARILY_UNAVAILABLE", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/TemporarilyUnavailable"}}}}}}}, "/user/platform_limits": {"get": {"summary": "Get Platform Limits", "description": "Fetch all platform limits and counts available for an organization", "operationId": "getPlatformLimits", "parameters": [{"$ref": "#/components/parameters/Path"}], "tags": ["User"], "responses": {"200": {"description": "SUCCESS", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/PlatformLimits"}}}}, "403": {"description": "FORBIDDEN", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Forbidden"}}}}, "404": {"description": "NOT_FOUND", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/NotFound"}}}}, "500": {"description": "INTERNAL_ERROR", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/InternalError"}}}}, "503": {"description": "TEMPORARILY_UNAVAILABLE", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/TemporarilyUnavailable"}}}}}}}, "/bulk_shorten/validate": {}, "/bulk_shorten/{organization_guid}/uploads": {}, "/launchpads/{launchpad_id}": {}, "/launchpads": {}, "/site_layouts": {}, "/sites/{site_id}": {}, "/sites/{site_id}/clone": {}, "/launchpads/{launchpad_id}/draft": {}, "/launchpads/{launchpad_id}/publish": {}, "/launchpads/{launchpad_id}/buttons/{button_id}": {}, "/launchpads/{launchpad_id}/contents/social/{button_id}": {}, "/launchpads/{launchpad_id}/contents/youtubeVideo/{button_id}": {}, "/launchpads/{launchpad_id}/contents/image/{button_id}": {}, "/launchpads/{launchpad_id}/contents/grid/{button_id}": {}, "/launchpads/{launchpad_id}/contents/carousel/{button_id}": {}, "/launchpads/{launchpad_id}/contents/bitlink/{button_id}": {}, "/launchpads/{launchpad_id}/buttons": {}, "/launchpads/{launchpad_id}/contents/bitlink": {}, "/launchpads/{launchpad_id}/contents/social": {}, "/launchpads/{launchpad_id}/contents/youtubeVideo": {}, "/launchpads/{launchpad_id}/contents/image": {}, "/launchpads/{launchpad_id}/image_upload": {}, "/launchpads/{launchpad_id}/images_by_use/{image_use}": {}, "/launchpad_themes": {}, "/groups/{group_guid}/launchpads": {}, "/launchpads/{launchpad_id}/views/summary": {}, "/launchpads/{launchpad_id}/countries": {}, "/launchpads/{launchpad_id}/cities": {}, "/launchpads/{launchpad_id}/devices": {}, "/launchpads/{launchpad_id}/referrers": {}, "/launchpads/{launchpad_id}/views": {}, "/launchpads/{launchpad_id}/link_performance": {}, "/launchpads/{launchpad_id}/qr": {}, "/groups/{group_guid}/sites": {}, "/organizations/{organization_guid}/keep_sites": {}, "/sites/{launchpad_id}/buttons/youtubeVideo/prevalidate": {}, "/sites/{site_id}/containers/{container_id}/blocks": {}, "/sites/templates": {}, "/sites/:siteID/template": {}, "/sites/{site_id}/containers": {}, "/roles": {}, "/roles/{role_name}": {}, "/private/title": {}, "/private/mailgun_webhook": {}, "/experiments/{experiment_name}/evaluate": {}, "/experiments/{experiment_name}/add_to_cohort": {}, "/interventions/{intervention}": {}, "/interventions": {}, "/images": {}, "/images/{image_guid}": {}, "/bitlinks/{bitlink}/qr_logo": {}, "/qrcodes": {}, "/qrcode/{group_guid}": {}, "/qrcode/full/{id}": {}, "/qr-codes": {"post": {"summary": "Create a QR Code", "description": "Create a new QR Code and return its metadata", "requestBody": {"required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/PublicCreateQRCodeRequest", "example": {"title": "Default QR Code", "group_guid": "Ba1bc23dE4F", "destination": {"bitlink_id": "bit.ly/abc123"}, "archived": false, "render_customizations": {"background_color": "#ffffff", "dot_pattern_color": "#000000", "dot_pattern_type": "standard", "corners": {"corner_1": {"inner_color": "#000000", "outer_color": "#000000", "shape": "standard"}, "corner_2": {"inner_color": "#000000", "outer_color": "#000000", "shape": "standard"}, "corner_3": {"inner_color": "#000000", "outer_color": "#000000", "shape": "standard"}}, "branding": {"bitly_brand": true}, "spec_settings": {"error_correction": 4}}}, "examples": {"Minimal": {"title": "Minimal QR Code", "group_guid": "Ba1bc23dE4F", "destination": {"bitlink_id": "bit.ly/abc123"}}, "Link in Bio": {"title": "Link-in-Bio QR Code", "group_guid": "Ba1bc23dE4F", "destination": {"site_id": "Mabc123"}}, "Complex": {"title": "Complex QR Code", "group_guid": "Ba1bc23dE4F", "destination": {"bitlink_id": "bit.ly/abc123"}, "archived": false, "render_customizations": {"background_color": "#ffffff", "dot_pattern_color": "#EF8000", "dot_pattern_type": "rounded", "corners": {"corner_1": {"inner_color": "#EF8000", "outer_color": "#EF8000", "shape": "concave"}, "corner_2": {"inner_color": "#EF8000", "outer_color": "#EF8000", "shape": "leaf"}, "corner_3": {"inner_color": "#EF8000", "outer_color": "#EF8000", "shape": "target"}}, "logo": {"image_guid": "bitlylogo"}, "frame": {"id": "text_top_and_bottom", "colors": {"primary": "#F55656", "background": "#FFFFFF"}, "text": {"primary": {"content": "QR Frame"}, "secondary": {"content": "Frame Text"}}}, "branding": {"bitly_brand": true}}}, "Gradients": {"title": "Gradient QR Code", "group_guid": "Ba1bc23dE4F", "destination": {"bitlink_id": "bit.ly/abc123"}, "archived": false, "render_customizations": {"dot_pattern_type": "rounded", "corners": {"corner_1": {"shape": "leaf"}, "corner_2": {"shape": "leaf"}, "corner_3": {"shape": "leaf"}}, "gradient": {"style": "linear", "angle": 45, "colors": [{"color": "#C80404", "offset": 10}, {"color": "#042F86", "offset": 90}], "exclude_corners": false}, "background_gradient": {"style": "radial", "colors": [{"color": "#C696EE", "offset": 25}, {"color": "#D4E1A8", "offset": 50}]}}}, "Framed": {"title": "Framed QR Code", "group_guid": "Ba1bc23dE4F", "destination": {"bitlink_id": "bit.ly/abc123"}, "archived": false, "render_customizations": {"frame": {"id": "arrow", "colors": {"primary": "#F55656", "background": "#FFFFFF"}, "text": {"primary": {"content": "Scan Here"}}}, "background_color": "#ffffff", "dot_pattern_color": "#EF8000", "dot_pattern_type": "rounded", "corners": {"corner_1": {"inner_color": "#EF8000", "outer_color": "#EF8000", "shape": "concave"}, "corner_2": {"inner_color": "#EF8000", "outer_color": "#EF8000", "shape": "leaf"}, "corner_3": {"inner_color": "#EF8000", "outer_color": "#EF8000", "shape": "target"}}, "logo": {"image_guid": "bitlylogo"}}}, "Lowest Error Correction": {"title": "Lowest Error Correction QR Code", "group_guid": "Ba1bc23dE4F", "destination": {"bitlink_id": "bit.ly/abc123"}, "render_customizations": {"spec_settings": {"error_correction": 1}}}, "GS1": {"title": "GS1 QR Code", "group_guid": "Ba1bc23dE4F", "destination": {"bitlink_id": "bit.ly/abc123"}, "gs1": {"values": [{"key": "01", "value": "12345670"}]}}}}}}}, "operationId": "createQRCodePublic", "tags": ["QR Codes"], "responses": {"201": {"description": "CREATED", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/QRCodeMinimal"}}}}, "400": {"description": "BAD_REQUEST", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/BadRequest"}}}}, "402": {"description": "UPGRADE_REQUIRED", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/UpgradeRequired"}}}}, "403": {"description": "FORBIDDEN", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Forbidden"}}}}, "404": {"description": "NOT_FOUND", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/NotFound"}}}}, "429": {"description": "MONTHLY_LIMIT_EXCEEDED", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/MonthlyLimitExceeded", "example": "BRANDED_LINK_MONTHLY_LIMIT_EXCEEDED"}}}}, "410": {"description": "GONE", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Gone"}}}}, "500": {"description": "INTERNAL_ERROR", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/InternalError"}}}}}}}, "/qr-codes/{qrcode_id}": {"get": {"summary": "Retrieve a QR Code", "description": "Gets the QR code with a matching id.", "operationId": "getQRCodeByIdPublic", "tags": ["QR Codes"], "parameters": [{"in": "path", "name": "qrcode_id", "description": "The QR code ID", "schema": {"type": "string"}, "required": true}], "responses": {"200": {"description": "SUCCESS", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/QRCodeDetails"}}}}, "400": {"description": "BAD_REQUEST", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/BadRequest"}}}}, "403": {"description": "FORBIDDEN", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Forbidden"}}}}, "404": {"description": "NOT_FOUND", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/NotFound"}}}}, "410": {"description": "GONE", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Gone"}}}}, "500": {"description": "INTERNAL_ERROR", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/InternalError"}}}}}}, "patch": {"summary": "Update a QR Code", "description": "Updates the QR code with a matching id and returns it.", "operationId": "updateQRCodePublic", "tags": ["QR Codes"], "parameters": [{"in": "path", "name": "qrcode_id", "description": "The QR code ID", "schema": {"type": "string"}, "required": true, "example": "Qabc123"}], "requestBody": {"required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/PublicUpdateQRCodeRequest", "example": {"title": "Default QR Code Updated", "archived": false, "render_customizations": {"background_color": "#ffffff", "dot_pattern_color": "#000000", "dot_pattern_type": "standard", "corners": {"corner_1": {"inner_color": "#000000", "outer_color": "#000000", "shape": "standard"}, "corner_2": {"inner_color": "#000000", "outer_color": "#000000", "shape": "standard"}, "corner_3": {"inner_color": "#000000", "outer_color": "#000000", "shape": "standard"}}, "branding": {"bitly_brand": true}, "spec_settings": {"error_correction": 4}}}, "examples": {"Minimal": {"title": "Minimal QR Code Updated"}, "Complex": {"title": "Complex QR Code Updated", "archived": false, "render_customizations": {"background_color": "#ffffff", "dot_pattern_color": "#EF8000", "dot_pattern_type": "rounded", "corners": {"corner_1": {"inner_color": "#EF8000", "outer_color": "#EF8000", "shape": "concave"}, "corner_2": {"inner_color": "#EF8000", "outer_color": "#EF8000", "shape": "leaf"}, "corner_3": {"inner_color": "#EF8000", "outer_color": "#EF8000", "shape": "target"}}, "logo": {"image_guid": "bitlylogo"}, "frame": {"id": "text_top_and_bottom", "colors": {"primary": "#F55656", "background": "#FFFFFF"}, "text": {"primary": {"content": "QR Frame"}, "secondary": {"content": "Frame Text"}}}, "branding": {"bitly_brand": true}}}, "Gradients": {"title": "Gradient QR Code Updated", "archived": false, "render_customizations": {"dot_pattern_type": "rounded", "corners": {"corner_1": {"shape": "leaf"}, "corner_2": {"shape": "leaf"}, "corner_3": {"shape": "leaf"}}, "gradient": {"style": "linear", "angle": 45, "colors": [{"color": "#C80404", "offset": 10}, {"color": "#042F86", "offset": 90}], "exclude_corners": false}, "background_gradient": {"style": "radial", "colors": [{"color": "#C696EE", "offset": 25}, {"color": "#D4E1A8", "offset": 50}]}}}, "Framed": {"title": "Framed QR Code Updated", "archived": false, "render_customizations": {"frame": {"id": "arrow", "colors": {"primary": "#F55656", "background": "#FFFFFF"}, "text": {"primary": {"content": "Scan Here"}}}, "background_color": "#ffffff", "dot_pattern_color": "#EF8000", "dot_pattern_type": "rounded", "corners": {"corner_1": {"inner_color": "#EF8000", "outer_color": "#EF8000", "shape": "concave"}, "corner_2": {"inner_color": "#EF8000", "outer_color": "#EF8000", "shape": "leaf"}, "corner_3": {"inner_color": "#EF8000", "outer_color": "#EF8000", "shape": "target"}}, "logo": {"image_guid": "bitlylogo"}}}, "Lowest Error Correction": {"title": "Lowest Error Correction QR Code Updated", "render_customizations": {"spec_settings": {"error_correction": 1}}}, "GS1": {"title": "GS1 QR Code Updated", "gs1": {"values": [{"key": "01", "value": "12345670"}]}}}}}}}, "responses": {"200": {"description": "SUCCESS", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/QRCodeMinimal"}}}}, "400": {"description": "BAD_REQUEST", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/BadRequest"}}}}, "403": {"description": "FORBIDDEN", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Forbidden"}}}}, "404": {"description": "NOT_FOUND", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/NotFound"}}}}, "410": {"description": "GONE", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Gone"}}}}, "500": {"description": "INTERNAL_ERROR", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/InternalError"}}}}}}}, "/qr-codes/{qrcode_id}/image": {"get": {"summary": "Retrieve a QR Code image", "description": "Get an image of a given QR code with a matching id and a format based on the Accept header.\nIf a base64 encoded value inside of JSON is preferred send Accept: application/json.\nIn addition to Accept: application/json the image format can be specified using the query parameter 'format'.\nIf no format is specified anywhere the default will be SVG.\n", "operationId": "getQRCodeImagePublic", "tags": ["QR Codes"], "parameters": [{"in": "header", "name": "Accept", "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.", "schema": {"type": "string"}, "required": false, "example": "image/svg+xml"}, {"in": "path", "name": "qrcode_id", "description": "The QR code ID", "schema": {"type": "string"}, "required": true}, {"in": "query", "name": "format", "description": "The format type of the image. If there is an image format in the header it takes precedence.", "schema": {"type": "string", "enum": ["svg"], "default": "svg", "example": "svg"}, "required": false}], "responses": {"200": {"description": "SUCCESS", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/PublicQRCodeImageResponse"}}, "image/svg+xml": {"schema": {"type": "string"}, "example": ""}}}, "400": {"description": "BAD_REQUEST", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/BadRequest"}}}}, "403": {"description": "FORBIDDEN", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Forbidden"}}}}, "404": {"description": "NOT_FOUND", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/NotFound"}}}}, "410": {"description": "GONE", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Gone"}}}}, "500": {"description": "INTERNAL_ERROR", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/InternalError"}}}}}}}, "/qr-codes/{qrcode_id}/scans": {"get": {"summary": "Get Scans for a QR Code", "description": "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.", "operationId": "getScanMetricsForQRCode", "tags": ["QR Codes"], "parameters": [{"$ref": "#/components/parameters/QRCodeID"}, {"$ref": "#/components/parameters/TimeUnit"}, {"$ref": "#/components/parameters/UnitAmount"}, {"$ref": "#/components/parameters/UnitReferenceTimeStamp"}], "responses": {"200": {"description": "SUCCESS", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/BitlinkScans"}}}}, "400": {"description": "BAD_REQUEST", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/BadRequest"}}}}, "403": {"description": "FORBIDDEN", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Forbidden"}}}}, "404": {"description": "NOT_FOUND", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/NotFound"}}}}, "410": {"description": "GONE", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Gone"}}}}, "500": {"description": "INTERNAL_ERROR", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/InternalError"}}}}, "503": {"description": "TEMPORARILY_UNAVAILABLE", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/TemporarilyUnavailable"}}}}}}}, "/qr-codes/{qrcode_id}/scans/summary": {"get": {"summary": "Get Scans Summary for a QR Code", "description": "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.", "operationId": "getScanMetricsSummaryForQRCode", "tags": ["QR Codes"], "parameters": [{"$ref": "#/components/parameters/QRCodeID"}, {"$ref": "#/components/parameters/TimeUnit"}, {"$ref": "#/components/parameters/UnitAmount"}, {"$ref": "#/components/parameters/UnitReferenceTimeStamp"}], "responses": {"200": {"description": "SUCCESS", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/BitlinkScansSummary"}}}}, "400": {"description": "BAD_REQUEST", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/BadRequest"}}}}, "403": {"description": "FORBIDDEN", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Forbidden"}}}}, "404": {"description": "NOT_FOUND", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/NotFound"}}}}, "410": {"description": "GONE", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Gone"}}}}, "500": {"description": "INTERNAL_ERROR", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/InternalError"}}}}, "503": {"description": "TEMPORARILY_UNAVAILABLE", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/TemporarilyUnavailable"}}}}}}}, "/qr-codes/{qrcode_id}/scans/countries": {"get": {"summary": "Get Scans for a QR Code by Country", "description": "Returns the country origins of scan traffic for the specified QR Code.", "tags": ["QR Codes"], "operationId": "getScanMetricsForQRCodeByCountries", "parameters": [{"$ref": "#/components/parameters/QRCodeID"}, {"$ref": "#/components/parameters/TimeUnit"}, {"$ref": "#/components/parameters/UnitAmount"}, {"$ref": "#/components/parameters/Size"}, {"$ref": "#/components/parameters/UnitReferenceTimeStamp"}], "responses": {"200": {"description": "SUCCESS", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ScanMetrics"}}, "text/csv": {"schema": {"$ref": "#/components/schemas/ScanMetrics"}, "example": "Country, Scans\nUS, 5\n"}}}, "400": {"description": "BAD_REQUEST", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/BadRequest"}}}}, "403": {"description": "FORBIDDEN", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Forbidden"}}}}, "404": {"description": "NOT_FOUND", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/NotFound"}}}}, "410": {"description": "GONE", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Gone"}}}}, "500": {"description": "INTERNAL_ERROR", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/InternalError"}}}}, "503": {"description": "TEMPORARILY_UNAVAILABLE", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/TemporarilyUnavailable"}}}}}}}, "/qr-codes/{qrcode_id}/scans/cities": {"get": {"x-premium": true, "summary": "Get Metrics for a QR Code by City", "description": "Returns the city origins of scan traffic for the specified QR Code.", "tags": ["QR Codes"], "operationId": "getScanMetricsForQRCodeByCities", "parameters": [{"$ref": "#/components/parameters/QRCodeID"}, {"$ref": "#/components/parameters/TimeUnit"}, {"$ref": "#/components/parameters/UnitAmount"}, {"$ref": "#/components/parameters/Size"}, {"$ref": "#/components/parameters/UnitReferenceTimeStamp"}], "responses": {"200": {"description": "SUCCESS", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/CityScanMetrics"}}, "text/csv": {"schema": {"$ref": "#/components/schemas/CityScanMetrics"}, "example": "City, Subregion, Region, Country, Scans\nNew York, , NY, US, 5\n"}}}, "400": {"description": "BAD_REQUEST", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/BadRequest"}}}}, "402": {"description": "UPGRADE_REQUIRED", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/UpgradeRequired"}}}}, "403": {"description": "FORBIDDEN", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Forbidden"}}}}, "404": {"description": "NOT_FOUND", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/NotFound"}}}}, "410": {"description": "GONE", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Gone"}}}}, "500": {"description": "INTERNAL_ERROR", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/InternalError"}}}}, "503": {"description": "TEMPORARILY_UNAVAILABLE", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/TemporarilyUnavailable"}}}}}}}, "/qr-codes/{qrcode_id}/scans/device_os": {"get": {"x-premium": true, "summary": "Get Scans for a QR Code by Device OS", "description": "Returns the device os generating scan traffic for the specified QR Code.", "tags": ["QR Codes"], "operationId": "getScanMetricsForQRCodeByDevicesOS", "parameters": [{"$ref": "#/components/parameters/QRCodeID"}, {"$ref": "#/components/parameters/TimeUnit"}, {"$ref": "#/components/parameters/UnitAmount"}, {"$ref": "#/components/parameters/Size"}, {"$ref": "#/components/parameters/UnitReferenceTimeStamp"}], "responses": {"200": {"description": "SUCCESS", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ScanMetrics"}}, "text/csv": {"schema": {"$ref": "#/components/schemas/ScanMetrics"}, "example": "Device OS, Scans\nApple, 5\n"}}}, "400": {"description": "BAD_REQUEST", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/BadRequest"}}}}, "402": {"description": "UPGRADE_REQUIRED", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/UpgradeRequired"}}}}, "403": {"description": "FORBIDDEN", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Forbidden"}}}}, "404": {"description": "NOT_FOUND", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/NotFound"}}}}, "410": {"description": "GONE", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Gone"}}}}, "500": {"description": "INTERNAL_ERROR", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/InternalError"}}}}, "503": {"description": "TEMPORARILY_UNAVAILABLE", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/TemporarilyUnavailable"}}}}}}}, "/qr-codes/{qrcode_id}/scans/browsers": {"get": {"x-premium": true, "summary": "Get Scans for a QR Code by Browser", "description": "Returns the browsers generating scan traffic to the specified QR Code.", "tags": ["QR Codes"], "operationId": "getScanMetricsForQRCodeByBrowser", "parameters": [{"$ref": "#/components/parameters/QRCodeID"}, {"$ref": "#/components/parameters/TimeUnit"}, {"$ref": "#/components/parameters/UnitAmount"}, {"$ref": "#/components/parameters/Size"}, {"$ref": "#/components/parameters/UnitReferenceTimeStamp"}], "responses": {"200": {"description": "SUCCESS", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ScanMetrics"}}, "text/csv": {"schema": {"$ref": "#/components/schemas/ScanMetrics"}, "example": "Browser, Scans\nGoogle Chrome, 5\n"}}}, "400": {"description": "BAD_REQUEST", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/BadRequest"}}}}, "402": {"description": "UPGRADE_REQUIRED", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/UpgradeRequired"}}}}, "403": {"description": "FORBIDDEN", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Forbidden"}}}}, "404": {"description": "NOT_FOUND", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/NotFound"}}}}, "410": {"description": "GONE", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Gone"}}}}, "500": {"description": "INTERNAL_ERROR", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/InternalError"}}}}, "503": {"description": "TEMPORARILY_UNAVAILABLE", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/TemporarilyUnavailable"}}}}}}}, "/groups/{group_guid}/qr-codes": {"get": {"summary": "Retrieve QR Codes by Group", "description": "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", "operationId": "listQRMinimal", "tags": ["QR Codes"], "parameters": [{"$ref": "#/components/parameters/FilterHasRenderCustomizations"}, {"$ref": "#/components/parameters/FilterArchived"}, {"$ref": "#/components/parameters/Size"}, {"$ref": "#/components/parameters/SearchAfterQR"}], "responses": {"200": {"description": "SUCCESS", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/QRCodesMinimal"}}}}, "403": {"description": "FORBIDDEN", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Forbidden"}}}}, "429": {"description": "MONTHLY_LIMIT_EXCEEDED", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/MonthlyLimitExceeded", "example": "API_USAGE_LIMIT_EXCEEDED"}}}}, "500": {"description": "INTERNAL_ERROR", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/InternalError"}}}}}}}, "/qrcode/{id}": {}, "/qrcode/{id}/redirect": {}, "/qrcode/bitlink/{bitlinkId}": {}, "/qrcodes/batch": {}, "/qrcodes/search/{group_guid}": {}, "/qrcodes/customization/options/{group_guid}": {}, "/qrcodes/preview/{group_guid}": {}, "/qrcodes/preview/{group_guid}/{id}": {}, "/qr-codes/{id}/to-bitlink": {}, "/groups/{group_guid}/product_utilization": {}, "/analytics/groups/{group_guid}/reports/{report_id}": {}, "/analytics/groups/{group_guid}/duplicate/{report_id}": {}, "/analytics/groups/{group_guid}/reports": {}, "/analytics/groups/{group_guid}/reports_list": {}, "/analytics/groups/{group_guid}/create_default_report": {}, "/analytics/groups/{group_guid}/reports/{report_id}/modules/{module_guid}": {}, "/analytics/groups/{group_guid}/modules/{module_guid}": {}, "/analytics/groups/{group_guid}/modules": {}, "/canva/userbrand/{canvaUserID}/{canvaBrandID}": {}, "/canva/login/{login}": {}, "/organizations/{organization_guid}/controlled_domain/request": {}, "/organizations/{organizationGUID}/valid_domains": {}, "/organizations/{organization_guid}/invitation_requests": {}, "/paypal/billing_agreement": {}, "/bitlinks/{bitlink}/qr": {"get": {"x-premium": true, "summary": "Retrieve a QR Code", "description": "Retrieves a QR code for a Bitlink.", "tags": ["Bitlinks"], "operationId": "getBitlinkQRCode", "parameters": [{"$ref": "#/components/parameters/Bitlink"}, {"$ref": "#/components/parameters/ImageFormat"}], "responses": {"200": {"description": "SUCCESS", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/FullQRCode"}}}}, "400": {"description": "BAD_REQUEST", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/BadRequest"}}}}, "402": {"description": "UPGRADE_REQUIRED", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/UpgradeRequired"}}}}, "403": {"description": "FORBIDDEN", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Forbidden"}}}}, "404": {"description": "NOT_FOUND", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/NotFound"}}}}, "410": {"description": "GONE", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Gone"}}}}, "429": {"description": "MONTHLY_LIMIT_EXCEEDED", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/MonthlyLimitExceeded", "example": "API_USAGE_LIMIT_EXCEEDED"}}}}, "500": {"description": "INTERNAL_ERROR", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/InternalError"}}}}}}, "patch": {"summary": "Update a QR Code", "description": "Updates an existing QR Code", "tags": ["Bitlinks"], "operationId": "updateBitlinkQRCode", "parameters": [{"$ref": "#/components/parameters/Bitlink"}], "requestBody": {"required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/QRCustomizations"}}}}, "responses": {"200": {"description": "SUCCESS", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/FullQRCode"}}}}, "400": {"description": "BAD_REQUEST", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/BadRequest"}}}}, "402": {"description": "UPGRADE_REQUIRED", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/UpgradeRequired"}}}}, "403": {"description": "FORBIDDEN", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Forbidden"}}}}, "404": {"description": "NOT_FOUND", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/NotFound"}}}}, "410": {"description": "GONE", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Gone"}}}}, "429": {"description": "MONTHLY_LIMIT_EXCEEDED", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/MonthlyLimitExceeded", "example": "API_USAGE_LIMIT_EXCEEDED"}}}}, "500": {"description": "INTERNAL_ERROR", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/InternalError"}}}}}}, "post": {"summary": "Create a QR Code", "description": "Creates a QR code for existing Bitlink", "tags": ["Bitlinks"], "operationId": "createBitlinkQRCode", "parameters": [{"$ref": "#/components/parameters/Bitlink"}], "requestBody": {"required": true, "content": {"application/json": {"schema": {"$ref": "#/components/schemas/QRCustomizations"}}}}, "responses": {"201": {"description": "CREATED", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/FullQRCode"}}}}, "400": {"description": "BAD_REQUEST", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/BadRequest"}}}}, "402": {"description": "UPGRADE_REQUIRED", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/UpgradeRequired"}}}}, "403": {"description": "FORBIDDEN", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Forbidden"}}}}, "404": {"description": "NOT_FOUND", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/NotFound"}}}}, "410": {"description": "GONE", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Gone"}}}}, "429": {"description": "MONTHLY_LIMIT_EXCEEDED", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/MonthlyLimitExceeded", "example": "API_USAGE_LIMIT_EXCEEDED"}}}}, "500": {"description": "INTERNAL_ERROR", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/InternalError"}}}}}}}}, "components": {"securitySchemes": {"bearerAuth": {"type": "http", "scheme": "bearer"}}, "parameters": {"InvoiceID": {"name": "invoiceID", "in": "path", "required": true, "schema": {"type": "string"}, "example": "abcd1234"}, "ModuleGUID": {"name": "module_guid", "in": "path", "required": true, "schema": {"type": "string"}, "example": "X21233435"}, "Facet": {"name": "facet", "in": "path", "required": true, "schema": {"type": "string", "enum": ["countries", "devices", "referrers"]}}, "Login": {"name": "login", "description": "The login for a Bitly user", "in": "path", "required": true, "schema": {"type": "string"}, "example": "chauncey"}, "Email": {"name": "email", "description": "An email address", "in": "path", "required": true, "schema": {"type": "string"}, "example": "chauncey@bit.ly"}, "LoginFilter": {"name": "login", "description": "The login for a Bitly user", "in": "query", "required": true, "schema": {"type": "string"}, "example": "chauncey"}, "LoginsFilter": {"name": "logins", "description": "The logins for Bitly users", "in": "query", "schema": {"type": "array", "items": {"type": "string"}}, "example": ["chauncey", "o_2j0lp05cb3"]}, "PromoCodeID": {"name": "promo_code", "description": "A promo code string", "in": "path", "required": true, "schema": {"type": "string"}, "example": "PROMOCODETEST"}, "FullNameSearch": {"name": "full_name_search", "description": "A partial string that will be compared to the full name of a user", "in": "query", "schema": {"type": "string"}, "example": "chauncey"}, "OrganizationGUID": {"name": "organization_guid", "description": "A GUID for a Bitly organization", "in": "path", "required": true, "schema": {"type": "string"}, "example": "Oa1bcd234eF"}, "OrganizationGUIDFilter": {"name": "organization_guid", "description": "A GUID for a Bitly organization", "in": "query", "schema": {"type": "string"}, "example": "Oa1bcd234eF"}, "OrganizationGUIDRequired": {"name": "organization_guid", "description": "A GUID for a Bitly organization", "in": "query", "required": true, "schema": {"type": "string"}, "example": "Oa1bcd234eF"}, "QRCodeID": {"name": "qrcode_id", "in": "path", "description": "The QR Code ID", "required": true, "schema": {"type": "string"}, "example": "Qabcde12345"}, "QRTemplateID": {"name": "template_id", "in": "path", "required": true, "schema": {"type": "string"}, "example": "abcd1234"}, "GroupGUID": {"name": "group_guid", "description": "A GUID for a Bitly group", "in": "path", "required": true, "schema": {"type": "string"}, "example": "Ba1bc23dE4F"}, "GroupGUIDFilter": {"name": "group_guid", "description": "A GUID for a Bitly group", "in": "query", "schema": {"type": "string"}, "example": "Ba1bc23dE4F"}, "GroupGUIDsFilter": {"name": "group_guid", "description": "GUIDs for a Bitly group", "in": "query", "schema": {"type": "array", "items": {"type": "string"}}, "example": ["Ba1bc23dE4F", "Br1bc55dE4J"]}, "CampaignGUIDFilter": {"name": "campaign_guid", "description": "A GUID for a Bitly campaign", "in": "query", "schema": {"type": "string"}, "example": "Ca1bcd2EFGh"}, "ChannelGUID": {"name": "channel_guid", "description": "A GUID for a Bitly Channel", "in": "path", "required": true, "schema": {"type": "string"}, "example": "Ha1bc2DefGh"}, "PreferenceName": {"name": "preference", "description": "The preference name for a user preference", "in": "path", "required": true, "schema": {"type": "string"}, "example": "domain_preference"}, "PreferenceValue": {"name": "value", "description": "The value of a user preference", "in": "path", "required": true, "schema": {"type": "string"}, "example": "chauncey.ly"}, "WebhookGUID": {"name": "webhook_guid", "description": "A GUID for a Bitly webhook", "in": "path", "required": true, "schema": {"type": "string"}, "example": "Wa1bcDefG23"}, "SSOVerifySlug": {"name": "url_slug", "description": "A potential slug for SSO", "in": "path", "required": true, "schema": {"type": "string"}, "example": "bitly"}, "Size": {"name": "size", "description": "The quantity of items to be be returned", "in": "query", "schema": {"type": "integer", "default": 50}, "example": 10}, "FetchPrice": {"name": "fetch_price", "description": "Include pricing information for a domain", "in": "query", "schema": {"type": "boolean", "default": false}, "example": true}, "ExtendedResults": {"name": "extended_results", "description": "fetch more results from search that can be complimentary", "in": "query", "schema": {"type": "boolean", "default": false}, "example": true}, "Page": {"name": "page", "description": "Integer specifying the numbered result at which to start", "in": "query", "schema": {"type": "integer", "default": 1}, "example": 1}, "CreatedBefore": {"name": "created_before", "description": "Timestamp as an integer unix epoch (seconds only)", "in": "query", "schema": {"type": "integer"}, "example": 1694529902}, "CreatedAfter": {"name": "created_after", "description": "Timestamp as an integer unix epoch (seconds only)", "in": "query", "schema": {"type": "integer"}, "example": 1694529902}, "Archived": {"name": "archived", "description": "Whether or not to include archived bitlinks", "in": "query", "schema": {"type": "string", "default": "off", "enum": ["on", "off", "both"]}, "example": "both"}, "Deeplinks": {"name": "deeplinks", "description": "Filter to only Bitlinks that contain deeplinks", "in": "query", "schema": {"type": "string", "default": "both", "enum": ["on", "off", "both"]}, "example": "both"}, "DomainDeeplinks": {"name": "domain_deeplinks", "description": "Filter to only Bitlinks that contain deeplinks configured with a custom domain", "in": "query", "schema": {"type": "string", "default": "both", "enum": ["on", "off", "both"]}, "example": "both"}, "FilterCampaignGUID": {"name": "campaign_guid", "description": "Filter to return only links for the given campaign GUID, can be provided", "schema": {"type": "string"}, "in": "query", "example": "Ca1bcd2EFGh"}, "FilterChannelGUID": {"name": "channel_guid", "description": "Filter to return only links for the given channel GUID, can be provided, overrides all other parameters", "schema": {"type": "string"}, "in": "query", "example": "Ha1bc2DefGh"}, "ReportGUID": {"name": "report_id", "description": "A GUID for a Bitly Analytics Report", "in": "path", "required": true, "schema": {"type": "string"}, "example": "Ra1bcd234eF"}, "Tags": {"name": "tags", "description": "Filter by given tags", "in": "query", "style": "form", "explode": true, "schema": {"type": "array", "items": {"type": "string"}}, "example": ["bitly", "api"]}, "BitlinksForEngagements": {"name": "bitlink", "description": "Filter by given bitlinks", "in": "query", "style": "form", "explode": true, "schema": {"type": "array", "items": {"type": "string"}}, "example": ["bit.ly/123456"]}, "LaunchpadIDs": {"name": "launchpad_ids", "description": "Filter by launchpad id", "in": "query", "style": "form", "explode": true, "schema": {"type": "array", "items": {"type": "string"}}, "example": ["M1234567890"]}, "ExperimentName": {"name": "experiment_name", "description": "An identifier for a given experiment", "in": "path", "required": true, "schema": {"type": "string"}, "example": "test_experiment"}, "InterventionType": {"name": "intervention", "description": "the type of intervention (e.g. downgrade, upgrade, etc)", "in": "path", "required": true, "schema": {"type": "string"}, "example": "downgrade"}, "EncodingLogin": {"name": "encoding_login", "description": "Filter by the login of the authenticated user that created the Bitlink", "in": "query", "schema": {"type": "array", "items": {"type": "string"}}, "style": "form", "explode": true, "example": ["chauncey"]}, "SearchAfter": {"name": "search_after", "description": "Token used to search next batch of links, only use response from API as input value.", "in": "query", "schema": {"type": "string"}, "example": "b746bca90ea9f77b"}, "SearchAfterQR": {"name": "search_after", "description": "Token used to search next batch of qr codes, only use response from API as input value.", "in": "query", "schema": {"type": "string"}}, "FilterCustomBitlink": {"name": "custom_bitlink", "in": "query", "schema": {"type": "string", "default": "both", "enum": ["on", "off", "both"]}, "example": "both"}, "FilterCustom": {"name": "custom", "description": "a filter value if the resource has been customized", "in": "query", "schema": {"type": "string", "default": "both", "enum": ["on", "off", "both"]}, "example": "both"}, "FilterHasRenderCustomizations": {"name": "has_render_customizations", "description": "a filter value if the QRCode has any render customizations (like color or shape changes)", "in": "query", "schema": {"type": "string", "default": "both", "enum": ["on", "off", "both"]}, "example": "both"}, "FilterHidden": {"name": "hidden", "description": "a filter value if resource is hidden/archived", "in": "query", "schema": {"type": "string", "default": "off", "enum": ["on", "off", "both"]}, "example": "both"}, "FilterArchived": {"name": "archived", "description": "a filter value if resource is archived or hidden", "in": "query", "schema": {"type": "string", "default": "off", "enum": ["on", "off", "both"]}, "example": "both"}, "FilterQRCodes": {"name": "filter", "in": "query", "schema": {"type": "string", "enum": ["hidden", "customized"]}}, "SortQRCodes": {"name": "sort", "in": "query", "required": true, "schema": {"type": "string", "enum": ["creation", "scans"]}}, "Sort": {"name": "sort", "description": "The type of sorting that you would like to do", "in": "path", "required": true, "schema": {"type": "string", "enum": ["clicks"]}, "example": "clicks"}, "TimeUnit": {"name": "unit", "description": "A unit of time", "schema": {"$ref": "#/components/schemas/TimeUnit"}, "required": true, "in": "query", "example": "month"}, "TimeUnitOptional": {"name": "unit", "description": "A unit of time", "schema": {"$ref": "#/components/schemas/TimeUnit"}, "in": "query", "example": "month"}, "MetricsFacet": {"name": "facet", "description": "A facet of metrics (e.g. country, referrer, ...)", "schema": {"type": "string"}, "required": true, "in": "path", "example": "country"}, "MetricsLimit": {"name": "limit", "description": "only return this number of facet values (subtotal only)", "schema": {"type": "integer", "default": 100}, "required": false, "in": "query", "example": 50}, "UnitAmount": {"name": "units", "description": "An integer representing the time units to query data for. pass -1 to return all units of time", "schema": {"type": "integer", "default": -1}, "required": true, "in": "query", "example": 1}, "UnitAmountOptional": {"name": "units", "description": "An integer representing the time units to query data for. pass -1 to return all units of time.", "schema": {"type": "integer", "default": -1}, "in": "query", "example": 1}, "UnitReferenceTimeStamp": {"name": "unit_reference", "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)", "schema": {"type": "string"}, "required": false, "in": "query", "example": "2006-01-02T15:04:05-0700"}, "Bitlink": {"name": "bitlink", "description": "A Bitlink made of the domain and hash", "in": "path", "required": true, "schema": {"type": "string"}, "example": "bit.ly/12a4b6c"}, "BSDFilter": {"name": "bsd", "description": "a branded short domains to filter results", "in": "query", "required": false, "schema": {"type": "array", "items": {"type": "string"}}, "example": "nyti.ms"}, "Color": {"name": "color", "description": "A color denoted in hexadecimal format ei. \"1133ff\"", "in": "query", "schema": {"type": "string"}, "example": "1133ff"}, "ExcludeBitlyLogo": {"name": "exclude_bitly_logo", "description": "Removes the Bitly logo from the center of the generated QR image", "in": "query", "schema": {"type": "boolean"}, "example": false}, "LogoImageGUID": {"name": "logo_image_guid", "description": "Image GUID that is used to retrieve QR code center images", "in": "query", "schema": {"type": "string"}, "example": "I123456789"}, "ImageFormat": {"name": "image_format", "description": "Determines the image format of the returned QR code", "in": "query", "schema": {"type": "string", "enum": ["png", "svg"], "default": "png"}, "example": "svg"}, "CustomBitlink": {"name": "custom_bitlink", "description": "A Custom Bitlink made of the domain and keyword", "in": "path", "schema": {"type": "string"}, "required": true, "example": "chauncey.ly/chauncey"}, "CampaignGUID": {"name": "campaign_guid", "description": "A GUID for a Bitly campaign", "in": "path", "required": true, "schema": {"type": "string"}, "example": "Ca1bcd2EFGh"}, "ClientID": {"name": "client_id", "description": "The client ID of an OAuth app", "in": "path", "required": true, "schema": {"type": "string"}, "example": "1234a56b789cd0e123456fg7h8901j123km45n6p"}, "Limit": {"name": "limit", "description": "limit the amount of results returned", "in": "query", "schema": {"type": "integer"}, "example": 50}, "Offset": {"name": "offset", "description": "set the starting index of the result set", "in": "query", "schema": {"type": "integer"}, "example": 50}, "Query": {"name": "query", "description": "The value that you would like to search", "in": "query", "schema": {"type": "string"}, "example": "api"}, "Domain": {"name": "domain", "description": "a web domain", "in": "path", "required": true, "schema": {"type": "string"}, "example": "bit.ly"}, "TierName": {"name": "TierName", "description": "The name of a pricing plan", "in": "path", "required": true, "schema": {"type": "string"}, "example": "free"}, "CustomDomain": {"name": "custom_domain", "description": "find out more about your custom domain", "in": "path", "required": true, "schema": {"type": "string"}, "example": "chauncey.ly"}, "DeeplinkAppGUID": {"name": "deeplink_app_guid", "description": "the guid reference to a deeplink app", "in": "path", "required": true, "schema": {"type": "string"}, "example": "Ab1cdE2fG3h"}, "DeeplinkRuleGUID": {"name": "deeplink_rule_guid", "description": "the guid of a deeplink rule", "in": "path", "required": true, "schema": {"type": "string"}, "example": "Ra1bcD2eF3g"}, "ShareableReport": {"name": "shareable_report", "description": "Shareable Report URL to validate", "in": "query", "required": true, "schema": {"type": "string"}, "example": "http://dev.bitly.com"}, "ThirdPartyAppID": {"name": "third_party_app_id", "description": "the third party app id describing a specific ios/android app", "in": "query", "required": true, "schema": {"type": "string"}, "example": "com.bitly.app"}, "DeviceID": {"name": "device_id", "description": "the id of the mobile device being registered", "in": "query", "required": true, "schema": {"type": "string"}, "example": "00000000-000000000000000"}, "DeviceIDType": {"name": "device_id_type", "description": "the type of the device id that is being registered", "in": "query", "required": true, "schema": {"type": "string"}, "example": "IDFA"}, "AppGUID": {"name": "app_id", "description": "the guid of the deeplink application", "in": "query", "required": true, "schema": {"type": "string"}, "example": "my-cool-app"}, "OSMaj": {"name": "osmaj", "description": "the major version of the operating system", "in": "query", "required": false, "schema": {"type": "string"}, "example": "Android 2.3"}, "OSMin": {"name": "osmin", "description": "the minor version of the operating system", "in": "query", "required": false, "schema": {"type": "string"}, "example": "Android 2.3.025"}, "DSM": {"name": "dsm", "description": "the device model name", "in": "query", "required": false, "schema": {"type": "string"}, "example": "iPhoneXS"}, "OS": {"name": "os", "description": "the os of a specific ios/android app", "in": "query", "required": true, "schema": {"$ref": "#/components/schemas/MobileOS"}, "example": "ios"}, "PreferencesExpire": {"name": "expire_hours", "description": "Number of hours before marking preference as 'expired'", "in": "query", "schema": {"type": "string"}, "example": 1}, "BitlinksClicks": {"name": "bitlink_id", "description": "The query parameter used to get clicks for a Bitlink", "in": "query", "style": "form", "explode": true, "schema": {"type": "array", "items": {"type": "string"}}, "required": true, "example": "bit.ly/1234abcd"}, "Path": {"name": "path", "description": "The specific path for which information is requested", "in": "query", "schema": {"type": "string"}, "example": "/organizations/{organization_guid}"}, "sortBy": {"name": "sort_by", "description": "Country code property you would like to sort country codes by", "in": "query", "required": false, "schema": {"type": "string"}, "example": "CountryName"}, "LaunchpadGUID": {"name": "launchpad_id", "description": "A GUID for a Bitly Link Launchpad", "in": "path", "required": true, "schema": {"type": "string"}, "example": "Sa1bcd234eF"}, "SiteID": {"name": "site_id", "description": "A GUID for a Bitly Site", "in": "path", "required": true, "schema": {"type": "string"}, "example": "M0000guid01"}, "ContainerID": {"name": "container_id", "description": "A GUID for a Bitly Container", "in": "path", "required": true, "schema": {"type": "string"}, "example": "L0000guid01"}, "LaunchpadButtonGUID": {"name": "button_id", "description": "A GUID for a Bitly Link Launchpad button", "in": "path", "required": true, "schema": {"type": "string"}, "example": "Ta1bcd234eF"}, "ContentType": {"name": "content_type", "description": "Type of microsite content", "in": "path", "required": true, "schema": {"type": "string", "enum": ["bitlink", "social"]}, "example": "bitlink"}, "ImageGUID": {"name": "image_guid", "description": "A GUID for an image uploaded to Bitly", "in": "path", "required": true, "schema": {"type": "string"}, "example": "Ia1bcd234eF"}, "ImageUse": {"name": "image_use", "description": "An image use for an image uploaded to Bitly", "in": "path", "required": true, "schema": {"type": "string"}, "example": "profile"}, "AuthorizationID": {"name": "authorization_id", "description": "A ID for an oAuth authorization", "in": "path", "required": true, "schema": {"type": "string"}, "example": "12a34567b8c901d2efg345678h901ab2345c67de"}, "RoleName": {"name": "role_name", "description": "The role specified for a user", "in": "path", "required": true, "schema": {"type": "string"}, "example": "admin"}, "BillingPaymentMethodID": {"name": "payment_method_id", "in": "path", "required": true, "schema": {"type": "string"}, "example": "abcd1234"}, "URL": {"name": "url", "in": "query", "required": true, "schema": {"type": "string"}, "example": "https://example.com"}, "LongURL": {"name": "long_url", "in": "query", "style": "form", "explode": true, "required": true, "schema": {"type": "array", "minItems": 1, "maxItems": 15, "items": {"type": "string"}}, "example": "long_url=https://example.com&long_url=https://anotherlink.com"}}, "schemas": {"AutobrandedDomain": {"type": "object", "required": ["result"], "properties": {"result": {"type": "array", "minItems": 1, "maxItems": 15, "items": {"type": "object", "required": ["long_url"], "properties": {"long_url": {"type": "string"}, "autobranded_domain": {"type": "string"}, "error": {"type": "string", "enum": ["INVALID_ARG_LONG_URL", "NOT_FOUND"]}}}}}}, "InstallPreference": {"type": "string", "enum": ["no_install", "auto_install", "promote_install"]}, "CustomDomain": {"type": "object", "properties": {"organization_guid": {"type": "string"}, "custom_domain": {"type": "string"}}}, "UMGroupPreferenceUpdate": {"type": "object", "allOf": [{"properties": {"preference": {"type": "string"}, "value": {"type": "string"}}}]}, "UMGroupPreference": {"type": "object", "allOf": [{"properties": {"group_guid": {"type": "string"}, "preference": {"type": "string"}, "value": {"type": "string"}, "created": {"type": "string", "description": "ISO timestamp"}, "modified": {"type": "string", "description": "ISO timestamp"}, "is_active": {"type": "boolean"}}}]}, "UMGroupPreferences": {"type": "object", "properties": {"preferences": {"type": "array", "items": {"$ref": "#/components/schemas/UMGroupPreference"}}}}, "BillingPaymentMethodID": {"type": "string"}, "BillingAccount": {"type": "object", "properties": {"account_id": {"type": "string"}, "account_num": {"type": "string"}, "card_type": {"type": "string"}, "end_date": {"description": "ISO timestamp", "type": "string"}, "last_four_digits": {"type": "string"}, "payment_method_type": {"type": "string", "enum": ["PayPal", "CreditCard"]}, "renewal_date": {"description": "ISO timestamp", "type": "string"}, "subscription_price": {"type": "number"}, "subscription_status": {"type": "string"}, "tax_id": {"type": "string"}, "company_name": {"type": "string"}, "billing_info": {"$ref": "#/components/schemas/BillingInfo"}, "contact_info": {"$ref": "#/components/schemas/ContactInfo"}, "subscription_discounts": {"type": "array", "items": {"$ref": "#/components/schemas/SubscriptionDiscount"}}}}, "BillingAccountID": {"type": "object", "properties": {"billing_account_id": {"type": "string"}}}, "BillingSignature": {"type": "object", "properties": {"signature": {"type": "string"}, "token": {"type": "string"}, "tenant_id": {"type": "string"}, "key": {"type": "string"}, "iframe_id": {"type": "string"}, "field_account_id": {"type": "string"}}}, "PayPalToken": {"type": "object", "properties": {"token_id": {"type": "string"}}}, "OrgTierHistory": {"type": "object", "nullable": true, "required": ["org_guid", "status", "created", "modified", "tier_name", "tier_change_date", "activated", "deactivated"], "properties": {"org_guid": {"type": "string"}, "status": {"type": "string"}, "created": {"description": "ISO timestamp", "type": "string"}, "modified": {"description": "ISO timestamp", "type": "string"}, "tier_name": {"type": "string"}, "tier_change_date": {"description": "ISO timestamp", "type": "string"}, "activated": {"description": "ISO timestamp", "type": "string"}, "deactivated": {"description": "ISO timestamp", "type": "string"}}}, "SubscriptionCancelledDate": {"type": "object", "properties": {"subscription_cancelled_date": {"description": "ISO timestamp", "type": "string"}}}, "PaymentInvoices": {"type": "object", "properties": {"payment_invoices": {"type": "array", "items": {"$ref": "#/components/schemas/PaymentInvoice"}}}}, "PaymentInvoice": {"type": "object", "properties": {"invoice_date": {"type": "string"}, "invoice_due_date": {"type": "string"}, "invoice_number": {"type": "string"}, "invoice_id": {"type": "string"}, "charges": {"type": "object", "$ref": "#/components/schemas/Charges"}, "subtotal": {"type": "number"}, "total_tax": {"type": "number"}, "total": {"type": "number"}, "payments": {"type": "array", "items": {"$ref": "#/components/schemas/Payments"}}, "description": {"type": "string"}}}, "PaymentInvoiceDetail": {"type": "object", "properties": {"invoice_summary": {"type": "object", "$ref": "#/components/schemas/PaymentInvoice"}, "billing_account": {"type": "object", "$ref": "#/components/schemas/BillingAccount"}, "subscription_discounts": {"type": "array", "items": {"$ref": "#/components/schemas/SubscriptionDiscount"}}}}, "Charges": {"type": "object", "properties": {"charge_amount": {"type": "number"}, "charge_name": {"type": "string"}, "processing_type": {"type": "string"}, "tax_amount": {"type": "number"}}}, "Payments": {"type": "object", "properties": {"payment_amount": {"type": "number"}, "payment_date": {"type": "string"}, "payment_number": {"type": "string"}}}, "AnnualRenewalReminderRequest": {"type": "object", "properties": {"subscription_ID": {"type": "string"}, "org_guid": {"type": "string"}}}, "FieldError": {"type": "object", "properties": {"field": {"type": "string"}, "error_code": {"type": "string"}, "message": {"type": "string"}}}, "Error": {"type": "object", "properties": {"message": {"type": "string"}, "description": {"type": "string"}, "resource": {"type": "string"}, "errors": {"type": "array", "items": {"$ref": "#/components/schemas/FieldError"}}}}, "SimplifiedError": {"type": "object", "properties": {"message": {"type": "string"}, "description": {"type": "string"}, "resource": {"type": "string"}}}, "UsersPagination": {"type": "object", "properties": {"prev": {"type": "string"}, "next": {"type": "string"}, "page": {"type": "integer"}, "total": {"type": "integer"}, "size": {"type": "integer"}}}, "BitlinksPagination": {"type": "object", "properties": {"next": {"type": "string"}, "search_after": {"type": "string"}, "size": {"type": "integer"}}}, "LaunchpadsPagination": {"type": "object", "properties": {"prev": {"type": "string"}, "next": {"type": "string"}, "page": {"type": "integer"}, "total": {"type": "integer"}, "size": {"type": "integer"}}}, "QRPagination": {"type": "object", "description": "This object specifies how to query the next set of results.", "properties": {"next": {"type": "string", "description": "a hyperlink to the next set of results."}, "search_after": {"type": "string", "description": "the identifier of where to begin searching for the next set of results.", "example": "Qn8sfFRC2tm"}, "size": {"type": "integer", "description": "the number of results returned from this query.", "example": 50}}}, "Group": {"type": "object", "required": ["guid", "organization_guid", "name", "created", "modified", "is_active", "role", "bsds"], "allOf": [{"$ref": "#/components/schemas/HasReferences"}, {"properties": {"name": {"type": "string"}, "guid": {"type": "string"}, "created": {"type": "string"}, "modified": {"type": "string"}, "is_active": {"type": "boolean"}, "role": {"type": "string"}, "organization_guid": {"type": "string"}, "bsds": {"type": "array", "items": {"type": "string"}}}}]}, "Groups": {"type": "object", "required": ["groups"], "properties": {"groups": {"type": "array", "items": {"$ref": "#/components/schemas/Group"}}}}, "GroupUpdate": {"type": "object", "properties": {"name": {"type": "string"}, "organization_guid": {"type": "string"}, "bsds": {"type": "array", "items": {"type": "string"}}}, "example": {"name": "My New Group", "organization_guid": "Oa1bcd234eF", "bsds": ["chauncey.ly"]}}, "SSOSettings": {"type": "object", "properties": {"organization_guid": {"type": "string"}, "identity_provider": {"type": "string"}, "issuer_url": {"type": "string"}, "url_slug": {"type": "string"}, "idp_url": {"type": "string"}, "saml_endpoint": {"type": "string"}, "certificate": {"type": "string"}, "slo_endpoint": {"type": "string"}, "domains": {"type": "array", "items": {"type": "string"}}, "default_group_guid": {"type": "string"}}}, "SSOSlug": {"type": "object", "properties": {"url_slug": {"type": "string"}}}, "SSOVerifySlug": {"type": "object", "properties": {"url_slug": {"type": "string"}, "available": {"type": "boolean"}}}, "OrganizationUpdate": {"type": "object", "required": ["name"], "properties": {"name": {"type": "string"}}}, "Organization": {"type": "object", "required": ["guid", "name", "is_active", "tier", "tier_family", "tier_display_name", "role", "created", "modified", "bsds"], "allOf": [{"$ref": "#/components/schemas/HasReferences"}, {"properties": {"name": {"type": "string"}, "is_active": {"type": "boolean"}, "guid": {"type": "string"}, "tier": {"type": "string"}, "tier_family": {"type": "string"}, "tier_display_name": {"type": "string"}, "role": {"type": "string"}, "created": {"type": "string"}, "modified": {"type": "string"}, "bsds": {"type": "array", "items": {"type": "string"}}}}]}, "Organizations": {"type": "object", "required": ["organizations"], "properties": {"organizations": {"type": "array", "items": {"$ref": "#/components/schemas/Organization"}}}}, "BasicInfo": {"type": "object", "properties": {"company_name": {"type": "string"}, "vat_id": {"type": "string"}}}, "BillingInfo": {"type": "object", "properties": {"billing_contact": {"type": "object", "$ref": "#/components/schemas/BillingContact"}, "basic_info": {"type": "object", "$ref": "#/components/schemas/BasicInfo"}, "billing_address": {"type": "object", "$ref": "#/components/schemas/BillingAddress"}}}, "UpgradeOrgBody": {"type": "object", "properties": {"org_guid": {"type": "string"}, "payment_method_id": {"type": "string"}, "payment_provider": {"type": "string", "enum": ["zuora"], "default": "zuora"}, "rate_plan_name": {"type": "string"}, "company_name": {"type": "string"}, "tax_id": {"type": "string"}, "promo_code": {"type": "string"}, "billing_info": {"type": "object", "$ref": "#/components/schemas/BillingInfo"}}}, "DowngradeOrgBody": {"type": "object", "properties": {"org_guid": {"type": "string"}, "account_num": {"type": "string"}, "term_end_date": {"type": "string"}}}, "ContactInfo": {"type": "object", "required": ["first_name", "last_name", "address"], "properties": {"first_name": {"type": "string"}, "last_name": {"type": "string"}, "address": {"type": "object", "$ref": "#/components/schemas/BillingAddress"}}}, "SubscriptionDiscount": {"type": "object", "properties": {"billing_period": {"type": "string"}, "effective_end_date": {"type": "string"}, "effective_start_date": {"type": "string"}, "up_to_periods_type": {"type": "string"}, "product_rate_plan_charge_id": {"type": "string"}, "model": {"type": "string"}, "end_date_condition": {"type": "string"}, "up_to_periods": {"type": "number"}, "discount_amount": {"type": "number"}, "discount_percentage": {"type": "number"}}}, "BillingDowngrade": {"type": "object", "properties": {"tier_name": {"type": "string"}, "group_guids": {"type": "array", "items": {"type": "string"}}, "microsite_guids": {"type": "array", "items": {"type": "string"}}, "promo_code": {"type": "string"}}}, "PayPalTokenRequest": {"type": "object", "properties": {"org_guid": {"type": "string"}, "tier_name": {"type": "string"}, "billing_period": {"type": "string"}}}, "BillingContact": {"type": "object", "properties": {"billing_contact_id": {"type": "string"}, "first_name": {"type": "string"}, "last_name": {"type": "string"}, "phone": {"type": "string"}, "email": {"type": "string"}, "description": {"type": "string"}}}, "BillingAddress": {"type": "object", "properties": {"address_1": {"type": "string"}, "address_2": {"type": "string"}, "city": {"type": "string"}, "state": {"type": "string"}, "zip_code": {"type": "string"}, "country": {"type": "string"}}}, "CreatePaymentMethod": {"type": "object", "properties": {"type": {"type": "string"}, "paypal_baid": {"type": "string"}, "paypal_email": {"type": "string"}}}, "PaymentMethod": {"type": "object", "properties": {"payment_method_id": {"type": "string"}}}, "User": {"type": "object", "required": ["login", "is_active", "created", "modified", "is_2fa_enabled", "name", "emails", "is_sso_user"], "properties": {"login": {"type": "string"}, "name": {"type": "string"}, "is_active": {"type": "boolean"}, "created": {"type": "string"}, "modified": {"type": "string"}, "is_sso_user": {"type": "boolean"}, "emails": {"type": "array", "items": {"$ref": "#/components/schemas/Email"}}, "is_2fa_enabled": {"type": "boolean"}, "default_group_guid": {"type": "string"}}}, "UserInternal": {"type": "object", "allOf": [{"$ref": "#/components/schemas/User"}, {"properties": {"role_name": {"type": "string"}}}]}, "Users": {"type": "object", "properties": {"users": {"type": "array", "items": {"$ref": "#/components/schemas/UserInternal"}}, "pagination": {"$ref": "#/components/schemas/UsersPagination"}, "fullNameFilter": {"type": "string"}}}, "CreateUserBody": {"type": "object", "required": ["login", "name", "email"], "properties": {"login": {"type": "string"}, "name": {"type": "string"}, "email": {"type": "string"}, "full_name": {"type": "string"}, "invite_token": {"type": "string"}, "campaign_source": {"type": "string"}}}, "PublicOAuthUser": {"type": "object", "properties": {"login": {"type": "string"}, "Access_Token": {"type": "string"}}}, "UserUpdate": {"type": "object", "properties": {"name": {"type": "string"}, "default_group_guid": {"type": "string"}}, "example": {"name": "Chauncey McPufferson", "default_group_guid": "Ba1bc23dE4F"}}, "OrganizationPreferences": {"type": "object", "properties": {"preferences": {"type": "array", "items": {"$ref": "#/components/schemas/OrganizationPreference"}}}}, "OrganizationPreference": {"type": "object", "allOf": [{"properties": {"preference_name": {"type": "string"}, "value": {"type": "string"}, "created": {"type": "string"}, "modified": {"type": "string"}}}]}, "UserPreferences": {"type": "object", "properties": {"preferences": {"type": "array", "items": {"$ref": "#/components/schemas/UserPreference"}}}}, "UserPreference": {"type": "object", "allOf": [{"properties": {"login": {"type": "string"}, "preference": {"type": "string"}, "value": {"type": "string"}, "is_active": {"type": "boolean"}, "expired": {"type": "boolean"}, "last_seen": {"type": "string"}, "created": {"type": "string"}, "modified": {"type": "string"}}}]}, "UserPreferenceBody": {"type": "object", "properties": {"preference": {"type": "string"}, "value": {"type": "string"}, "is_active": {"type": "boolean"}}}, "UserPasswordChange": {"type": "object", "required": ["original_password", "new_password"], "properties": {"original_password": {"type": "string"}, "new_password": {"type": "string"}}}, "UserOnboardingSurvey": {"type": "object", "properties": {"login": {"type": "string"}, "team_type": {"type": "string"}, "first_name": {"type": "string"}, "last_name": {"type": "string"}, "use_cases": {"type": "array", "items": {"type": "string"}}, "use_cases_other": {"type": "array", "items": {"type": "string"}}, "organization_name": {"type": "string"}, "job_title": {"type": "string"}, "department": {"type": "string"}, "department_other": {"type": "string"}, "company_size": {"type": "string"}, "version": {"type": "number"}, "created": {"type": "string"}, "modified": {"type": "string"}}}, "Email": {"type": "object", "properties": {"email": {"type": "string"}, "is_primary": {"type": "boolean"}, "is_verified": {"type": "boolean"}}}, "EmailBody": {"type": "object", "properties": {"email": {"type": "string"}, "is_primary": {"type": "boolean"}, "status": {"type": "string"}}}, "OrgEmailBody": {"type": "object", "properties": {"email": {"type": "string"}, "org_guid": {"type": "string"}, "login": {"type": "string"}}}, "OrgEmail": {"type": "object", "properties": {"email": {"type": "string"}, "org_guid": {"type": "string"}, "login": {"type": "string"}, "created_ts": {"type": "integer"}}}, "OrgEmails": {"type": "object", "description": "an array of org emails", "properties": {"emails": {"type": "array", "items": {"$ref": "#/components/schemas/OrgEmail"}}}}, "GroupBitlinksCount": {"type": "object", "properties": {"unit": {"type": "string"}, "units": {"type": "integer"}, "unit_reference": {"type": "string"}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/CountItem"}}}}, "CountItem": {"type": "object", "properties": {"ts": {"type": "string"}, "count": {"type": "integer"}}}, "QRCodes": {"type": "object", "properties": {"qr_codes": {"type": "array", "items": {"$ref": "#/components/schemas/FullQRCodeWithScans"}}, "size": {"type": "integer"}, "page": {"type": "integer"}, "total": {"type": "integer"}}}, "OrgInvitationRequest": {"type": "object", "properties": {"login": {"type": "string"}, "created": {"type": "string"}, "status": {"type": "string"}, "notes": {"type": "string"}}}, "FullQRCodeWithScans": {"type": "object", "properties": {"id": {"type": "string"}, "title": {"type": "string"}, "link": {"type": "string"}, "long_url": {"type": "string"}, "group_guid": {"type": "string"}, "customization": {"type": "object", "$ref": "#/components/schemas/QRCustomizations"}, "qr_uri": {"type": "string", "description": "Data URI of QR Code image"}, "is_hidden": {"type": "boolean"}, "is_customized": {"type": "boolean"}, "scans": {"type": "integer"}, "created": {"type": "string"}, "modified": {"type": "string"}, "created_ts": {"type": "integer"}, "modified_ts": {"type": "integer"}}}, "FullQRCode": {"type": "object", "properties": {"id": {"type": "string"}, "link": {"type": "string"}, "group_guid": {"type": "string"}, "customization": {"type": "object", "$ref": "#/components/schemas/QRCustomizations"}, "qr_code": {"type": "string", "description": "Data URI of QR Code image"}, "logo_image_url": {"type": "string", "description": "Public URL of QR Code logo"}, "is_customized": {"type": "boolean"}, "is_hidden": {"type": "boolean"}, "has_stored": {"type": "boolean"}, "created": {"type": "string"}, "modified": {"type": "string"}}}, "QRCustomizations": {"type": "object", "properties": {"color": {"type": "string", "description": "A color denoted in hexadecimal format ei. \"1133ff\""}, "exclude_bitly_logo": {"type": "boolean", "description": "Removes the Bitly logo from the center of the generated QR image"}, "image_format": {"description": "Determines the image format of the returned QR code", "type": "string", "enum": ["png", "svg"], "default": "png"}, "logo_image_guid": {"type": "string", "description": "Logo must first be uploaded through Bitly's QR Code Modal located on the \"All links\" page. Once created, a call to \"Retrieve a QR Code\" with specified bitlink will return the auto-generated \"logo_image_guid\""}, "is_hidden": {"type": "boolean", "description": "Determine whether to hide the QR code. Passing true will hide the QR code."}}, "example": {"color": "1133ff", "exclude_bitly_logo": true, "image_format": "svg", "logo_image_guid": "I123456789", "is_hidden": true}}, "QRLogoImagesResponse": {"type": "object", "properties": {"qr_logo_images": {"type": "array", "items": {"$ref": "#/components/schemas/QRLogoImages"}}}}, "ImageFormat": {"description": "Determines the image format of the returned QR code", "type": "string", "enum": ["png", "svg"], "default": "png"}, "QRLogoImages": {"type": "object", "properties": {"image_guid": {"type": "string"}, "url": {"type": "string", "description": "Public URL of QR Code logo"}}}, "ShortenBitlinkBody": {"type": "object", "allOf": [{"$ref": "#/components/schemas/HasReferences"}, {"properties": {"link": {"type": "string"}, "id": {"type": "string"}, "long_url": {"type": "string"}, "archived": {"type": "boolean"}, "created_at": {"type": "string"}, "custom_bitlinks": {"type": "array", "items": {"type": "string"}, "description": "list of previously edited backhalfs for the bitlink - these are in reverse chronological order, with the most recently edited backhalf first"}, "tags": {"type": "array", "items": {"type": "string"}}, "deeplinks": {"type": "array", "items": {"$ref": "#/components/schemas/DeeplinkRule"}}}}]}, "LinkDeletionResponse": {"type": "object", "properties": {"links_deleted": {"type": "array", "items": {"$ref": "#/components/schemas/DeletedLink"}, "example": [{"id": "bit.ly/12a4b6c"}, {"id": "chauncey.ly/documentation"}]}}}, "DeletedLink": {"type": "object", "properties": {"id": {"type": "string"}}}, "BitlinkBody": {"type": "object", "allOf": [{"$ref": "#/components/schemas/HasReferences"}, {"$ref": "#/components/schemas/BitlinkUpdate"}]}, "BitlinkUpdate": {"type": "object", "properties": {"link": {"type": "string"}, "id": {"type": "string"}, "long_url": {"type": "string"}, "title": {"type": "string"}, "archived": {"type": "boolean"}, "created_at": {"type": "string"}, "created_by": {"type": "string"}, "client_id": {"type": "string"}, "custom_bitlinks": {"type": "array", "items": {"type": "string"}, "description": "list of previously edited backhalfs for the bitlink - these are in reverse chronological order, with the most recently edited backhalf first"}, "tags": {"type": "array", "items": {"type": "string"}}, "launchpad_ids": {"type": "array", "items": {"type": "string"}}, "deeplinks": {"type": "array", "items": {"$ref": "#/components/schemas/DeeplinkRule"}}, "is_deleted": {"type": "boolean"}, "campaign_ids": {"type": "array", "items": {"type": "string"}}}}, "BitlinkUpdateBody": {"type": "object", "properties": {"title": {"type": "string"}, "archived": {"type": "boolean"}, "tags": {"type": "array", "items": {"type": "string"}}, "deeplinks": {"type": "array", "items": {"$ref": "#/components/schemas/DeeplinkRule"}}}}, "Bitlinks": {"type": "object", "properties": {"links": {"type": "array", "items": {"$ref": "#/components/schemas/BitlinkBody"}}, "pagination": {"$ref": "#/components/schemas/BitlinksPagination"}}}, "ExpandBitlink": {"type": "object", "properties": {"bitlink_id": {"type": "string"}}, "example": {"bitlink_id": "bit.ly/12a4b6c"}}, "ExpandedBitlink": {"type": "object", "properties": {"link": {"type": "string"}, "id": {"type": "string"}, "long_url": {"type": "string"}, "created_at": {"type": "string"}}}, "ClickLink": {"type": "object", "properties": {"clicks": {"type": "integer"}, "id": {"type": "string"}}}, "SortedLinks": {"type": "object", "properties": {"links": {"type": "array", "items": {"$ref": "#/components/schemas/BitlinkBody"}}, "sorted_links": {"type": "array", "items": {"$ref": "#/components/schemas/ClickLink"}}}}, "DeeplinkRule": {"type": "object", "properties": {"guid": {"type": "string"}, "bitlink": {"type": "string"}, "app_uri_path": {"type": "string"}, "install_url": {"type": "string"}, "app_guid": {"type": "string"}, "os": {"$ref": "#/components/schemas/MobileOS"}, "install_type": {"$ref": "#/components/schemas/InstallPreference"}, "created": {"type": "string", "description": "ISO timestamp"}, "modified": {"type": "string", "description": "ISO timestamp"}, "brand_guid": {"type": "string"}}}, "DeeplinkRules": {"type": "object", "properties": {"rules": {"type": "array", "items": {"$ref": "#/components/schemas/DeeplinkRule"}}}}, "Deeplink": {"type": "object", "properties": {"app_id": {"type": "string"}, "app_uri_path": {"type": "string"}, "install_url": {"type": "string"}, "install_type": {"$ref": "#/components/schemas/InstallPreference"}}}, "TimeUnit": {"description": "the unit of time queried for (minute, hour, day, week, month)", "type": "string", "enum": ["minute", "hour", "day", "week", "month"], "default": "day"}, "UnitAmount": {"type": "integer", "description": "the number of units queried for", "default": -1}, "UnitReferenceTimeStamp": {"description": "data returned up to this reference timestamp", "type": "string"}, "FullShorten": {"type": "object", "required": ["long_url"], "properties": {"long_url": {"type": "string"}, "domain": {"type": "string", "default": "bit.ly"}, "group_guid": {"type": "string", "description": "Always include a specific group and custom domain in your shorten calls."}, "title": {"type": "string"}, "tags": {"type": "array", "items": {"type": "string"}}, "deeplinks": {"type": "array", "items": {"$ref": "#/components/schemas/Deeplink"}}}, "example": {"long_url": "https://dev.bitly.com", "domain": "bit.ly", "group_guid": "Ba1bc23dE4F", "title": "Bitly API Documentation", "tags": ["bitly", "api"], "deeplinks": [{"app_id": "com.bitly.app", "app_uri_path": "/store?id=123456", "install_url": "https://play.google.com/store/apps/details?id=com.bitly.app&hl=en_US", "install_type": "promote_install"}]}}, "Shorten": {"type": "object", "required": ["long_url"], "properties": {"long_url": {"type": "string"}, "domain": {"type": "string", "default": "bit.ly"}, "group_guid": {"type": "string"}}, "example": {"long_url": "https://dev.bitly.com", "domain": "bit.ly", "group_guid": "Ba1bc23dE4F"}}, "LinkClicks": {"type": "object", "properties": {"clicks": {"type": "integer"}, "date": {"type": "string"}}}, "QRScans": {"type": "object", "properties": {"scans": {"type": "integer"}, "date": {"type": "string"}}}, "Clicks": {"type": "object", "properties": {"link_clicks": {"type": "array", "items": {"$ref": "#/components/schemas/LinkClicks"}}, "units": {"type": "integer"}, "unit": {"type": "string", "enum": ["minute", "hour", "day", "week", "month"]}, "unit_reference": {"type": "string"}}}, "Scans": {"type": "object", "properties": {"qr_scans": {"type": "array", "items": {"$ref": "#/components/schemas/QRScans"}}, "units": {"type": "integer"}, "unit": {"type": "string", "enum": ["minute", "hour", "day", "week", "month"]}, "unit_reference": {"type": "string"}}}, "TotalEngagements": {"type": "object", "properties": {"engagements": {"type": "array", "items": {"$ref": "#/components/schemas/Engagements"}}, "units": {"type": "integer"}, "unit": {"type": "string", "enum": ["minute", "hour", "day", "week", "month"]}, "unit_reference": {"type": "string"}}}, "Engagements": {"type": "object", "properties": {"engagement_count": {"type": "integer"}, "engagements": {"$ref": "#/components/schemas/Engagement"}, "date": {"type": "string"}}}, "Engagement": {"type": "object", "properties": {"lib_button_clicks": {"type": "integer"}, "clicks": {"type": "integer"}, "scans": {"type": "integer"}}}, "TotalEngagementsSummary": {"type": "object", "properties": {"total_engagements": {"type": "integer"}, "engagements": {"$ref": "#/components/schemas/Engagement"}, "units": {"type": "integer"}, "unit": {"type": "string", "enum": ["minute", "hour", "day", "week", "month"]}, "unit_reference": {"type": "string"}}}, "BitlinkClicks": {"type": "object", "properties": {"bitlink_clicks": {"type": "array", "items": {"$ref": "#/components/schemas/LinkClicks"}}, "units": {"type": "integer"}, "unit": {"type": "string", "enum": ["minute", "hour", "day", "week", "month"]}, "unit_reference": {"type": "string"}}}, "BitlinkScans": {"type": "object", "properties": {"scans": {"type": "array", "items": {"$ref": "#/components/schemas/QRScans"}}, "units": {"type": "integer"}, "unit": {"type": "string", "enum": ["minute", "hour", "day", "week", "month"]}, "unit_reference": {"type": "string"}}}, "PaginatedAnalyticsReports": {"type": "object", "properties": {"page": {"type": "number"}, "size": {"type": "number"}, "total_found": {"type": "number"}, "reports": {"type": "array", "items": {"$ref": "#/components/schemas/AnalyticsReport"}}}}, "AnalyticsReport": {"type": "object", "properties": {"report_guid": {"type": "string"}, "login": {"type": "string"}, "group_guid": {"type": "string"}, "last_modified_by": {"type": "string"}, "user_full_name": {"type": "string"}, "created": {"type": "string"}, "modified": {"type": "string"}, "is_active": {"type": "boolean"}, "settings": {"$ref": "#/components/schemas/ReportSettings"}}}, "AnalyticsReports": {"type": "object", "properties": {"reports": {"type": "array", "items": {"$ref": "#/components/schemas/AnalyticsReport"}}}}, "ButtonClicks": {"type": "object", "properties": {"bitlink_scans": {"type": "array", "items": {"$ref": "#/components/schemas/Clicks"}}, "units": {"type": "integer"}, "unit": {"type": "string", "enum": ["minute", "hour", "day", "week", "month"]}, "unit_reference": {"type": "string"}}}, "ReportSettings": {"type": "object", "properties": {"preset_time_range": {"type": "string", "enum": ["LAST_30_DAY", "LAST_7_DAY", "LAST_90_DAY", "TODAY", "YESTERDAY"]}, "report_start": {"type": "string"}, "report_end": {"type": "string"}, "allow_edits": {"type": "boolean"}, "filters": {"$ref": "#/components/schemas/ReportFilters"}, "associated_modules": {"type": "array", "items": {"$ref": "#/components/schemas/Module"}}, "report_content": {"$ref": "#/components/schemas/AnalyticsReportContent"}}}, "ReportFilters": {"type": "object", "properties": {"bitlinks": {"type": "array", "items": {"type": "string"}}}}, "AnalyticsReportContent": {"type": "object", "properties": {"title": {"type": "string"}}}, "Module": {"type": "object", "properties": {"module_guid": {"type": "string"}, "last_modified_by": {"type": "string"}, "created": {"type": "string"}, "is_active": {"type": "boolean"}, "login": {"type": "string"}, "group_guid": {"type": "string"}, "settings": {"$ref": "#/components/schemas/ModuleSettings"}}}, "ModuleSettings": {"type": "object", "properties": {"allow_edits": {"type": "boolean"}, "visualization": {"$ref": "#/components/schemas/ChartVisualization"}, "chart_type": {"type": "string", "enum": ["devices", "referrers", "engagements", "comparison", "performance_over_time", "top_performing", "location"]}}}, "ChartVisualization": {"type": "object", "properties": {"type": {"type": "string", "enum": ["line", "table", "doughnut", "bar", "highlight", "map"]}, "time_comparison_details": {"$ref": "#/components/schemas/TimeComparisonDetails"}}}, "TimeComparisonDetails": {"type": "object", "properties": {"comparison_start": {"$ref": "#/components/schemas/UnitReferenceTimeStamp"}, "comparison_end": {"$ref": "#/components/schemas/UnitReferenceTimeStamp"}}}, "UpdateAnalyticsModule": {"type": "object", "properties": {"module_settings": {"$ref": "#/components/schemas/ModuleSettings"}, "is_active": {"type": "boolean"}}}, "CreateAnalyticsModule": {"type": "object", "properties": {"module_settings": {"$ref": "#/components/schemas/ModuleSettings"}, "group_guid": {"type": "string"}, "report_guid": {"type": "string"}}}, "CreateAnalyticsReport": {"type": "object", "properties": {"group_guid": {"type": "string"}, "report_settings": {"$ref": "#/components/schemas/ReportSettings"}}}, "UpdateAnalyticsReport": {"type": "object", "properties": {"report_settings": {"$ref": "#/components/schemas/ReportSettings"}, "is_active": {"type": "boolean"}}}, "LaunchpadLinkPerformance": {"type": "object", "properties": {"total": {"type": "integer"}, "link_clicks": {"type": "array", "items": {"$ref": "#/components/schemas/LaunchpadClicks"}}, "performance_start": {"type": "string"}, "performance_end": {"type": "string"}, "units": {"type": "integer"}, "unit": {"type": "string", "enum": ["minute", "hour", "day", "week", "month"]}, "unit_reference": {"type": "string"}, "page": {"$ref": "#/components/schemas/LaunchpadsPagination"}}}, "LaunchpadButtonTypeEnum": {"description": "Available button types for Launchpad content", "type": "string", "enum": ["bitlink", "youtubeVideo", "image", "carousel", "grid"]}, "LaunchpadClicks": {"type": "object", "properties": {"clicks": {"type": "integer"}, "date": {"type": "string"}, "title": {"type": "string"}, "is_active": {"type": "boolean"}, "long_url": {"type": "string"}, "type": {"$ref": "#/components/schemas/LaunchpadButtonTypeEnum"}, "bitlink_id": {"type": "string"}, "domain": {"type": "string"}, "keyword": {"type": "string"}}}, "ClicksSummary": {"type": "object", "properties": {"total_clicks": {"type": "integer"}, "units": {"type": "integer"}, "unit": {"type": "string", "enum": ["minute", "hour", "day", "week", "month"]}, "unit_reference": {"type": "string"}}}, "ScansSummary": {"type": "object", "properties": {"total_scans": {"type": "integer"}, "units": {"type": "integer"}, "unit": {"type": "string", "enum": ["minute", "hour", "day", "week", "month"]}, "unit_reference": {"type": "string"}}}, "BitlinkClicksSummary": {"type": "object", "properties": {"total_bitlink_clicks": {"type": "integer"}, "units": {"type": "integer"}, "unit": {"type": "string", "enum": ["minute", "hour", "day", "week", "month"]}, "unit_reference": {"type": "string"}}}, "BitlinkScansSummary": {"type": "object", "properties": {"total_scans": {"type": "integer"}, "units": {"type": "integer"}, "unit": {"type": "string", "enum": ["minute", "hour", "day", "week", "month"]}, "unit_reference": {"type": "string"}}}, "ButtonClicksSummary": {"type": "object", "properties": {"total_button_clicks": {"type": "integer"}, "units": {"type": "integer"}, "unit": {"type": "string", "enum": ["minute", "hour", "day", "week", "month"]}, "unit_reference": {"type": "string"}}}, "Views": {"type": "object", "properties": {"launchpad_views": {"type": "array", "items": {"$ref": "#/components/schemas/ViewMetric"}}, "units": {"type": "integer"}, "unit": {"type": "string", "enum": ["minute", "hour", "day", "week", "month"]}, "unit_reference": {"type": "string"}, "facet": {"type": "string", "enum": ["views", "countries", "referrers", "devices"]}}}, "ViewsSummary": {"type": "object", "properties": {"total_views": {"type": "integer"}, "units": {"type": "integer"}, "unit": {"type": "string", "enum": ["minute", "hour", "day", "week", "month"]}, "unit_reference": {"type": "string"}}}, "CampaignClickData": {"type": "object", "properties": {"ts": {"type": "integer"}, "clicks": {"type": "integer"}}}, "ChannelBitlink": {"type": "object", "required": ["bitlink_id", "campaign_guid", "channel_guid", "created_ts"], "properties": {"created_ts": {"type": "integer"}, "bitlink_id": {"type": "string"}, "campaign_guid": {"type": "string"}, "channel_guid": {"type": "string"}, "title": {"type": "string"}, "total_clicks": {"type": "integer"}, "clicks": {"type": "array", "items": {"$ref": "#/components/schemas/CampaignClickData"}}, "keyword_link": {"type": "string"}, "link": {"type": "string"}, "long_url": {"type": "string"}, "client_id": {"type": "string"}, "campaign_ids": {"type": "array", "items": {"type": "string"}}}}, "ChannelBitlinks": {"type": "object", "properties": {"bitlinks": {"type": "array", "items": {"$ref": "#/components/schemas/ChannelBitlink"}}, "total": {"type": "integer"}}}, "CampaignClicks": {"type": "object", "properties": {"unit": {"type": "string", "enum": ["minute", "hour", "day", "week", "month"]}, "units": {"type": "integer"}, "unit_reference": {"type": "string"}, "rollup": {"type": "boolean"}, "limit": {"type": "integer"}, "data": {"$ref": "#/components/schemas/CampaignClicksData"}}}, "CampaignClicksData": {"type": "object", "properties": {"guid": {"type": "string"}, "brand_guid": {"type": "string"}, "created_by": {"type": "string"}, "name": {"type": "string"}, "description": {"type": "string"}, "created_ts": {"type": "integer"}, "modified_ts": {"type": "integer"}, "total_clicks": {"type": "integer"}, "campaign_channels": {"type": "array", "items": {"$ref": "#/components/schemas/CampaignChannelClicks"}}}}, "CampaignChannelClicks": {"type": "object", "properties": {"campaign_guid": {"type": "string"}, "channel_guid": {"type": "string"}, "channel_name": {"type": "string"}, "created_ts": {"type": "integer"}, "total_clicks": {"type": "integer"}, "clicks": {"type": "array", "items": {"$ref": "#/components/schemas/CampaignClickData"}}, "channel_bitlinks": {"$ref": "#/components/schemas/ChannelBitlinks"}}}, "Tags": {"type": "object", "properties": {"tags": {"type": "array", "items": {"type": "string"}}}}, "EncodingLogin": {"type": "object", "properties": {"encoding_login": {"type": "array", "items": {"type": "string"}}}}, "GroupPreferences": {"type": "object", "properties": {"group_guid": {"type": "string"}, "domain_preference": {"type": "string"}}}, "AddCustomBitlink": {"type": "object", "properties": {"custom_bitlink": {"type": "string"}, "bitlink_id": {"type": "string"}}, "example": {"custom_bitlink": "chauncey.ly/documentation", "bitlink_id": "chauncey.ly/1234abcd"}}, "UpdateCustomBitlink": {"type": "object", "properties": {"bitlink_id": {"type": "string"}}, "example": {"bitlink_id": "chauncey.ly/1234abcd"}}, "CustomBitlink": {"type": "object", "properties": {"custom_bitlink": {"type": "string"}, "bitlink": {"$ref": "#/components/schemas/BitlinkBody"}, "bitlink_history": {"type": "array", "items": {"$ref": "#/components/schemas/CustomBitlinkHistory"}}}}, "CustomBitlinkHistory": {"type": "object", "properties": {"uuid": {"type": "string"}, "group_guid": {"type": "string"}, "keyword": {"type": "string"}, "bsd": {"type": "string"}, "hash": {"type": "string"}, "login": {"type": "string"}, "long_url": {"type": "string"}, "created": {"type": "string"}, "first_created": {"type": "string"}, "deactivated": {"type": "string"}, "is_active": {"type": "boolean"}}}, "Metric": {"type": "object", "properties": {"key": {"type": "string"}, "value": {"type": "integer"}}}, "CityMetric": {"type": "object", "properties": {"clicks": {"type": "integer"}, "city": {"type": "string"}, "subregion": {"type": "string"}, "region": {"type": "string"}, "country": {"type": "string"}}}, "OtherMetrics": {"type": "object", "properties": {"other_city_clicks": {"type": "integer"}, "no_city_clicks": {"type": "integer"}}}, "OtherScanMetrics": {"type": "object", "properties": {"other_city_scans": {"type": "integer"}, "no_city_scans": {"type": "integer"}}}, "CityBitlinkClicksMetric": {"type": "object", "properties": {"bitlink_clicks": {"type": "integer"}, "city": {"type": "string"}, "subregion": {"type": "string"}, "region": {"type": "string"}, "country": {"type": "string"}}}, "BitlinkClicksMetric": {"type": "object", "properties": {"bitlink_clicks": {"type": "integer"}, "value": {"type": "string"}}}, "BaseBitlinkClicksMetrics": {"type": "object", "properties": {"unit": {"type": "string"}, "units": {"type": "integer"}, "facet": {"type": "string", "enum": ["countries", "cities", "device_os", "browsers"]}, "unit_reference": {"type": "string"}}}, "BitlinkClicksMetrics": {"type": "object", "allOf": [{"$ref": "#/components/schemas/BaseBitlinkClicksMetrics"}, {"properties": {"metrics": {"type": "array", "items": {"$ref": "#/components/schemas/BitlinkClicksMetric"}}}}]}, "CityBitlinkClicksMetrics": {"type": "object", "allOf": [{"$ref": "#/components/schemas/BaseBitlinkClicksMetrics"}, {"properties": {"metrics": {"type": "array", "items": {"$ref": "#/components/schemas/CityBitlinkClicksMetric"}}, "other_metrics": {"type": "object", "$ref": "#/components/schemas/OtherBitlinkClicksMetrics"}}}]}, "OtherBitlinkClicksMetrics": {"type": "object", "properties": {"other_city_bitlink_clicks": {"type": "integer"}, "no_city_bitlink_clicks": {"type": "integer"}}}, "OtherViewMetrics": {"type": "object", "properties": {"other_city_views": {"type": "integer"}, "no_city_views": {"type": "integer"}}}, "ClickMetric": {"type": "object", "properties": {"clicks": {"type": "integer"}, "value": {"type": "string"}}}, "ViewMetric": {"type": "object", "properties": {"views": {"type": "integer"}, "value": {"type": "string"}}}, "DeviceMetric": {"type": "object", "properties": {"clicks": {"type": "integer"}, "device_type": {"type": "string"}}}, "BaseMetrics": {"type": "object", "properties": {"unit": {"type": "string"}, "units": {"type": "integer"}, "facet": {"type": "string", "enum": ["countries", "cities", "devices", "referrers", "referrers_by_domain", "referring_domains", "referring_networks", "shorten_counts"]}, "unit_reference": {"type": "string"}}}, "Metrics": {"type": "object", "allOf": [{"$ref": "#/components/schemas/BaseMetrics"}, {"properties": {"metrics": {"type": "array", "items": {"$ref": "#/components/schemas/Metric"}}}}]}, "ClickMetrics": {"type": "object", "allOf": [{"$ref": "#/components/schemas/BaseMetrics"}, {"properties": {"metrics": {"type": "array", "items": {"$ref": "#/components/schemas/ClickMetric"}}}}]}, "DeviceMetrics": {"type": "object", "allOf": [{"$ref": "#/components/schemas/BaseMetrics"}, {"properties": {"metrics": {"type": "array", "items": {"$ref": "#/components/schemas/DeviceMetric"}}}}]}, "CityMetrics": {"type": "object", "allOf": [{"$ref": "#/components/schemas/BaseMetrics"}, {"properties": {"metrics": {"type": "array", "items": {"$ref": "#/components/schemas/CityMetric"}}, "other_metrics": {"type": "object", "$ref": "#/components/schemas/OtherMetrics"}}}]}, "CityScanMetric": {"type": "object", "properties": {"scans": {"type": "integer"}, "city": {"type": "string"}, "subregion": {"type": "string"}, "region": {"type": "string"}, "country": {"type": "string"}}}, "ScanMetric": {"type": "object", "properties": {"scans": {"type": "integer"}, "value": {"type": "string"}}}, "BaseScanMetrics": {"type": "object", "properties": {"unit": {"type": "string"}, "units": {"type": "integer"}, "facet": {"type": "string", "enum": ["countries", "cities", "device_os", "browsers"]}, "unit_reference": {"type": "string"}}}, "ScanMetrics": {"type": "object", "allOf": [{"$ref": "#/components/schemas/BaseScanMetrics"}, {"properties": {"metrics": {"type": "array", "items": {"$ref": "#/components/schemas/ScanMetric"}}}}]}, "CityScanMetrics": {"type": "object", "allOf": [{"$ref": "#/components/schemas/BaseScanMetrics"}, {"properties": {"metrics": {"type": "array", "items": {"$ref": "#/components/schemas/CityScanMetric"}}, "other_metrics": {"type": "object", "$ref": "#/components/schemas/OtherScanMetrics"}}}]}, "CityViewMetrics": {"type": "object", "allOf": [{"$ref": "#/components/schemas/BaseMetrics"}, {"properties": {"launchpad_views": {"type": "array", "items": {"$ref": "#/components/schemas/ViewMetric"}}, "other_metrics": {"type": "object", "$ref": "#/components/schemas/OtherViewMetrics"}}}]}, "ReferrersByDomain": {"type": "object", "properties": {"network": {"type": "string"}, "referrers": {"type": "array", "items": {"$ref": "#/components/schemas/Metric"}}}}, "ReferrersByDomains": {"type": "object", "properties": {"unit": {"type": "string"}, "units": {"type": "integer"}, "facet": {"type": "string", "enum": ["referrers_by_domains"]}, "unit_reference": {"type": "string"}, "referrers_by_domain": {"type": "array", "items": {"$ref": "#/components/schemas/ReferrersByDomain"}}}}, "AggregateClicksForBitlinks": {"type": "object", "properties": {"unit_reference": {"type": "string"}, "unit": {"type": "string"}, "units": {"type": "number"}, "clicks": {"type": "array", "items": {"$ref": "#/components/schemas/ClicksForAggregate"}}}}, "AggregateClicksForBitlinksByCitiesFacet": {"type": "object", "properties": {"unit_reference": {"type": "string"}, "unit": {"type": "string"}, "units": {"type": "number"}, "facet": {"type": "string"}, "totals_for_time_period": {"type": "array", "items": {"$ref": "#/components/schemas/ClicksByCitiesFacet"}}}}, "AggregateClicksForBitlinksByFacet": {"type": "object", "properties": {"unit_reference": {"type": "string"}, "unit": {"type": "string"}, "units": {"type": "number"}, "facet": {"type": "string"}, "totals_for_time_period": {"type": "array", "items": {"$ref": "#/components/schemas/ClicksByFacet"}}}}, "SortedEngagements": {"type": "object", "properties": {"unit_reference": {"type": "string"}, "unit": {"type": "string"}, "units": {"type": "number"}, "sorted_engagements": {"type": "array", "items": {"$ref": "#/components/schemas/EngagementForSort"}}}}, "EngagementForSort": {"type": "object", "properties": {"engagements": {"type": "number"}, "bitlink": {"type": "string"}}}, "BitlinkEngagements": {"type": "object", "properties": {"unit_reference": {"type": "string"}, "unit": {"type": "number"}, "units": {"type": "string"}, "clicks_over_time": {"type": "array", "items": {"$ref": "#/components/schemas/ClicksOverTime"}}}}, "ClicksForAggregate": {"type": "object", "properties": {"date": {"type": "integer"}, "clicks": {"type": "integer"}}}, "ClicksOverTime": {"type": "object", "properties": {"date": {"type": "string"}, "engagements_by_facet": {"type": "array", "items": {"$ref": "#/components/schemas/ClicksByFacet"}}}}, "ClicksByFacet": {"type": "object", "properties": {"value": {"type": "string"}, "clicks": {"type": "number"}}}, "ClicksByCitiesFacet": {"type": "object", "properties": {"city": {"type": "string"}, "clicks": {"type": "number"}, "region": {"type": "string"}, "subregion": {"type": "string"}, "country": {"type": "string"}}}, "Campaign": {"type": "object", "allOf": [{"$ref": "#/components/schemas/HasReferences"}, {"properties": {"guid": {"type": "string"}, "group_guid": {"type": "string"}, "created_by": {"type": "string"}, "name": {"type": "string"}, "description": {"type": "string"}, "created": {"type": "string", "description": "ISO timestamp"}, "modified": {"type": "string", "description": "ISO timestamp"}}}]}, "Event": {"type": "object", "required": ["action", "login", "org_guid", "ui_action", "ui_action_date", "initiated_by", "referrer"], "properties": {"login": {"type": "string"}, "org_guid": {"type": "string"}, "group_guid": {"type": "string"}, "ui_action": {"type": "string"}, "ui_action_date": {"type": "string"}, "initiated_by": {"type": "string", "enum": ["app", "user"]}, "referrer": {"type": "string"}, "action": {"type": "string"}}}, "Campaigns": {"type": "object", "properties": {"campaigns": {"type": "array", "items": {"$ref": "#/components/schemas/Campaign"}}}}, "CampaignModify": {"type": "object", "properties": {"group_guid": {"type": "string"}, "name": {"type": "string"}, "description": {"type": "string"}, "channel_guids": {"type": "array", "items": {"type": "string"}}}, "example": {"group_guid": "Ba1bc23dE4F", "name": "My Campaign", "description": "my new campaign", "channel_guids": ["Ha1bc2DefGj", "Ha1bc2DefGk"]}}, "CampaignAddBitlink": {"type": "object", "properties": {"channel_guids": {"type": "array", "items": {"type": "string"}}, "url": {"type": "string"}, "add_utm_params": {"type": "boolean"}}}, "CampaignAddBitlinkResponse": {"type": "object", "properties": {"message": {"type": "string"}, "data": {"type": "object", "properties": {"successes": {"type": "integer"}, "shorten_failures": {"type": "integer"}, "other_link_failures": {"type": "integer"}, "create_bitlink_failures": {"type": "integer"}, "results": {"type": "array", "items": {"$ref": "#/components/schemas/AddBitlinkResult"}}}}}}, "AddBitlinkResult": {"type": "object", "properties": {"channel_guid": {"type": "string"}, "hash": {"type": "string"}, "long_url": {"type": "string"}, "url": {"type": "string"}, "keyword_link": {"type": "string"}, "title": {"type": "string"}, "new_channel_bitlink": {"type": "boolean"}, "bitlink_created_ts": {"type": "integer"}, "shorten_link_error": {"type": "string"}, "channel_bitlink_error": {"type": "string"}, "other_link_error": {"type": "string"}}}, "BaseChannelBitlink": {"type": "object", "properties": {"campaign_guid": {"type": "string"}, "bitlink_id": {"type": "string"}}}, "BaseChannel": {"type": "object", "properties": {"name": {"type": "string"}, "guid": {"type": "string"}, "created": {"type": "string", "description": "ISO TIMESTAMP"}, "modified": {"type": "string", "description": "ISO_TIMESTAMP"}, "group_guid": {"type": "string"}}}, "Channel": {"type": "object", "allOf": [{"$ref": "#/components/schemas/BaseChannel"}, {"$ref": "#/components/schemas/HasReferences"}]}, "ChannelModify": {"type": "object", "allOf": [{"$ref": "#/components/schemas/BaseChannel"}, {"properties": {"bitlinks": {"type": "array", "items": {"$ref": "#/components/schemas/BaseChannelBitlink"}}}}]}, "Channels": {"type": "object", "properties": {"channels": {"type": "array", "items": {"$ref": "#/components/schemas/Channel"}}}}, "HasReferences": {"type": "object", "properties": {"references": {"type": "object", "additionalProperties": {"type": "string"}}}}, "OAuthApps": {"type": "object", "properties": {"applications": {"type": "array", "items": {"$ref": "#/components/schemas/OAuthAppFull"}}}}, "OAuthApp": {"type": "object", "required": ["name", "client_id", "link", "description"], "properties": {"name": {"type": "string"}, "client_id": {"type": "string"}, "description": {"type": "string"}, "link": {"type": "string"}}}, "OAuthAppFull": {"type": "object", "required": ["name", "client_id", "client_secret", "redirect_uris", "link", "description"], "properties": {"name": {"type": "string"}, "client_id": {"type": "string"}, "client_secret": {"type": "string"}, "redirect_uris": {"type": "array", "items": {"type": "string"}}, "description": {"type": "string"}, "link": {"type": "string"}}}, "UpdateApp": {"type": "object", "properties": {"name": {"type": "string"}, "description": {"type": "string"}, "link": {"type": "string"}, "redirect_uris": {"type": "array", "items": {"type": "string"}}, "ip_allowlist": {"type": "array", "items": {"type": "string"}}}}, "OAuthAppWithOwnerLogin": {"type": "object", "properties": {"name": {"type": "string"}, "client_id": {"type": "string"}, "description": {"type": "string"}, "link": {"type": "string"}, "owner_login": {"type": "string"}}}, "Authorization": {"type": "object", "properties": {"id": {"type": "string"}, "client_id": {"type": "string"}, "created": {"type": "string", "description": "ISO timestamp"}, "app": {"$ref": "#/components/schemas/OAuthAppWithOwnerLogin"}}}, "Authorizations": {"type": "object", "properties": {"authorizations": {"type": "array", "items": {"$ref": "#/components/schemas/Authorization"}}}}, "BSDsResponse": {"type": "object", "properties": {"bsds": {"type": "array", "items": {"type": "string"}}}}, "BSDSearchResult": {"type": "object", "properties": {"domain": {"type": "string"}, "subdomain": {"type": "string"}, "zone": {"type": "string"}, "link": {"type": "string"}, "type": {"type": "string", "enum": ["affiliate", "reseller"]}}}, "BSDSearchResults": {"type": "object", "properties": {"results": {"type": "array", "items": {"$ref": "#/components/schemas/BSDSearchResult"}}}}, "DomainStatus": {"type": "object", "properties": {"domain": {"type": "string"}, "zone": {"type": "string"}, "status": {"type": "string", "enum": ["unavailable", "available", "complimentary"]}, "price": {"type": "string"}}}, "DomainPurchase": {"type": "object", "properties": {"domain": {"type": "string"}, "order_id": {"type": "integer"}, "vendor": {"type": "string"}, "org_guid": {"type": "string"}, "created": {"type": "string", "description": "ISO timestamp"}}}, "Tier": {"type": "object", "description": "a single tier", "required": ["name", "display_name", "description", "family", "price", "display_icon", "is_self_service", "is_paid", "billing_period_type", "sort_order", "consumable_features", "access_features", "add_on_settings"], "properties": {"name": {"type": "string"}, "display_name": {"type": "string"}, "description": {"type": "string"}, "family": {"type": "string", "enum": ["basic", "company", "core", "developer", "educator", "enterprise", "free", "growth", "premium", "pro", "qr_code_essentials", "spotlight", "starter", "teams"]}, "price": {"type": "integer"}, "display_icon": {"type": "string"}, "is_self_service": {"type": "boolean"}, "is_paid": {"type": "boolean"}, "billing_period_type": {"type": "string", "enum": ["annual", "month"]}, "sort_order": {"type": "integer"}, "consumable_features": {"type": "array", "items": {"$ref": "#/components/schemas/DefaultConsumableFeature"}}, "access_features": {"type": "array", "items": {"$ref": "#/components/schemas/DefaultAccessFeature"}}, "add_on_settings": {"type": "array", "items": {"$ref": "#/components/schemas/AddOnSetting"}}}}, "Tiers": {"type": "array", "items": {"$ref": "#/components/schemas/Tier"}}, "DefaultConsumableFeature": {"type": "object", "description": "the tier default values for a single consumable feature", "properties": {"name": {"type": "string"}, "limit": {"type": "integer"}}}, "DefaultAccessFeature": {"type": "object", "description": "the tier default values for a single access feature", "properties": {"name": {"type": "string"}, "has_access": {"type": "boolean"}}}, "AddOnSetting": {"type": "object", "description": "the add on settings associated with the tier", "properties": {"feature_name": {"type": "string"}, "limit": {"type": "integer"}, "product": {"type": "string"}, "incr": {"type": "integer"}, "price": {"type": "number"}}}, "AddOns": {"type": "object", "description": "a list of add-ons entitlements that an org wants to purchase", "properties": {"add_ons": {"type": "array", "items": {"$ref": "#/components/schemas/AddOn"}}}}, "AddOn": {"type": "object", "description": "an add on purchase request", "properties": {"feature_name": {"type": "string"}, "quantity": {"type": "number"}}}, "DomainValidateBody": {"type": "object", "description": "custom domain in validation queue", "required": ["organization_guid", "custom_domain"], "properties": {"organization_guid": {"type": "string"}, "custom_domain": {"type": "string"}, "group_guids": {"type": "array", "items": {"type": "string"}}, "prevalidate": {"type": "boolean"}}}, "DomainValidate": {"type": "object", "description": "custom domain in validation queue", "required": ["organization_guid", "custom_domain"], "properties": {"organization_guid": {"type": "string"}, "custom_domain": {"type": "string"}, "domain": {"type": "string"}, "subdomain": {"type": "string"}, "group_guids": {"type": "array", "items": {"type": "string"}}, "prevalidate": {"type": "boolean"}}}, "DomainUpdate": {"type": "object", "description": "update custom domain fields", "properties": {"root_redirect": {"type": "string"}, "wildcard_redirect": {"type": "string"}, "https_enabled": {"type": "boolean"}, "hsts_enabled": {"type": "boolean"}, "upgrade_insecure_requests": {"type": "boolean"}}}, "CustomDomainBody": {"type": "object", "description": "information about given custom domain", "properties": {"custom_domain": {"type": "string"}, "is_active": {"type": "boolean"}, "group_guids": {"type": "array", "items": {"type": "string"}}, "ssl_configuration_error": {"type": "string"}, "configuration_last_check_ts": {"type": "string"}, "root_redirect": {"type": "string"}, "https_bitlinks": {"type": "boolean"}, "ssl_autoconfigure_error": {"type": "boolean"}, "https_enabled": {"type": "boolean"}, "hsts_enabled": {"type": "boolean"}, "created": {"type": "integer"}, "wildcard_redirect": {"type": "string"}, "validation_status": {"type": "string", "enum": ["ok", "pending", "error"]}, "validation_error": {"type": "string"}, "deeplink_apps": {"type": "array", "items": {"$ref": "#/components/schemas/MinimalDeeplinkApp"}}, "upgrade_insecure_requests": {"type": "boolean"}, "ssl_cert": {"type": "object", "$ref": "#/components/schemas/PublicSSLCert"}}}, "CustomDomains": {"type": "object", "properties": {"custom_domains": {"type": "array", "items": {"$ref": "#/components/schemas/CustomDomainBody"}}, "upgrade_required": {"type": "boolean"}}}, "AppAssociationDetail": {"type": "object", "properties": {"app_guid": {"type": "string"}, "priority": {"type": "integer"}, "os": {"$ref": "#/components/schemas/MobileOS"}, "fallback": {"type": "boolean"}}}, "AppAssociations": {"type": "object", "properties": {"custom_domain": {"type": "string"}, "ios_apps": {"type": "array", "items": {"$ref": "#/components/schemas/AppAssociationDetail"}}, "android_apps": {"type": "array", "items": {"$ref": "#/components/schemas/AppAssociationDetail"}}, "ios_install_preference": {"$ref": "#/components/schemas/InstallPreference"}, "android_install_preference": {"$ref": "#/components/schemas/InstallPreference"}}}, "PublicSSLCert": {"type": "object", "description": "SSL Certification", "properties": {"valid_end": {"type": "string"}, "custom_cert": {"type": "boolean"}, "issuer": {"type": "string"}}}, "PublicValidate": {"type": "object", "description": "Info needed for domain validation", "properties": {"organization_guid": {"type": "string"}, "custom_domain": {"type": "string"}}}, "MinimalDeeplinkApp": {"type": "object", "description": "Deep Linking object", "properties": {"guid": {"type": "string"}, "os": {"$ref": "#/components/schemas/MobileOS"}}}, "DeeplinkApp": {"type": "object", "required": ["third_party_app_id", "name", "install_url", "os"], "properties": {"guid": {"type": "string"}, "organization_guid": {"type": "string"}, "third_party_app_id": {"type": "string"}, "scheme": {"type": "string"}, "name": {"type": "string"}, "icon_url": {"type": "string"}, "install_url": {"type": "string"}, "os": {"$ref": "#/components/schemas/MobileOS"}, "modified_ts": {"type": "string"}, "created_ts": {"type": "string"}, "legacy_app_id": {"type": "string"}, "apple_app_entitlement_id": {"type": "string"}, "android_sha256": {"type": "array", "items": {"type": "string"}}}}, "DeeplinkApps": {"type": "object", "properties": {"apps": {"type": "array", "items": {"$ref": "#/components/schemas/DeeplinkApp"}}}}, "DeeplinkMetric": {"type": "object", "properties": {"app_opens": {"type": "integer"}, "app_installs": {"type": "integer"}, "store_visits": {"type": "integer"}, "web_opens": {"type": "integer"}, "interstital_views": {"type": "integer"}}}, "DeeplinkMetricsRollup": {"type": "object", "properties": {"ios": {"$ref": "#/components/schemas/DeeplinkMetric"}, "android": {"$ref": "#/components/schemas/DeeplinkMetric"}, "other": {"$ref": "#/components/schemas/DeeplinkMetric"}, "unit": {"$ref": "#/components/schemas/TimeUnit"}, "units": {"$ref": "#/components/schemas/UnitAmount"}, "unit_reference": {"$ref": "#/components/schemas/UnitReferenceTimeStamp"}}}, "MobileOS": {"type": "string", "enum": ["ios", "android"]}, "GroupBitlinksCountRollup": {"type": "object", "properties": {"unit": {"type": "string"}, "units": {"type": "integer"}, "unit_reference": {"type": "string"}, "total_clicks": {"type": "integer"}}}, "FacetCountItem": {"type": "object", "properties": {"count": {"type": "integer"}, "value": {"type": "string"}}}, "FacetCountData": {"type": "object", "properties": {"ts": {"type": "integer"}, "total_count": {"type": "integer"}, "items": {"type": "array", "items": {"$ref": "#/components/schemas/FacetCountItem"}}}}, "GroupClicks": {"type": "object", "properties": {"unit": {"type": "string"}, "units": {"type": "integer"}, "unit_reference": {"type": "string"}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/CountItem"}}}}, "GroupClicksByFacet": {"type": "object", "properties": {"unit": {"type": "string"}, "units": {"type": "integer"}, "unit_reference": {"type": "string"}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/FacetCountData"}}}}, "GroupClicksByFacetRollup": {"type": "object", "properties": {"unit": {"type": "string"}, "units": {"type": "integer"}, "unit_reference": {"type": "string"}, "data": {"type": "array", "items": {"$ref": "#/components/schemas/FacetCountItem"}}}}, "AccessFeature": {"type": "object", "required": ["id", "name", "created", "modified", "has_access", "is_tier_default"], "properties": {"created": {"type": "string", "description": "ISO_TIMESTAMP"}, "modified": {"type": "string", "description": "ISO_TIMESTAMP"}, "id": {"type": "string"}, "name": {"type": "string"}, "has_access": {"type": "boolean"}, "is_tier_default": {"type": "boolean"}}}, "ConsumableFeature": {"type": "object", "properties": {"created": {"type": "string", "description": "ISO_TIMESTAMP"}, "modified": {"type": "string", "description": "ISO_TIMESTAMP"}, "id": {"type": "string"}, "name": {"type": "string"}, "limit": {"type": "integer"}, "is_tier_default": {"type": "boolean"}, "add_ons": {"type": "array", "items": {"$ref": "#/components/schemas/ConsumableFeatureAddOn"}}}}, "ConsumableFeatureAddOn": {"type": "object", "properties": {"created": {"type": "string", "description": "ISO_TIMESTAMP", "example": "2006-01-02T15:04:05-0700"}, "modified": {"type": "string", "description": "ISO_TIMESTAMP", "example": "2006-01-02T15:04:05-0700"}, "start_date": {"type": "string", "description": "ISO_TIMESTAMP", "example": "2006-01-02T15:04:05-0700"}, "end_date": {"type": "string", "description": "ISO_TIMESTAMP", "example": "2006-01-02T15:04:05-0700"}, "feature_name": {"type": "string"}, "quantity": {"type": "integer"}, "is_active": {"type": "boolean"}}}, "AddOnUsage": {"type": "object", "properties": {"amount_purchased": {"type": "integer", "example": 1}, "amount_available_for_purchase": {"type": "integer", "example": 49}, "amount_used": {"type": "integer", "example": 1}}}, "ConsumableFeatureFull": {"type": "object", "properties": {"created": {"type": "string", "description": "ISO_TIMESTAMP"}, "modified": {"type": "string", "description": "ISO_TIMESTAMP"}, "id": {"type": "string"}, "name": {"type": "string"}, "limit": {"type": "integer"}, "is_tier_default": {"type": "boolean"}, "is_enforced": {"type": "boolean"}, "is_limited": {"type": "boolean"}, "count": {"type": "integer"}, "add_on_usage": {"type": "object", "$ref": "#/components/schemas/AddOnUsage"}}}, "AccessFeatures": {"type": "object", "required": ["access_features"], "properties": {"access_features": {"type": "array", "items": {"$ref": "#/components/schemas/AccessFeature"}}}}, "ConsumableFeatures": {"type": "object", "properties": {"consumable_features": {"type": "array", "items": {"$ref": "#/components/schemas/ConsumableFeature"}}}}, "FeatureUsage": {"type": "object", "required": ["consumable_features", "access_features"], "properties": {"consumable_features": {"type": "array", "description": "an array of all of the organizations consumable features", "items": {"$ref": "#/components/schemas/ConsumableFeatureFull"}}, "access_features": {"type": "array", "description": "an array of all of the organizations access features", "items": {"$ref": "#/components/schemas/AccessFeature"}}}}, "CreateOAuthAppReq": {"type": "object", "required": ["name", "redirect_uris", "link"], "properties": {"redirect_uris": {"type": "array", "items": {"type": "string"}}, "ip_allowlist": {"type": "array", "items": {"type": "string"}}, "name": {"type": "string"}, "description": {"type": "string"}, "link": {"type": "string"}}}, "ActivityLogs": {"type": "object", "properties": {"next_page": {"type": "string"}, "activity": {"type": "array", "items": {"$ref": "#/components/schemas/ActivityLog"}}}}, "ActivityLog": {"type": "object", "properties": {"action_description": {"type": "string"}, "action_login": {"type": "string"}, "ts": {"description": "ISO timestamp", "type": "string"}, "user": {"type": "string"}, "action": {"type": "string"}, "org_guid": {"type": "string"}, "id": {"type": "string"}, "country_code": {"type": "string"}, "region": {"type": "string"}, "sub_region": {"type": "string"}, "city": {"type": "string"}, "isp": {"type": "string"}, "bitly_admin": {"type": "boolean", "description": "Indicates an action take by Bitly"}, "metadata": {"type": "object", "additionalProperties": {"type": "string"}}}}, "PurchaseBSD": {"type": "object", "properties": {"agreed_at": {"type": "string", "description": "ISO_TIMESTAMP"}, "agreement_keys": {"type": "array", "items": {"type": "string"}}, "domain": {"type": "string"}, "organization_guid": {"type": "string"}}}, "PurchaseBSDResponse": {"type": "object", "properties": {"domain": {"type": "string"}, "organization_guid": {"type": "string"}, "total": {"type": "string"}, "order_id": {"type": "integer"}}}, "DomainAgreements": {"type": "object", "properties": {"domain_agreements": {"type": "array", "items": {"$ref": "#/components/schemas/DomainAgreement"}}}}, "DomainDNS": {"type": "object", "properties": {"domain": {"type": "string", "description": "the requested domain"}, "dns_provider": {"type": "string", "enum": ["unknown", "godaddy", "cloudflare", "namecheap"], "description": "the detected DNS provider for the requested domain", "example": "unknown, namecheap, godaddy"}, "type": {"type": "string", "enum": ["A", "CNAME", "unknown"], "description": "the type of DNS record returned"}, "records": {"type": "array", "items": {"type": "string"}, "description": "the records returned by the lookup"}, "records_valid": {"type": "boolean", "description": "whether the returned records represent a valid configuration"}}, "example": {"dns_provider": "namecheap", "domain": "my.domain.com", "type": "CNAME", "records": ["cname.bitly.com"], "records_valid": true}}, "Feedback": {"type": "object", "properties": {"selection": {"type": "string"}, "optional_text": {"type": "string"}}}, "DeactivateUser": {"type": "object", "properties": {"feedback": {"allOf": [{"$ref": "#/components/schemas/Feedback"}]}, "confirm_text": {"type": "string"}}}, "DomainRegistrarInfo": {"type": "object", "properties": {"domain": {"description": "name of the requested domain", "type": "string"}, "status": {"description": "processing status of the domain", "type": "string"}, "renew_auto": {"description": "whether the domain is configured to automatically renew", "type": "boolean"}, "renew_deadline": {"description": "date the domain must renew by", "type": "string"}, "expires": {"description": "when the domain will expire", "type": "string"}, "expiration_protected": {"description": "whether the domain is protected from expiration", "type": "boolean"}}}, "DomainAgreement": {"type": "object", "properties": {"agreement_key": {"type": "string"}, "content": {"type": "string"}, "title": {"type": "string"}, "url": {"type": "string"}}}, "DomainRegister": {"type": "object", "properties": {"redirect_url": {"type": "string"}}}, "ShareableReport": {"type": "object", "properties": {"shareable_report": {"type": "string"}, "bitlink_id": {"type": "string"}}}, "ThirdPartyAppData": {"type": "object", "properties": {"third_party_app_id": {"type": "string"}, "os": {"$ref": "#/components/schemas/MobileOS"}, "install_url": {"type": "string"}, "icon_url": {"type": "string"}, "name": {"type": "string"}}}, "Webhook": {"type": "object", "allOf": [{"$ref": "#/components/schemas/HasReferences"}, {"properties": {"guid": {"type": "string"}, "created": {"type": "string"}, "modified": {"type": "string"}, "modified_by": {"type": "string"}, "alerted": {"type": "string"}, "deactivated": {"type": "string"}, "is_active": {"type": "boolean"}, "is_alert": {"type": "boolean"}, "organization_guid": {"type": "string"}, "group_guid": {"type": "string"}, "name": {"type": "string"}, "event": {"type": "string"}, "url": {"type": "string"}, "status": {"type": "string"}, "oauth_url": {"type": "string"}, "client_id": {"type": "string"}, "client_secret": {"type": "string"}, "fetch_tags": {"type": "boolean"}}}], "required": ["guid", "created", "modified", "modified_by", "alerted", "deactivated", "is_active", "is_alert", "organization_guid", "name", "event", "url"]}, "Webhooks": {"type": "object", "properties": {"webhooks": {"type": "array", "items": {"$ref": "#/components/schemas/Webhook"}}}}, "WebhookCreate": {"type": "object", "required": ["organization_guid", "name", "event", "url"], "properties": {"is_active": {"type": "boolean"}, "organization_guid": {"type": "string"}, "group_guid": {"type": "string"}, "name": {"type": "string"}, "event": {"type": "string"}, "url": {"type": "string"}, "oauth_url": {"type": "string"}, "client_id": {"type": "string"}, "client_secret": {"type": "string"}, "fetch_tags": {"type": "boolean"}}, "example": {"is_active": true, "organization_guid": "Oa1bcd234eF", "group_guid": "Ba1bc23dE4F", "name": "My Webhook", "event": "decodes", "url": "https://bitly.com/webhooks", "oauth_url": "https://fake.com/oauth", "client_id": "fakeclientid123", "client_secret": "itsasecreticanttellyou"}}, "WebhookUpdate": {"type": "object", "required": ["guid"], "properties": {"guid": {"type": "string"}, "is_active": {"type": "boolean"}, "organization_guid": {"type": "string"}, "group_guid": {"type": "string"}, "name": {"type": "string"}, "event": {"type": "string"}, "url": {"type": "string"}, "oauth_url": {"type": "string"}, "client_id": {"type": "string"}, "client_secret": {"type": "string"}, "fetch_tags": {"type": "boolean"}}, "example": {"guid": "Wa1bcDefG23", "is_active": true, "organization_guid": "Oa1bcd234eF", "group_guid": "Ba1bc23dE4F", "name": "My Webhook", "event": "decodes", "url": "https://bitly.com/webhooks", "oauth_url": "https://fake.com/oauth", "client_id": "fakeclientid123", "client_secret": "itsasecreticanttellyou"}}, "PlanLimits": {"type": "object", "allOf": [{"$ref": "#/components/schemas/HasReferences"}, {"properties": {"organization_guid": {"type": "string"}, "plan_limits": {"type": "array", "items": {"$ref": "#/components/schemas/PlanLimit"}}}}]}, "PlanLimit": {"type": "object", "properties": {"name": {"type": "string"}, "description": {"type": "string"}, "limit": {"type": "integer"}, "count": {"type": "integer"}}}, "PlatformLimits": {"type": "object", "properties": {"platform_limits": {"type": "array", "items": {"$ref": "#/components/schemas/PlatformLimit"}}}}, "PlatformLimit": {"type": "object", "properties": {"endpoint": {"type": "string"}, "methods": {"type": "array", "items": {"$ref": "#/components/schemas/MethodLimit"}}}}, "MethodLimit": {"type": "object", "properties": {"name": {"type": "string"}, "limit": {"type": "integer"}, "count": {"type": "integer"}}}, "InvitationsCreate": {"type": "object", "required": ["emails", "role_name"], "properties": {"emails": {"type": "array", "items": {"type": "string"}}, "role_name": {"type": "string"}, "groups": {"type": "array", "items": {"$ref": "#/components/schemas/InvitationGroup"}}, "created": {"type": "string"}}}, "InvitationsError": {"type": "object", "allOf": [{"properties": {"message": {"type": "string"}, "emails": {"type": "array", "items": {"type": "string"}}}}]}, "Invitation": {"type": "object", "required": ["email", "role_name"], "properties": {"email": {"type": "string"}, "role_name": {"type": "string"}, "groups": {"type": "array", "items": {"$ref": "#/components/schemas/InvitationGroup"}}, "created": {"type": "string"}}}, "InvitationGroup": {"type": "object", "allOf": [{"properties": {"group_guid": {"type": "string"}, "role_name": {"type": "string"}, "created": {"type": "string"}}}]}, "DataExportQuery": {"type": "object", "required": ["report_type", "emails"], "properties": {"report_type": {"type": "string", "enum": ["links_metrics", "gdpr_sar", "qr_codes", "org_users"]}, "emails": {"type": "array", "items": {"type": "string"}}, "created_before": {"type": "integer"}, "created_after": {"type": "integer"}, "modified_after": {"type": "integer"}, "query": {"type": "string"}, "keyword": {"type": "string"}, "archived": {"type": "string"}, "link_deeplinks": {"type": "string"}, "custom_bitlink": {"type": "string"}, "tags": {"type": "array", "items": {"type": "string"}}, "campaign_ids": {"type": "array", "items": {"type": "string"}}, "unit": {"type": "string"}, "units": {"type": "integer"}, "unit_reference": {"type": "integer"}, "include_max_history": {"type": "boolean", "description": "Includes the maximum available history for the user in the report. Default is false."}, "max_history_minimum_count": {"type": "integer", "description": "The minimum number of clicks a link must have in order to be included in the report during their max history. Default is 0 which means all links are included. For example, value of 100 means only links at least a 100 clicks during this time period (max history) will be included in the report."}, "metrics_columns": {"description": "Parameters for custom metrics column in the report. Each entry in the array will result in a new metrics column in the report.", "type": "array", "items": {"$ref": "#/components/schemas/MetricsColumn"}}}}, "LinksReportRequestBody": {"type": "object", "properties": {"include_max_history": {"type": "boolean"}, "include_max_time_period": {"type": "boolean"}, "bitlink_ids": {"type": "array", "items": {"type": "string"}}, "time_periods": {"type": "array", "items": {"$ref": "#/components/schemas/TimePeriod"}}, "metrics_columns": {"type": "array", "items": {"$ref": "#/components/schemas/MetricsColumn"}}}}, "TimePeriod": {"type": "object", "properties": {"from": {"type": "integer", "example": 1670411241, "description": "Unix of the start of the date time range for this column to be included in the report."}, "to": {"type": "integer", "example": 1701947241, "description": "Unix of the end of the date time range for this column to be included in the report."}, "csv_header_prefix": {"type": "string", "example": "Engagements Custom Date Range", "description": "Metrics column header on the csv follow the format \"%s (01/01/2020 - 01/01/2022).\" This field determines what goes on the first %s. For example, \"Engagements Custom Date Range\" will result in \"Engagements Custom Date Range (01/01/2020 - 01/01/2022)\"."}, "minimum_count": {"type": "integer", "minimum": 0, "description": "The minimum number of clicks a link must have in order to be included in the report. Default is 0. For example, minimum_count 100 means only links with at least a 100 clicks during this time period will be included in the report."}}}, "MetricsColumn": {"type": "object", "properties": {"unix_from": {"type": "integer", "example": 1670411241, "description": "Unix of the start of the date time range for this column to be included in the report."}, "unix_to": {"type": "integer", "example": 1701947241, "description": "Unix of the end of the date time range for this column to be included in the report."}, "csv_header_prefix": {"type": "string", "example": "Engagements Custom Date Range", "description": "Metrics column header on the csv follow the format \"%s (01/01/2020 - 01/01/2022).\" This field determines what goes on the first %s. For example, \"Engagements Custom Date Range\" will result in \"Engagements Custom Date Range (01/01/2020 - 01/01/2022)\"."}, "minimum_count": {"type": "integer", "minimum": 0, "description": "The minimum number of clicks a link must have in order to be included in the report. Default is 0. For example, minimum_count 100 means only links with at least a 100 clicks during this time period will be included in the report."}}}, "LinksReportRequestResponse": {"type": "object", "properties": {"brand_guid": {"type": "string"}, "rows": {"type": "array", "items": {"type": "object", "properties": {"bitlink": {"type": "string"}, "custom_bitlink": {"type": "string"}, "created": {"type": "integer"}, "title": {"type": "string"}, "long_url": {"type": "string"}, "status": {"type": "string"}, "metrics": {"type": "array", "items": {"type": "object", "properties": {"from": {"type": "integer"}, "to": {"type": "integer"}, "count": {"type": "integer"}, "csv_header_prefix": {"type": "string"}}}}}}}}}, "OrgUsersDataExportQuery": {"type": "object", "required": ["emails"], "properties": {"emails": {"type": "array", "items": {"type": "string"}}}}, "Invitations": {"type": "object", "properties": {"invitations": {"type": "array", "items": {"$ref": "#/components/schemas/Invitation"}}}}, "FormCapturePayload": {"type": "object", "properties": {"name": {"type": "string"}, "version": {"type": "string"}, "submit_text": {"type": "string"}, "skip_text": {"type": "string"}, "login": {"type": "string"}, "org_guid": {"type": "string"}, "group_guid": {"type": "string"}, "response_status": {"type": "string"}, "pages": {"type": "array", "items": {"$ref": "#/components/schemas/FormPage"}}}}, "FormPage": {"type": "object", "properties": {"fields": {"type": "array", "items": {"$ref": "#/components/schemas/FormField"}}}}, "FormField": {"type": "object", "properties": {"name": {"type": "string"}, "field_type": {"type": "string"}, "label": {"type": "string"}, "required": {"type": "boolean"}, "response": {"type": "string"}, "config": {"type": "object", "$ref": "#/components/schemas/FormConfig"}}}, "FormConfig": {"type": "object", "properties": {"options": {"type": "array", "items": {"$ref": "#/components/schemas/FormSelectOptions"}}}}, "FormSelectOptions": {"type": "object", "properties": {"key": {"type": "string"}, "display": {"type": "string"}}}, "InvitationsAccept": {"type": "object", "properties": {"tokens": {"type": "array", "items": {"type": "string"}}}}, "InvitationForLogin": {"type": "object", "required": ["invited_by_email", "invited_by", "token", "invited_org_guid", "invited_org_name"], "properties": {"invited_by_email": {"type": "string"}, "invited_by": {"type": "string"}, "token": {"type": "string"}, "invited_org_guid": {"type": "string"}, "invited_org_name": {"type": "string"}}}, "InvitationsForLogin": {"type": "object", "properties": {"invitations": {"type": "array", "items": {"$ref": "#/components/schemas/InvitationForLogin"}}}}, "CreateOverrideRules": {"type": "object", "required": ["rules"], "properties": {"rules": {"type": "string"}, "group_guid": {"type": "string"}}}, "UpdateOverrideRules": {"type": "object", "properties": {"rules": {"type": "string"}}}, "BitlinkOverrides": {"type": "object", "required": ["id", "rules", "version", "created", "modified", "link", "group_guid"], "allOf": [{"$ref": "#/components/schemas/HasReferences"}, {"properties": {"id": {"type": "string"}, "rules": {"type": "string"}, "version": {"type": "integer"}, "created": {"type": "string"}, "modified": {"type": "string"}, "link": {"type": "string", "description": "The fully qualified URL to the Override which is the Bitly link to use. Ex: https://foo.com/bar"}, "group_guid": {"type": "string"}}}]}, "BitlinkOverridesData": {"type": "object", "required": ["overrides", "total_count"], "properties": {"overrides": {"type": "array", "items": {"$ref": "#/components/schemas/BitlinkOverrides"}}, "total_count": {"type": "integer"}}}, "BitlinkHistory": {"type": "object", "allOf": [{"$ref": "#/components/schemas/HasReferences"}, {"properties": {"id": {"type": "string", "description": "The domain and backhalf of the parent override"}, "group_guid": {"type": "string"}, "target_bitlink_id": {"type": "string", "description": "The domain and backhalf of the underlying hash link"}, "hash": {"type": "string", "description": "The backhalf of the underlying hash link"}, "login": {"type": "string"}, "long_url": {"type": "string"}, "created_at": {"type": "string"}, "deactivated_at": {"type": "string"}, "is_active": {"type": "boolean"}, "is_deleted": {"type": "boolean"}, "version": {"type": "number"}}}]}, "BitlinkOverrideHistory": {"type": "object", "properties": {"bitlinks": {"type": "array", "nullable": true, "items": {"$ref": "#/components/schemas/BitlinkHistory"}}, "total_count": {"type": "integer"}}}, "ClicksForBitlinks": {"type": "object", "properties": {"clicks": {"type": "array", "items": {"$ref": "#/components/schemas/ClicksCount"}}}}, "ClicksCount": {"type": "object", "properties": {"bitlink_id": {"type": "string"}, "clicks": {"type": "integer"}, "error": {"type": "string"}}}, "BulkShortenUploads": {"type": "object", "required": ["uploads"], "properties": {"uploads": {"type": "array", "items": {"$ref": "#/components/schemas/BulkShortenUpload"}}}}, "BulkShortenUpload": {"type": "object", "required": ["group_guid", "org_guid", "report_url", "name", "uploaded_by", "status", "created"], "properties": {"org_guid": {"type": "string"}, "group_guid": {"type": "string"}, "report_url": {"type": "string"}, "name": {"type": "string"}, "uploaded_by": {"type": "string"}, "status": {"type": "string", "enum": ["in_progress", "success", "partial_success", "failure"]}, "created": {"type": "string"}}}, "BulkShortenValidate": {"type": "object", "required": ["filename"], "properties": {"group_guid": {"type": "string"}, "email": {"type": "string"}, "filename": {"type": "string"}, "custom_domain": {"type": "string"}}}, "BulkShortenUploadData": {"type": "object", "required": ["headers", "upload_url"], "properties": {"headers": {"type": "object"}, "upload_url": {"type": "string"}}}, "TwoFactorCode": {"type": "object", "required": ["code"], "properties": {"code": {"type": "string"}}}, "TwoFactor": {"type": "object", "required": ["country_code", "phone_number"], "properties": {"country_code": {"type": "string"}, "phone_number": {"type": "string"}, "status": {"type": "string"}}}, "TwoFactorVerify": {"type": "object", "required": ["is_valid", "is_expired"], "properties": {"is_valid": {"type": "boolean"}, "is_expired": {"type": "boolean"}}}, "CountryCodes": {"type": "array", "items": {"$ref": "#/components/schemas/CountryCode"}}, "CountryCode": {"type": "object", "properties": {"CountryName": {"type": "string"}, "CallingCode": {"type": "integer"}, "ISO2": {"type": "string"}, "ISO3": {"type": "string"}}}, "Launchpad": {"type": "object", "required": ["is_active"], "properties": {"launchpad_id": {"type": "string", "example": "M1234567890"}, "draft_id": {"type": "string", "example": "M1234567890"}, "is_edited": {"type": "boolean"}, "domain": {"type": "string", "example": "bit.ly"}, "keyword": {"type": "string", "example": "bitlySocial"}, "uri": {"type": "string", "example": "bit.ly/bio/bitlySocial"}, "is_active": {"type": "boolean"}, "launchpad_appearance": {"type": "object", "$ref": "#/components/schemas/LaunchpadAppearance"}, "images": {"type": "object", "$ref": "#/components/schemas/LaunchpadImages"}, "buttons": {"type": "array", "items": {"$ref": "#/components/schemas/LaunchpadButton"}}, "socials": {"type": "array", "items": {"$ref": "#/components/schemas/LaunchpadSocial"}}, "scheme": {"type": "string", "example": "https"}}}, "UpdateLaunchpad": {"type": "object", "required": ["is_active"], "properties": {"launchpad_id": {"type": "string", "example": "M1234567890"}, "domain": {"type": "string", "example": "bit.ly"}, "keyword": {"type": "string", "example": "bitlySocial"}, "uri": {"type": "string", "example": "bit.ly/bio/bitlySocial"}, "is_active": {"type": "boolean"}, "launchpad_appearance": {"type": "object", "$ref": "#/components/schemas/LaunchpadAppearance"}}}, "Launchpads": {"type": "object", "properties": {"launchpads": {"type": "array", "items": {"$ref": "#/components/schemas/Launchpad"}}}}, "LaunchpadAppearance": {"type": "object", "required": ["hide_bitly_logo"], "properties": {"layout_v2": {"type": "integer"}, "header_appearance": {"$ref": "#/components/schemas/BitlySiteHeaderAppearance"}, "launchpad_id": {"type": "string", "example": "M1234567890"}, "background": {"type": "string", "example": "#FFFFFF"}, "bottom_background": {"type": "string", "example": "#FFFFFF"}, "launchpad_text_color": {"type": "string", "example": "#000000"}, "description_color": {"type": "string", "example": "#000000"}, "avatar_image_url": {"type": "string", "example": "https://placeimg.com/300/300/people"}, "background_image_url": {"type": "string", "example": "https://placeimg.com/300/300/people"}, "avatar_upload_image": {"type": "string", "example": "https://placeimg.com/300/300/people"}, "background_upload_image": {"type": "string", "example": "https://placeimg.com/300/300/people"}, "font": {"type": "string", "example": "comic sans"}, "display_name": {"type": "string", "example": "Bitly"}, "description": {"type": "string", "example": "A URL shortener built with powerful tools to help you grow and protect your brand."}, "hide_bitly_logo": {"type": "boolean"}, "theme_id": {"type": "integer", "example": 123}, "layout": {"type": "string", "example": "classic"}, "button_appearance": {"type": "object", "$ref": "#/components/schemas/LaunchpadButtonAppearance"}, "style_preference": {"type": "string", "enum": ["custom", "theme", "image"]}, "background_image_alignment": {"type": "string", "enum": ["stretch", "fit", "repeat"]}, "social_icon_color": {"type": "string", "enum": ["color", "black", "white"]}, "social_icon_layout_position": {"type": "string", "enum": ["icon", "button"]}, "social_icon_position": {"type": "string", "enum": ["top", "bottom"]}}}, "LaunchpadButtonCommon": {"type": "object", "properties": {"launchpad_id": {"type": "string", "example": "M1234567890"}, "button_id": {"type": "string", "example": "L1234567890"}, "sort_order": {"type": "integer"}, "schedule_start": {"type": "string"}, "schedule_end": {"type": "string"}, "is_active": {"type": "boolean"}, "is_pinned": {"type": "boolean"}, "type": {"$ref": "#/components/schemas/LaunchpadButtonTypeEnum"}, "parent": {"type": "string"}, "is_sample": {"type": "boolean"}}}, "LaunchpadButton": {"allOf": [{"$ref": "#/components/schemas/LaunchpadButtonCommon"}, {"type": "object", "required": ["is_active"], "properties": {"bitlink": {"type": "string", "example": "https://bit.ly/GzmMT6"}, "long_url": {"type": "string", "example": "https://www.google.com", "x-faker": "internet.url"}, "scheme": {"type": "string", "example": "https"}, "domain": {"type": "string", "example": "bit.ly"}, "keyword": {"type": "string", "example": "L1234567890"}, "title": {"type": "string", "example": "Short links, big results"}, "description": {"type": "string", "example": "my description"}, "content": {"type": "object", "$ref": "#/components/schemas/LaunchpadButtonContent"}}}]}, "LaunchpadSocial": {"allOf": [{"$ref": "#/components/schemas/LaunchpadButtonCommon"}, {"type": "object"}], "required": ["is_active"], "properties": {"content": {"type": "object", "$ref": "#/components/schemas/LaunchpadContentSocial"}, "type": {"type": "string", "example": "social"}}}, "SiteBlockTypeEnum": {"description": "Available block types for Site blocks", "type": "string", "enum": ["bitlink", "youtubeVideo", "image", "carousel", "grid"]}, "SiteContainerTypeEnum": {"description": "Available container types", "type": "string", "enum": ["carousel", "grid"]}, "SiteBlockCommon": {"type": "object", "properties": {"site_id": {"type": "string", "example": "M1234567890"}, "block_id": {"type": "string", "example": "L1234567890"}, "sort_order": {"type": "integer"}, "schedule_start": {"type": "string"}, "schedule_end": {"type": "string"}, "is_active": {"type": "boolean"}, "is_pinned": {"type": "boolean"}, "is_sample": {"type": "boolean"}, "type": {"$ref": "#/components/schemas/SiteBlockTypeEnum"}}}, "SiteBlockContent": {"allOf": [{"$ref": "#/components/schemas/BlockContentYoutube"}, {"$ref": "#/components/schemas/BlockContentSocial"}], "type": "object", "properties": {"link_title": {"type": "string"}, "description": {"type": "string"}, "bitlink_id": {"type": "string"}, "image_guid": {"type": "string"}, "image_url": {"type": "string"}, "aspect_ratio": {"type": "string"}}}, "BlockContentYoutube": {"type": "object", "properties": {"thumbnail_url": {"type": "string"}}}, "BlockContentSocial": {"type": "object", "properties": {"channel": {"type": "string"}, "channel_url": {"type": "string"}}}, "TemplatesRequest": {"type": "object", "properties": {"site_id": {"type": "string", "example": "M1234567890"}}}, "Template": {"type": "object", "properties": {"template_guid": {"type": "string", "example": "T1234567890"}, "content": {"$ref": "#/components/schemas/BitlySiteContent"}, "appearance": {"$ref": "#/components/schemas/BitlySiteAppearance"}, "blocks": {"$ref": "#/components/schemas/SiteBlocks"}, "status": {"type": "string"}, "category": {"type": "string"}, "created": {"type": "string"}, "modified": {"type": "string"}, "is_active": {"type": "boolean"}, "is_paid": {"type": "boolean"}}}, "TemplatesResponse": {"type": "object", "properties": {"templates": {"type": "array", "items": {"$ref": "#/components/schemas/Template"}}}}, "ApplyTemplateRequest": {"type": "object", "properties": {"template_guid": {"type": "string", "example": "T1234567890"}}}, "SiteBlock": {"allOf": [{"$ref": "#/components/schemas/SiteBlockCommon"}, {"type": "object"}], "required": ["is_active"], "properties": {"container_id": {"type": "string", "example": "L1234567890"}, "content": {"$ref": "#/components/schemas/SiteBlockContent"}}}, "SiteBlocks": {"type": "array", "items": {"$ref": "#/components/schemas/SiteBlock"}}, "BlockOrders": {"type": "object", "properties": {"block_order": {"type": "array", "items": {"$ref": "#/components/schemas/BlockOrder"}}}}, "BlockOrder": {"type": "object", "properties": {"block_id": {"type": "string"}, "sort_order": {"type": "integer"}}}, "SiteBlockContainerRequest": {"type": "object", "properties": {"type": {"$ref": "#/components/schemas/SiteContainerTypeEnum"}, "content": {"type": "object"}}}, "LaunchpadImages": {"type": "object", "properties": {"profile": {"type": "object", "$ref": "#/components/schemas/LaunchpadImage"}, "background": {"type": "object", "$ref": "#/components/schemas/LaunchpadImage"}}}, "LaunchpadImage": {"type": "object", "properties": {"crop": {"type": "string", "example": "{\"Min\": {\"X\": 0, \"Y\": 0}, \"Max\": {\"X\": 1, \"Y\": 1}}"}, "url": {"type": "string", "example": "https://bit.ly/GzmMT6"}, "image_use": {"type": "string", "example": "background"}, "image_guid": {"type": "string"}}}, "ImageCommon": {"type": "object", "properties": {"image_guid": {"type": "string"}, "image_url": {"type": "string"}, "crop": {"type": "string", "example": "{\"Min\": {\"X\": 0, \"Y\": 0}, \"Max\": {\"X\": 1, \"Y\": 1}}"}}}, "ButtonThumbnailImage": {"$ref": "#/components/schemas/ImageCommon"}, "LaunchpadButtonRequest": {"type": "object", "properties": {"bitlink": {"type": "string", "example": "https://bit.ly/GzmMT6"}, "long_url": {"type": "string", "example": "https://www.google.com"}, "domain": {"type": "string", "example": "bit.ly"}, "title": {"type": "string", "example": "Short links, big results"}, "schedule_start": {"type": "string"}, "schedule_end": {"type": "string"}, "is_active": {"type": "boolean"}, "is_pinned": {"type": "boolean"}, "description": {"type": "string", "example": "my description"}, "parent": {"type": "string"}, "content": {"type": "object", "$ref": "#/components/schemas/ContentRequestBitlink"}, "button_thumbnail_image": {"type": "object", "$ref": "#/components/schemas/ButtonThumbnailImage"}}}, "LaunchpadSocialRequest": {"type": "object", "properties": {"schedule_start": {"type": "string"}, "schedule_end": {"type": "string"}, "is_active": {"type": "boolean"}, "content": {"type": "object", "$ref": "#/components/schemas/ContentRequestSocial"}}}, "ContentRequestBitlink": {"type": "object", "properties": {"bitlink": {"type": "string", "example": "https://bit.ly/GzmMT6"}, "title": {"type": "string", "example": "Short links, big results"}, "is_pinned": {"type": "boolean"}, "description": {"type": "string", "example": "my description"}}}, "ContentRequestSocial": {"type": "object", "properties": {"url": {"type": "string", "example": "https://www.facebook.com"}, "channel": {"type": "string", "example": "facebook"}}}, "LaunchpadContentBitlinkRequest": {"type": "object", "properties": {"content": {"type": "object", "properties": {"description": {"type": "string", "example": "my description"}, "bitlink": {"type": "string", "example": "https://bit.ly/GzmMT6"}, "title": {"type": "string", "example": "Short links, big results"}}, "example": "https://bit.ly/GzmMT6"}, "schedule_start": {"type": "string"}, "schedule_end": {"type": "string"}, "is_active": {"type": "boolean"}, "is_pinned": {"type": "boolean"}, "parent": {"type": "string"}}}, "LaunchpadButtonContent": {"type": "object", "anyOf": [{"$ref": "#/components/schemas/YoutubeVideoResponse"}, {"$ref": "#/components/schemas/LaunchpadContentSocial"}, {"$ref": "#/components/schemas/LaunchpadImageContentData"}]}, "LaunchpadContentSocialRequest": {"type": "object", "properties": {"content": {"type": "object", "$ref": "#/components/schemas/LaunchpadContentSocial"}, "schedule_start": {"type": "string"}, "schedule_end": {"type": "string"}, "is_active": {"type": "boolean"}}}, "LaunchpadContentYouTubeRequest": {"type": "object", "properties": {"content": {"type": "object", "$ref": "#/components/schemas/YoutubeVideoRequest"}, "schedule_start": {"type": "string"}, "schedule_end": {"type": "string"}, "is_active": {"type": "boolean"}, "is_pinned": {"type": "boolean"}, "parent": {"type": "string"}}}, "LaunchpadContentYouTubeResponse": {"allOf": [{"$ref": "#/components/schemas/LaunchpadButtonCommon"}, {"type": "object"}], "properties": {"launchpad_id": {"type": "string", "example": "M1234567890"}, "button_id": {"type": "string", "example": "L1234567890"}, "content": {"type": "object", "$ref": "#/components/schemas/YoutubeVideoResponse"}}}, "YoutubeVideoRequest": {"type": "object", "properties": {"video_url": {"type": "string", "example": "youtube.com/embed/"}, "thumbnail_url": {"type": "string", "example": "https://i.ytimg.com"}, "link_title": {"type": "string", "example": "myvideo"}}}, "YoutubeVideoResponse": {"type": "object", "properties": {"video_url": {"type": "string", "example": "youtube.com/embed/"}, "thumbnail_url": {"type": "string", "example": "https://i.ytimg.com"}, "link_title": {"type": "string", "example": "myvideo"}, "bitlink_id": {"type": "string", "example": "bit.ly/123"}}}, "LaunchpadContentSocial": {"type": "object", "properties": {"url": {"type": "string", "example": "facebook.com/profile"}, "channel": {"type": "string", "example": "facebook"}}}, "LaunchpadContentImageRequest": {"type": "object", "properties": {"content": {"type": "object", "$ref": "#/components/schemas/LaunchpadImageContentRequestData"}, "schedule_start": {"type": "string"}, "schedule_end": {"type": "string"}, "is_active": {"type": "boolean"}, "is_pinned": {"type": "boolean"}, "parent": {"type": "string"}}}, "LaunchpadContainerRequest": {"type": "object", "properties": {"content": {"type": "object"}, "is_active": {"type": "boolean"}, "is_pinned": {"type": "boolean"}}}, "LaunchpadContainerResponse": {"allOf": [{"$ref": "#/components/schemas/LaunchpadButtonCommon"}, {"type": "object", "properties": {"content": {"type": "object"}}}]}, "LaunchpadContentImage": {"allOf": [{"$ref": "#/components/schemas/LaunchpadButtonCommon"}, {"type": "object", "properties": {"content": {"type": "object", "$ref": "#/components/schemas/LaunchpadImageContentData"}}}]}, "LaunchpadImageContentRequestData": {"allOf": [{"$ref": "#/components/schemas/LaunchpadImageContentData"}, {"$ref": "#/components/schemas/LaunchpadContentImageShortenURLData"}]}, "LaunchpadImageContentData": {"allOf": [{"$ref": "#/components/schemas/ImageCommon"}, {"type": "object", "properties": {"aspect_ratio": {"type": "string", "example": "1:1"}, "link_title": {"type": "string", "example": "my image"}, "description": {"type": "string", "example": "more about my image"}, "bitlink_id": {"type": "string", "example": "bit.ly/123"}}}]}, "LaunchpadContentImageShortenURLData": {"type": "object", "properties": {"long_url": {"type": "string", "example": "https://example.com"}, "domain": {"type": "string", "example": "bit.ly"}}}, "LaunchpadButtonAppearance": {"type": "object", "properties": {"button_background": {"type": "string", "example": "#FFFFFF"}, "button_text_color": {"type": "string", "example": "#000000"}, "shape": {"type": "integer"}, "shadow": {"type": "integer"}}}, "UpdateButtonSortOrder": {"type": "object", "properties": {"buttons": {"type": "array", "items": {"$ref": "#/components/schemas/LaunchpadButtonSortOrder"}}}}, "LaunchpadButtonSortOrder": {"type": "object", "required": ["button_id", "sort_order"], "properties": {"button_id": {"type": "string", "example": "L1234567890"}, "sort_order": {"type": "integer"}}}, "CreateLaunchpad": {"type": "object", "required": ["group_guid", "domain", "keyword"], "properties": {"group_guid": {"type": "string", "example": "B1234567890"}, "domain": {"type": "string", "example": "bit.ly"}, "keyword": {"type": "string", "example": "bitlySocial"}, "uri": {"type": "string", "example": "bit.ly/bio/bitlySocial"}}}, "SiteCloneRequest": {"type": "object", "properties": {"uri": {"type": "string", "example": "bit.ly/bio/bitlySocial"}}}, "LaunchpadPresetThemes": {"type": "array", "items": {"$ref": "#/components/schemas/LaunchpadPresetTheme"}}, "LaunchpadPresetTheme": {"type": "object", "properties": {"theme_id": {"type": "integer", "example": 123}, "display_name": {"type": "string", "example": "Sky"}, "background": {"type": "string", "example": "#FFFFFF"}, "launchpad_text_color": {"type": "string", "example": "#000000"}, "description_color": {"type": "string", "example": "#000000"}, "avatar_background": {"type": "string", "example": "#FFFFFF"}, "button_text_color": {"type": "string", "example": "#FFFFFF"}, "button_background": {"type": "string", "example": "#000000"}, "is_active": {"type": "boolean"}, "layout": {"type": "string"}}}, "LaunchpadQRCode": {"type": "object", "properties": {"link": {"type": "string"}, "launchpad_id": {"type": "string"}, "qr_code": {"type": "string"}, "qr_code_id": {"type": "string"}}}, "BitlySiteContent": {"type": "object", "properties": {"display_name": {"type": "string"}, "description": {"type": "string"}}}, "BitlySiteHeaderAppearance": {"type": "object", "properties": {"banner_type": {"type": "string", "enum": ["none", "hero", "rounded_up", "gradient", "square", "frame"]}, "profile_image_size": {"type": "string", "enum": ["xs", "sm", "med", "lg", "xl"]}, "profile_image_shape": {"type": "string", "enum": ["round", "rounded_square", "square"]}, "profile_image_border_size": {"type": "string", "enum": ["none", "xs", "sm", "med", "lg", "xl"]}, "profile_image_type": {"type": "string", "enum": ["single", "repeating"]}, "profile_image_location": {"type": "string", "enum": ["center", "top_left", "top_right", "bottom_left", "bottom_right"]}, "title_size": {"type": "string", "enum": ["xs", "sm", "med", "lg", "xl"]}, "title_alignment": {"type": "string", "enum": ["left", "center"]}, "title_weight": {"type": "string", "enum": ["regular", "bold", "semi_bold"]}, "title_border_type": {"type": "string", "enum": ["none", "below", "above_and_below"]}, "title_location": {"type": "string", "enum": ["center", "center_bottom", "center_top", "top_left", "top_right", "bottom_left", "bottom_right"]}, "description_size": {"type": "string", "enum": ["xs", "sm", "med", "lg", "xl"]}, "description_alignment": {"type": "string", "enum": ["left", "center"]}, "description_weight": {"type": "string", "enum": ["regular", "bold", "semi_bold"]}, "description_border_type": {"type": "string", "enum": ["none", "below", "above_and_below"]}, "description_location": {"type": "string", "enum": ["center", "top_left", "top_right", "bottom_left", "bottom_right"]}, "header_background_color": {"type": "string"}}}, "BitlySiteAppearance": {"type": "object", "properties": {"layout_v2": {"type": "integer"}, "header_appearance": {"$ref": "#/components/schemas/BitlySiteHeaderAppearance"}, "theme_id": {"type": "integer"}, "hide_bitly_logo": {"type": "boolean"}, "layout": {"type": "string"}, "font": {"type": "string"}, "style_preference": {"type": "string"}, "background_color": {"type": "string"}, "bottom_background_color": {"type": "string"}, "text_color": {"type": "string"}, "description_color": {"type": "string"}, "background_preference": {"type": "string"}, "background_image_alignment": {"type": "string"}, "background_image_url": {"type": "string"}, "background_image_guid": {"type": "string"}, "avatar_image_url": {"type": "string"}, "avatar_image_guid": {"type": "string"}, "default_button_background_color": {"type": "string"}, "default_button_text_color": {"type": "string"}, "default_button_shape": {"type": "string"}, "default_button_shadow": {"type": "string"}, "default_social_icon_color": {"type": "string"}, "default_social_icon_layout": {"type": "string"}, "default_social_icon_position": {"type": "string"}}}, "BitlySite": {"type": "object", "allOf": [{"properties": {"site_guid": {"type": "string"}, "group_guid": {"type": "string"}, "status": {"type": "string"}, "is_edited": {"type": "boolean"}, "uri": {"type": "string"}, "content": {"$ref": "#/components/schemas/BitlySiteContent"}, "appearance": {"$ref": "#/components/schemas/BitlySiteAppearance"}, "button_count": {"type": "integer"}, "last_published": {"type": "string"}, "created": {"type": "string"}, "modified": {"type": "string"}}}]}, "BitlySites": {"type": "object", "properties": {"group_guid": {"type": "string"}, "sites": {"type": "array", "items": {"$ref": "#/components/schemas/BitlySite"}}}}, "BitlySiteLayoutsResponse": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "integer", "example": 1}, "header_appearance": {"type": "object", "$ref": "#/components/schemas/BitlySiteHeaderAppearance"}, "is_paid": {"type": "boolean"}, "is_active": {"type": "boolean"}}}}, "PrevalidateYouTubeVideoRequest": {"type": "object", "properties": {"video_id": {"type": "string"}}}, "KeepSitesRequest": {"type": "object", "properties": {"keep_sites": {"type": "array", "items": {"type": "string"}}}}, "LaunchpadImageUpload": {"type": "object", "properties": {"image": {"type": "string", "format": "binary"}, "position": {"type": "string", "enum": ["profile", "background", "other"]}, "crop": {"type": "string", "example": "{\"Min\": {\"X\": 0, \"Y\": 0}, \"Max\": {\"X\": 1, \"Y\": 1}}"}}}, "ImageCropPoint": {"type": "object", "properties": {"x": {"type": "integer"}, "y": {"type": "integer"}}}, "ImageCrop": {"type": "object", "properties": {"min": {"type": "object", "$ref": "#/components/schemas/ImageCropPoint"}, "max": {"type": "object", "$ref": "#/components/schemas/ImageCropPoint"}}}, "ImageUpdate": {"type": "object", "properties": {"group_guid": {"type": "string"}, "crop": {"$ref": "#/components/schemas/ImageCrop"}}}, "LaunchpadImageUpdate": {"type": "object", "properties": {"image_url": {"type": "string"}, "image_guid": {"type": "string"}}}, "PublicImageURL": {"type": "object", "properties": {"public_image_url": {"type": "string"}}}, "AddToCohort": {"type": "object", "properties": {"entity_type": {"type": "string", "example": "orgGUID"}, "identifier": {"type": "string", "example": "Od9qdz189sR"}, "cohort": {"type": "integer", "example": 1}}}, "Cohort": {"type": "object", "properties": {"cohort_number": {"type": "integer"}, "cohort_description": {"type": "string"}}}, "EvaluateRequest": {"type": "object", "properties": {"login": {"type": "string", "example": "testLogin"}, "org_guid": {"type": "string", "example": "O123abcd"}, "cookie": {"type": "string", "example": "cookie123"}}}, "EvaluateInterventionRequest": {"type": "object", "properties": {"org_guid": {"type": "string", "example": "O123abcd"}}}, "EvaluateResponse": {"type": "object", "properties": {"cohort": {"type": "integer", "example": 0}}}, "EvaluateInterventionResponse": {"type": "object", "properties": {"tier": {"type": "string", "example": "basic"}, "intervention": {"type": "string", "example": "downgrade"}, "monthly_promo": {"type": "object", "properties": {"promo_code": {"type": "string"}, "is_valid": {"type": "boolean"}, "discount_type": {"type": "string", "enum": ["fixedAmount", "percent"]}, "discount_amount": {"type": "number"}, "num_periods_to_apply_discount": {"type": "integer"}, "num_periods_to_apply_discount_type": {"type": "string", "enum": ["month", "annual"]}, "valid_plans": {"type": "array", "items": {"type": "string"}}}}, "annual_promo": {"type": "object", "properties": {"promo_code": {"type": "string"}, "is_valid": {"type": "boolean"}, "discount_type": {"type": "string", "enum": ["fixedAmount", "percent"]}, "discount_amount": {"type": "number"}, "num_periods_to_apply_discount": {"type": "integer"}, "num_periods_to_apply_discount_type": {"type": "string", "enum": ["month", "annual"]}, "valid_plans": {"type": "array", "items": {"type": "string"}}}}}}, "PromoCode": {"type": "object", "properties": {"promo_code": {"type": "string"}, "is_valid": {"type": "boolean"}, "discount_type": {"type": "string", "enum": ["fixedAmount", "percent"]}, "discount_amount": {"type": "number"}, "num_periods_to_apply_discount": {"type": "integer"}, "num_periods_to_apply_discount_type": {"type": "string", "enum": ["month", "annual"]}, "valid_plans": {"type": "array", "items": {"type": "string"}}}}, "PromoCodeValidPlans": {"type": "object", "properties": {"valid_plans": {"type": "array", "items": {"type": "string"}}}}, "ApplyDiscount": {"type": "object", "properties": {"promo_code": {"type": "string"}}}, "ImageUpload": {"type": "object", "properties": {"image": {"type": "string", "format": "binary"}, "group_guid": {"type": "string"}, "use": {"type": "string", "enum": [null, "default_qr_code_image", "link_in_bio"]}, "crop": {"type": "string", "example": "{\"Min\": {\"X\": 0, \"Y\": 0}, \"Max\": {\"X\": 1, \"Y\": 1}}"}}}, "ImageUploadResponse": {"type": "object", "properties": {"image_url": {"type": "string"}, "image_guid": {"type": "string"}}}, "UserRole": {"type": "object", "required": ["login"], "properties": {"organization_guid": {"type": "string"}, "group_guid": {"type": "string"}, "login": {"type": "string"}, "role_name": {"type": "string"}}}, "BulkAddResponse": {"type": "object", "properties": {"message": {"type": "string"}, "data": {"type": "object", "properties": {"successes": {"type": "integer"}, "csv_format_failures": {"type": "integer"}, "link_save_failures": {"type": "integer"}, "keyword_failures": {"type": "integer"}, "channel_bitlink_failures": {"type": "integer"}, "results": {"type": "array", "items": {"type": "string"}}}}}}, "Intervention": {"type": "object", "properties": {"guid": {"type": "string"}, "login": {"type": "string"}, "org_guid": {"type": "string"}, "intervention_action": {"type": "string", "example": "downgrade"}, "intervention_date": {"type": "string", "example": "2021-01-01T00:00:00Z"}, "interventions_offered": {"type": "array", "items": {"$ref": "#/components/schemas/InterventionsOffered"}}}}, "InterventionsOffered": {"type": "object", "properties": {"intervention_type": {"type": "string", "example": "promocode"}, "intervention_value": {"type": "string", "example": "TRYBASICMONTHLY12"}, "intervention_response": {"type": "string", "example": "Accepted"}}}, "BulkUpdateRequest": {"type": "object", "required": ["action"], "properties": {"action": {"type": "string", "enum": ["archive", "edit_tags"], "description": "archive or edit_tags"}, "archive": {"type": "boolean"}, "add_tags": {"type": "array", "items": {"type": "string"}}, "remove_tags": {"type": "array", "items": {"type": "string"}}, "links": {"type": "array", "items": {"type": "string"}, "description": "this is limited to 100 bitlink ids"}}, "example": {"action": "edit_tags", "add_tags": ["tag1", "tag2"], "links": ["bit.ly/1234abcd", "bit.ly/5678efgh"]}}, "BulkUpdate": {"type": "object", "properties": {"links": {"type": "array", "items": {"type": "string"}}}}, "GenericAccessTokenReq": {"type": "object", "required": ["password"], "properties": {"password": {"type": "string"}}}, "GenericAccessToken": {"type": "object", "required": ["access_token", "is_new_token"], "properties": {"access_token": {"type": "string"}, "is_new_token": {"type": "boolean"}}}, "OrganizationGUID": {"type": "object", "properties": {"organization_guid": {"type": "string"}}}, "TitleResponse": {"type": "object", "properties": {"url": {"type": "string"}, "title": {"type": "string"}}}, "QRCode": {"description": "A full QR code with data and customization values", "type": "object", "properties": {"qrcode_id": {"description": "The QR code's id, as a guid", "type": "string"}, "title": {"description": "The QR code's title", "type": "string"}, "render_customizations": {"$ref": "#/components/schemas/QRCodeCustomizations"}, "scannability": {"description": "A decimal number between 0 and 1 representing how likely the QR code is to scan properly, 0 being unscannable and 1 being very scannable", "type": "number"}, "is_hidden": {"description": "A boolean representing if the QR code is being hidden from the user", "type": "boolean"}, "is_customized": {"description": "A boolean representing if any of the QR code's customization values have been changed from their default setting", "type": "boolean"}, "serialized_content": {"description": "The serialized string of the QR code's content", "type": "string"}, "qr_code_type": {"$ref": "#/components/schemas/QRCodeTypeEnum"}, "customization_hash": {"description": "A hash calculated from all the QR code's customization fields", "type": "string"}, "full_hash": {"description": "A hash calculated from all the QR code's customization and content fields", "type": "string"}, "created": {"type": "string", "description": "ISO_TIMESTAMP"}, "modified": {"type": "string", "description": "ISO_TIMESTAMP"}, "created_ts": {"description": "The unix epoch time when the QR code was created. This field will be deprecated soon. Use created instead.", "type": "integer"}, "modified_ts": {"description": "The unix epoch time when the QR code was updated. Use modified instead of this field. Deprecation soon.", "type": "integer"}, "svg": {"description": "The QR code's svg image data as a data uri", "type": "string", "example": "data:image/svg+xml;base64,YWN2ZyB4b3xucz8iaHR0cDi..."}, "png": {"description": "The QR code's png image data as a data uri", "type": "string", "example": "data:image/png;base64,YWN2ZyB4b3xucz8iaHR0cDi..."}, "jpg": {"description": "The QR code's jpg image data as a data uri", "type": "string", "example": "data:image/jpeg;base64,YWN2ZyB4b3xucz8iaHR0cDi..."}, "thumbnail": {"description": "The QR code's thumbnail image data as a data uri. Can be svg, png, jpg", "type": "string", "example": "data:image/svg+xml;base64,YWN2ZyB4b3xucz8iaHR0cDi..."}, "dynamic_content": {"$ref": "#/components/schemas/QRCodeDynamic"}, "static_content": {"$ref": "#/components/schemas/QRCodeStatic"}, "spec_settings": {"$ref": "#/components/schemas/QRCodeSpecSettings"}, "gs1": {"$ref": "#/components/schemas/GS1Metadata"}}}, "QRCodeDetails": {"type": "object", "properties": {"qrcode_id": {"type": "string"}, "group_guid": {"type": "string"}, "title": {"type": "string"}, "gs1": {"$ref": "#/components/schemas/GS1Metadata"}, "render_customizations": {"$ref": "#/components/schemas/QRCodeCustomizationsPublic"}, "archived": {"type": "boolean"}, "created": {"type": "string"}, "modified": {"type": "string"}}}, "QRCodeDestination": {"type": "object", "properties": {"bitlink_id": {"type": "string"}, "long_url": {"type": "string"}, "site_id": {"type": "string"}}}, "QRCodeMinimal": {"type": "object", "properties": {"qrcode_id": {"type": "string"}, "group_guid": {"type": "string"}, "title": {"type": "string"}, "archived": {"type": "boolean"}, "created": {"type": "string"}, "modified": {"type": "string"}}}, "GS1Metadata": {"description": "Contains GS1 related metadata", "type": "object", "properties": {"values": {"description": "A list of GS1 application identifiers and their values", "type": "array", "items": {"$ref": "#/components/schemas/GS1Value"}}}}, "GS1Value": {"type": "object", "properties": {"key": {"type": "string", "description": "A valid GS1 application identifier, qualifier, attribute, etc."}, "value": {"type": "string", "description": "A syntactically correct value associated with the application identifier in the key field."}}}, "QRCodeTemplate": {"description": "A template for a set of QR code customizations", "type": "object", "properties": {"id": {"description": "The QR code template's id, as a shortid", "type": "string"}, "brand_guid": {"description": "The Bitly brand_guid preference for use in the Bitly Canva app", "type": "string"}, "render_customizations": {"$ref": "#/components/schemas/QRCodeCustomizations"}, "customization_hash": {"description": "A hash calculated from all the QR code's customization fields", "type": "string"}, "premade": {"description": "A boolean representing whether this is a default template premade by bitly", "type": "boolean"}, "is_active": {"description": "A boolean representing if this template is currently active", "type": "boolean"}, "created_ts": {"description": "The unix epoch time when the QR code template was created", "type": "integer"}, "modified_ts": {"description": "The unix epoch time when the QR code template was updated", "type": "integer"}, "svg": {"description": "The QR code template's thumbnail svg image data as a data uri", "type": "string", "example": "data:image/svg+xml;base64,YWN2ZyB4b3xucz8iaHR0cDi..."}}}, "CreateQRCodeFromUrlRequest": {"description": "Request to create a QR code from a Url", "required": ["group_guid"], "type": "object", "properties": {"group_guid": {"type": "string"}, "long_url": {"description": "The destination URL the QR should point to. Always use long_url or bitlink, not both.", "type": "string"}, "bitlink": {"description": "The bitlink the QR should point to. Always use long_url or bitlink, not both.", "type": "string"}, "response_format": {"description": "The file format to be returned after creation. Call GET /v4/qrcodes/{qrcode id} to get the QR code in a different format after creation.", "type": "string", "enum": ["png", "svg"], "default": "png"}, "render_customizations": {"$ref": "#/components/schemas/QRCodeCustomizations"}}, "example": {"long_url": "https://dev.bitly.com", "group_guid": "Ba1bc23dE4F", "response_format": "svg"}}, "CreateQRCodeRequest": {"description": "Customization and content values for a QR code", "required": ["qr_code_type"], "type": "object", "properties": {"title": {"type": "string"}, "group_guid": {"type": "string"}, "render_customizations": {"$ref": "#/components/schemas/QRCodeCustomizations"}, "is_customized": {"description": "A boolean representing if any of the QR code's customization values have been changed from their default setting", "type": "boolean"}, "qr_code_type": {"$ref": "#/components/schemas/QRCodeTypeEnum"}, "dynamic_content": {"$ref": "#/components/schemas/QRCodeDynamic"}, "static_content": {"$ref": "#/components/schemas/QRCodeStatic"}, "format": {"$ref": "#/components/schemas/ImageFormat"}, "gs1": {"$ref": "#/components/schemas/GS1Metadata"}}}, "UpdateQRCodeRequest": {"description": "Customization and content values for a QR code", "type": "object", "properties": {"title": {"type": "string"}, "render_customizations": {"$ref": "#/components/schemas/QRCodeCustomizations"}, "is_hidden": {"description": "A boolean representing if the QR code is being hidden from the user", "type": "boolean"}, "static_content": {"$ref": "#/components/schemas/QRCodeStatic"}}}, "QRCodeCustomizationsPublic": {"description": "Options for customizing a QR Code's appearance", "type": "object", "properties": {"background_color": {"description": "The QR code's background color in hex code format with values for alpha channel", "type": "string", "example": "#ff07d280"}, "dot_pattern_color": {"description": "The QR code's dot pattern color in hex code format", "type": "string", "example": "#ff07d2"}, "dot_pattern_type": {"$ref": "#/components/schemas/QRCodeDotPatternType"}, "corners": {"$ref": "#/components/schemas/QRCodeCorners"}, "gradient": {"$ref": "#/components/schemas/QRCodeGradient"}, "background_gradient": {"$ref": "#/components/schemas/QRCodeGradient"}, "logo": {"$ref": "#/components/schemas/QRCodeLogoPublic"}, "frame": {"$ref": "#/components/schemas/QRCodeFrameRequest"}, "branding": {"$ref": "#/components/schemas/QRCodeBranding"}, "spec_settings": {"$ref": "#/components/schemas/QRCodeSpecSettingsPublic"}}}, "QRCodeCustomizations": {"description": "Options for customizing a QR Code's appearance", "type": "object", "properties": {"background_color": {"description": "The QR code's background color in hex code format with values for alpha channel", "type": "string", "example": "#ff07d280"}, "dot_pattern_color": {"description": "The QR code's dot pattern color in hex code format", "type": "string", "example": "#ff07d2"}, "dot_pattern_type": {"$ref": "#/components/schemas/QRCodeDotPatternType"}, "corners": {"$ref": "#/components/schemas/QRCodeCorners"}, "gradient": {"$ref": "#/components/schemas/QRCodeGradient"}, "background_gradient": {"$ref": "#/components/schemas/QRCodeGradient"}, "logo": {"$ref": "#/components/schemas/QRCodeLogo"}, "frame": {"$ref": "#/components/schemas/QRCodeFrameRequest"}, "text": {"$ref": "#/components/schemas/QRCodeText"}, "shape": {"$ref": "#/components/schemas/QRCodeShape"}, "branding": {"$ref": "#/components/schemas/QRCodeBranding"}, "spec_settings": {"$ref": "#/components/schemas/QRCodeSpecSettings"}}}, "PublicCreateQRCodeRequest": {"description": "Customization and content values for a QR code created through the public API", "type": "object", "properties": {"title": {"type": "string", "description": "The title of the QR Code"}, "group_guid": {"type": "string", "description": "Identify which group to place the QR Code."}, "render_customizations": {"$ref": "#/components/schemas/QRCodeCustomizationsPublic"}, "archived": {"description": "A boolean representing if the QR code should be archived (hidden from the UI) upon creation", "type": "boolean"}, "destination": {"$ref": "#/components/schemas/QRCodeDestination"}, "gs1": {"$ref": "#/components/schemas/GS1Metadata"}}, "example": {"title": "A Test QR Code", "group_guid": "Ba1bc23dE4F", "destination": {"bitlink_id": "bit.ly/abc123", "site_id": "Mabc123"}, "archived": false, "render_customizations": {"background_color": "#ffffff", "dot_pattern_color": "#EF8000", "dot_pattern_type": "rounded", "corners": {"corner_1": {"inner_color": "#EF8000", "outer_color": "#EF8000", "shape": "leaf"}, "corner_2": {"inner_color": "#EF8000", "outer_color": "#EF8000", "shape": "leaf"}, "corner_3": {"inner_color": "#EF8000", "outer_color": "#EF8000", "shape": "leaf"}}, "gradient": {"style": "linear", "angle": 45, "colors": [{"color": "#c80404", "offset": 10}, {"color": "#042f86", "offset": 90}], "exclude_corners": false}, "background_gradient": {"style": "radial", "colors": [{"color": "#c696ee", "offset": 25}, {"color": "#d4e1a8", "offset": 50}]}, "logo": {"image_guid": "bitlylogo"}, "frame": {"id": "text_bottom", "colors": {"primary": "#f55656", "background": "#ffffff"}, "text": {"primary": {"content": "QR Frame"}, "secondary": {"content": "Frame Text"}}}, "branding": {"bitly_brand": true}, "spec_settings": {"error_correction": 4}}}}, "PublicUpdateQRCodeRequest": {"description": "Customization and content values for a QR code created through the public API", "type": "object", "properties": {"title": {"type": "string"}, "render_customizations": {"$ref": "#/components/schemas/QRCodeCustomizationsPublic"}, "archived": {"description": "A boolean representing if the QR code has been archived", "type": "boolean"}, "gs1": {"$ref": "#/components/schemas/GS1Metadata"}}, "example": {"title": "Updated Title", "archived": true, "render_customizations": {"background_color": "#ffffff", "dot_pattern_color": "#EF8000", "dot_pattern_type": "rounded", "corners": {"corner_1": {"inner_color": "#EF8000", "outer_color": "#EF8000", "shape": "leaf"}, "corner_2": {"inner_color": "#EF8000", "outer_color": "#EF8000", "shape": "leaf"}, "corner_3": {"inner_color": "#EF8000", "outer_color": "#EF8000", "shape": "leaf"}}, "gradient": {"style": "linear", "angle": 45, "colors": [{"color": "#c80404", "offset": 10}, {"color": "#042f86", "offset": 90}], "exclude_corners": false}, "background_gradient": {"style": "radial", "colors": [{"color": "#c696ee", "offset": 25}, {"color": "#d4e1a8", "offset": 50}]}, "logo": {"image_guid": "bitlylogo"}, "frame": {"id": "text_bottom", "colors": {"primary": "#f55656", "background": "#ffffff"}, "text": {"primary": {"content": "QR Frame"}, "secondary": {"content": "Frame Text"}}}, "branding": {"bitly_brand": true}, "spec_settings": {"error_correction": 4}}}}, "PublicQRCodeImageResponse": {"description": "Wraps the image data for a QR code.", "type": "object", "properties": {"qr_code_image": {"description": "The stringified data for the QR code's image", "type": "string"}}}, "PublicQrCode": {"description": "A public QR code with data and customization values", "type": "object", "properties": {"id": {"description": "The QR code's id, as a guid", "type": "string"}, "group_guid": {"type": "string"}, "long_url": {"description": "The destination URL", "type": "string"}, "archived": {"description": "A boolean representing if the QR code has been archived", "type": "boolean"}, "created_at": {"type": "string", "description": "ISO_TIMESTAMP"}, "created_by": {"type": "string"}, "client_id": {"type": "string"}, "is_deleted": {"type": "boolean"}, "image": {"description": "The QR code's image data as a data uri", "type": "string"}, "render_customizations": {"$ref": "#/components/schemas/QRCodeCustomizations"}}}, "QRCodeFullResponse": {"description": "QR code Response", "type": "object", "properties": {"qr_code": {"$ref": "#/components/schemas/QRCode"}}}, "QRCodeFullListResponse": {"description": "QR code list Response", "type": "object", "properties": {"qr_codes": {"type": "array", "items": {"$ref": "#/components/schemas/QRCode"}}}}, "QRCodeFullPaginatedListResponse": {"description": "QR code paginated list Response", "type": "object", "properties": {"qr_codes": {"type": "array", "items": {"$ref": "#/components/schemas/QRCode"}}, "pagination": {"$ref": "#/components/schemas/QRPagination"}, "page_number": {"description": "The 1-based page requested", "type": "integer"}, "page_size": {"description": "The desired size of each page of results", "type": "integer"}, "total_count": {"description": "The count of all the qrcodes that match the filter", "type": "integer"}, "current_count": {"description": "The count of the current number of qrcodes in the response", "type": "integer"}}}, "QRCodesMinimal": {"description": "QR code paginated list Response", "type": "object", "properties": {"qr_codes": {"type": "array", "items": {"$ref": "#/components/schemas/QRCodeMinimal"}}, "pagination": {"$ref": "#/components/schemas/QRPagination"}}}, "QRCodeCustomizationOptionsResponse": {"description": "QR Code customization options response", "type": "object", "properties": {"frames": {"description": "list of frame options", "type": "array", "items": {"$ref": "#/components/schemas/QRCodeFrameResponseItem"}}, "dot_patterns": {"description": "list of dot pattern options", "type": "array", "items": {"$ref": "#/components/schemas/QRCodeDotPattern"}}, "corners": {"description": "list of corner options", "type": "array", "items": {"$ref": "#/components/schemas/QRCodeCornerResponseItem"}}, "shapes": {"description": "list of shape options", "type": "array", "items": {"$ref": "#/components/schemas/QRCodeShapeItem"}}, "formats": {"description": "list of image format options", "type": "array", "items": {"type": "string"}}, "dynamic_types": {"description": "list of dynamic type options", "type": "array", "items": {"$ref": "#/components/schemas/QRCodeTypeItem"}}, "static_types": {"description": "list of static type options", "type": "array", "items": {"$ref": "#/components/schemas/QRCodeTypeItem"}}, "logos": {"description": "list of logo options", "type": "array", "items": {"$ref": "#/components/schemas/QRCodeLogoImage"}}}}, "PreviewQRCodeRequestV2": {"description": "Request to create a preview of a QRCode", "type": "object", "properties": {"render_customizations": {"$ref": "#/components/schemas/QRCodeCustomizations"}, "static_content": {"$ref": "#/components/schemas/QRCodeStatic"}}}, "QRCodeTemplateRequest": {"description": "Request to create a template of a QRCode customization", "type": "object", "required": ["render_customizations"], "properties": {"render_customizations": {"$ref": "#/components/schemas/QRCodeCustomizations"}}}, "QRCodeTemplateResponse": {"description": "A QR Code Template response", "type": "object", "properties": {"qr_code_template": {"description": "An object representing the QR Code template", "$ref": "#/components/schemas/QRCodeTemplate"}}}, "QRCodeTemplatesResponse": {"description": "A QR Code Templates response", "type": "object", "properties": {"qr_code_templates": {"description": "A list of qr code templates", "type": "array", "items": {"$ref": "#/components/schemas/QRCodeTemplate"}}}}, "RedirectQRCodeRequest": {"description": "Request to redirect a QRCode", "type": "object", "required": ["brand_guid", "long_url"], "properties": {"brand_guid": {"type": "string", "example": "B1234567890"}, "long_url": {"type": "string", "example": "https://www.google.com"}}}, "PublicQRCodeResponse": {"description": "Public QR code Response", "type": "object", "properties": {"qr_code": {"$ref": "#/components/schemas/QRCodeMinimal"}}}, "QRCodeCorners": {"description": "An object representing all three corners of the QR code. The corners corresponding to each property are: corner_1 = top left, corner_2 = top right, and corner_3 = bottom right", "type": "object", "properties": {"corner_1": {"$ref": "#/components/schemas/QRCodeCorner"}, "corner_2": {"$ref": "#/components/schemas/QRCodeCorner"}, "corner_3": {"$ref": "#/components/schemas/QRCodeCorner"}}}, "QRCodeCorner": {"description": "Represents one corner, both inner and outer, of a QR code, with color and shape values", "type": "object", "properties": {"inner_color": {"description": "The inner color of a corner of the QR code in hex code format", "type": "string"}, "outer_color": {"description": "The outer color of a corner of the QR code in hex code format", "type": "string"}, "shape": {"description": "The shape one of the QR code's corners should take", "type": "string", "enum": ["standard", "slightly_round", "rounded", "extra_round", "leaf", "leaf_inner", "leaf_outer", "target", "concave"], "default": "standard"}}}, "QRCodeGradient": {"type": "object", "properties": {"style": {"description": "The style of the gradient. Can be either linear or radial.", "type": "string", "enum": ["no_gradient", "linear", "radial"], "default": "no_gradient"}, "angle": {"description": "The angle by which the gradient will be rotated. Only applies to linear gradients.", "type": "number"}, "colors": {"description": "The list of hex colors and their offsets to be used in the gradient.", "type": "array", "items": {"$ref": "#/components/schemas/GradientColor"}}, "exclude_corners": {"description": "Ignore gradient mask on corners", "type": "boolean"}}}, "GradientColor": {"type": "object", "properties": {"color": {"description": "A color in hexadecimal format to be used in one of the gradient's elements", "type": "string", "example": "#ff0098"}, "offset": {"description": "A number between 0-100 denoting the offset of the gradient color, interpreted as a percentage", "type": "integer", "default": 0}}}, "QRCodeLogoPublic": {"type": "object", "properties": {"image_guid": {"type": "string", "description": "A GUID for an image uploaded to Bitly"}}}, "QRCodeLogo": {"type": "object", "properties": {"image_guid": {"type": "string", "description": "A GUID for an image uploaded to Bitly"}, "crop_type": {"description": "The type of crop, either rectangular or circular, to be used on the logo", "type": "string", "enum": ["rectangle", "circle"], "default": "rectangle"}, "crop": {"description": "An object denoting the position and size of the crop", "type": "object", "properties": {"x": {"description": "The x coordinate used to position the crop", "type": "integer"}, "y": {"description": "The y coordinate used to position the crop", "type": "integer"}, "w": {"description": "The width of the crop. Will instead be used as the radius for a circular crop.", "type": "integer"}, "h": {"description": "The height of the crop. Will be completely disregarded for a circular crop.", "type": "integer"}}}}}, "QRCodeBranding": {"type": "object", "properties": {"bitly_brand": {"description": "A boolean that determines if the QR code should have the bitly brand in its bottom right corner", "type": "boolean"}}}, "QRCodeFrameRequest": {"type": "object", "required": ["id"], "properties": {"id": {"description": "The unique id of the selected frame", "$ref": "#/components/schemas/QRCodeFrameType"}, "colors": {"description": "An object of named colors denoting which color should go to which area of the frame", "type": "object", "properties": {"primary": {"description": "The primary color of the frame in hex code format", "type": "string"}, "secondary": {"description": "The secondary color of the frame in hex code format", "type": "string"}, "background": {"description": "The background color of the frame in hex code format", "type": "string"}}}, "text": {"description": "The text to be inserted into the QR code's frame", "type": "object", "properties": {"primary": {"$ref": "#/components/schemas/Text"}, "secondary": {"$ref": "#/components/schemas/Text"}}}}}, "QRCodeFrame": {"type": "object", "required": ["id"], "properties": {"id": {"description": "The unique id of the selected frame", "$ref": "#/components/schemas/QRCodeFrameType"}, "immutable": {"description": "A readonly value denoting if the user should be able to customize the frame", "type": "boolean"}, "colors": {"description": "An object of named colors denoting which color should go to which area of the frame", "type": "object", "properties": {"primary": {"description": "The primary color of the frame in hex code format", "type": "string"}, "secondary": {"description": "The secondary color of the frame in hex code format", "type": "string"}, "background": {"description": "The background color of the frame in hex code format", "type": "string"}}}, "text": {"description": "The text to be inserted into the QR code's frame", "type": "object", "properties": {"primary": {"$ref": "#/components/schemas/Text"}, "secondary": {"$ref": "#/components/schemas/Text"}}}, "thumbnail": {"description": "The QR code's thumbnail image data as a data uri. Can be svg, png, jpg. Only used in response bodies.", "type": "string", "example": "data:image/svg+xml;base64,YWN2ZyB4b3xucz8iaHR0cDi..."}}}, "QRCodeFrameResponseItem": {"allOf": [{"$ref": "#/components/schemas/QRCodeFrame"}], "type": "object", "required": ["immutable", "thumbnail"], "properties": {"immutable": {"type": "boolean"}, "thumbnail": {"description": "A QR code shape's thumbnail image data as a data uri. Can be svg, png, jpg. Only used in response bodies.", "type": "string", "example": "data:image/svg+xml;base64,YWN2ZyB4b3xucz8iaHR0cDi..."}, "locked": {"$ref": "#/components/schemas/Locked"}, "is_hidden": {"type": "boolean", "description": "If true, this frame will be hidden from the selectable frames in the UI. It does not stop you from using this frame. We use this for seasonal frames."}}}, "QRCodeText": {"description": "Contains the center, top, and bottom text to be used in the QR code", "type": "object", "properties": {"center": {"type": "object", "$ref": "#/components/schemas/Text"}, "top": {"type": "object", "$ref": "#/components/schemas/Text"}, "bottom": {"type": "object", "$ref": "#/components/schemas/Text"}}, "example": {"center": {"content": "Some example center text!", "color": "#ff0098", "font": "Helvetica"}, "top": {"content": "Some example bottom text!", "color": "#00ff00", "font": "Helvetica"}, "bottom": {"content": "Some example bottom text!", "color": "#000000", "font": "Helvetica"}}}, "Text": {"description": "An object describing text with color", "type": "object", "required": ["content"], "properties": {"content": {"description": "The text to be used", "type": "string"}, "color": {"description": "The color of the text in hex code format", "type": "string", "default": "#ffffff"}}}, "QRCodeShape": {"description": "Describes the shape of the QR code's container", "type": "object", "required": ["id"], "properties": {"id": {"$ref": "#/components/schemas/QRCodeShapeType"}, "angle": {"description": "The angle from 0-360 at which the QR code's shape should be rotated", "type": "integer", "default": 0}, "outline": {"description": "The outline of the QR code's shape, formatted like a CSS border shorthand", "type": "string", "example": "3px black solid", "default": "none"}, "content_ratio": {"description": "Denotes how much of the container should be taken up by the QR code itself e.g. 0.7 would mean the QR code takes up 70% the container", "type": "number", "default": 1}}, "example": {"id": "octagon", "angle": 125, "outline": "3px dotted red", "content_ratio": 0.8}}, "QRCodeShapeItem": {"description": "The response object detailing a QR code shape with id and thumbnail", "allOf": [{"$ref": "#/components/schemas/QRCodeShape"}], "type": "object", "properties": {"thumbnail": {"description": "A QR code shape's thumbnail image data as a data uri. Can be svg, png, jpg. Only used in response bodies.", "type": "string", "example": "data:image/svg+xml;base64,YWN2ZyB4b3xucz8iaHR0cDi..."}, "locked": {"$ref": "#/components/schemas/Locked"}}}, "QRCodeDynamic": {"description": "An object containing relevant properties for dynamic QR codes, i.e. ones that are linked to a bitlink", "type": "object", "required": ["dynamic_id"], "properties": {"dynamic_id": {"description": "A unique id acting like a foreign key to reference the dynamic content. For bitlinks this would be the `/`, for other content it should be a standard guid.", "type": "string", "example": "12a4b6c"}, "short_url": {"description": "The linked bitlink's short url", "type": "string", "example": "bit.ly/12a4b6c"}, "long_url": {"description": "The linked bitlink's long url", "type": "string", "example": "google.com/search?q=bitlink"}, "total_scan_count": {"description": "A calculated field representing the number of times the QR code has been scanned", "type": "integer"}}}, "QRCodeStatic": {"description": "An object containing relevant properties for static QR codes, i.e. ones that are NOT linked to a bitlink", "type": "object", "properties": {"static_type": {"type": "string", "enum": ["v_card", "wifi", "email", "phone", "text"]}, "v_card": {"$ref": "#/components/schemas/QRCodeVirtualCard"}, "wifi": {"$ref": "#/components/schemas/QRCodeWifi"}, "email": {"$ref": "#/components/schemas/QRCodeEmail"}, "phone": {"$ref": "#/components/schemas/QRCodePhoneNumber"}, "text": {"$ref": "#/components/schemas/QRCodeTextMessage"}}}, "QRCodeVirtualCard": {"description": "A vertual card, usually business card, stored in a QR code", "type": "object", "properties": {"first_name": {"description": "The card owner's first name", "type": "string"}, "last_name": {"description": "The card owner's last name", "type": "string"}, "phone_numbers": {"description": "A list of the card owner's phone numbers", "type": "array", "items": {"type": "string"}}}}, "QRCodeWifi": {"description": "Wifi login information stored in a QR code", "type": "object", "properties": {"ssid": {"description": "The wifi ssid", "type": "string"}, "password": {"description": "The wifi password", "type": "string"}, "encryption": {"description": "The type of encryption that the wifi uses", "type": "string"}}}, "QRCodeEmail": {"description": "A preconfigured email message stored in a QR code", "type": "object", "properties": {"to": {"description": "The recipient's email address", "type": "string"}, "from": {"description": "The sender's email address", "type": "string"}, "cc": {"description": "Email addresses to be CC'd", "type": "string"}, "subject": {"description": "The email's subject", "type": "string"}, "body": {"description": "The email's body", "type": "string"}}}, "QRCodePhoneNumber": {"description": "A phone number stored in a QR code", "type": "object", "properties": {"phone_number": {"description": "The recipient's phone number", "type": "string"}}}, "QRCodeTextMessage": {"description": "A preconfigured text message stored in a QR code", "type": "object", "properties": {"phone_number": {"description": "The recipient's phone number", "type": "string"}, "message": {"description": "A preconfigured text message", "type": "string"}}}, "DeletedQRCodeResponse": {"type": "object", "properties": {"qrcode_id": {"description": "The QR code's id, as a guid", "type": "string"}}}, "BulkAddQRCodeResponse": {"type": "object", "required": ["message", "successes", "csv_format_failures", "qr_code_save_failures", "keyword_failures"], "properties": {"message": {"type": "string"}, "successes": {"type": "integer"}, "csv_format_failures": {"type": "integer"}, "qr_code_save_failures": {"type": "integer"}, "keyword_failures": {"type": "integer"}}}, "QRCodeLogoImage": {"type": "object", "required": ["id", "thumbnail"], "properties": {"id": {"$ref": "#/components/schemas/QRCodeLogoType"}, "thumbnail": {"description": "The QR code's thumbnail image data as a data uri. Can be svg, png, jpg. Only used in response bodies.", "example": "data:image/svg+xml;base64,YWN2ZyB4b3xucz8iaHR0cDi..."}, "locked": {"$ref": "#/components/schemas/Locked"}}}, "QRCodeDotPattern": {"type": "object", "required": ["id", "thumbnail"], "properties": {"id": {"$ref": "#/components/schemas/QRCodeDotPatternType"}, "thumbnail": {"description": "The QR code's thumbnail image data as a data uri. Can be svg, png, jpg. Only used in response bodies.", "example": "data:image/svg+xml;base64,YWN2ZyB4b3xucz8iaHR0cDi..."}, "locked": {"$ref": "#/components/schemas/Locked"}}}, "QRCodeTypeItem": {"type": "object", "required": ["id", "name", "thumbnail"], "properties": {"id": {"$ref": "#/components/schemas/QRCodeTypeEnum"}, "name": {"type": "string"}, "thumbnail": {"description": "The QR code's thumbnail image data as a data uri. Can be svg, png, jpg. Only used in response bodies.", "type": "string", "example": "data:image/svg+xml;base64,YWN2ZyB4b3xucz8iaHR0cDi..."}, "locked": {"$ref": "#/components/schemas/Locked"}}}, "QRCodeTypeEnum": {"description": "The type of dynamic/static content the QR serves, e.g. Link In Bio page, micro site, bitlink, email, text, Wifi, etc.", "type": "string", "enum": ["bitlink", "long_url", "link_in_bio", "v_card", "wifi", "email", "phone", "text"]}, "QRCodeTypeResponse": {"type": "object", "required": ["dynamic", "static"], "properties": {"dynamic": {"description": "A list of dynamic QR code types, such as bitlink, email, link in bio, micro site, etc.", "type": "array", "items": {"$ref": "#/components/schemas/QRCodeTypeItem"}}, "static": {"description": "A list of static QR code types, such as wifi password, email, text message, etc.", "type": "array", "items": {"$ref": "#/components/schemas/QRCodeTypeItem"}}}}, "QRCodeShapeType": {"type": "string", "description": "The enclosing shape of the entire qr code. Square is the default.", "enum": ["square", "circle", "hexagon", "octogon", "triangle", "rectangle", "star", "heart", "diamond", "curved_corner"], "default": "square"}, "QRCodeFrameType": {"type": "string", "enum": ["none", "border_only", "text_bottom", "tooltip_bottom", "arrow", "text_top", "text_bottom_in_frame", "script", "text_top_and_bottom", "url", "instagram"], "default": "none"}, "QRCodeDotPatternType": {"type": "string", "enum": ["standard", "circle", "block", "blob", "rounded", "vertical", "horizontal", "triangle", "heart", "star", "diamond"], "default": "standard"}, "QRCodeLogoType": {"type": "string", "enum": ["nologo", "uploadlogo", "customtext", "bitlylogo", "facebooklogo", "instagramlogo", "twitterlogo", "youtubelogo", "linkedinlogo", "tiktoklogo"], "default": "bitlylogo"}, "QRCodeSpecSettingsPublic": {"description": "The QR code's editable spec settings, which for now is just the error correction", "type": "object", "properties": {"error_correction": {"description": "The amount of error correction that the QR code was generated with", "type": "integer"}}}, "QRCodeSpecSettings": {"description": "The QR code's version, error correction, and mask values", "type": "object", "properties": {"version": {"description": "The QR code's selected version, determined automatically when the QR code is generated", "type": "integer"}, "error_correction": {"description": "The amount of error correction that the QR code was generated with", "type": "integer"}, "mask": {"description": "The mask value, which changes the QR codes dot arrangement without changing the underlying data", "type": "integer"}}}, "QRCodeCornerResponseItem": {"type": "object", "properties": {"id": {"type": "string"}, "thumbnail": {"description": "A QR code shape's thumbnail image data as a data url. Can be svg, png, jpg. Only used in response bodies.", "type": "string"}, "locked": {"$ref": "#/components/schemas/Locked"}}}, "QRCodeImageResponse": {"type": "object", "properties": {"qr_code": {"type": "string", "description": "The data uri for the QR code", "example": "data:image/svg+xml;base64,YWN2ZyB4b3xucz8iaHR0cDi..."}}}, "QRCodeURI": {"type": "object", "properties": {"qr_uri": {"type": "string", "description": "The data uri of the code", "example": "data:image/svg+xml;base64,YWN2ZyB4b3xucz8iaHR0cDi..."}}}, "Locked": {"description": "Determines whether the user has acccess to this field", "type": "boolean", "example": true}, "ProductUtilizationResponse": {"type": "object", "properties": {"link_created": {"description": "whether the Links product has been utilized", "type": "boolean"}, "qr_code_created": {"description": "whether the QR Codes product has been utilized", "type": "boolean"}, "lib_created": {"description": "whether the Link-in-bio product has been utilized", "type": "boolean"}, "analytics_dashboard_created": {"description": "whether the Analytics Dashboard product has been utilized", "type": "boolean"}}}, "PublicCanvaUserBrand": {"description": "An object representing a Canva UserBrand record", "type": "object", "properties": {"canva_user_id": {"description": "The Canva User's ID", "type": "string"}, "canva_brand_id": {"description": "The Canva User's Brand ID", "type": "string"}, "login": {"description": "The Bitly login associated with the canva_user_id and canva_brand_id", "type": "string"}, "active": {"description": "The records active status field", "type": "boolean"}, "brand_guid": {"description": "The Bitly brand_guid preference for use in the Bitly Canva app", "type": "string"}, "org_guid": {"description": "The Bitly org_guid preference for use in the Bitly Canva app", "type": "string"}}}, "UpdateCanvaUserBrand": {"description": "The request body for updating a Canva UserBrands preferred Brand GUID and inferred Org GUID", "type": "object", "properties": {"brand_guid": {"description": "The Bitly brand_guid preference for use in the Bitly Canva app", "type": "string"}}}, "PostOrganizationControlledDomainRequest": {"description": "The request body for validating and sending a controlled domain verification request email", "type": "object", "required": ["domain", "email"], "properties": {"domain": {"type": "string", "description": "Controlled domain which the user is requesting to join"}, "email": {"type": "string", "description": "Email address of the user requesting to join a controlled domain"}}, "example": {"domain": "bit.ly", "email": "chauncey@bit.ly"}}, "Address": {"type": "object", "properties": {"recipient_name": {"type": "string"}, "line1": {"type": "string"}, "line2": {"type": "string"}, "city": {"type": "string"}, "state": {"type": "string"}, "postal_code": {"type": "string"}, "country_code": {"type": "string"}}}, "PayerInfo": {"type": "object", "properties": {"email": {"type": "string"}, "first_name": {"type": "string"}, "last_name": {"type": "string"}, "payer_id": {"type": "string"}, "tenant": {"type": "string"}}}, "Payer": {"type": "object", "properties": {"payer_info": {"$ref": "#/components/schemas/PayerInfo"}}}, "BillingAgreement": {"type": "object", "properties": {"id": {"type": "string"}, "state": {"type": "string"}, "payer": {"$ref": "#/components/schemas/Payer"}, "shipping_address": {"$ref": "#/components/schemas/Address"}, "create_time": {"type": "string"}, "update_time": {"type": "string"}}}, "BillingAgreementToken": {"type": "object", "required": ["paypal_token_id"], "properties": {"paypal_token_id": {"type": "string", "description": "PayPal Session Token"}}}, "ValidDomainsResponse": {"type": "object", "properties": {"valid_control_domains": {"type": "array", "items": {"type": "string"}}}}, "OrgInvitationRequests": {"type": "object", "properties": {"org_invitation_requests": {"type": "array", "items": {"$ref": "#/components/schemas/OrgInvitationRequest"}}}}, "BadRequest": {"description": "BAD_REQUEST", "allOf": [{"$ref": "#/components/schemas/Error"}]}, "UnprocessableEntity": {"description": "UNPROCESSABLE_ENTITY", "allOf": [{"$ref": "#/components/schemas/Error"}]}, "TooManyRequests": {"description": "TOO_MANY_REQUESTS", "allOf": [{"$ref": "#/components/schemas/Error"}]}, "MonthlyLimitExceeded": {"description": "MONTHLY_LIMIT_EXCEEDED", "allOf": [{"$ref": "#/components/schemas/SimplifiedError"}]}, "NotFound": {"description": "NOT_FOUND", "allOf": [{"$ref": "#/components/schemas/Error"}]}, "Conflict": {"description": "CONFLICT", "allOf": [{"$ref": "#/components/schemas/Error"}]}, "UpgradeRequired": {"description": "UPGRADE_REQUIRED", "allOf": [{"$ref": "#/components/schemas/Error"}]}, "Forbidden": {"description": "FORBIDDEN", "allOf": [{"$ref": "#/components/schemas/Error"}]}, "InternalError": {"description": "INTERNAL_ERROR", "allOf": [{"$ref": "#/components/schemas/Error"}]}, "BadGateway": {"description": "BAD_GATEWAY", "allOf": [{"$ref": "#/components/schemas/Error"}]}, "TemporarilyUnavailable": {"description": "TEMPORARILY_UNAVAILABLE", "allOf": [{"$ref": "#/components/schemas/Error"}]}, "ExpectationFailed": {"description": "EXPECTATION_FAILED", "allOf": [{"$ref": "#/components/schemas/Error"}]}, "Timeout": {"description": "TIMEOUT", "allOf": [{"$ref": "#/components/schemas/Error"}]}, "Unauthorized": {"description": "UNAUTHORIZED", "allOf": [{"$ref": "#/components/schemas/Error"}]}, "Gone": {"description": "GONE", "allOf": [{"$ref": "#/components/schemas/Error"}]}}}}