CINXE.COM

<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta name="viewport" content="width=device-width"/><link rel="shortcut icon" href="https://dl6fh5ptkejqa.cloudfront.net/0482a3c938673192a591f2845b9eb275.png" type="image/x-icon"/><title>Bitly API Reference</title><meta name="next-head-count" content="4"/><link rel="stylesheet" id="onetrust-css" href="https://docrdsfx76ssb.cloudfront.net/static/onetrust.css" type="text/css" media="all"/><link rel="preload" href="/_next/static/css/38515dabedc25d7c.css" as="style"/><link rel="stylesheet" href="/_next/static/css/38515dabedc25d7c.css" data-n-g=""/><link rel="preload" href="/_next/static/css/e3efc1b4d4ce4495.css" as="style"/><link rel="stylesheet" href="/_next/static/css/e3efc1b4d4ce4495.css" data-n-p=""/><noscript data-n-css=""></noscript><script defer="" nomodule="" src="/_next/static/chunks/polyfills-c67a75d1b6f99dc8.js"></script><script type="text/javascript" src="https://cdn.cookielaw.org/consent/26c7d0bf-48ec-4646-8f57-e4e1135d9d05/OtAutoBlock.js" defer="" data-nscript="beforeInteractive"></script><script src="https://cdn.cookielaw.org/scripttemplates/otSDKStub.js" type="text/javascript" charSet="UTF-8" data-domain-script="26c7d0bf-48ec-4646-8f57-e4e1135d9d05" defer="" data-nscript="beforeInteractive"></script><script src="https://docrdsfx76ssb.cloudfront.net/static/onetrust.js" id="onetrust-js" defer="" data-nscript="beforeInteractive"></script><script src="/_next/static/chunks/webpack-9b312e20a4e32339.js" defer=""></script><script src="/_next/static/chunks/framework-4506680c0e686bbe.js" defer=""></script><script src="/_next/static/chunks/main-a3ed914212fa324f.js" defer=""></script><script src="/_next/static/chunks/pages/_app-7a045c60b3a601c7.js" defer=""></script><script src="/_next/static/chunks/825-0e7f9db653b2a41f.js" defer=""></script><script src="/_next/static/chunks/214-2a67779996894e32.js" defer=""></script><script src="/_next/static/chunks/pages/%5BapiReference%5D-1451d0ad8dd51b56.js" defer=""></script><script src="/_next/static/b51c46fbb713db1dcf918361ef8e91da90fce810/_buildManifest.js" defer=""></script><script src="/_next/static/b51c46fbb713db1dcf918361ef8e91da90fce810/_ssgManifest.js" defer=""></script></head><body><div id="__next"><div class="Layout_layout__WuuTt"><div class="Layout_header__HIFcZ"><a href="#main" class="SkipLink_skipLink__Y1WwC">Skip to main content</a><header class="Header_header__jiqMu"><div class="Header_headerContent__6viXb"><div class="Header_headerIcon__fYgGU"><svg xmlns="http://www.w3.org/2000/svg" viewBox="-1376 546.6 90 45" xml:space="preserve"><title>Bitly</title><path d="M-1329.1 577c-4.5 0-7-2.7-7-6 0-1.3.1-11.4.1-11.4-1.5 0-2.2-.8-2.2-1.7 0-1 .8-1.9 2-1.9v-4.7c0-1.6 1.2-2.9 2.8-2.9 1.6 0 2.8 1.3 2.8 2.9 0 1.2-.1 2.8-.1 4.7h2.9c1.5 0 2.2.8 2.2 1.9 0 1.1-.8 1.8-1.9 1.8h-3.2c-.1 3.2-.2 7.1-.2 10.1 0 1.1.8 2.4 2.6 2.4 4.3 0 5.5-4.3 5.5-12.4 0-1.1.9-1.9 1.9-1.9 1.1 0 1.9.8 1.9 1.9.1 10.7-2.5 17.2-10.1 17.2"></path><path d="M-1310.9 560.5s1.8-1.2 2.9-1.2c1.1 0 .9.2.9 1.3 0 11.6-2.1 16.5-9.6 16.5-3.3 0-6.3-2.4-6.3-5.4 0-1.2.2-3.5.2-4.6 0-11.2-.2-13.5-.2-16.8 0-1.6 1.3-3 2.9-3 1.6 0 2.8 1.3 2.8 2.9 0 3.3-.4 8-.5 20.4 0 1 .5 1.8 1.8 1.8 4.3-.2 4.9-5.1 5.1-11.9"></path><path d="M-1297.3 575s-1.6 2.1-5.6 2c-5.3-.1-7.7-4.3-8-8.6-.2-3.3-.1-5.1-.1-7.3 0-1.6 1.1-2.9 2.6-2.9 1.6 0 2.5 1.3 2.5 2.9 0 2.1-.1 3.5-.2 5.9 0 2.8.9 5.3 3.2 5.2 2.2 0 4.7-.9 4.7-5.7v-5.4c0-1.6 1.1-2.9 2.7-2.9s2.7 1.3 2.7 2.9c0 2.1-.2 3.8-.2 7.1 0 0-.1 6.6.1 8.1.7-.2 1.8-1 2.9-2.7.7-1 2-1.3 2.7-.8 1.1.6 1.1 1.9.6 2.8-1.1 2.3-2.4 3.8-5.9 5 0 4-.3 9.8-7.6 10.9-6.3.9-9.1-2.7-9.1-5.8 0-4.9 4.9-6.3 11.9-8.1l.1-2.6zm.6 6.4c-3.6.8-8 1.9-8 4.1 0 2.1 2.2 2.4 4 2.1 3.7-.8 4.1-3 4-6.2zM-1347.6 571.6c0-1.3-.2-12.2-.2-12.2 0-1.6 1-2.9 2.6-2.9s2.6 1.4 2.6 2.9c-.2 5.1-.3 8.4-.3 10.2 0 1 .6 2.6 2.2 2.6 3.8 0 4.6-3.5 4.6-12.1 0-1.1 1.1-1.9 2.2-1.9s1.9.8 1.9 1.9c0 13-2.3 16.9-9.6 16.9-2.8 0-6-1.9-6-5.4"></path><path d="M-1345.8 557.5c-1.1 0-1.1.2-1.8 1.3 0 4.8-1.2 10.7-6.6 12.9 3.8-8-.1-15.3-6.4-15.3-3 0-4.9 1.1-6.1 2.1 0-2.3.1-6.4.1-6.4 0-2.9-1-5.1-4.5-5.2-2 0-3.5.9-4.5 3-.3.8-.2 1.6.5 2 .6.3 1.5.1 1.9-.5.3-.4.5-.5.7-.4.4 0 .4.7.5 1.2 0 .3.3 5.1.2 17.7 0 3.5 2.7 7.5 9.3 7.5 13 0 18.6-4.8 18.6-17.7-.3-1.2-.9-2.2-1.9-2.2zm-16.9 14.9c-2.5 0-4.2-.7-4.3-2.9v-2.2c.2-3.1 2.4-5.4 4.6-5.8 2.7-.5 4.5.7 4.5 4.2-.1 2.4-.8 6.6-4.8 6.7zM-1345.1 548.4c1.6 0 2.9 1.3 2.9 2.9s-1.3 2.9-2.9 2.9c-1.6 0-2.9-1.3-2.9-2.9s1.3-2.9 2.9-2.9"></path></svg>Developer</div><div class="Header_desktopHeaderLinks__afkP5"><nav><a class="Header_link__GeEkF" href="/">Documentation</a><a class="Header_link__GeEkF Header_activeLink__QO_Eu" href="/api-reference/">API Reference</a></nav><div class="Header_ctaWrapper__rejBO"><a class="Button_button__45M_W" href="https://bitly.com/pages/pricing" target="_blank" rel="noopener noreferrer">Start Now</a></div></div><div class="Header_mobileHamburger__i_8mq"><button class="Header_menuIcon__5w7RR"><svg height="32" style="enable-background:new 0 0 32 32" width="32" xml:space="preserve" xmlns="http://www.w3.org/2000/svg"><title>Navigation</title><path d="M4 10h24a2 2 0 0 0 0-4H4a2 2 0 0 0 0 4zm24 4H4a2 2 0 0 0 0 4h24a2 2 0 0 0 0-4zm0 8H4a2 2 0 0 0 0 4h24a2 2 0 0 0 0-4z"></path></svg></button></div></div></header></div><div class="Layout_body__KWn_X"><nav class="Layout_navigation__1M5jp Layout_navigationHide__DviHj"><div class="Header_mobileHeaderLinks__EmNZ6"><nav><a class="Header_link__GeEkF" href="/">Documentation</a><a class="Header_link__GeEkF Header_activeLink__QO_Eu" href="/api-reference/">API Reference</a></nav><div class="Header_ctaWrapper__rejBO"><a class="Button_button__45M_W" href="https://bitly.com/pages/pricing" target="_blank" rel="noopener noreferrer">Start Now</a></div></div><div><div class="Collapsible_collapsible__Rx1_w"><button class="Collapsible_toggle__K8a50"><div>Bitlinks</div><div class="Collapsible_chevron__hYprk"><svg viewBox="0 0 8 14" xmlns="http://www.w3.org/2000/svg"><path d="M6.463 7 .987 1.66a.61.61 0 0 1 0-.878.648.648 0 0 1 .9 0L7.813 6.56a.61.61 0 0 1 0 .878l-5.926 5.78a.648.648 0 0 1-.9 0 .61.61 0 0 1 0-.879L6.463 7Z"></path></svg></div></button></div><div class="Collapsible_collapsible__Rx1_w"><button class="Collapsible_toggle__K8a50"><div>BSDs</div><div class="Collapsible_chevron__hYprk"><svg viewBox="0 0 8 14" xmlns="http://www.w3.org/2000/svg"><path d="M6.463 7 .987 1.66a.61.61 0 0 1 0-.878.648.648 0 0 1 .9 0L7.813 6.56a.61.61 0 0 1 0 .878l-5.926 5.78a.648.648 0 0 1-.9 0 .61.61 0 0 1 0-.879L6.463 7Z"></path></svg></div></button></div><div class="Collapsible_collapsible__Rx1_w"><button class="Collapsible_toggle__K8a50"><div>Campaigns</div><div class="Collapsible_chevron__hYprk"><svg viewBox="0 0 8 14" xmlns="http://www.w3.org/2000/svg"><path d="M6.463 7 .987 1.66a.61.61 0 0 1 0-.878.648.648 0 0 1 .9 0L7.813 6.56a.61.61 0 0 1 0 .878l-5.926 5.78a.648.648 0 0 1-.9 0 .61.61 0 0 1 0-.879L6.463 7Z"></path></svg></div></button></div><div class="Collapsible_collapsible__Rx1_w"><button class="Collapsible_toggle__K8a50"><div>Custom Bitlinks</div><div class="Collapsible_chevron__hYprk"><svg viewBox="0 0 8 14" xmlns="http://www.w3.org/2000/svg"><path d="M6.463 7 .987 1.66a.61.61 0 0 1 0-.878.648.648 0 0 1 .9 0L7.813 6.56a.61.61 0 0 1 0 .878l-5.926 5.78a.648.648 0 0 1-.9 0 .61.61 0 0 1 0-.879L6.463 7Z"></path></svg></div></button></div><div class="Collapsible_collapsible__Rx1_w"><button class="Collapsible_toggle__K8a50"><div>Groups</div><div class="Collapsible_chevron__hYprk"><svg viewBox="0 0 8 14" xmlns="http://www.w3.org/2000/svg"><path d="M6.463 7 .987 1.66a.61.61 0 0 1 0-.878.648.648 0 0 1 .9 0L7.813 6.56a.61.61 0 0 1 0 .878l-5.926 5.78a.648.648 0 0 1-.9 0 .61.61 0 0 1 0-.879L6.463 7Z"></path></svg></div></button></div><div class="Collapsible_collapsible__Rx1_w"><button class="Collapsible_toggle__K8a50"><div>Organizations</div><div class="Collapsible_chevron__hYprk"><svg viewBox="0 0 8 14" xmlns="http://www.w3.org/2000/svg"><path d="M6.463 7 .987 1.66a.61.61 0 0 1 0-.878.648.648 0 0 1 .9 0L7.813 6.56a.61.61 0 0 1 0 .878l-5.926 5.78a.648.648 0 0 1-.9 0 .61.61 0 0 1 0-.879L6.463 7Z"></path></svg></div></button></div><div class="Collapsible_collapsible__Rx1_w"><button class="Collapsible_toggle__K8a50"><div>QR Codes</div><div class="Collapsible_chevron__hYprk"><svg viewBox="0 0 8 14" xmlns="http://www.w3.org/2000/svg"><path d="M6.463 7 .987 1.66a.61.61 0 0 1 0-.878.648.648 0 0 1 .9 0L7.813 6.56a.61.61 0 0 1 0 .878l-5.926 5.78a.648.648 0 0 1-.9 0 .61.61 0 0 1 0-.879L6.463 7Z"></path></svg></div></button></div><div class="Collapsible_collapsible__Rx1_w"><button class="Collapsible_toggle__K8a50"><div>User</div><div class="Collapsible_chevron__hYprk"><svg viewBox="0 0 8 14" xmlns="http://www.w3.org/2000/svg"><path d="M6.463 7 .987 1.66a.61.61 0 0 1 0-.878.648.648 0 0 1 .9 0L7.813 6.56a.61.61 0 0 1 0 .878l-5.926 5.78a.648.648 0 0 1-.9 0 .61.61 0 0 1 0-.879L6.463 7Z"></path></svg></div></button></div><div class="Collapsible_collapsible__Rx1_w"><button class="Collapsible_toggle__K8a50"><div>Webhooks</div><div class="Collapsible_chevron__hYprk"><svg viewBox="0 0 8 14" xmlns="http://www.w3.org/2000/svg"><path d="M6.463 7 .987 1.66a.61.61 0 0 1 0-.878.648.648 0 0 1 .9 0L7.813 6.56a.61.61 0 0 1 0 .878l-5.926 5.78a.648.648 0 0 1-.9 0 .61.61 0 0 1 0-.879L6.463 7Z"></path></svg></div></button></div></div></nav><main id="main" class="Layout_content__Dwd3J" style="scroll-behavior:smooth"><div><div class="ApiReference_title__aBj6t">Bitly API (4.0.0)</div><div class="ApiReference_subtitle__p_qv_">OpenAPI Specification: <a class="Button_button__45M_W" href="https://dev.bitly.com/v4/v4.json" target="_blank" rel="noopener noreferrer">Download</a></div><div class="ApiReference_tagInfo__YVbgw"><h2 class="ApiReference_tagName__IJx2p">Bitlinks</h2><p class="ApiReference_tagDescription__8c1GM">Bitlinks are shortened links. They could begin with the bit.ly domain or your own custom branded short domain (BSD). </p></div><div class="MethodDetail_methodContainer__3EF7h" id="createBitlink"><div class="MethodDetail_method__fyEiw"><div><h3 class="MethodHeader_h3__seOfC">Shorten a Link</h3><h4 class="MethodHeader_description__3_p_p"><div class="MethodHeader_iconStyle__x5Ow4"><svg viewBox="0 0 18 6" xmlns="http://www.w3.org/2000/svg" class="IconRest_restIcon__3pju8 post"><title>Post</title><path d="M1.072 5.885V3.898c.026.006.069.011.129.017a3.88 3.88 0 0 0 .364.016h.125c.27 0 .533-.037.786-.11.253-.075.478-.193.677-.355.198-.162.357-.368.477-.618s.18-.551.18-.903c0-.401-.07-.727-.208-.977a1.592 1.592 0 0 0-.536-.585 1.971 1.971 0 0 0-.739-.28 4.854 4.854 0 0 0-.817-.07C1.249.033.987.045.724.07.46.095.219.13 0 .173v5.712h1.072Zm.461-2.934h-.098a2.344 2.344 0 0 1-.27-.017.818.818 0 0 1-.093-.016V1.047c.057-.011.133-.02.227-.03.093-.007.193-.012.297-.012.135 0 .268.014.399.042.13.027.246.077.348.148a.796.796 0 0 1 .246.284.954.954 0 0 1 .094.45c0 .214-.032.387-.098.519a.782.782 0 0 1-.262.309c-.11.074-.233.125-.371.152a2.141 2.141 0 0 1-.419.042ZM6.47 6c.694 0 1.212-.265 1.553-.795.342-.53.513-1.265.513-2.205 0-.44-.038-.843-.114-1.212a2.872 2.872 0 0 0-.36-.947 1.78 1.78 0 0 0-.637-.618C7.163.074 6.844 0 6.469 0c-.35 0-.653.069-.911.206a1.78 1.78 0 0 0-.645.59c-.172.255-.3.57-.384.943A5.804 5.804 0 0 0 4.404 3c0 .44.037.843.11 1.212.073.368.191.684.356.947.164.264.378.47.641.618.263.149.583.223.958.223Zm0-1.005c-.203 0-.366-.053-.489-.157a.989.989 0 0 1-.281-.425 2.57 2.57 0 0 1-.133-.63A8.129 8.129 0 0 1 5.53 3c0-.66.065-1.157.195-1.492.13-.335.378-.503.743-.503.209 0 .376.054.501.161a1 1 0 0 1 .286.433c.065.181.106.393.125.635.018.241.027.497.027.766 0 .34-.014.636-.043.886-.029.25-.08.457-.152.622a.826.826 0 0 1-.29.367.803.803 0 0 1-.454.12ZM10.991 6c.297 0 .574-.037.83-.111.255-.074.476-.187.664-.338.188-.151.334-.338.438-.56.104-.223.157-.483.157-.78 0-.307-.067-.563-.2-.766a1.814 1.814 0 0 0-.493-.507 3.3 3.3 0 0 0-.641-.342 11.165 11.165 0 0 1-.642-.28 2.185 2.185 0 0 1-.493-.313.562.562 0 0 1-.199-.445c0-.176.072-.316.215-.42.144-.105.34-.157.59-.157a2.757 2.757 0 0 1 .767.107.14.14 0 0 0 .047.008v.915h.86V.338a2.45 2.45 0 0 0-.735-.247C11.85.03 11.536 0 11.218 0c-.282 0-.537.041-.767.124-.23.082-.426.197-.59.346A1.557 1.557 0 0 0 9.476 1a1.66 1.66 0 0 0-.137.68c0 .324.067.588.2.792.133.203.297.372.493.506.195.135.409.246.641.334.232.088.446.176.642.264.195.088.36.19.492.305.133.115.2.266.2.453 0 .209-.081.375-.243.499-.161.123-.388.185-.68.185-.162 0-.314-.018-.458-.053a2.256 2.256 0 0 1-.395-.136l-.047-.017v-.816h-.86V5.53c.067.039.156.085.266.14.11.055.236.107.379.157.143.05.3.09.47.124.169.033.353.049.55.049Zm6.29-.115v-.907h-.885V1.022h.744v.997H18V.115h-4.287V2.02h.86v-.997h.752v3.956h-.892v.907h2.847Z"></path></svg></div> /v4/shorten</h4><p class="MethodHeader_description__3_p_p">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.</p></div><div><h4 class="ParameterList_h4__nH9G8 ParameterList_dividing__wRGRx">Request Body Schema</h4><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">long_url</span><span class="Parameter_type__djM_s">string</span><span class="Parameter_required__pcK_H">Required</span></div></div><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">domain</span><span class="Parameter_type__djM_s">string</span></div><div class="Parameter_default__HHgG0 Parameter_spacer__JKXbH">Default: <span class="Parameter_label__DUY7G">"bit.ly"</span></div></div><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">group_guid</span><span class="Parameter_type__djM_s">string</span></div></div></div></div><div class="MethodDetail_examples__8nXeM"><div><label class="CodeSyntaxSelector_header__6P_Jc CodeSyntaxSelector_headerDark__hI3A0"><span>Request</span><div class="CodeSyntaxSelector_header__6P_Jc CodeSyntaxSelector_headerDark__hI3A0"><div class="Select_wrapper__58utF Select_dark__KPIws"><select class="Select_select__qXz_Z Select_dark__KPIws" aria-label="Select" autoComplete="off"><option value="cURL" selected="">cURL</option><option value="Node">Node</option><option value="Browser">Browser</option><option value="Go">Go</option><option value="Python">Python</option></select><svg viewBox="0 0 8 14" xmlns="http://www.w3.org/2000/svg"><path d="M6.463 7 .987 1.66a.61.61 0 0 1 0-.878.648.648 0 0 1 .9 0L7.813 6.56a.61.61 0 0 1 0 .878l-5.926 5.78a.648.648 0 0 1-.9 0 .61.61 0 0 1 0-.879L6.463 7Z"></path></svg></div></div></label><div class="CodeSyntaxSelector_body__hBJ7j CodeSyntaxSelector_bodyDark__cizVw"><div class="CodeBlock_codeBlock__KlURa"><pre tabindex="0" style="color:#ffffff;font-family:ProximaNova, monospace;line-height:1.2;font-size:1rem"><code class="language-bash" style="white-space:pre"><span class="token token" style="color:#ee6123">curl</span><span> </span><span class="token token punctuation">\</span><span> </span><span>-H </span><span class="token token" style="color:#acda95">'Authorization: Bearer {TOKEN}'</span><span> </span><span class="token token punctuation">\</span><span> </span><span>-H </span><span class="token token" style="color:#acda95">'Content-Type: application/json'</span><span> </span><span class="token token punctuation">\</span><span> </span><span>-X POST </span><span class="token token punctuation">\</span><span> </span><span>-d </span><span class="token token" style="color:#acda95">'{ </span><span class="token token" style="color:#acda95"> "long_url": "https://dev.bitly.com", </span><span class="token token" style="color:#acda95"> "domain": "bit.ly", </span><span class="token token" style="color:#acda95"> "group_guid": "Ba1bc23dE4F" </span><span class="token token" style="color:#acda95">}'</span><span> </span><span class="token token punctuation">\</span><span> </span>https://api-ssl.bitly.com/v4/shorten</code></pre></div></div></div><div><label class="CodeSyntaxSelector_header__6P_Jc"><span>Response</span><div class="CodeSyntaxSelector_header__6P_Jc"><div class="Select_wrapper__58utF"><select class="Select_select__qXz_Z" aria-label="Select" autoComplete="off"><option value="200" selected="">200 SUCCESS</option><option value="201">201 CREATED</option><option value="400">400 BAD_REQUEST</option><option value="403">403 FORBIDDEN</option><option value="417">417 EXPECTATION_FAILED</option><option value="422">422 UNPROCESSABLE_ENTITY</option><option value="429">429 MONTHLY_LIMIT_EXCEEDED</option><option value="500">500 INTERNAL_ERROR</option><option value="503">503 TEMPORARILY_UNAVAILABLE</option></select><svg viewBox="0 0 8 14" xmlns="http://www.w3.org/2000/svg"><path d="M6.463 7 .987 1.66a.61.61 0 0 1 0-.878.648.648 0 0 1 .9 0L7.813 6.56a.61.61 0 0 1 0 .878l-5.926 5.78a.648.648 0 0 1-.9 0 .61.61 0 0 1 0-.879L6.463 7Z"></path></svg></div></div></label><div class="CodeSyntaxSelector_body__hBJ7j"><div class="CodeBlock_codeBlock__KlURa"><pre tabindex="0" style="color:#36383b;font-family:ProximaNova, monospace;line-height:1.2;font-size:1rem"><code class="language-json" style="white-space:pre"><span class="token token punctuation">{</span><span> </span><span> </span><span class="token token property">"references"</span><span class="token token operator">:</span><span> </span><span class="token token punctuation">{</span><span> </span><span class="token token" style="color:#51763e">"any"</span><span> </span><span class="token token punctuation">}</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"link"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"id"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"long_url"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"archived"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"boolean"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"created_at"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"custom_bitlinks"</span><span class="token token operator">:</span><span> </span><span class="token token punctuation">[</span><span> </span><span> </span><span class="token token" style="color:#51763e">"string"</span><span> </span><span> </span><span class="token token punctuation">]</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"tags"</span><span class="token token operator">:</span><span> </span><span class="token token punctuation">[</span><span> </span><span> </span><span class="token token" style="color:#51763e">"string"</span><span> </span><span> </span><span class="token token punctuation">]</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"deeplinks"</span><span class="token token operator">:</span><span> </span><span class="token token punctuation">[</span><span> </span><span> </span><span class="token token punctuation">{</span><span> </span><span> </span><span class="token token property">"guid"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"bitlink"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"app_uri_path"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"install_url"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"app_guid"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"os"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"install_type"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"created"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"modified"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"brand_guid"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span> </span><span> </span><span class="token token punctuation">}</span><span> </span><span> </span><span class="token token punctuation">]</span><span> </span><span></span><span class="token token punctuation">}</span></code></pre></div></div></div></div></div><div class="MethodDetail_methodContainer__3EF7h" id="createFullBitlink"><div class="MethodDetail_method__fyEiw"><div><h3 class="MethodHeader_h3__seOfC">Create a Bitlink</h3><h4 class="MethodHeader_description__3_p_p"><div class="MethodHeader_iconStyle__x5Ow4"><svg viewBox="0 0 18 6" xmlns="http://www.w3.org/2000/svg" class="IconRest_restIcon__3pju8 post"><title>Post</title><path d="M1.072 5.885V3.898c.026.006.069.011.129.017a3.88 3.88 0 0 0 .364.016h.125c.27 0 .533-.037.786-.11.253-.075.478-.193.677-.355.198-.162.357-.368.477-.618s.18-.551.18-.903c0-.401-.07-.727-.208-.977a1.592 1.592 0 0 0-.536-.585 1.971 1.971 0 0 0-.739-.28 4.854 4.854 0 0 0-.817-.07C1.249.033.987.045.724.07.46.095.219.13 0 .173v5.712h1.072Zm.461-2.934h-.098a2.344 2.344 0 0 1-.27-.017.818.818 0 0 1-.093-.016V1.047c.057-.011.133-.02.227-.03.093-.007.193-.012.297-.012.135 0 .268.014.399.042.13.027.246.077.348.148a.796.796 0 0 1 .246.284.954.954 0 0 1 .094.45c0 .214-.032.387-.098.519a.782.782 0 0 1-.262.309c-.11.074-.233.125-.371.152a2.141 2.141 0 0 1-.419.042ZM6.47 6c.694 0 1.212-.265 1.553-.795.342-.53.513-1.265.513-2.205 0-.44-.038-.843-.114-1.212a2.872 2.872 0 0 0-.36-.947 1.78 1.78 0 0 0-.637-.618C7.163.074 6.844 0 6.469 0c-.35 0-.653.069-.911.206a1.78 1.78 0 0 0-.645.59c-.172.255-.3.57-.384.943A5.804 5.804 0 0 0 4.404 3c0 .44.037.843.11 1.212.073.368.191.684.356.947.164.264.378.47.641.618.263.149.583.223.958.223Zm0-1.005c-.203 0-.366-.053-.489-.157a.989.989 0 0 1-.281-.425 2.57 2.57 0 0 1-.133-.63A8.129 8.129 0 0 1 5.53 3c0-.66.065-1.157.195-1.492.13-.335.378-.503.743-.503.209 0 .376.054.501.161a1 1 0 0 1 .286.433c.065.181.106.393.125.635.018.241.027.497.027.766 0 .34-.014.636-.043.886-.029.25-.08.457-.152.622a.826.826 0 0 1-.29.367.803.803 0 0 1-.454.12ZM10.991 6c.297 0 .574-.037.83-.111.255-.074.476-.187.664-.338.188-.151.334-.338.438-.56.104-.223.157-.483.157-.78 0-.307-.067-.563-.2-.766a1.814 1.814 0 0 0-.493-.507 3.3 3.3 0 0 0-.641-.342 11.165 11.165 0 0 1-.642-.28 2.185 2.185 0 0 1-.493-.313.562.562 0 0 1-.199-.445c0-.176.072-.316.215-.42.144-.105.34-.157.59-.157a2.757 2.757 0 0 1 .767.107.14.14 0 0 0 .047.008v.915h.86V.338a2.45 2.45 0 0 0-.735-.247C11.85.03 11.536 0 11.218 0c-.282 0-.537.041-.767.124-.23.082-.426.197-.59.346A1.557 1.557 0 0 0 9.476 1a1.66 1.66 0 0 0-.137.68c0 .324.067.588.2.792.133.203.297.372.493.506.195.135.409.246.641.334.232.088.446.176.642.264.195.088.36.19.492.305.133.115.2.266.2.453 0 .209-.081.375-.243.499-.161.123-.388.185-.68.185-.162 0-.314-.018-.458-.053a2.256 2.256 0 0 1-.395-.136l-.047-.017v-.816h-.86V5.53c.067.039.156.085.266.14.11.055.236.107.379.157.143.05.3.09.47.124.169.033.353.049.55.049Zm6.29-.115v-.907h-.885V1.022h.744v.997H18V.115h-4.287V2.02h.86v-.997h.752v3.956h-.892v.907h2.847Z"></path></svg></div> /v4/bitlinks</h4><p class="MethodHeader_description__3_p_p">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.</p></div><div><h4 class="ParameterList_h4__nH9G8 ParameterList_dividing__wRGRx">Request Body Schema</h4><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">long_url</span><span class="Parameter_type__djM_s">string</span><span class="Parameter_required__pcK_H">Required</span></div></div><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">domain</span><span class="Parameter_type__djM_s">string</span></div><div class="Parameter_default__HHgG0 Parameter_spacer__JKXbH">Default: <span class="Parameter_label__DUY7G">"bit.ly"</span></div></div><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">group_guid</span><span class="Parameter_type__djM_s">string</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">Always include a specific group and custom domain in your shorten calls.</div></div><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">title</span><span class="Parameter_type__djM_s">string</span></div></div><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">tags</span><span class="Parameter_type__djM_s">array of string</span></div></div><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">deeplinks</span><span class="Parameter_type__djM_s">array of object</span></div><div class="Parameter_nestedList__KmKgd"><div class="Parameter_nested__X3i_l"><div class="Parameter_parameter__J0LgW Parameter_compact__V5419"><div><span class="Parameter_name___UYgz">app_id</span><span class="Parameter_type__djM_s">string</span></div></div></div><div class="Parameter_nested__X3i_l"><div class="Parameter_parameter__J0LgW Parameter_compact__V5419"><div><span class="Parameter_name___UYgz">app_uri_path</span><span class="Parameter_type__djM_s">string</span></div></div></div><div class="Parameter_nested__X3i_l"><div class="Parameter_parameter__J0LgW Parameter_compact__V5419"><div><span class="Parameter_name___UYgz">install_url</span><span class="Parameter_type__djM_s">string</span></div></div></div><div class="Parameter_nested__X3i_l"><div class="Parameter_parameter__J0LgW Parameter_compact__V5419"><div><span class="Parameter_name___UYgz">install_type</span><span class="Parameter_type__djM_s">string</span></div><div class="Parameter_enum__csO6P Parameter_spacer__JKXbH">Enum: <span class="Parameter_label__DUY7G">"no_install"</span><span class="Parameter_label__DUY7G">"auto_install"</span><span class="Parameter_label__DUY7G">"promote_install"</span></div></div></div></div></div></div></div><div class="MethodDetail_examples__8nXeM"><div><label class="CodeSyntaxSelector_header__6P_Jc CodeSyntaxSelector_headerDark__hI3A0"><span>Request</span><div class="CodeSyntaxSelector_header__6P_Jc CodeSyntaxSelector_headerDark__hI3A0"><div class="Select_wrapper__58utF Select_dark__KPIws"><select class="Select_select__qXz_Z Select_dark__KPIws" aria-label="Select" autoComplete="off"><option value="cURL" selected="">cURL</option><option value="Node">Node</option><option value="Browser">Browser</option><option value="Go">Go</option><option value="Python">Python</option></select><svg viewBox="0 0 8 14" xmlns="http://www.w3.org/2000/svg"><path d="M6.463 7 .987 1.66a.61.61 0 0 1 0-.878.648.648 0 0 1 .9 0L7.813 6.56a.61.61 0 0 1 0 .878l-5.926 5.78a.648.648 0 0 1-.9 0 .61.61 0 0 1 0-.879L6.463 7Z"></path></svg></div></div></label><div class="CodeSyntaxSelector_body__hBJ7j CodeSyntaxSelector_bodyDark__cizVw"><div class="CodeBlock_codeBlock__KlURa"><pre tabindex="0" style="color:#ffffff;font-family:ProximaNova, monospace;line-height:1.2;font-size:1rem"><code class="language-bash" style="white-space:pre"><span class="token token" style="color:#ee6123">curl</span><span> </span><span class="token token punctuation">\</span><span> </span><span>-H </span><span class="token token" style="color:#acda95">'Authorization: Bearer {TOKEN}'</span><span> </span><span class="token token punctuation">\</span><span> </span><span>-H </span><span class="token token" style="color:#acda95">'Content-Type: application/json'</span><span> </span><span class="token token punctuation">\</span><span> </span><span>-X POST </span><span class="token token punctuation">\</span><span> </span><span>-d </span><span class="token token" style="color:#acda95">'{ </span><span class="token token" style="color:#acda95"> "long_url": "https://dev.bitly.com", </span><span class="token token" style="color:#acda95"> "domain": "bit.ly", </span><span class="token token" style="color:#acda95"> "group_guid": "Ba1bc23dE4F", </span><span class="token token" style="color:#acda95"> "title": "Bitly API Documentation", </span><span class="token token" style="color:#acda95"> "tags": [ </span><span class="token token" style="color:#acda95"> "bitly", </span><span class="token token" style="color:#acda95"> "api" </span><span class="token token" style="color:#acda95"> ], </span><span class="token token" style="color:#acda95"> "deeplinks": [ </span><span class="token token" style="color:#acda95"> { </span><span class="token token" style="color:#acda95"> "app_id": "com.bitly.app", </span><span class="token token" style="color:#acda95"> "app_uri_path": "/store?id=123456", </span><span class="token token" style="color:#acda95"> "install_url": "https://play.google.com/store/apps/details?id=com.bitly.app&hl=en_US", </span><span class="token token" style="color:#acda95"> "install_type": "promote_install" </span><span class="token token" style="color:#acda95"> } </span><span class="token token" style="color:#acda95"> ] </span><span class="token token" style="color:#acda95">}'</span><span> </span><span class="token token punctuation">\</span><span> </span>https://api-ssl.bitly.com/v4/bitlinks</code></pre></div></div></div><div><label class="CodeSyntaxSelector_header__6P_Jc"><span>Response</span><div class="CodeSyntaxSelector_header__6P_Jc"><div class="Select_wrapper__58utF"><select class="Select_select__qXz_Z" aria-label="Select" autoComplete="off"><option value="200" selected="">200 SUCCESS</option><option value="201">201 CREATED</option><option value="400">400 BAD_REQUEST</option><option value="402">402 UPGRADE_REQUIRED</option><option value="403">403 FORBIDDEN</option><option value="404">404 NOT_FOUND</option><option value="417">417 EXPECTATION_FAILED</option><option value="422">422 UNPROCESSABLE_ENTITY</option><option value="429">429 MONTHLY_LIMIT_EXCEEDED</option><option value="500">500 INTERNAL_ERROR</option><option value="503">503 TEMPORARILY_UNAVAILABLE</option></select><svg viewBox="0 0 8 14" xmlns="http://www.w3.org/2000/svg"><path d="M6.463 7 .987 1.66a.61.61 0 0 1 0-.878.648.648 0 0 1 .9 0L7.813 6.56a.61.61 0 0 1 0 .878l-5.926 5.78a.648.648 0 0 1-.9 0 .61.61 0 0 1 0-.879L6.463 7Z"></path></svg></div></div></label><div class="CodeSyntaxSelector_body__hBJ7j"><div class="CodeBlock_codeBlock__KlURa"><pre tabindex="0" style="color:#36383b;font-family:ProximaNova, monospace;line-height:1.2;font-size:1rem"><code class="language-json" style="white-space:pre"><span class="token token punctuation">{</span><span> </span><span> </span><span class="token token property">"references"</span><span class="token token operator">:</span><span> </span><span class="token token punctuation">{</span><span> </span><span class="token token" style="color:#51763e">"any"</span><span> </span><span class="token token punctuation">}</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"link"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"id"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"long_url"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"title"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"archived"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"boolean"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"created_at"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"created_by"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"client_id"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"custom_bitlinks"</span><span class="token token operator">:</span><span> </span><span class="token token punctuation">[</span><span> </span><span> </span><span class="token token" style="color:#51763e">"string"</span><span> </span><span> </span><span class="token token punctuation">]</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"tags"</span><span class="token token operator">:</span><span> </span><span class="token token punctuation">[</span><span> </span><span> </span><span class="token token" style="color:#51763e">"string"</span><span> </span><span> </span><span class="token token punctuation">]</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"launchpad_ids"</span><span class="token token operator">:</span><span> </span><span class="token token punctuation">[</span><span> </span><span> </span><span class="token token" style="color:#51763e">"string"</span><span> </span><span> </span><span class="token token punctuation">]</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"qr_code_ids"</span><span class="token token operator">:</span><span> </span><span class="token token punctuation">[</span><span> </span><span> </span><span class="token token" style="color:#51763e">"string"</span><span> </span><span> </span><span class="token token punctuation">]</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"deeplinks"</span><span class="token token operator">:</span><span> </span><span class="token token punctuation">[</span><span> </span><span> </span><span class="token token punctuation">{</span><span> </span><span> </span><span class="token token property">"guid"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"bitlink"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"app_uri_path"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"install_url"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"app_guid"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"os"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"install_type"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"created"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"modified"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"brand_guid"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span> </span><span> </span><span class="token token punctuation">}</span><span> </span><span> </span><span class="token token punctuation">]</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"campaign_ids"</span><span class="token token operator">:</span><span> </span><span class="token token punctuation">[</span><span> </span><span> </span><span class="token token" style="color:#51763e">"string"</span><span> </span><span> </span><span class="token token punctuation">]</span><span> </span><span></span><span class="token token punctuation">}</span></code></pre></div></div></div></div></div><div class="MethodDetail_methodContainer__3EF7h" id="deleteBitlink"><div class="MethodDetail_method__fyEiw"><div><h3 class="MethodHeader_h3__seOfC">Delete a Bitlink</h3><h4 class="MethodHeader_description__3_p_p"><div class="MethodHeader_iconStyle__x5Ow4"><svg viewBox="0 0 28 6" xmlns="http://www.w3.org/2000/svg" class="IconRest_restIcon__3pju8 delete"><title>Delete</title><path d="M1.439 6c.54 0 .984-.087 1.33-.262.345-.175.616-.405.811-.69.196-.287.331-.612.406-.979.075-.366.113-.74.113-1.123 0-.422-.038-.811-.113-1.17a2.419 2.419 0 0 0-.398-.931 1.918 1.918 0 0 0-.775-.62C2.486.075 2.073 0 1.575 0c-.128 0-.274.003-.438.008C.974.014.816.021.663.03A11.118 11.118 0 0 0 0 .083v5.834c.07.01.169.02.297.029L.7 5.97c.14.008.276.015.41.02.134.006.244.009.33.009Zm.128-1.015c-.027 0-.061-.002-.104-.004a35.064 35.064 0 0 0-.133-.009l-.067-.004-.066-.004a.56.56 0 0 1-.096-.013V1.05c.048-.006.12-.013.217-.021.096-.009.196-.013.297-.013.306 0 .547.061.724.183.176.122.31.278.398.466.088.189.144.397.168.624a6.241 6.241 0 0 1-.004 1.39 2.07 2.07 0 0 1-.177.658c-.09.194-.229.35-.413.47-.185.12-.433.179-.744.179Zm7.145.923V4.893H6.084V3.47H8.47V2.455H6.084V1.098h2.588V.083h-3.69v5.825h3.73Zm4.854 0V3.537h-.997v1.356H10.97V.083h-1.1v5.825h3.696Zm4.79 0V4.893h-2.628V3.47h2.387V2.455h-2.387V1.098h2.588V.083h-3.69v5.825h3.73Zm4.404 0v-.915h-.908V1h.763v1.007h.884V.083h-4.404v1.923h.884V.999h.772v3.994h-.916v.915h2.925Zm5.24 0V4.893h-2.628V3.47h2.387V2.455h-2.387V1.098h2.588V.083H24.27v5.825H28Z"></path></svg></div> /v4/bitlinks/{bitlink}</h4><p class="MethodHeader_description__3_p_p">Delete an unedited hash Bitlink.</p></div><div><h4 class="ParameterList_h4__nH9G8 ParameterList_dividing__wRGRx">Path Parameters</h4><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">bitlink</span><span class="Parameter_type__djM_s">string</span><span class="Parameter_required__pcK_H">Required</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">A Bitlink made of the domain and hash</div></div></div></div><div class="MethodDetail_examples__8nXeM"><div><label class="CodeSyntaxSelector_header__6P_Jc CodeSyntaxSelector_headerDark__hI3A0"><span>Request</span><div class="CodeSyntaxSelector_header__6P_Jc CodeSyntaxSelector_headerDark__hI3A0"><div class="Select_wrapper__58utF Select_dark__KPIws"><select class="Select_select__qXz_Z Select_dark__KPIws" aria-label="Select" autoComplete="off"><option value="cURL" selected="">cURL</option><option value="Node">Node</option><option value="Browser">Browser</option><option value="Go">Go</option><option value="Python">Python</option></select><svg viewBox="0 0 8 14" xmlns="http://www.w3.org/2000/svg"><path d="M6.463 7 .987 1.66a.61.61 0 0 1 0-.878.648.648 0 0 1 .9 0L7.813 6.56a.61.61 0 0 1 0 .878l-5.926 5.78a.648.648 0 0 1-.9 0 .61.61 0 0 1 0-.879L6.463 7Z"></path></svg></div></div></label><div class="CodeSyntaxSelector_body__hBJ7j CodeSyntaxSelector_bodyDark__cizVw"><div class="CodeBlock_codeBlock__KlURa"><pre tabindex="0" style="color:#ffffff;font-family:ProximaNova, monospace;line-height:1.2;font-size:1rem"><code class="language-bash" style="white-space:pre"><span class="token token" style="color:#ee6123">curl</span><span> </span><span class="token token punctuation">\</span><span> </span><span>-H </span><span class="token token" style="color:#acda95">'Authorization: Bearer {TOKEN}'</span><span> </span><span class="token token punctuation">\</span><span> </span><span>-X DELETE </span><span class="token token punctuation">\</span><span> </span>https://api-ssl.bitly.com/v4/bitlinks/bit.ly/12a4b6c</code></pre></div></div></div><div><label class="CodeSyntaxSelector_header__6P_Jc"><span>Response</span><div class="CodeSyntaxSelector_header__6P_Jc"><div class="Select_wrapper__58utF"><select class="Select_select__qXz_Z" aria-label="Select" autoComplete="off"><option value="200" selected="">200 SUCCESS</option><option value="400">400 BAD_REQUEST</option><option value="403">403 FORBIDDEN</option><option value="404">404 NOT_FOUND</option><option value="429">429 MONTHLY_LIMIT_EXCEEDED</option><option value="500">500 INTERNAL_ERROR</option><option value="503">503 TEMPORARILY_UNAVAILABLE</option></select><svg viewBox="0 0 8 14" xmlns="http://www.w3.org/2000/svg"><path d="M6.463 7 .987 1.66a.61.61 0 0 1 0-.878.648.648 0 0 1 .9 0L7.813 6.56a.61.61 0 0 1 0 .878l-5.926 5.78a.648.648 0 0 1-.9 0 .61.61 0 0 1 0-.879L6.463 7Z"></path></svg></div></div></label><div class="CodeSyntaxSelector_body__hBJ7j"><div class="CodeBlock_codeBlock__KlURa"><pre tabindex="0" style="color:#36383b;font-family:ProximaNova, monospace;line-height:1.2;font-size:1rem"><code class="language-json" style="white-space:pre"><span class="token token punctuation">{</span><span> </span><span> </span><span class="token token property">"links_deleted"</span><span class="token token operator">:</span><span> </span><span class="token token punctuation">[</span><span> </span><span> </span><span class="token token punctuation">{</span><span> </span><span> </span><span class="token token property">"id"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span> </span><span> </span><span class="token token punctuation">}</span><span> </span><span> </span><span class="token token punctuation">]</span><span> </span><span></span><span class="token token punctuation">}</span></code></pre></div></div></div></div></div><div class="MethodDetail_methodContainer__3EF7h" id="updateBitlink"><div class="MethodDetail_method__fyEiw"><div><h3 class="MethodHeader_h3__seOfC">Update a Bitlink</h3><h4 class="MethodHeader_description__3_p_p"><div class="MethodHeader_iconStyle__x5Ow4"><svg viewBox="0 0 23 6" xmlns="http://www.w3.org/2000/svg" class="IconRest_restIcon__3pju8 patch"><title>Patch</title><path d="M1.095 5.885V3.898c.027.006.07.011.132.017a4.052 4.052 0 0 0 .372.016h.128c.277 0 .545-.037.803-.11.259-.075.49-.193.692-.355.202-.162.365-.368.487-.618.123-.25.184-.551.184-.903 0-.401-.07-.727-.212-.977a1.606 1.606 0 0 0-.547-.585 2.041 2.041 0 0 0-.756-.28 5.067 5.067 0 0 0-.835-.07c-.267 0-.534.012-.804.037C.47.095.224.13 0 .173v5.712h1.095Zm.472-2.934h-.1a2.448 2.448 0 0 1-.276-.017.853.853 0 0 1-.096-.016V1.047c.059-.011.136-.02.232-.03.096-.007.197-.012.304-.012.138 0 .274.014.408.042a.964.964 0 0 1 .355.148.801.801 0 0 1 .252.284.937.937 0 0 1 .096.45c0 .214-.033.387-.1.519a.787.787 0 0 1-.268.309 1.038 1.038 0 0 1-.38.152 2.235 2.235 0 0 1-.427.042Zm3.79 2.934.383-1.278h1.67l.4 1.278h1.152L7.163.115H6.068L4.26 5.885h1.095ZM7.194 3.7h-1.2l.56-1.929h.072l.568 1.929Zm5.668 2.184v-.907h-.903V1.022h.76v.997h.879V.115H9.218V2.02h.879v-.997h.767v3.956h-.91v.907h2.91Zm3.91.115c.276 0 .547-.036.81-.107.265-.072.482-.17.652-.297V3.948h-.88v.997c-.164.033-.335.05-.51.05-.246 0-.464-.049-.656-.145a1.383 1.383 0 0 1-.488-.408 1.881 1.881 0 0 1-.304-.63A2.973 2.973 0 0 1 15.293 3c0-.34.038-.636.112-.886.075-.25.179-.457.312-.622.133-.165.29-.287.468-.367.178-.08.371-.12.58-.12.175 0 .346.014.511.042v.94h.88V.271a2.727 2.727 0 0 0-.548-.19A3.419 3.419 0 0 0 16.796 0c-.303 0-.613.05-.927.152-.314.102-.6.27-.855.503a2.611 2.611 0 0 0-.628.923c-.163.382-.244.856-.244 1.422 0 .544.072 1.007.216 1.389.144.382.336.692.576.931.24.24.518.412.835.52.317.106.652.16 1.003.16Zm3.325-.115V3.47h1.807v2.415H23V.115h-1.095v2.35h-1.807V.114h-1.095v5.77h1.095Z"></path></svg></div> /v4/bitlinks/{bitlink}</h4><p class="MethodHeader_description__3_p_p">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)</p></div><div><h4 class="ParameterList_h4__nH9G8 ParameterList_dividing__wRGRx">Path Parameters</h4><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">bitlink</span><span class="Parameter_type__djM_s">string</span><span class="Parameter_required__pcK_H">Required</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">A Bitlink made of the domain and hash</div></div></div><div><h4 class="ParameterList_h4__nH9G8 ParameterList_dividing__wRGRx">Request Body Schema</h4><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">title</span><span class="Parameter_type__djM_s">string</span></div></div><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">archived</span><span class="Parameter_type__djM_s">boolean</span></div></div><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">tags</span><span class="Parameter_type__djM_s">array of string</span></div></div><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">deeplinks</span><span class="Parameter_type__djM_s">array of object</span></div><div class="Parameter_nestedList__KmKgd"><div class="Parameter_nested__X3i_l"><div class="Parameter_parameter__J0LgW Parameter_compact__V5419"><div><span class="Parameter_name___UYgz">guid</span><span class="Parameter_type__djM_s">string</span></div></div></div><div class="Parameter_nested__X3i_l"><div class="Parameter_parameter__J0LgW Parameter_compact__V5419"><div><span class="Parameter_name___UYgz">bitlink</span><span class="Parameter_type__djM_s">string</span></div></div></div><div class="Parameter_nested__X3i_l"><div class="Parameter_parameter__J0LgW Parameter_compact__V5419"><div><span class="Parameter_name___UYgz">app_uri_path</span><span class="Parameter_type__djM_s">string</span></div></div></div><div class="Parameter_nested__X3i_l"><div class="Parameter_parameter__J0LgW Parameter_compact__V5419"><div><span class="Parameter_name___UYgz">install_url</span><span class="Parameter_type__djM_s">string</span></div></div></div><div class="Parameter_nested__X3i_l"><div class="Parameter_parameter__J0LgW Parameter_compact__V5419"><div><span class="Parameter_name___UYgz">app_guid</span><span class="Parameter_type__djM_s">string</span></div></div></div><div class="Parameter_nested__X3i_l"><div class="Parameter_parameter__J0LgW Parameter_compact__V5419"><div><span class="Parameter_name___UYgz">os</span><span class="Parameter_type__djM_s">string</span></div><div class="Parameter_enum__csO6P Parameter_spacer__JKXbH">Enum: <span class="Parameter_label__DUY7G">"ios"</span><span class="Parameter_label__DUY7G">"android"</span></div></div></div><div class="Parameter_nested__X3i_l"><div class="Parameter_parameter__J0LgW Parameter_compact__V5419"><div><span class="Parameter_name___UYgz">install_type</span><span class="Parameter_type__djM_s">string</span></div><div class="Parameter_enum__csO6P Parameter_spacer__JKXbH">Enum: <span class="Parameter_label__DUY7G">"no_install"</span><span class="Parameter_label__DUY7G">"auto_install"</span><span class="Parameter_label__DUY7G">"promote_install"</span></div></div></div><div class="Parameter_nested__X3i_l"><div class="Parameter_parameter__J0LgW Parameter_compact__V5419"><div><span class="Parameter_name___UYgz">created</span><span class="Parameter_type__djM_s">string</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">ISO timestamp</div></div></div><div class="Parameter_nested__X3i_l"><div class="Parameter_parameter__J0LgW Parameter_compact__V5419"><div><span class="Parameter_name___UYgz">modified</span><span class="Parameter_type__djM_s">string</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">ISO timestamp</div></div></div><div class="Parameter_nested__X3i_l"><div class="Parameter_parameter__J0LgW Parameter_compact__V5419"><div><span class="Parameter_name___UYgz">brand_guid</span><span class="Parameter_type__djM_s">string</span></div></div></div></div></div></div></div><div class="MethodDetail_examples__8nXeM"><div><label class="CodeSyntaxSelector_header__6P_Jc CodeSyntaxSelector_headerDark__hI3A0"><span>Request</span><div class="CodeSyntaxSelector_header__6P_Jc CodeSyntaxSelector_headerDark__hI3A0"><div class="Select_wrapper__58utF Select_dark__KPIws"><select class="Select_select__qXz_Z Select_dark__KPIws" aria-label="Select" autoComplete="off"><option value="cURL" selected="">cURL</option><option value="Node">Node</option><option value="Browser">Browser</option><option value="Go">Go</option><option value="Python">Python</option></select><svg viewBox="0 0 8 14" xmlns="http://www.w3.org/2000/svg"><path d="M6.463 7 .987 1.66a.61.61 0 0 1 0-.878.648.648 0 0 1 .9 0L7.813 6.56a.61.61 0 0 1 0 .878l-5.926 5.78a.648.648 0 0 1-.9 0 .61.61 0 0 1 0-.879L6.463 7Z"></path></svg></div></div></label><div class="CodeSyntaxSelector_body__hBJ7j CodeSyntaxSelector_bodyDark__cizVw"><div class="CodeBlock_codeBlock__KlURa"><pre tabindex="0" style="color:#ffffff;font-family:ProximaNova, monospace;line-height:1.2;font-size:1rem"><code class="language-bash" style="white-space:pre"><span class="token token" style="color:#ee6123">curl</span><span> </span><span class="token token punctuation">\</span><span> </span><span>-H </span><span class="token token" style="color:#acda95">'Authorization: Bearer {TOKEN}'</span><span> </span><span class="token token punctuation">\</span><span> </span><span>-H </span><span class="token token" style="color:#acda95">'Content-Type: application/json'</span><span> </span><span class="token token punctuation">\</span><span> </span><span>-X PATCH </span><span class="token token punctuation">\</span><span> </span><span>-d </span><span class="token token" style="color:#acda95">'{ </span><span class="token token" style="color:#acda95"> "title": "Bitly API Documentation", </span><span class="token token" style="color:#acda95"> "archived": false, </span><span class="token token" style="color:#acda95"> "tags": [ </span><span class="token token" style="color:#acda95"> "bitly", </span><span class="token token" style="color:#acda95"> "api" </span><span class="token token" style="color:#acda95"> ], </span><span class="token token" style="color:#acda95"> "deeplinks": [ </span><span class="token token" style="color:#acda95"> { </span><span class="token token" style="color:#acda95"> "guid": "Ra1bcD2eF3h", </span><span class="token token" style="color:#acda95"> "bitlink": "bit.ly/documentation", </span><span class="token token" style="color:#acda95"> "app_uri_path": "/store?id=123456", </span><span class="token token" style="color:#acda95"> "install_url": "https://play.google.com/store/apps/details?id=com.bitly.app&hl=en_US", </span><span class="token token" style="color:#acda95"> "app_guid": "Ab1cdE2fG3h", </span><span class="token token" style="color:#acda95"> "os": "android", </span><span class="token token" style="color:#acda95"> "install_type": "promote_install", </span><span class="token token" style="color:#acda95"> "brand_guid": "Ba1bc23dE4F" </span><span class="token token" style="color:#acda95"> } </span><span class="token token" style="color:#acda95"> ] </span><span class="token token" style="color:#acda95">}'</span><span> </span><span class="token token punctuation">\</span><span> </span>https://api-ssl.bitly.com/v4/bitlinks/bit.ly/12a4b6c</code></pre></div></div></div><div><label class="CodeSyntaxSelector_header__6P_Jc"><span>Response</span><div class="CodeSyntaxSelector_header__6P_Jc"><div class="Select_wrapper__58utF"><select class="Select_select__qXz_Z" aria-label="Select" autoComplete="off"><option value="200" selected="">200 SUCCESS</option><option value="400">400 BAD_REQUEST</option><option value="402">402 UPGRADE_REQUIRED</option><option value="403">403 FORBIDDEN</option><option value="404">404 NOT_FOUND</option><option value="410">410 GONE</option><option value="422">422 UNPROCESSABLE_ENTITY</option><option value="429">429 MONTHLY_LIMIT_EXCEEDED</option><option value="500">500 INTERNAL_ERROR</option><option value="503">503 TEMPORARILY_UNAVAILABLE</option></select><svg viewBox="0 0 8 14" xmlns="http://www.w3.org/2000/svg"><path d="M6.463 7 .987 1.66a.61.61 0 0 1 0-.878.648.648 0 0 1 .9 0L7.813 6.56a.61.61 0 0 1 0 .878l-5.926 5.78a.648.648 0 0 1-.9 0 .61.61 0 0 1 0-.879L6.463 7Z"></path></svg></div></div></label><div class="CodeSyntaxSelector_body__hBJ7j"><div class="CodeBlock_codeBlock__KlURa"><pre tabindex="0" style="color:#36383b;font-family:ProximaNova, monospace;line-height:1.2;font-size:1rem"><code class="language-json" style="white-space:pre"><span class="token token punctuation">{</span><span> </span><span> </span><span class="token token property">"references"</span><span class="token token operator">:</span><span> </span><span class="token token punctuation">{</span><span> </span><span class="token token" style="color:#51763e">"any"</span><span> </span><span class="token token punctuation">}</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"link"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"id"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"long_url"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"title"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"archived"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"boolean"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"created_at"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"created_by"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"client_id"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"custom_bitlinks"</span><span class="token token operator">:</span><span> </span><span class="token token punctuation">[</span><span> </span><span> </span><span class="token token" style="color:#51763e">"string"</span><span> </span><span> </span><span class="token token punctuation">]</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"tags"</span><span class="token token operator">:</span><span> </span><span class="token token punctuation">[</span><span> </span><span> </span><span class="token token" style="color:#51763e">"string"</span><span> </span><span> </span><span class="token token punctuation">]</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"launchpad_ids"</span><span class="token token operator">:</span><span> </span><span class="token token punctuation">[</span><span> </span><span> </span><span class="token token" style="color:#51763e">"string"</span><span> </span><span> </span><span class="token token punctuation">]</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"qr_code_ids"</span><span class="token token operator">:</span><span> </span><span class="token token punctuation">[</span><span> </span><span> </span><span class="token token" style="color:#51763e">"string"</span><span> </span><span> </span><span class="token token punctuation">]</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"deeplinks"</span><span class="token token operator">:</span><span> </span><span class="token token punctuation">[</span><span> </span><span> </span><span class="token token punctuation">{</span><span> </span><span> </span><span class="token token property">"guid"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"bitlink"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"app_uri_path"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"install_url"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"app_guid"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"os"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"install_type"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"created"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"modified"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"brand_guid"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span> </span><span> </span><span class="token token punctuation">}</span><span> </span><span> </span><span class="token token punctuation">]</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"campaign_ids"</span><span class="token token operator">:</span><span> </span><span class="token token punctuation">[</span><span> </span><span> </span><span class="token token" style="color:#51763e">"string"</span><span> </span><span> </span><span class="token token punctuation">]</span><span> </span><span></span><span class="token token punctuation">}</span></code></pre></div></div></div></div></div><div class="MethodDetail_methodContainer__3EF7h" id="getBitlink"><div class="MethodDetail_method__fyEiw"><div><h3 class="MethodHeader_h3__seOfC">Retrieve a Bitlink</h3><h4 class="MethodHeader_description__3_p_p"><div class="MethodHeader_iconStyle__x5Ow4"><svg viewBox="0 0 14 6" xmlns="http://www.w3.org/2000/svg" class="IconRest_restIcon__3pju8 get"><title>Get</title><path d="M2.587 6c.307 0 .607-.044.9-.132.295-.088.533-.217.716-.387V2.876H2.271v.825h1.027v1.145a.772.772 0 0 1-.239.1 1.4 1.4 0 0 1-.383.049 1.338 1.338 0 0 1-1.083-.52c-.135-.17-.24-.379-.316-.626a2.879 2.879 0 0 1-.113-.84c0-.352.038-.655.113-.907.076-.253.182-.46.32-.623.137-.162.3-.281.488-.358a1.783 1.783 0 0 1 .97-.082l.13.032v.915h.889V.28a3.182 3.182 0 0 0-.59-.202A3.507 3.507 0 0 0 2.676 0c-.313 0-.628.055-.946.165a2.4 2.4 0 0 0-.861.523 2.707 2.707 0 0 0-.627.92C.081 1.98 0 2.433 0 2.966c0 .506.067.946.202 1.323.135.376.318.692.55.948a2.2 2.2 0 0 0 .82.572A2.7 2.7 0 0 0 2.587 6Zm6.24-.115V4.879H6.184V3.47h2.4V2.465h-2.4V1.121h2.602V.115h-3.71v5.77h3.75Zm4.43 0v-.907h-.914V1.022h.768v.997H14V.115H9.57V2.02h.89v-.997h.776v3.956h-.922v.907h2.942Z"></path></svg></div> /v4/bitlinks/{bitlink}</h4><p class="MethodHeader_description__3_p_p">Returns information for the specified link.</p></div><div><h4 class="ParameterList_h4__nH9G8 ParameterList_dividing__wRGRx">Path Parameters</h4><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">bitlink</span><span class="Parameter_type__djM_s">string</span><span class="Parameter_required__pcK_H">Required</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">A Bitlink made of the domain and hash</div></div></div></div><div class="MethodDetail_examples__8nXeM"><div><label class="CodeSyntaxSelector_header__6P_Jc CodeSyntaxSelector_headerDark__hI3A0"><span>Request</span><div class="CodeSyntaxSelector_header__6P_Jc CodeSyntaxSelector_headerDark__hI3A0"><div class="Select_wrapper__58utF Select_dark__KPIws"><select class="Select_select__qXz_Z Select_dark__KPIws" aria-label="Select" autoComplete="off"><option value="cURL" selected="">cURL</option><option value="Node">Node</option><option value="Browser">Browser</option><option value="Go">Go</option><option value="Python">Python</option></select><svg viewBox="0 0 8 14" xmlns="http://www.w3.org/2000/svg"><path d="M6.463 7 .987 1.66a.61.61 0 0 1 0-.878.648.648 0 0 1 .9 0L7.813 6.56a.61.61 0 0 1 0 .878l-5.926 5.78a.648.648 0 0 1-.9 0 .61.61 0 0 1 0-.879L6.463 7Z"></path></svg></div></div></label><div class="CodeSyntaxSelector_body__hBJ7j CodeSyntaxSelector_bodyDark__cizVw"><div class="CodeBlock_codeBlock__KlURa"><pre tabindex="0" style="color:#ffffff;font-family:ProximaNova, monospace;line-height:1.2;font-size:1rem"><code class="language-bash" style="white-space:pre"><span class="token token" style="color:#ee6123">curl</span><span> </span><span class="token token punctuation">\</span><span> </span><span>-H </span><span class="token token" style="color:#acda95">'Authorization: Bearer {TOKEN}'</span><span> </span><span class="token token punctuation">\</span><span> </span><span>-X GET </span><span class="token token punctuation">\</span><span> </span>https://api-ssl.bitly.com/v4/bitlinks/bit.ly/12a4b6c</code></pre></div></div></div><div><label class="CodeSyntaxSelector_header__6P_Jc"><span>Response</span><div class="CodeSyntaxSelector_header__6P_Jc"><div class="Select_wrapper__58utF"><select class="Select_select__qXz_Z" aria-label="Select" autoComplete="off"><option value="200" selected="">200 SUCCESS</option><option value="403">403 FORBIDDEN</option><option value="404">404 NOT_FOUND</option><option value="410">410 GONE</option><option value="429">429 MONTHLY_LIMIT_EXCEEDED</option><option value="500">500 INTERNAL_ERROR</option><option value="503">503 TEMPORARILY_UNAVAILABLE</option></select><svg viewBox="0 0 8 14" xmlns="http://www.w3.org/2000/svg"><path d="M6.463 7 .987 1.66a.61.61 0 0 1 0-.878.648.648 0 0 1 .9 0L7.813 6.56a.61.61 0 0 1 0 .878l-5.926 5.78a.648.648 0 0 1-.9 0 .61.61 0 0 1 0-.879L6.463 7Z"></path></svg></div></div></label><div class="CodeSyntaxSelector_body__hBJ7j"><div class="CodeBlock_codeBlock__KlURa"><pre tabindex="0" style="color:#36383b;font-family:ProximaNova, monospace;line-height:1.2;font-size:1rem"><code class="language-json" style="white-space:pre"><span class="token token punctuation">{</span><span> </span><span> </span><span class="token token property">"references"</span><span class="token token operator">:</span><span> </span><span class="token token punctuation">{</span><span> </span><span class="token token" style="color:#51763e">"any"</span><span> </span><span class="token token punctuation">}</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"link"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"id"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"long_url"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"title"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"archived"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"boolean"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"created_at"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"created_by"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"client_id"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"custom_bitlinks"</span><span class="token token operator">:</span><span> </span><span class="token token punctuation">[</span><span> </span><span> </span><span class="token token" style="color:#51763e">"string"</span><span> </span><span> </span><span class="token token punctuation">]</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"tags"</span><span class="token token operator">:</span><span> </span><span class="token token punctuation">[</span><span> </span><span> </span><span class="token token" style="color:#51763e">"string"</span><span> </span><span> </span><span class="token token punctuation">]</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"launchpad_ids"</span><span class="token token operator">:</span><span> </span><span class="token token punctuation">[</span><span> </span><span> </span><span class="token token" style="color:#51763e">"string"</span><span> </span><span> </span><span class="token token punctuation">]</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"qr_code_ids"</span><span class="token token operator">:</span><span> </span><span class="token token punctuation">[</span><span> </span><span> </span><span class="token token" style="color:#51763e">"string"</span><span> </span><span> </span><span class="token token punctuation">]</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"deeplinks"</span><span class="token token operator">:</span><span> </span><span class="token token punctuation">[</span><span> </span><span> </span><span class="token token punctuation">{</span><span> </span><span> </span><span class="token token property">"guid"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"bitlink"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"app_uri_path"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"install_url"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"app_guid"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"os"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"install_type"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"created"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"modified"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"brand_guid"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span> </span><span> </span><span class="token token punctuation">}</span><span> </span><span> </span><span class="token token punctuation">]</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"campaign_ids"</span><span class="token token operator">:</span><span> </span><span class="token token punctuation">[</span><span> </span><span> </span><span class="token token" style="color:#51763e">"string"</span><span> </span><span> </span><span class="token token punctuation">]</span><span> </span><span></span><span class="token token punctuation">}</span></code></pre></div></div></div></div></div><div class="MethodDetail_methodContainer__3EF7h" id="expandBitlink"><div class="MethodDetail_method__fyEiw"><div><h3 class="MethodHeader_h3__seOfC">Expand a Bitlink</h3><h4 class="MethodHeader_description__3_p_p"><div class="MethodHeader_iconStyle__x5Ow4"><svg viewBox="0 0 18 6" xmlns="http://www.w3.org/2000/svg" class="IconRest_restIcon__3pju8 post"><title>Post</title><path d="M1.072 5.885V3.898c.026.006.069.011.129.017a3.88 3.88 0 0 0 .364.016h.125c.27 0 .533-.037.786-.11.253-.075.478-.193.677-.355.198-.162.357-.368.477-.618s.18-.551.18-.903c0-.401-.07-.727-.208-.977a1.592 1.592 0 0 0-.536-.585 1.971 1.971 0 0 0-.739-.28 4.854 4.854 0 0 0-.817-.07C1.249.033.987.045.724.07.46.095.219.13 0 .173v5.712h1.072Zm.461-2.934h-.098a2.344 2.344 0 0 1-.27-.017.818.818 0 0 1-.093-.016V1.047c.057-.011.133-.02.227-.03.093-.007.193-.012.297-.012.135 0 .268.014.399.042.13.027.246.077.348.148a.796.796 0 0 1 .246.284.954.954 0 0 1 .094.45c0 .214-.032.387-.098.519a.782.782 0 0 1-.262.309c-.11.074-.233.125-.371.152a2.141 2.141 0 0 1-.419.042ZM6.47 6c.694 0 1.212-.265 1.553-.795.342-.53.513-1.265.513-2.205 0-.44-.038-.843-.114-1.212a2.872 2.872 0 0 0-.36-.947 1.78 1.78 0 0 0-.637-.618C7.163.074 6.844 0 6.469 0c-.35 0-.653.069-.911.206a1.78 1.78 0 0 0-.645.59c-.172.255-.3.57-.384.943A5.804 5.804 0 0 0 4.404 3c0 .44.037.843.11 1.212.073.368.191.684.356.947.164.264.378.47.641.618.263.149.583.223.958.223Zm0-1.005c-.203 0-.366-.053-.489-.157a.989.989 0 0 1-.281-.425 2.57 2.57 0 0 1-.133-.63A8.129 8.129 0 0 1 5.53 3c0-.66.065-1.157.195-1.492.13-.335.378-.503.743-.503.209 0 .376.054.501.161a1 1 0 0 1 .286.433c.065.181.106.393.125.635.018.241.027.497.027.766 0 .34-.014.636-.043.886-.029.25-.08.457-.152.622a.826.826 0 0 1-.29.367.803.803 0 0 1-.454.12ZM10.991 6c.297 0 .574-.037.83-.111.255-.074.476-.187.664-.338.188-.151.334-.338.438-.56.104-.223.157-.483.157-.78 0-.307-.067-.563-.2-.766a1.814 1.814 0 0 0-.493-.507 3.3 3.3 0 0 0-.641-.342 11.165 11.165 0 0 1-.642-.28 2.185 2.185 0 0 1-.493-.313.562.562 0 0 1-.199-.445c0-.176.072-.316.215-.42.144-.105.34-.157.59-.157a2.757 2.757 0 0 1 .767.107.14.14 0 0 0 .047.008v.915h.86V.338a2.45 2.45 0 0 0-.735-.247C11.85.03 11.536 0 11.218 0c-.282 0-.537.041-.767.124-.23.082-.426.197-.59.346A1.557 1.557 0 0 0 9.476 1a1.66 1.66 0 0 0-.137.68c0 .324.067.588.2.792.133.203.297.372.493.506.195.135.409.246.641.334.232.088.446.176.642.264.195.088.36.19.492.305.133.115.2.266.2.453 0 .209-.081.375-.243.499-.161.123-.388.185-.68.185-.162 0-.314-.018-.458-.053a2.256 2.256 0 0 1-.395-.136l-.047-.017v-.816h-.86V5.53c.067.039.156.085.266.14.11.055.236.107.379.157.143.05.3.09.47.124.169.033.353.049.55.049Zm6.29-.115v-.907h-.885V1.022h.744v.997H18V.115h-4.287V2.02h.86v-.997h.752v3.956h-.892v.907h2.847Z"></path></svg></div> /v4/expand</h4><p class="MethodHeader_description__3_p_p">Returns the short link and long URL for the specified link.</p></div><div><h4 class="ParameterList_h4__nH9G8 ParameterList_dividing__wRGRx">Request Body Schema</h4><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">bitlink_id</span><span class="Parameter_type__djM_s">string</span></div></div></div></div><div class="MethodDetail_examples__8nXeM"><div><label class="CodeSyntaxSelector_header__6P_Jc CodeSyntaxSelector_headerDark__hI3A0"><span>Request</span><div class="CodeSyntaxSelector_header__6P_Jc CodeSyntaxSelector_headerDark__hI3A0"><div class="Select_wrapper__58utF Select_dark__KPIws"><select class="Select_select__qXz_Z Select_dark__KPIws" aria-label="Select" autoComplete="off"><option value="cURL" selected="">cURL</option><option value="Node">Node</option><option value="Browser">Browser</option><option value="Go">Go</option><option value="Python">Python</option></select><svg viewBox="0 0 8 14" xmlns="http://www.w3.org/2000/svg"><path d="M6.463 7 .987 1.66a.61.61 0 0 1 0-.878.648.648 0 0 1 .9 0L7.813 6.56a.61.61 0 0 1 0 .878l-5.926 5.78a.648.648 0 0 1-.9 0 .61.61 0 0 1 0-.879L6.463 7Z"></path></svg></div></div></label><div class="CodeSyntaxSelector_body__hBJ7j CodeSyntaxSelector_bodyDark__cizVw"><div class="CodeBlock_codeBlock__KlURa"><pre tabindex="0" style="color:#ffffff;font-family:ProximaNova, monospace;line-height:1.2;font-size:1rem"><code class="language-bash" style="white-space:pre"><span class="token token" style="color:#ee6123">curl</span><span> </span><span class="token token punctuation">\</span><span> </span><span>-H </span><span class="token token" style="color:#acda95">'Authorization: Bearer {TOKEN}'</span><span> </span><span class="token token punctuation">\</span><span> </span><span>-H </span><span class="token token" style="color:#acda95">'Content-Type: application/json'</span><span> </span><span class="token token punctuation">\</span><span> </span><span>-X POST </span><span class="token token punctuation">\</span><span> </span><span>-d </span><span class="token token" style="color:#acda95">'{ </span><span class="token token" style="color:#acda95"> "bitlink_id": "bit.ly/12a4b6c" </span><span class="token token" style="color:#acda95">}'</span><span> </span><span class="token token punctuation">\</span><span> </span>https://api-ssl.bitly.com/v4/expand</code></pre></div></div></div><div><label class="CodeSyntaxSelector_header__6P_Jc"><span>Response</span><div class="CodeSyntaxSelector_header__6P_Jc"><div class="Select_wrapper__58utF"><select class="Select_select__qXz_Z" aria-label="Select" autoComplete="off"><option value="200" selected="">200 SUCCESS</option><option value="400">400 BAD_REQUEST</option><option value="404">404 NOT_FOUND</option><option value="410">410 GONE</option><option value="422">422 UNPROCESSABLE_ENTITY</option><option value="500">500 INTERNAL_ERROR</option><option value="503">503 TEMPORARILY_UNAVAILABLE</option></select><svg viewBox="0 0 8 14" xmlns="http://www.w3.org/2000/svg"><path d="M6.463 7 .987 1.66a.61.61 0 0 1 0-.878.648.648 0 0 1 .9 0L7.813 6.56a.61.61 0 0 1 0 .878l-5.926 5.78a.648.648 0 0 1-.9 0 .61.61 0 0 1 0-.879L6.463 7Z"></path></svg></div></div></label><div class="CodeSyntaxSelector_body__hBJ7j"><div class="CodeBlock_codeBlock__KlURa"><pre tabindex="0" style="color:#36383b;font-family:ProximaNova, monospace;line-height:1.2;font-size:1rem"><code class="language-json" style="white-space:pre"><span class="token token punctuation">{</span><span> </span><span> </span><span class="token token property">"link"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"id"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"long_url"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"created_at"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span> </span><span></span><span class="token token punctuation">}</span></code></pre></div></div></div></div></div><div class="MethodDetail_methodContainer__3EF7h" id="getClicksForBitlink"><div class="MethodDetail_method__fyEiw"><div><h3 class="MethodHeader_h3__seOfC">Get Clicks for a Bitlink</h3><h4 class="MethodHeader_description__3_p_p"><div class="MethodHeader_iconStyle__x5Ow4"><svg viewBox="0 0 14 6" xmlns="http://www.w3.org/2000/svg" class="IconRest_restIcon__3pju8 get"><title>Get</title><path d="M2.587 6c.307 0 .607-.044.9-.132.295-.088.533-.217.716-.387V2.876H2.271v.825h1.027v1.145a.772.772 0 0 1-.239.1 1.4 1.4 0 0 1-.383.049 1.338 1.338 0 0 1-1.083-.52c-.135-.17-.24-.379-.316-.626a2.879 2.879 0 0 1-.113-.84c0-.352.038-.655.113-.907.076-.253.182-.46.32-.623.137-.162.3-.281.488-.358a1.783 1.783 0 0 1 .97-.082l.13.032v.915h.889V.28a3.182 3.182 0 0 0-.59-.202A3.507 3.507 0 0 0 2.676 0c-.313 0-.628.055-.946.165a2.4 2.4 0 0 0-.861.523 2.707 2.707 0 0 0-.627.92C.081 1.98 0 2.433 0 2.966c0 .506.067.946.202 1.323.135.376.318.692.55.948a2.2 2.2 0 0 0 .82.572A2.7 2.7 0 0 0 2.587 6Zm6.24-.115V4.879H6.184V3.47h2.4V2.465h-2.4V1.121h2.602V.115h-3.71v5.77h3.75Zm4.43 0v-.907h-.914V1.022h.768v.997H14V.115H9.57V2.02h.89v-.997h.776v3.956h-.922v.907h2.942Z"></path></svg></div> /v4/bitlinks/{bitlink}/clicks</h4><p class="MethodHeader_description__3_p_p">Returns the click counts for the specified link in an array based on a date.</p></div><div><h4 class="ParameterList_h4__nH9G8 ParameterList_dividing__wRGRx">Path Parameters</h4><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">bitlink</span><span class="Parameter_type__djM_s">string</span><span class="Parameter_required__pcK_H">Required</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">A Bitlink made of the domain and hash</div></div></div><div><h4 class="ParameterList_h4__nH9G8 ParameterList_dividing__wRGRx">Query Parameters</h4><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">unit</span><span class="Parameter_type__djM_s">string</span><span class="Parameter_required__pcK_H">Required</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">A unit of time</div><div class="Parameter_default__HHgG0 Parameter_spacer__JKXbH">Default: <span class="Parameter_label__DUY7G">"day"</span></div><div class="Parameter_enum__csO6P Parameter_spacer__JKXbH">Enum: <span class="Parameter_label__DUY7G">"minute"</span><span class="Parameter_label__DUY7G">"hour"</span><span class="Parameter_label__DUY7G">"day"</span><span class="Parameter_label__DUY7G">"week"</span><span class="Parameter_label__DUY7G">"month"</span></div></div><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">units</span><span class="Parameter_type__djM_s">integer</span><span class="Parameter_required__pcK_H">Required</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">An integer representing the time units to query data for. pass -1 to return all units of time</div><div class="Parameter_default__HHgG0 Parameter_spacer__JKXbH">Default: <span class="Parameter_label__DUY7G">-1</span></div></div><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">unit_reference</span><span class="Parameter_type__djM_s">string</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">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)</div></div></div></div><div class="MethodDetail_examples__8nXeM"><div><label class="CodeSyntaxSelector_header__6P_Jc CodeSyntaxSelector_headerDark__hI3A0"><span>Request</span><div class="CodeSyntaxSelector_header__6P_Jc CodeSyntaxSelector_headerDark__hI3A0"><div class="Select_wrapper__58utF Select_dark__KPIws"><select class="Select_select__qXz_Z Select_dark__KPIws" aria-label="Select" autoComplete="off"><option value="cURL" selected="">cURL</option><option value="Node">Node</option><option value="Browser">Browser</option><option value="Go">Go</option><option value="Python">Python</option></select><svg viewBox="0 0 8 14" xmlns="http://www.w3.org/2000/svg"><path d="M6.463 7 .987 1.66a.61.61 0 0 1 0-.878.648.648 0 0 1 .9 0L7.813 6.56a.61.61 0 0 1 0 .878l-5.926 5.78a.648.648 0 0 1-.9 0 .61.61 0 0 1 0-.879L6.463 7Z"></path></svg></div></div></label><div class="CodeSyntaxSelector_body__hBJ7j CodeSyntaxSelector_bodyDark__cizVw"><div class="CodeBlock_codeBlock__KlURa"><pre tabindex="0" style="color:#ffffff;font-family:ProximaNova, monospace;line-height:1.2;font-size:1rem"><code class="language-bash" style="white-space:pre"><span class="token token" style="color:#ee6123">curl</span><span> </span><span class="token token punctuation">\</span><span> </span><span>-H </span><span class="token token" style="color:#acda95">'Authorization: Bearer {TOKEN}'</span><span> </span><span class="token token punctuation">\</span><span> </span><span>-X GET </span><span class="token token punctuation">\</span><span> </span><span>https://api-ssl.bitly.com/v4/bitlinks/bit.ly/12a4b6c/clicks?unit</span><span class="token token operator">=</span><span>month</span><span class="token token operator">&</span><span class="token token assign-left variable">units</span><span class="token token operator">=</span><span class="token token" style="color:#a1b8f3">1</span><span class="token token operator">&</span><span class="token token assign-left variable">unit_reference</span><span class="token token operator">=</span><span class="token token" style="color:#a1b8f3">2006</span><span>-01-02T15%3A04%3A05-0700</span></code></pre></div></div></div><div><label class="CodeSyntaxSelector_header__6P_Jc"><span>Response</span><div class="CodeSyntaxSelector_header__6P_Jc"><div class="Select_wrapper__58utF"><select class="Select_select__qXz_Z" aria-label="Select" autoComplete="off"><option value="200" selected="">200 SUCCESS</option><option value="403">403 FORBIDDEN</option><option value="404">404 NOT_FOUND</option><option value="429">429 MONTHLY_LIMIT_EXCEEDED</option><option value="500">500 INTERNAL_ERROR</option><option value="503">503 TEMPORARILY_UNAVAILABLE</option></select><svg viewBox="0 0 8 14" xmlns="http://www.w3.org/2000/svg"><path d="M6.463 7 .987 1.66a.61.61 0 0 1 0-.878.648.648 0 0 1 .9 0L7.813 6.56a.61.61 0 0 1 0 .878l-5.926 5.78a.648.648 0 0 1-.9 0 .61.61 0 0 1 0-.879L6.463 7Z"></path></svg></div></div></label><div class="CodeSyntaxSelector_body__hBJ7j"><div class="Response_formatSelect__Wt_qa"><div class="ButtonToggle_buttonToggle__6YJhd"><label class="ButtonToggle_label__ohGaG"><input class="ButtonToggle_input__vkfUm" name="getClicksForBitlink" type="radio" checked=""/><span>json</span></label><label class="ButtonToggle_label__ohGaG"><input class="ButtonToggle_input__vkfUm" name="getClicksForBitlink" type="radio"/><span>csv</span></label></div></div><div class="CodeBlock_codeBlock__KlURa"><pre tabindex="0" style="color:#36383b;font-family:ProximaNova, monospace;line-height:1.2;font-size:1rem"><code class="language-json" style="white-space:pre"><span class="token token punctuation">{</span><span> </span><span> </span><span class="token token property">"link_clicks"</span><span class="token token operator">:</span><span> </span><span class="token token punctuation">[</span><span> </span><span> </span><span class="token token punctuation">{</span><span> </span><span> </span><span class="token token property">"clicks"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"integer"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"date"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span> </span><span> </span><span class="token token punctuation">}</span><span> </span><span> </span><span class="token token punctuation">]</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"units"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"integer"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"unit"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"unit_reference"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span> </span><span></span><span class="token token punctuation">}</span></code></pre></div></div></div></div></div><div class="MethodDetail_methodContainer__3EF7h" id="getClicksSummaryForBitlink"><div class="MethodDetail_method__fyEiw"><div><h3 class="MethodHeader_h3__seOfC">Get a Clicks Summary for a Bitlink</h3><h4 class="MethodHeader_description__3_p_p"><div class="MethodHeader_iconStyle__x5Ow4"><svg viewBox="0 0 14 6" xmlns="http://www.w3.org/2000/svg" class="IconRest_restIcon__3pju8 get"><title>Get</title><path d="M2.587 6c.307 0 .607-.044.9-.132.295-.088.533-.217.716-.387V2.876H2.271v.825h1.027v1.145a.772.772 0 0 1-.239.1 1.4 1.4 0 0 1-.383.049 1.338 1.338 0 0 1-1.083-.52c-.135-.17-.24-.379-.316-.626a2.879 2.879 0 0 1-.113-.84c0-.352.038-.655.113-.907.076-.253.182-.46.32-.623.137-.162.3-.281.488-.358a1.783 1.783 0 0 1 .97-.082l.13.032v.915h.889V.28a3.182 3.182 0 0 0-.59-.202A3.507 3.507 0 0 0 2.676 0c-.313 0-.628.055-.946.165a2.4 2.4 0 0 0-.861.523 2.707 2.707 0 0 0-.627.92C.081 1.98 0 2.433 0 2.966c0 .506.067.946.202 1.323.135.376.318.692.55.948a2.2 2.2 0 0 0 .82.572A2.7 2.7 0 0 0 2.587 6Zm6.24-.115V4.879H6.184V3.47h2.4V2.465h-2.4V1.121h2.602V.115h-3.71v5.77h3.75Zm4.43 0v-.907h-.914V1.022h.768v.997H14V.115H9.57V2.02h.89v-.997h.776v3.956h-.922v.907h2.942Z"></path></svg></div> /v4/bitlinks/{bitlink}/clicks/summary</h4><p class="MethodHeader_description__3_p_p">Returns the click counts for the specified link rolled up into a single field.</p></div><div><h4 class="ParameterList_h4__nH9G8 ParameterList_dividing__wRGRx">Path Parameters</h4><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">bitlink</span><span class="Parameter_type__djM_s">string</span><span class="Parameter_required__pcK_H">Required</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">A Bitlink made of the domain and hash</div></div></div><div><h4 class="ParameterList_h4__nH9G8 ParameterList_dividing__wRGRx">Query Parameters</h4><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">unit</span><span class="Parameter_type__djM_s">string</span><span class="Parameter_required__pcK_H">Required</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">A unit of time</div><div class="Parameter_default__HHgG0 Parameter_spacer__JKXbH">Default: <span class="Parameter_label__DUY7G">"day"</span></div><div class="Parameter_enum__csO6P Parameter_spacer__JKXbH">Enum: <span class="Parameter_label__DUY7G">"minute"</span><span class="Parameter_label__DUY7G">"hour"</span><span class="Parameter_label__DUY7G">"day"</span><span class="Parameter_label__DUY7G">"week"</span><span class="Parameter_label__DUY7G">"month"</span></div></div><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">units</span><span class="Parameter_type__djM_s">integer</span><span class="Parameter_required__pcK_H">Required</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">An integer representing the time units to query data for. pass -1 to return all units of time</div><div class="Parameter_default__HHgG0 Parameter_spacer__JKXbH">Default: <span class="Parameter_label__DUY7G">-1</span></div></div><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">unit_reference</span><span class="Parameter_type__djM_s">string</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">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)</div></div></div></div><div class="MethodDetail_examples__8nXeM"><div><label class="CodeSyntaxSelector_header__6P_Jc CodeSyntaxSelector_headerDark__hI3A0"><span>Request</span><div class="CodeSyntaxSelector_header__6P_Jc CodeSyntaxSelector_headerDark__hI3A0"><div class="Select_wrapper__58utF Select_dark__KPIws"><select class="Select_select__qXz_Z Select_dark__KPIws" aria-label="Select" autoComplete="off"><option value="cURL" selected="">cURL</option><option value="Node">Node</option><option value="Browser">Browser</option><option value="Go">Go</option><option value="Python">Python</option></select><svg viewBox="0 0 8 14" xmlns="http://www.w3.org/2000/svg"><path d="M6.463 7 .987 1.66a.61.61 0 0 1 0-.878.648.648 0 0 1 .9 0L7.813 6.56a.61.61 0 0 1 0 .878l-5.926 5.78a.648.648 0 0 1-.9 0 .61.61 0 0 1 0-.879L6.463 7Z"></path></svg></div></div></label><div class="CodeSyntaxSelector_body__hBJ7j CodeSyntaxSelector_bodyDark__cizVw"><div class="CodeBlock_codeBlock__KlURa"><pre tabindex="0" style="color:#ffffff;font-family:ProximaNova, monospace;line-height:1.2;font-size:1rem"><code class="language-bash" style="white-space:pre"><span class="token token" style="color:#ee6123">curl</span><span> </span><span class="token token punctuation">\</span><span> </span><span>-H </span><span class="token token" style="color:#acda95">'Authorization: Bearer {TOKEN}'</span><span> </span><span class="token token punctuation">\</span><span> </span><span>-X GET </span><span class="token token punctuation">\</span><span> </span><span>https://api-ssl.bitly.com/v4/bitlinks/bit.ly/12a4b6c/clicks/summary?unit</span><span class="token token operator">=</span><span>month</span><span class="token token operator">&</span><span class="token token assign-left variable">units</span><span class="token token operator">=</span><span class="token token" style="color:#a1b8f3">1</span><span class="token token operator">&</span><span class="token token assign-left variable">unit_reference</span><span class="token token operator">=</span><span class="token token" style="color:#a1b8f3">2006</span><span>-01-02T15%3A04%3A05-0700</span></code></pre></div></div></div><div><label class="CodeSyntaxSelector_header__6P_Jc"><span>Response</span><div class="CodeSyntaxSelector_header__6P_Jc"><div class="Select_wrapper__58utF"><select class="Select_select__qXz_Z" aria-label="Select" autoComplete="off"><option value="200" selected="">200 SUCCESS</option><option value="403">403 FORBIDDEN</option><option value="404">404 NOT_FOUND</option><option value="429">429 MONTHLY_LIMIT_EXCEEDED</option><option value="500">500 INTERNAL_ERROR</option><option value="503">503 TEMPORARILY_UNAVAILABLE</option></select><svg viewBox="0 0 8 14" xmlns="http://www.w3.org/2000/svg"><path d="M6.463 7 .987 1.66a.61.61 0 0 1 0-.878.648.648 0 0 1 .9 0L7.813 6.56a.61.61 0 0 1 0 .878l-5.926 5.78a.648.648 0 0 1-.9 0 .61.61 0 0 1 0-.879L6.463 7Z"></path></svg></div></div></label><div class="CodeSyntaxSelector_body__hBJ7j"><div class="CodeBlock_codeBlock__KlURa"><pre tabindex="0" style="color:#36383b;font-family:ProximaNova, monospace;line-height:1.2;font-size:1rem"><code class="language-json" style="white-space:pre"><span class="token token punctuation">{</span><span> </span><span> </span><span class="token token property">"total_clicks"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"integer"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"units"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"integer"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"unit"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"unit_reference"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span> </span><span></span><span class="token token punctuation">}</span></code></pre></div></div></div></div></div><div class="MethodDetail_methodContainer__3EF7h" id="getMetricsForBitlinkByCountries"><div class="MethodDetail_method__fyEiw"><div><h3 class="MethodHeader_h3__seOfC">Get Metrics for a Bitlink by Country</h3><h4 class="MethodHeader_description__3_p_p"><div class="MethodHeader_iconStyle__x5Ow4"><svg viewBox="0 0 14 6" xmlns="http://www.w3.org/2000/svg" class="IconRest_restIcon__3pju8 get"><title>Get</title><path d="M2.587 6c.307 0 .607-.044.9-.132.295-.088.533-.217.716-.387V2.876H2.271v.825h1.027v1.145a.772.772 0 0 1-.239.1 1.4 1.4 0 0 1-.383.049 1.338 1.338 0 0 1-1.083-.52c-.135-.17-.24-.379-.316-.626a2.879 2.879 0 0 1-.113-.84c0-.352.038-.655.113-.907.076-.253.182-.46.32-.623.137-.162.3-.281.488-.358a1.783 1.783 0 0 1 .97-.082l.13.032v.915h.889V.28a3.182 3.182 0 0 0-.59-.202A3.507 3.507 0 0 0 2.676 0c-.313 0-.628.055-.946.165a2.4 2.4 0 0 0-.861.523 2.707 2.707 0 0 0-.627.92C.081 1.98 0 2.433 0 2.966c0 .506.067.946.202 1.323.135.376.318.692.55.948a2.2 2.2 0 0 0 .82.572A2.7 2.7 0 0 0 2.587 6Zm6.24-.115V4.879H6.184V3.47h2.4V2.465h-2.4V1.121h2.602V.115h-3.71v5.77h3.75Zm4.43 0v-.907h-.914V1.022h.768v.997H14V.115H9.57V2.02h.89v-.997h.776v3.956h-.922v.907h2.942Z"></path></svg></div> /v4/bitlinks/{bitlink}/countries</h4><p class="MethodHeader_description__3_p_p">Returns the country origins of click traffic for the specified link.</p></div><div><h4 class="ParameterList_h4__nH9G8 ParameterList_dividing__wRGRx">Path Parameters</h4><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">bitlink</span><span class="Parameter_type__djM_s">string</span><span class="Parameter_required__pcK_H">Required</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">A Bitlink made of the domain and hash</div></div></div><div><h4 class="ParameterList_h4__nH9G8 ParameterList_dividing__wRGRx">Query Parameters</h4><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">unit</span><span class="Parameter_type__djM_s">string</span><span class="Parameter_required__pcK_H">Required</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">A unit of time</div><div class="Parameter_default__HHgG0 Parameter_spacer__JKXbH">Default: <span class="Parameter_label__DUY7G">"day"</span></div><div class="Parameter_enum__csO6P Parameter_spacer__JKXbH">Enum: <span class="Parameter_label__DUY7G">"minute"</span><span class="Parameter_label__DUY7G">"hour"</span><span class="Parameter_label__DUY7G">"day"</span><span class="Parameter_label__DUY7G">"week"</span><span class="Parameter_label__DUY7G">"month"</span></div></div><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">units</span><span class="Parameter_type__djM_s">integer</span><span class="Parameter_required__pcK_H">Required</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">An integer representing the time units to query data for. pass -1 to return all units of time</div><div class="Parameter_default__HHgG0 Parameter_spacer__JKXbH">Default: <span class="Parameter_label__DUY7G">-1</span></div></div><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">size</span><span class="Parameter_type__djM_s">integer</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">The quantity of items to be be returned</div><div class="Parameter_default__HHgG0 Parameter_spacer__JKXbH">Default: <span class="Parameter_label__DUY7G">50</span></div></div><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">unit_reference</span><span class="Parameter_type__djM_s">string</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">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)</div></div></div></div><div class="MethodDetail_examples__8nXeM"><div><label class="CodeSyntaxSelector_header__6P_Jc CodeSyntaxSelector_headerDark__hI3A0"><span>Request</span><div class="CodeSyntaxSelector_header__6P_Jc CodeSyntaxSelector_headerDark__hI3A0"><div class="Select_wrapper__58utF Select_dark__KPIws"><select class="Select_select__qXz_Z Select_dark__KPIws" aria-label="Select" autoComplete="off"><option value="cURL" selected="">cURL</option><option value="Node">Node</option><option value="Browser">Browser</option><option value="Go">Go</option><option value="Python">Python</option></select><svg viewBox="0 0 8 14" xmlns="http://www.w3.org/2000/svg"><path d="M6.463 7 .987 1.66a.61.61 0 0 1 0-.878.648.648 0 0 1 .9 0L7.813 6.56a.61.61 0 0 1 0 .878l-5.926 5.78a.648.648 0 0 1-.9 0 .61.61 0 0 1 0-.879L6.463 7Z"></path></svg></div></div></label><div class="CodeSyntaxSelector_body__hBJ7j CodeSyntaxSelector_bodyDark__cizVw"><div class="CodeBlock_codeBlock__KlURa"><pre tabindex="0" style="color:#ffffff;font-family:ProximaNova, monospace;line-height:1.2;font-size:1rem"><code class="language-bash" style="white-space:pre"><span class="token token" style="color:#ee6123">curl</span><span> </span><span class="token token punctuation">\</span><span> </span><span>-H </span><span class="token token" style="color:#acda95">'Authorization: Bearer {TOKEN}'</span><span> </span><span class="token token punctuation">\</span><span> </span><span>-X GET </span><span class="token token punctuation">\</span><span> </span><span>https://api-ssl.bitly.com/v4/bitlinks/bit.ly/12a4b6c/countries?unit</span><span class="token token operator">=</span><span>month</span><span class="token token operator">&</span><span class="token token assign-left variable">units</span><span class="token token operator">=</span><span class="token token" style="color:#a1b8f3">1</span><span class="token token operator">&</span><span class="token token assign-left variable">size</span><span class="token token operator">=</span><span class="token token" style="color:#a1b8f3">10</span><span class="token token operator">&</span><span class="token token assign-left variable">unit_reference</span><span class="token token operator">=</span><span class="token token" style="color:#a1b8f3">2006</span><span>-01-02T15%3A04%3A05-0700</span></code></pre></div></div></div><div><label class="CodeSyntaxSelector_header__6P_Jc"><span>Response</span><div class="CodeSyntaxSelector_header__6P_Jc"><div class="Select_wrapper__58utF"><select class="Select_select__qXz_Z" aria-label="Select" autoComplete="off"><option value="200" selected="">200 SUCCESS</option><option value="400">400 BAD_REQUEST</option><option value="403">403 FORBIDDEN</option><option value="404">404 NOT_FOUND</option><option value="410">410 GONE</option><option value="429">429 MONTHLY_LIMIT_EXCEEDED</option><option value="500">500 INTERNAL_ERROR</option><option value="503">503 TEMPORARILY_UNAVAILABLE</option></select><svg viewBox="0 0 8 14" xmlns="http://www.w3.org/2000/svg"><path d="M6.463 7 .987 1.66a.61.61 0 0 1 0-.878.648.648 0 0 1 .9 0L7.813 6.56a.61.61 0 0 1 0 .878l-5.926 5.78a.648.648 0 0 1-.9 0 .61.61 0 0 1 0-.879L6.463 7Z"></path></svg></div></div></label><div class="CodeSyntaxSelector_body__hBJ7j"><div class="Response_formatSelect__Wt_qa"><div class="ButtonToggle_buttonToggle__6YJhd"><label class="ButtonToggle_label__ohGaG"><input class="ButtonToggle_input__vkfUm" name="getMetricsForBitlinkByCountries" type="radio" checked=""/><span>json</span></label><label class="ButtonToggle_label__ohGaG"><input class="ButtonToggle_input__vkfUm" name="getMetricsForBitlinkByCountries" type="radio"/><span>csv</span></label></div></div><div class="CodeBlock_codeBlock__KlURa"><pre tabindex="0" style="color:#36383b;font-family:ProximaNova, monospace;line-height:1.2;font-size:1rem"><code class="language-json" style="white-space:pre"><span class="token token punctuation">{</span><span> </span><span> </span><span class="token token property">"unit"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"units"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"integer"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"facet"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"unit_reference"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"metrics"</span><span class="token token operator">:</span><span> </span><span class="token token punctuation">[</span><span> </span><span> </span><span class="token token punctuation">{</span><span> </span><span> </span><span class="token token property">"clicks"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"integer"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"value"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span> </span><span> </span><span class="token token punctuation">}</span><span> </span><span> </span><span class="token token punctuation">]</span><span> </span><span></span><span class="token token punctuation">}</span></code></pre></div></div></div></div></div><div class="MethodDetail_methodContainer__3EF7h" id="getMetricsForBitlinkByCities"><div class="MethodDetail_method__fyEiw"><div><h3 class="MethodHeader_h3__seOfC">Get Metrics for a Bitlink by City</h3><h4 class="MethodHeader_description__3_p_p"><div class="MethodHeader_iconStyle__x5Ow4"><svg viewBox="0 0 14 6" xmlns="http://www.w3.org/2000/svg" class="IconRest_restIcon__3pju8 get"><title>Get</title><path d="M2.587 6c.307 0 .607-.044.9-.132.295-.088.533-.217.716-.387V2.876H2.271v.825h1.027v1.145a.772.772 0 0 1-.239.1 1.4 1.4 0 0 1-.383.049 1.338 1.338 0 0 1-1.083-.52c-.135-.17-.24-.379-.316-.626a2.879 2.879 0 0 1-.113-.84c0-.352.038-.655.113-.907.076-.253.182-.46.32-.623.137-.162.3-.281.488-.358a1.783 1.783 0 0 1 .97-.082l.13.032v.915h.889V.28a3.182 3.182 0 0 0-.59-.202A3.507 3.507 0 0 0 2.676 0c-.313 0-.628.055-.946.165a2.4 2.4 0 0 0-.861.523 2.707 2.707 0 0 0-.627.92C.081 1.98 0 2.433 0 2.966c0 .506.067.946.202 1.323.135.376.318.692.55.948a2.2 2.2 0 0 0 .82.572A2.7 2.7 0 0 0 2.587 6Zm6.24-.115V4.879H6.184V3.47h2.4V2.465h-2.4V1.121h2.602V.115h-3.71v5.77h3.75Zm4.43 0v-.907h-.914V1.022h.768v.997H14V.115H9.57V2.02h.89v-.997h.776v3.956h-.922v.907h2.942Z"></path></svg></div> /v4/bitlinks/{bitlink}/cities</h4><p class="MethodHeader_description__3_p_p">Returns the city origins of click traffic for the specified link.</p></div><div><h4 class="ParameterList_h4__nH9G8 ParameterList_dividing__wRGRx">Path Parameters</h4><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">bitlink</span><span class="Parameter_type__djM_s">string</span><span class="Parameter_required__pcK_H">Required</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">A Bitlink made of the domain and hash</div></div></div><div><h4 class="ParameterList_h4__nH9G8 ParameterList_dividing__wRGRx">Query Parameters</h4><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">unit</span><span class="Parameter_type__djM_s">string</span><span class="Parameter_required__pcK_H">Required</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">A unit of time</div><div class="Parameter_default__HHgG0 Parameter_spacer__JKXbH">Default: <span class="Parameter_label__DUY7G">"day"</span></div><div class="Parameter_enum__csO6P Parameter_spacer__JKXbH">Enum: <span class="Parameter_label__DUY7G">"minute"</span><span class="Parameter_label__DUY7G">"hour"</span><span class="Parameter_label__DUY7G">"day"</span><span class="Parameter_label__DUY7G">"week"</span><span class="Parameter_label__DUY7G">"month"</span></div></div><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">units</span><span class="Parameter_type__djM_s">integer</span><span class="Parameter_required__pcK_H">Required</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">An integer representing the time units to query data for. pass -1 to return all units of time</div><div class="Parameter_default__HHgG0 Parameter_spacer__JKXbH">Default: <span class="Parameter_label__DUY7G">-1</span></div></div><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">size</span><span class="Parameter_type__djM_s">integer</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">The quantity of items to be be returned</div><div class="Parameter_default__HHgG0 Parameter_spacer__JKXbH">Default: <span class="Parameter_label__DUY7G">50</span></div></div><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">unit_reference</span><span class="Parameter_type__djM_s">string</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">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)</div></div></div></div><div class="MethodDetail_examples__8nXeM"><div><label class="CodeSyntaxSelector_header__6P_Jc CodeSyntaxSelector_headerDark__hI3A0"><span>Request</span><div class="CodeSyntaxSelector_header__6P_Jc CodeSyntaxSelector_headerDark__hI3A0"><div class="Select_wrapper__58utF Select_dark__KPIws"><select class="Select_select__qXz_Z Select_dark__KPIws" aria-label="Select" autoComplete="off"><option value="cURL" selected="">cURL</option><option value="Node">Node</option><option value="Browser">Browser</option><option value="Go">Go</option><option value="Python">Python</option></select><svg viewBox="0 0 8 14" xmlns="http://www.w3.org/2000/svg"><path d="M6.463 7 .987 1.66a.61.61 0 0 1 0-.878.648.648 0 0 1 .9 0L7.813 6.56a.61.61 0 0 1 0 .878l-5.926 5.78a.648.648 0 0 1-.9 0 .61.61 0 0 1 0-.879L6.463 7Z"></path></svg></div></div></label><div class="CodeSyntaxSelector_body__hBJ7j CodeSyntaxSelector_bodyDark__cizVw"><div class="CodeBlock_codeBlock__KlURa"><pre tabindex="0" style="color:#ffffff;font-family:ProximaNova, monospace;line-height:1.2;font-size:1rem"><code class="language-bash" style="white-space:pre"><span class="token token" style="color:#ee6123">curl</span><span> </span><span class="token token punctuation">\</span><span> </span><span>-H </span><span class="token token" style="color:#acda95">'Authorization: Bearer {TOKEN}'</span><span> </span><span class="token token punctuation">\</span><span> </span><span>-X GET </span><span class="token token punctuation">\</span><span> </span><span>https://api-ssl.bitly.com/v4/bitlinks/bit.ly/12a4b6c/cities?unit</span><span class="token token operator">=</span><span>month</span><span class="token token operator">&</span><span class="token token assign-left variable">units</span><span class="token token operator">=</span><span class="token token" style="color:#a1b8f3">1</span><span class="token token operator">&</span><span class="token token assign-left variable">size</span><span class="token token operator">=</span><span class="token token" style="color:#a1b8f3">10</span><span class="token token operator">&</span><span class="token token assign-left variable">unit_reference</span><span class="token token operator">=</span><span class="token token" style="color:#a1b8f3">2006</span><span>-01-02T15%3A04%3A05-0700</span></code></pre></div></div></div><div><label class="CodeSyntaxSelector_header__6P_Jc"><span>Response</span><div class="CodeSyntaxSelector_header__6P_Jc"><div class="Select_wrapper__58utF"><select class="Select_select__qXz_Z" aria-label="Select" autoComplete="off"><option value="200" selected="">200 SUCCESS</option><option value="400">400 BAD_REQUEST</option><option value="402">402 UPGRADE_REQUIRED</option><option value="403">403 FORBIDDEN</option><option value="404">404 NOT_FOUND</option><option value="410">410 GONE</option><option value="429">429 MONTHLY_LIMIT_EXCEEDED</option><option value="500">500 INTERNAL_ERROR</option><option value="503">503 TEMPORARILY_UNAVAILABLE</option></select><svg viewBox="0 0 8 14" xmlns="http://www.w3.org/2000/svg"><path d="M6.463 7 .987 1.66a.61.61 0 0 1 0-.878.648.648 0 0 1 .9 0L7.813 6.56a.61.61 0 0 1 0 .878l-5.926 5.78a.648.648 0 0 1-.9 0 .61.61 0 0 1 0-.879L6.463 7Z"></path></svg></div></div></label><div class="CodeSyntaxSelector_body__hBJ7j"><div class="Response_formatSelect__Wt_qa"><div class="ButtonToggle_buttonToggle__6YJhd"><label class="ButtonToggle_label__ohGaG"><input class="ButtonToggle_input__vkfUm" name="getMetricsForBitlinkByCities" type="radio" checked=""/><span>json</span></label><label class="ButtonToggle_label__ohGaG"><input class="ButtonToggle_input__vkfUm" name="getMetricsForBitlinkByCities" type="radio"/><span>csv</span></label></div></div><div class="CodeBlock_codeBlock__KlURa"><pre tabindex="0" style="color:#36383b;font-family:ProximaNova, monospace;line-height:1.2;font-size:1rem"><code class="language-json" style="white-space:pre"><span class="token token punctuation">{</span><span> </span><span> </span><span class="token token property">"unit"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"units"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"integer"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"facet"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"unit_reference"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"metrics"</span><span class="token token operator">:</span><span> </span><span class="token token punctuation">[</span><span> </span><span> </span><span class="token token punctuation">{</span><span> </span><span> </span><span class="token token property">"clicks"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"integer"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"city"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"subregion"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"region"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"country"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span> </span><span> </span><span class="token token punctuation">}</span><span> </span><span> </span><span class="token token punctuation">]</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"other_metrics"</span><span class="token token operator">:</span><span> </span><span class="token token punctuation">{</span><span> </span><span> </span><span class="token token property">"other_city_clicks"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"integer"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"no_city_clicks"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"integer"</span><span> </span><span> </span><span class="token token punctuation">}</span><span> </span><span></span><span class="token token punctuation">}</span></code></pre></div></div></div></div></div><div class="MethodDetail_methodContainer__3EF7h" id="getMetricsForBitlinkByDevices"><div class="MethodDetail_method__fyEiw"><div><h3 class="MethodHeader_h3__seOfC">Get Metrics for a Bitlink by Device Type</h3><h4 class="MethodHeader_description__3_p_p"><div class="MethodHeader_iconStyle__x5Ow4"><svg viewBox="0 0 14 6" xmlns="http://www.w3.org/2000/svg" class="IconRest_restIcon__3pju8 get"><title>Get</title><path d="M2.587 6c.307 0 .607-.044.9-.132.295-.088.533-.217.716-.387V2.876H2.271v.825h1.027v1.145a.772.772 0 0 1-.239.1 1.4 1.4 0 0 1-.383.049 1.338 1.338 0 0 1-1.083-.52c-.135-.17-.24-.379-.316-.626a2.879 2.879 0 0 1-.113-.84c0-.352.038-.655.113-.907.076-.253.182-.46.32-.623.137-.162.3-.281.488-.358a1.783 1.783 0 0 1 .97-.082l.13.032v.915h.889V.28a3.182 3.182 0 0 0-.59-.202A3.507 3.507 0 0 0 2.676 0c-.313 0-.628.055-.946.165a2.4 2.4 0 0 0-.861.523 2.707 2.707 0 0 0-.627.92C.081 1.98 0 2.433 0 2.966c0 .506.067.946.202 1.323.135.376.318.692.55.948a2.2 2.2 0 0 0 .82.572A2.7 2.7 0 0 0 2.587 6Zm6.24-.115V4.879H6.184V3.47h2.4V2.465h-2.4V1.121h2.602V.115h-3.71v5.77h3.75Zm4.43 0v-.907h-.914V1.022h.768v.997H14V.115H9.57V2.02h.89v-.997h.776v3.956h-.922v.907h2.942Z"></path></svg></div> /v4/bitlinks/{bitlink}/devices</h4><p class="MethodHeader_description__3_p_p">Returns the device types generating click traffic to the specified link.</p></div><div><h4 class="ParameterList_h4__nH9G8 ParameterList_dividing__wRGRx">Path Parameters</h4><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">bitlink</span><span class="Parameter_type__djM_s">string</span><span class="Parameter_required__pcK_H">Required</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">A Bitlink made of the domain and hash</div></div></div><div><h4 class="ParameterList_h4__nH9G8 ParameterList_dividing__wRGRx">Query Parameters</h4><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">unit</span><span class="Parameter_type__djM_s">string</span><span class="Parameter_required__pcK_H">Required</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">A unit of time</div><div class="Parameter_default__HHgG0 Parameter_spacer__JKXbH">Default: <span class="Parameter_label__DUY7G">"day"</span></div><div class="Parameter_enum__csO6P Parameter_spacer__JKXbH">Enum: <span class="Parameter_label__DUY7G">"minute"</span><span class="Parameter_label__DUY7G">"hour"</span><span class="Parameter_label__DUY7G">"day"</span><span class="Parameter_label__DUY7G">"week"</span><span class="Parameter_label__DUY7G">"month"</span></div></div><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">units</span><span class="Parameter_type__djM_s">integer</span><span class="Parameter_required__pcK_H">Required</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">An integer representing the time units to query data for. pass -1 to return all units of time</div><div class="Parameter_default__HHgG0 Parameter_spacer__JKXbH">Default: <span class="Parameter_label__DUY7G">-1</span></div></div><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">size</span><span class="Parameter_type__djM_s">integer</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">The quantity of items to be be returned</div><div class="Parameter_default__HHgG0 Parameter_spacer__JKXbH">Default: <span class="Parameter_label__DUY7G">50</span></div></div><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">unit_reference</span><span class="Parameter_type__djM_s">string</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">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)</div></div></div></div><div class="MethodDetail_examples__8nXeM"><div><label class="CodeSyntaxSelector_header__6P_Jc CodeSyntaxSelector_headerDark__hI3A0"><span>Request</span><div class="CodeSyntaxSelector_header__6P_Jc CodeSyntaxSelector_headerDark__hI3A0"><div class="Select_wrapper__58utF Select_dark__KPIws"><select class="Select_select__qXz_Z Select_dark__KPIws" aria-label="Select" autoComplete="off"><option value="cURL" selected="">cURL</option><option value="Node">Node</option><option value="Browser">Browser</option><option value="Go">Go</option><option value="Python">Python</option></select><svg viewBox="0 0 8 14" xmlns="http://www.w3.org/2000/svg"><path d="M6.463 7 .987 1.66a.61.61 0 0 1 0-.878.648.648 0 0 1 .9 0L7.813 6.56a.61.61 0 0 1 0 .878l-5.926 5.78a.648.648 0 0 1-.9 0 .61.61 0 0 1 0-.879L6.463 7Z"></path></svg></div></div></label><div class="CodeSyntaxSelector_body__hBJ7j CodeSyntaxSelector_bodyDark__cizVw"><div class="CodeBlock_codeBlock__KlURa"><pre tabindex="0" style="color:#ffffff;font-family:ProximaNova, monospace;line-height:1.2;font-size:1rem"><code class="language-bash" style="white-space:pre"><span class="token token" style="color:#ee6123">curl</span><span> </span><span class="token token punctuation">\</span><span> </span><span>-H </span><span class="token token" style="color:#acda95">'Authorization: Bearer {TOKEN}'</span><span> </span><span class="token token punctuation">\</span><span> </span><span>-X GET </span><span class="token token punctuation">\</span><span> </span><span>https://api-ssl.bitly.com/v4/bitlinks/bit.ly/12a4b6c/devices?unit</span><span class="token token operator">=</span><span>month</span><span class="token token operator">&</span><span class="token token assign-left variable">units</span><span class="token token operator">=</span><span class="token token" style="color:#a1b8f3">1</span><span class="token token operator">&</span><span class="token token assign-left variable">size</span><span class="token token operator">=</span><span class="token token" style="color:#a1b8f3">10</span><span class="token token operator">&</span><span class="token token assign-left variable">unit_reference</span><span class="token token operator">=</span><span class="token token" style="color:#a1b8f3">2006</span><span>-01-02T15%3A04%3A05-0700</span></code></pre></div></div></div><div><label class="CodeSyntaxSelector_header__6P_Jc"><span>Response</span><div class="CodeSyntaxSelector_header__6P_Jc"><div class="Select_wrapper__58utF"><select class="Select_select__qXz_Z" aria-label="Select" autoComplete="off"><option value="200" selected="">200 SUCCESS</option><option value="400">400 BAD_REQUEST</option><option value="402">402 UPGRADE_REQUIRED</option><option value="403">403 FORBIDDEN</option><option value="404">404 NOT_FOUND</option><option value="410">410 GONE</option><option value="429">429 MONTHLY_LIMIT_EXCEEDED</option><option value="500">500 INTERNAL_ERROR</option><option value="503">503 TEMPORARILY_UNAVAILABLE</option></select><svg viewBox="0 0 8 14" xmlns="http://www.w3.org/2000/svg"><path d="M6.463 7 .987 1.66a.61.61 0 0 1 0-.878.648.648 0 0 1 .9 0L7.813 6.56a.61.61 0 0 1 0 .878l-5.926 5.78a.648.648 0 0 1-.9 0 .61.61 0 0 1 0-.879L6.463 7Z"></path></svg></div></div></label><div class="CodeSyntaxSelector_body__hBJ7j"><div class="Response_formatSelect__Wt_qa"><div class="ButtonToggle_buttonToggle__6YJhd"><label class="ButtonToggle_label__ohGaG"><input class="ButtonToggle_input__vkfUm" name="getMetricsForBitlinkByDevices" type="radio" checked=""/><span>json</span></label><label class="ButtonToggle_label__ohGaG"><input class="ButtonToggle_input__vkfUm" name="getMetricsForBitlinkByDevices" type="radio"/><span>csv</span></label></div></div><div class="CodeBlock_codeBlock__KlURa"><pre tabindex="0" style="color:#36383b;font-family:ProximaNova, monospace;line-height:1.2;font-size:1rem"><code class="language-json" style="white-space:pre"><span class="token token punctuation">{</span><span> </span><span> </span><span class="token token property">"unit"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"units"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"integer"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"facet"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"unit_reference"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"metrics"</span><span class="token token operator">:</span><span> </span><span class="token token punctuation">[</span><span> </span><span> </span><span class="token token punctuation">{</span><span> </span><span> </span><span class="token token property">"clicks"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"integer"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"device_type"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span> </span><span> </span><span class="token token punctuation">}</span><span> </span><span> </span><span class="token token punctuation">]</span><span> </span><span></span><span class="token token punctuation">}</span></code></pre></div></div></div></div></div><div class="MethodDetail_methodContainer__3EF7h" id="getMetricsForBitlinkByReferrers"><div class="MethodDetail_method__fyEiw"><div><h3 class="MethodHeader_h3__seOfC">Get Metrics for a Bitlink by Referrers</h3><h4 class="MethodHeader_description__3_p_p"><div class="MethodHeader_iconStyle__x5Ow4"><svg viewBox="0 0 14 6" xmlns="http://www.w3.org/2000/svg" class="IconRest_restIcon__3pju8 get"><title>Get</title><path d="M2.587 6c.307 0 .607-.044.9-.132.295-.088.533-.217.716-.387V2.876H2.271v.825h1.027v1.145a.772.772 0 0 1-.239.1 1.4 1.4 0 0 1-.383.049 1.338 1.338 0 0 1-1.083-.52c-.135-.17-.24-.379-.316-.626a2.879 2.879 0 0 1-.113-.84c0-.352.038-.655.113-.907.076-.253.182-.46.32-.623.137-.162.3-.281.488-.358a1.783 1.783 0 0 1 .97-.082l.13.032v.915h.889V.28a3.182 3.182 0 0 0-.59-.202A3.507 3.507 0 0 0 2.676 0c-.313 0-.628.055-.946.165a2.4 2.4 0 0 0-.861.523 2.707 2.707 0 0 0-.627.92C.081 1.98 0 2.433 0 2.966c0 .506.067.946.202 1.323.135.376.318.692.55.948a2.2 2.2 0 0 0 .82.572A2.7 2.7 0 0 0 2.587 6Zm6.24-.115V4.879H6.184V3.47h2.4V2.465h-2.4V1.121h2.602V.115h-3.71v5.77h3.75Zm4.43 0v-.907h-.914V1.022h.768v.997H14V.115H9.57V2.02h.89v-.997h.776v3.956h-.922v.907h2.942Z"></path></svg></div> /v4/bitlinks/{bitlink}/referrers</h4><p class="MethodHeader_description__3_p_p">Returns referrer click counts for the specified link.</p></div><div><h4 class="ParameterList_h4__nH9G8 ParameterList_dividing__wRGRx">Path Parameters</h4><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">bitlink</span><span class="Parameter_type__djM_s">string</span><span class="Parameter_required__pcK_H">Required</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">A Bitlink made of the domain and hash</div></div></div><div><h4 class="ParameterList_h4__nH9G8 ParameterList_dividing__wRGRx">Query Parameters</h4><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">unit</span><span class="Parameter_type__djM_s">string</span><span class="Parameter_required__pcK_H">Required</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">A unit of time</div><div class="Parameter_default__HHgG0 Parameter_spacer__JKXbH">Default: <span class="Parameter_label__DUY7G">"day"</span></div><div class="Parameter_enum__csO6P Parameter_spacer__JKXbH">Enum: <span class="Parameter_label__DUY7G">"minute"</span><span class="Parameter_label__DUY7G">"hour"</span><span class="Parameter_label__DUY7G">"day"</span><span class="Parameter_label__DUY7G">"week"</span><span class="Parameter_label__DUY7G">"month"</span></div></div><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">units</span><span class="Parameter_type__djM_s">integer</span><span class="Parameter_required__pcK_H">Required</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">An integer representing the time units to query data for. pass -1 to return all units of time</div><div class="Parameter_default__HHgG0 Parameter_spacer__JKXbH">Default: <span class="Parameter_label__DUY7G">-1</span></div></div><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">size</span><span class="Parameter_type__djM_s">integer</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">The quantity of items to be be returned</div><div class="Parameter_default__HHgG0 Parameter_spacer__JKXbH">Default: <span class="Parameter_label__DUY7G">50</span></div></div><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">unit_reference</span><span class="Parameter_type__djM_s">string</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">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)</div></div></div></div><div class="MethodDetail_examples__8nXeM"><div><label class="CodeSyntaxSelector_header__6P_Jc CodeSyntaxSelector_headerDark__hI3A0"><span>Request</span><div class="CodeSyntaxSelector_header__6P_Jc CodeSyntaxSelector_headerDark__hI3A0"><div class="Select_wrapper__58utF Select_dark__KPIws"><select class="Select_select__qXz_Z Select_dark__KPIws" aria-label="Select" autoComplete="off"><option value="cURL" selected="">cURL</option><option value="Node">Node</option><option value="Browser">Browser</option><option value="Go">Go</option><option value="Python">Python</option></select><svg viewBox="0 0 8 14" xmlns="http://www.w3.org/2000/svg"><path d="M6.463 7 .987 1.66a.61.61 0 0 1 0-.878.648.648 0 0 1 .9 0L7.813 6.56a.61.61 0 0 1 0 .878l-5.926 5.78a.648.648 0 0 1-.9 0 .61.61 0 0 1 0-.879L6.463 7Z"></path></svg></div></div></label><div class="CodeSyntaxSelector_body__hBJ7j CodeSyntaxSelector_bodyDark__cizVw"><div class="CodeBlock_codeBlock__KlURa"><pre tabindex="0" style="color:#ffffff;font-family:ProximaNova, monospace;line-height:1.2;font-size:1rem"><code class="language-bash" style="white-space:pre"><span class="token token" style="color:#ee6123">curl</span><span> </span><span class="token token punctuation">\</span><span> </span><span>-H </span><span class="token token" style="color:#acda95">'Authorization: Bearer {TOKEN}'</span><span> </span><span class="token token punctuation">\</span><span> </span><span>-X GET </span><span class="token token punctuation">\</span><span> </span><span>https://api-ssl.bitly.com/v4/bitlinks/bit.ly/12a4b6c/referrers?unit</span><span class="token token operator">=</span><span>month</span><span class="token token operator">&</span><span class="token token assign-left variable">units</span><span class="token token operator">=</span><span class="token token" style="color:#a1b8f3">1</span><span class="token token operator">&</span><span class="token token assign-left variable">size</span><span class="token token operator">=</span><span class="token token" style="color:#a1b8f3">10</span><span class="token token operator">&</span><span class="token token assign-left variable">unit_reference</span><span class="token token operator">=</span><span class="token token" style="color:#a1b8f3">2006</span><span>-01-02T15%3A04%3A05-0700</span></code></pre></div></div></div><div><label class="CodeSyntaxSelector_header__6P_Jc"><span>Response</span><div class="CodeSyntaxSelector_header__6P_Jc"><div class="Select_wrapper__58utF"><select class="Select_select__qXz_Z" aria-label="Select" autoComplete="off"><option value="200" selected="">200 SUCCESS</option><option value="400">400 BAD_REQUEST</option><option value="403">403 FORBIDDEN</option><option value="404">404 NOT_FOUND</option><option value="410">410 GONE</option><option value="429">429 MONTHLY_LIMIT_EXCEEDED</option><option value="500">500 INTERNAL_ERROR</option><option value="503">503 TEMPORARILY_UNAVAILABLE</option></select><svg viewBox="0 0 8 14" xmlns="http://www.w3.org/2000/svg"><path d="M6.463 7 .987 1.66a.61.61 0 0 1 0-.878.648.648 0 0 1 .9 0L7.813 6.56a.61.61 0 0 1 0 .878l-5.926 5.78a.648.648 0 0 1-.9 0 .61.61 0 0 1 0-.879L6.463 7Z"></path></svg></div></div></label><div class="CodeSyntaxSelector_body__hBJ7j"><div class="Response_formatSelect__Wt_qa"><div class="ButtonToggle_buttonToggle__6YJhd"><label class="ButtonToggle_label__ohGaG"><input class="ButtonToggle_input__vkfUm" name="getMetricsForBitlinkByReferrers" type="radio" checked=""/><span>json</span></label><label class="ButtonToggle_label__ohGaG"><input class="ButtonToggle_input__vkfUm" name="getMetricsForBitlinkByReferrers" type="radio"/><span>csv</span></label></div></div><div class="CodeBlock_codeBlock__KlURa"><pre tabindex="0" style="color:#36383b;font-family:ProximaNova, monospace;line-height:1.2;font-size:1rem"><code class="language-json" style="white-space:pre"><span class="token token punctuation">{</span><span> </span><span> </span><span class="token token property">"unit"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"units"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"integer"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"facet"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"unit_reference"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"metrics"</span><span class="token token operator">:</span><span> </span><span class="token token punctuation">[</span><span> </span><span> </span><span class="token token punctuation">{</span><span> </span><span> </span><span class="token token property">"clicks"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"integer"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"value"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span> </span><span> </span><span class="token token punctuation">}</span><span> </span><span> </span><span class="token token punctuation">]</span><span> </span><span></span><span class="token token punctuation">}</span></code></pre></div></div></div></div></div><div class="MethodDetail_methodContainer__3EF7h" id="getMetricsForBitlinkByReferrerName"><div class="MethodDetail_method__fyEiw"><div><h3 class="MethodHeader_h3__seOfC">Get Metrics for a Bitlink by Referrer Name</h3><h4 class="MethodHeader_description__3_p_p"><div class="MethodHeader_iconStyle__x5Ow4"><svg viewBox="0 0 14 6" xmlns="http://www.w3.org/2000/svg" class="IconRest_restIcon__3pju8 get"><title>Get</title><path d="M2.587 6c.307 0 .607-.044.9-.132.295-.088.533-.217.716-.387V2.876H2.271v.825h1.027v1.145a.772.772 0 0 1-.239.1 1.4 1.4 0 0 1-.383.049 1.338 1.338 0 0 1-1.083-.52c-.135-.17-.24-.379-.316-.626a2.879 2.879 0 0 1-.113-.84c0-.352.038-.655.113-.907.076-.253.182-.46.32-.623.137-.162.3-.281.488-.358a1.783 1.783 0 0 1 .97-.082l.13.032v.915h.889V.28a3.182 3.182 0 0 0-.59-.202A3.507 3.507 0 0 0 2.676 0c-.313 0-.628.055-.946.165a2.4 2.4 0 0 0-.861.523 2.707 2.707 0 0 0-.627.92C.081 1.98 0 2.433 0 2.966c0 .506.067.946.202 1.323.135.376.318.692.55.948a2.2 2.2 0 0 0 .82.572A2.7 2.7 0 0 0 2.587 6Zm6.24-.115V4.879H6.184V3.47h2.4V2.465h-2.4V1.121h2.602V.115h-3.71v5.77h3.75Zm4.43 0v-.907h-.914V1.022h.768v.997H14V.115H9.57V2.02h.89v-.997h.776v3.956h-.922v.907h2.942Z"></path></svg></div> /v4/bitlinks/{bitlink}/referrer_name</h4><p class="MethodHeader_description__3_p_p">Returns referrer click counts for the specified link.</p></div><div><h4 class="ParameterList_h4__nH9G8 ParameterList_dividing__wRGRx">Path Parameters</h4><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">bitlink</span><span class="Parameter_type__djM_s">string</span><span class="Parameter_required__pcK_H">Required</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">A Bitlink made of the domain and hash</div></div></div><div><h4 class="ParameterList_h4__nH9G8 ParameterList_dividing__wRGRx">Query Parameters</h4><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">unit</span><span class="Parameter_type__djM_s">string</span><span class="Parameter_required__pcK_H">Required</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">A unit of time</div><div class="Parameter_default__HHgG0 Parameter_spacer__JKXbH">Default: <span class="Parameter_label__DUY7G">"day"</span></div><div class="Parameter_enum__csO6P Parameter_spacer__JKXbH">Enum: <span class="Parameter_label__DUY7G">"minute"</span><span class="Parameter_label__DUY7G">"hour"</span><span class="Parameter_label__DUY7G">"day"</span><span class="Parameter_label__DUY7G">"week"</span><span class="Parameter_label__DUY7G">"month"</span></div></div><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">units</span><span class="Parameter_type__djM_s">integer</span><span class="Parameter_required__pcK_H">Required</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">An integer representing the time units to query data for. pass -1 to return all units of time</div><div class="Parameter_default__HHgG0 Parameter_spacer__JKXbH">Default: <span class="Parameter_label__DUY7G">-1</span></div></div><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">size</span><span class="Parameter_type__djM_s">integer</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">The quantity of items to be be returned</div><div class="Parameter_default__HHgG0 Parameter_spacer__JKXbH">Default: <span class="Parameter_label__DUY7G">50</span></div></div><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">unit_reference</span><span class="Parameter_type__djM_s">string</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">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)</div></div></div></div><div class="MethodDetail_examples__8nXeM"><div><label class="CodeSyntaxSelector_header__6P_Jc CodeSyntaxSelector_headerDark__hI3A0"><span>Request</span><div class="CodeSyntaxSelector_header__6P_Jc CodeSyntaxSelector_headerDark__hI3A0"><div class="Select_wrapper__58utF Select_dark__KPIws"><select class="Select_select__qXz_Z Select_dark__KPIws" aria-label="Select" autoComplete="off"><option value="cURL" selected="">cURL</option><option value="Node">Node</option><option value="Browser">Browser</option><option value="Go">Go</option><option value="Python">Python</option></select><svg viewBox="0 0 8 14" xmlns="http://www.w3.org/2000/svg"><path d="M6.463 7 .987 1.66a.61.61 0 0 1 0-.878.648.648 0 0 1 .9 0L7.813 6.56a.61.61 0 0 1 0 .878l-5.926 5.78a.648.648 0 0 1-.9 0 .61.61 0 0 1 0-.879L6.463 7Z"></path></svg></div></div></label><div class="CodeSyntaxSelector_body__hBJ7j CodeSyntaxSelector_bodyDark__cizVw"><div class="CodeBlock_codeBlock__KlURa"><pre tabindex="0" style="color:#ffffff;font-family:ProximaNova, monospace;line-height:1.2;font-size:1rem"><code class="language-bash" style="white-space:pre"><span class="token token" style="color:#ee6123">curl</span><span> </span><span class="token token punctuation">\</span><span> </span><span>-H </span><span class="token token" style="color:#acda95">'Authorization: Bearer {TOKEN}'</span><span> </span><span class="token token punctuation">\</span><span> </span><span>-X GET </span><span class="token token punctuation">\</span><span> </span><span>https://api-ssl.bitly.com/v4/bitlinks/bit.ly/12a4b6c/referrer_name?unit</span><span class="token token operator">=</span><span>month</span><span class="token token operator">&</span><span class="token token assign-left variable">units</span><span class="token token operator">=</span><span class="token token" style="color:#a1b8f3">1</span><span class="token token operator">&</span><span class="token token assign-left variable">size</span><span class="token token operator">=</span><span class="token token" style="color:#a1b8f3">10</span><span class="token token operator">&</span><span class="token token assign-left variable">unit_reference</span><span class="token token operator">=</span><span class="token token" style="color:#a1b8f3">2006</span><span>-01-02T15%3A04%3A05-0700</span></code></pre></div></div></div><div><label class="CodeSyntaxSelector_header__6P_Jc"><span>Response</span><div class="CodeSyntaxSelector_header__6P_Jc"><div class="Select_wrapper__58utF"><select class="Select_select__qXz_Z" aria-label="Select" autoComplete="off"><option value="200" selected="">200 SUCCESS</option><option value="400">400 BAD_REQUEST</option><option value="403">403 FORBIDDEN</option><option value="404">404 NOT_FOUND</option><option value="410">410 GONE</option><option value="500">500 INTERNAL_ERROR</option><option value="503">503 TEMPORARILY_UNAVAILABLE</option></select><svg viewBox="0 0 8 14" xmlns="http://www.w3.org/2000/svg"><path d="M6.463 7 .987 1.66a.61.61 0 0 1 0-.878.648.648 0 0 1 .9 0L7.813 6.56a.61.61 0 0 1 0 .878l-5.926 5.78a.648.648 0 0 1-.9 0 .61.61 0 0 1 0-.879L6.463 7Z"></path></svg></div></div></label><div class="CodeSyntaxSelector_body__hBJ7j"><div class="Response_formatSelect__Wt_qa"><div class="ButtonToggle_buttonToggle__6YJhd"><label class="ButtonToggle_label__ohGaG"><input class="ButtonToggle_input__vkfUm" name="getMetricsForBitlinkByReferrerName" type="radio" checked=""/><span>json</span></label><label class="ButtonToggle_label__ohGaG"><input class="ButtonToggle_input__vkfUm" name="getMetricsForBitlinkByReferrerName" type="radio"/><span>csv</span></label></div></div><div class="CodeBlock_codeBlock__KlURa"><pre tabindex="0" style="color:#36383b;font-family:ProximaNova, monospace;line-height:1.2;font-size:1rem"><code class="language-json" style="white-space:pre"><span class="token token punctuation">{</span><span> </span><span> </span><span class="token token property">"unit"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"units"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"integer"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"facet"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"unit_reference"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"metrics"</span><span class="token token operator">:</span><span> </span><span class="token token punctuation">[</span><span> </span><span> </span><span class="token token punctuation">{</span><span> </span><span> </span><span class="token token property">"clicks"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"integer"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"value"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span> </span><span> </span><span class="token token punctuation">}</span><span> </span><span> </span><span class="token token punctuation">]</span><span> </span><span></span><span class="token token punctuation">}</span></code></pre></div></div></div></div></div><div class="MethodDetail_methodContainer__3EF7h" id="getMetricsForBitlinkByReferringDomains"><div class="MethodDetail_method__fyEiw"><div><h3 class="MethodHeader_h3__seOfC">Get Metrics for a Bitlink by Referring Domains</h3><h4 class="MethodHeader_description__3_p_p"><div class="MethodHeader_iconStyle__x5Ow4"><svg viewBox="0 0 14 6" xmlns="http://www.w3.org/2000/svg" class="IconRest_restIcon__3pju8 get"><title>Get</title><path d="M2.587 6c.307 0 .607-.044.9-.132.295-.088.533-.217.716-.387V2.876H2.271v.825h1.027v1.145a.772.772 0 0 1-.239.1 1.4 1.4 0 0 1-.383.049 1.338 1.338 0 0 1-1.083-.52c-.135-.17-.24-.379-.316-.626a2.879 2.879 0 0 1-.113-.84c0-.352.038-.655.113-.907.076-.253.182-.46.32-.623.137-.162.3-.281.488-.358a1.783 1.783 0 0 1 .97-.082l.13.032v.915h.889V.28a3.182 3.182 0 0 0-.59-.202A3.507 3.507 0 0 0 2.676 0c-.313 0-.628.055-.946.165a2.4 2.4 0 0 0-.861.523 2.707 2.707 0 0 0-.627.92C.081 1.98 0 2.433 0 2.966c0 .506.067.946.202 1.323.135.376.318.692.55.948a2.2 2.2 0 0 0 .82.572A2.7 2.7 0 0 0 2.587 6Zm6.24-.115V4.879H6.184V3.47h2.4V2.465h-2.4V1.121h2.602V.115h-3.71v5.77h3.75Zm4.43 0v-.907h-.914V1.022h.768v.997H14V.115H9.57V2.02h.89v-.997h.776v3.956h-.922v.907h2.942Z"></path></svg></div> /v4/bitlinks/{bitlink}/referring_domains</h4><p class="MethodHeader_description__3_p_p">Returns the referring domain click counts for the specified link.</p></div><div><h4 class="ParameterList_h4__nH9G8 ParameterList_dividing__wRGRx">Path Parameters</h4><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">bitlink</span><span class="Parameter_type__djM_s">string</span><span class="Parameter_required__pcK_H">Required</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">A Bitlink made of the domain and hash</div></div></div><div><h4 class="ParameterList_h4__nH9G8 ParameterList_dividing__wRGRx">Query Parameters</h4><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">unit</span><span class="Parameter_type__djM_s">string</span><span class="Parameter_required__pcK_H">Required</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">A unit of time</div><div class="Parameter_default__HHgG0 Parameter_spacer__JKXbH">Default: <span class="Parameter_label__DUY7G">"day"</span></div><div class="Parameter_enum__csO6P Parameter_spacer__JKXbH">Enum: <span class="Parameter_label__DUY7G">"minute"</span><span class="Parameter_label__DUY7G">"hour"</span><span class="Parameter_label__DUY7G">"day"</span><span class="Parameter_label__DUY7G">"week"</span><span class="Parameter_label__DUY7G">"month"</span></div></div><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">units</span><span class="Parameter_type__djM_s">integer</span><span class="Parameter_required__pcK_H">Required</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">An integer representing the time units to query data for. pass -1 to return all units of time</div><div class="Parameter_default__HHgG0 Parameter_spacer__JKXbH">Default: <span class="Parameter_label__DUY7G">-1</span></div></div><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">size</span><span class="Parameter_type__djM_s">integer</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">The quantity of items to be be returned</div><div class="Parameter_default__HHgG0 Parameter_spacer__JKXbH">Default: <span class="Parameter_label__DUY7G">50</span></div></div><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">unit_reference</span><span class="Parameter_type__djM_s">string</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">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)</div></div></div></div><div class="MethodDetail_examples__8nXeM"><div><label class="CodeSyntaxSelector_header__6P_Jc CodeSyntaxSelector_headerDark__hI3A0"><span>Request</span><div class="CodeSyntaxSelector_header__6P_Jc CodeSyntaxSelector_headerDark__hI3A0"><div class="Select_wrapper__58utF Select_dark__KPIws"><select class="Select_select__qXz_Z Select_dark__KPIws" aria-label="Select" autoComplete="off"><option value="cURL" selected="">cURL</option><option value="Node">Node</option><option value="Browser">Browser</option><option value="Go">Go</option><option value="Python">Python</option></select><svg viewBox="0 0 8 14" xmlns="http://www.w3.org/2000/svg"><path d="M6.463 7 .987 1.66a.61.61 0 0 1 0-.878.648.648 0 0 1 .9 0L7.813 6.56a.61.61 0 0 1 0 .878l-5.926 5.78a.648.648 0 0 1-.9 0 .61.61 0 0 1 0-.879L6.463 7Z"></path></svg></div></div></label><div class="CodeSyntaxSelector_body__hBJ7j CodeSyntaxSelector_bodyDark__cizVw"><div class="CodeBlock_codeBlock__KlURa"><pre tabindex="0" style="color:#ffffff;font-family:ProximaNova, monospace;line-height:1.2;font-size:1rem"><code class="language-bash" style="white-space:pre"><span class="token token" style="color:#ee6123">curl</span><span> </span><span class="token token punctuation">\</span><span> </span><span>-H </span><span class="token token" style="color:#acda95">'Authorization: Bearer {TOKEN}'</span><span> </span><span class="token token punctuation">\</span><span> </span><span>-X GET </span><span class="token token punctuation">\</span><span> </span><span>https://api-ssl.bitly.com/v4/bitlinks/bit.ly/12a4b6c/referring_domains?unit</span><span class="token token operator">=</span><span>month</span><span class="token token operator">&</span><span class="token token assign-left variable">units</span><span class="token token operator">=</span><span class="token token" style="color:#a1b8f3">1</span><span class="token token operator">&</span><span class="token token assign-left variable">size</span><span class="token token operator">=</span><span class="token token" style="color:#a1b8f3">10</span><span class="token token operator">&</span><span class="token token assign-left variable">unit_reference</span><span class="token token operator">=</span><span class="token token" style="color:#a1b8f3">2006</span><span>-01-02T15%3A04%3A05-0700</span></code></pre></div></div></div><div><label class="CodeSyntaxSelector_header__6P_Jc"><span>Response</span><div class="CodeSyntaxSelector_header__6P_Jc"><div class="Select_wrapper__58utF"><select class="Select_select__qXz_Z" aria-label="Select" autoComplete="off"><option value="200" selected="">200 SUCCESS</option><option value="400">400 BAD_REQUEST</option><option value="403">403 FORBIDDEN</option><option value="404">404 NOT_FOUND</option><option value="410">410 GONE</option><option value="429">429 MONTHLY_LIMIT_EXCEEDED</option><option value="500">500 INTERNAL_ERROR</option><option value="503">503 TEMPORARILY_UNAVAILABLE</option></select><svg viewBox="0 0 8 14" xmlns="http://www.w3.org/2000/svg"><path d="M6.463 7 .987 1.66a.61.61 0 0 1 0-.878.648.648 0 0 1 .9 0L7.813 6.56a.61.61 0 0 1 0 .878l-5.926 5.78a.648.648 0 0 1-.9 0 .61.61 0 0 1 0-.879L6.463 7Z"></path></svg></div></div></label><div class="CodeSyntaxSelector_body__hBJ7j"><div class="CodeBlock_codeBlock__KlURa"><pre tabindex="0" style="color:#36383b;font-family:ProximaNova, monospace;line-height:1.2;font-size:1rem"><code class="language-json" style="white-space:pre"><span class="token token punctuation">{</span><span> </span><span> </span><span class="token token property">"unit"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"units"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"integer"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"facet"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"unit_reference"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"metrics"</span><span class="token token operator">:</span><span> </span><span class="token token punctuation">[</span><span> </span><span> </span><span class="token token punctuation">{</span><span> </span><span> </span><span class="token token property">"clicks"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"integer"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"value"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span> </span><span> </span><span class="token token punctuation">}</span><span> </span><span> </span><span class="token token punctuation">]</span><span> </span><span></span><span class="token token punctuation">}</span></code></pre></div></div></div></div></div><div class="MethodDetail_methodContainer__3EF7h" id="getMetricsForBitlinkByReferrersByDomains"><div class="MethodDetail_method__fyEiw"><div><h3 class="MethodHeader_h3__seOfC">Get Metrics for a Bitlink by Referrers by Domain</h3><h4 class="MethodHeader_description__3_p_p"><div class="MethodHeader_iconStyle__x5Ow4"><svg viewBox="0 0 14 6" xmlns="http://www.w3.org/2000/svg" class="IconRest_restIcon__3pju8 get"><title>Get</title><path d="M2.587 6c.307 0 .607-.044.9-.132.295-.088.533-.217.716-.387V2.876H2.271v.825h1.027v1.145a.772.772 0 0 1-.239.1 1.4 1.4 0 0 1-.383.049 1.338 1.338 0 0 1-1.083-.52c-.135-.17-.24-.379-.316-.626a2.879 2.879 0 0 1-.113-.84c0-.352.038-.655.113-.907.076-.253.182-.46.32-.623.137-.162.3-.281.488-.358a1.783 1.783 0 0 1 .97-.082l.13.032v.915h.889V.28a3.182 3.182 0 0 0-.59-.202A3.507 3.507 0 0 0 2.676 0c-.313 0-.628.055-.946.165a2.4 2.4 0 0 0-.861.523 2.707 2.707 0 0 0-.627.92C.081 1.98 0 2.433 0 2.966c0 .506.067.946.202 1.323.135.376.318.692.55.948a2.2 2.2 0 0 0 .82.572A2.7 2.7 0 0 0 2.587 6Zm6.24-.115V4.879H6.184V3.47h2.4V2.465h-2.4V1.121h2.602V.115h-3.71v5.77h3.75Zm4.43 0v-.907h-.914V1.022h.768v.997H14V.115H9.57V2.02h.89v-.997h.776v3.956h-.922v.907h2.942Z"></path></svg></div> /v4/bitlinks/{bitlink}/referrers_by_domains</h4><p class="MethodHeader_description__3_p_p">Returns click metrics grouped by referrers for the specified link.</p></div><div><h4 class="ParameterList_h4__nH9G8 ParameterList_dividing__wRGRx">Path Parameters</h4><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">bitlink</span><span class="Parameter_type__djM_s">string</span><span class="Parameter_required__pcK_H">Required</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">A Bitlink made of the domain and hash</div></div></div><div><h4 class="ParameterList_h4__nH9G8 ParameterList_dividing__wRGRx">Query Parameters</h4><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">unit</span><span class="Parameter_type__djM_s">string</span><span class="Parameter_required__pcK_H">Required</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">A unit of time</div><div class="Parameter_default__HHgG0 Parameter_spacer__JKXbH">Default: <span class="Parameter_label__DUY7G">"day"</span></div><div class="Parameter_enum__csO6P Parameter_spacer__JKXbH">Enum: <span class="Parameter_label__DUY7G">"minute"</span><span class="Parameter_label__DUY7G">"hour"</span><span class="Parameter_label__DUY7G">"day"</span><span class="Parameter_label__DUY7G">"week"</span><span class="Parameter_label__DUY7G">"month"</span></div></div><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">units</span><span class="Parameter_type__djM_s">integer</span><span class="Parameter_required__pcK_H">Required</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">An integer representing the time units to query data for. pass -1 to return all units of time</div><div class="Parameter_default__HHgG0 Parameter_spacer__JKXbH">Default: <span class="Parameter_label__DUY7G">-1</span></div></div><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">size</span><span class="Parameter_type__djM_s">integer</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">The quantity of items to be be returned</div><div class="Parameter_default__HHgG0 Parameter_spacer__JKXbH">Default: <span class="Parameter_label__DUY7G">50</span></div></div><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">unit_reference</span><span class="Parameter_type__djM_s">string</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">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)</div></div></div></div><div class="MethodDetail_examples__8nXeM"><div><label class="CodeSyntaxSelector_header__6P_Jc CodeSyntaxSelector_headerDark__hI3A0"><span>Request</span><div class="CodeSyntaxSelector_header__6P_Jc CodeSyntaxSelector_headerDark__hI3A0"><div class="Select_wrapper__58utF Select_dark__KPIws"><select class="Select_select__qXz_Z Select_dark__KPIws" aria-label="Select" autoComplete="off"><option value="cURL" selected="">cURL</option><option value="Node">Node</option><option value="Browser">Browser</option><option value="Go">Go</option><option value="Python">Python</option></select><svg viewBox="0 0 8 14" xmlns="http://www.w3.org/2000/svg"><path d="M6.463 7 .987 1.66a.61.61 0 0 1 0-.878.648.648 0 0 1 .9 0L7.813 6.56a.61.61 0 0 1 0 .878l-5.926 5.78a.648.648 0 0 1-.9 0 .61.61 0 0 1 0-.879L6.463 7Z"></path></svg></div></div></label><div class="CodeSyntaxSelector_body__hBJ7j CodeSyntaxSelector_bodyDark__cizVw"><div class="CodeBlock_codeBlock__KlURa"><pre tabindex="0" style="color:#ffffff;font-family:ProximaNova, monospace;line-height:1.2;font-size:1rem"><code class="language-bash" style="white-space:pre"><span class="token token" style="color:#ee6123">curl</span><span> </span><span class="token token punctuation">\</span><span> </span><span>-H </span><span class="token token" style="color:#acda95">'Authorization: Bearer {TOKEN}'</span><span> </span><span class="token token punctuation">\</span><span> </span><span>-X GET </span><span class="token token punctuation">\</span><span> </span><span>https://api-ssl.bitly.com/v4/bitlinks/bit.ly/12a4b6c/referrers_by_domains?unit</span><span class="token token operator">=</span><span>month</span><span class="token token operator">&</span><span class="token token assign-left variable">units</span><span class="token token operator">=</span><span class="token token" style="color:#a1b8f3">1</span><span class="token token operator">&</span><span class="token token assign-left variable">size</span><span class="token token operator">=</span><span class="token token" style="color:#a1b8f3">10</span><span class="token token operator">&</span><span class="token token assign-left variable">unit_reference</span><span class="token token operator">=</span><span class="token token" style="color:#a1b8f3">2006</span><span>-01-02T15%3A04%3A05-0700</span></code></pre></div></div></div><div><label class="CodeSyntaxSelector_header__6P_Jc"><span>Response</span><div class="CodeSyntaxSelector_header__6P_Jc"><div class="Select_wrapper__58utF"><select class="Select_select__qXz_Z" aria-label="Select" autoComplete="off"><option value="200" selected="">200 SUCCESS</option><option value="400">400 BAD_REQUEST</option><option value="403">403 FORBIDDEN</option><option value="404">404 NOT_FOUND</option><option value="410">410 GONE</option><option value="429">429 MONTHLY_LIMIT_EXCEEDED</option><option value="500">500 INTERNAL_ERROR</option><option value="503">503 TEMPORARILY_UNAVAILABLE</option></select><svg viewBox="0 0 8 14" xmlns="http://www.w3.org/2000/svg"><path d="M6.463 7 .987 1.66a.61.61 0 0 1 0-.878.648.648 0 0 1 .9 0L7.813 6.56a.61.61 0 0 1 0 .878l-5.926 5.78a.648.648 0 0 1-.9 0 .61.61 0 0 1 0-.879L6.463 7Z"></path></svg></div></div></label><div class="CodeSyntaxSelector_body__hBJ7j"><div class="CodeBlock_codeBlock__KlURa"><pre tabindex="0" style="color:#36383b;font-family:ProximaNova, monospace;line-height:1.2;font-size:1rem"><code class="language-json" style="white-space:pre"><span class="token token punctuation">{</span><span> </span><span> </span><span class="token token property">"unit"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"units"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"integer"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"facet"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"unit_reference"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"referrers_by_domain"</span><span class="token token operator">:</span><span> </span><span class="token token punctuation">[</span><span> </span><span> </span><span class="token token punctuation">{</span><span> </span><span> </span><span class="token token property">"network"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"referrers"</span><span class="token token operator">:</span><span> </span><span class="token token punctuation">[</span><span> </span><span> </span><span class="token token punctuation">{</span><span> </span><span> </span><span class="token token property">"key"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"value"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"integer"</span><span> </span><span> </span><span class="token token punctuation">}</span><span> </span><span> </span><span class="token token punctuation">]</span><span> </span><span> </span><span class="token token punctuation">}</span><span> </span><span> </span><span class="token token punctuation">]</span><span> </span><span></span><span class="token token punctuation">}</span></code></pre></div></div></div></div></div><div class="MethodDetail_methodContainer__3EF7h" id="getBitlinksByGroup"><div class="MethodDetail_method__fyEiw"><div><h3 class="MethodHeader_h3__seOfC">Retrieve Bitlinks by Group</h3><h4 class="MethodHeader_description__3_p_p"><div class="MethodHeader_iconStyle__x5Ow4"><svg viewBox="0 0 14 6" xmlns="http://www.w3.org/2000/svg" class="IconRest_restIcon__3pju8 get"><title>Get</title><path d="M2.587 6c.307 0 .607-.044.9-.132.295-.088.533-.217.716-.387V2.876H2.271v.825h1.027v1.145a.772.772 0 0 1-.239.1 1.4 1.4 0 0 1-.383.049 1.338 1.338 0 0 1-1.083-.52c-.135-.17-.24-.379-.316-.626a2.879 2.879 0 0 1-.113-.84c0-.352.038-.655.113-.907.076-.253.182-.46.32-.623.137-.162.3-.281.488-.358a1.783 1.783 0 0 1 .97-.082l.13.032v.915h.889V.28a3.182 3.182 0 0 0-.59-.202A3.507 3.507 0 0 0 2.676 0c-.313 0-.628.055-.946.165a2.4 2.4 0 0 0-.861.523 2.707 2.707 0 0 0-.627.92C.081 1.98 0 2.433 0 2.966c0 .506.067.946.202 1.323.135.376.318.692.55.948a2.2 2.2 0 0 0 .82.572A2.7 2.7 0 0 0 2.587 6Zm6.24-.115V4.879H6.184V3.47h2.4V2.465h-2.4V1.121h2.602V.115h-3.71v5.77h3.75Zm4.43 0v-.907h-.914V1.022h.768v.997H14V.115H9.57V2.02h.89v-.997h.776v3.956h-.922v.907h2.942Z"></path></svg></div> /v4/groups/{group_guid}/bitlinks</h4><p class="MethodHeader_description__3_p_p">Returns a paginated collection of Bitlinks for a group. The list of custom bitlinks has newest entries first.</p></div><div><h4 class="ParameterList_h4__nH9G8 ParameterList_dividing__wRGRx">Path Parameters</h4><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">group_guid</span><span class="Parameter_type__djM_s">string</span><span class="Parameter_required__pcK_H">Required</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">A GUID for a Bitly group</div></div></div><div><h4 class="ParameterList_h4__nH9G8 ParameterList_dividing__wRGRx">Query Parameters</h4><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">size</span><span class="Parameter_type__djM_s">integer</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">The quantity of items to be be returned</div><div class="Parameter_default__HHgG0 Parameter_spacer__JKXbH">Default: <span class="Parameter_label__DUY7G">50</span></div></div><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">search_after</span><span class="Parameter_type__djM_s">string</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">Token used to search next batch, only use response from API as input value.</div></div><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">query</span><span class="Parameter_type__djM_s">string</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">The value that you would like to search</div></div><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">created_before</span><span class="Parameter_type__djM_s">integer</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">Timestamp as an integer unix epoch (seconds only)</div></div><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">created_after</span><span class="Parameter_type__djM_s">integer</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">Timestamp as an integer unix epoch (seconds only)</div></div><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">archived</span><span class="Parameter_type__djM_s">string</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">Whether or not to include archived resources</div><div class="Parameter_default__HHgG0 Parameter_spacer__JKXbH">Default: <span class="Parameter_label__DUY7G">"off"</span></div><div class="Parameter_enum__csO6P Parameter_spacer__JKXbH">Enum: <span class="Parameter_label__DUY7G">"on"</span><span class="Parameter_label__DUY7G">"off"</span><span class="Parameter_label__DUY7G">"both"</span></div></div><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">deeplinks</span><span class="Parameter_type__djM_s">string</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">Filter to only Bitlinks that contain deeplinks</div><div class="Parameter_default__HHgG0 Parameter_spacer__JKXbH">Default: <span class="Parameter_label__DUY7G">"both"</span></div><div class="Parameter_enum__csO6P Parameter_spacer__JKXbH">Enum: <span class="Parameter_label__DUY7G">"on"</span><span class="Parameter_label__DUY7G">"off"</span><span class="Parameter_label__DUY7G">"both"</span></div></div><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">domain_deeplinks</span><span class="Parameter_type__djM_s">string</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">Filter to only Bitlinks that contain deeplinks configured with a custom domain</div><div class="Parameter_default__HHgG0 Parameter_spacer__JKXbH">Default: <span class="Parameter_label__DUY7G">"both"</span></div><div class="Parameter_enum__csO6P Parameter_spacer__JKXbH">Enum: <span class="Parameter_label__DUY7G">"on"</span><span class="Parameter_label__DUY7G">"off"</span><span class="Parameter_label__DUY7G">"both"</span></div></div><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">campaign_guid</span><span class="Parameter_type__djM_s">string</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">Filter to return only links for the given campaign GUID, can be provided</div></div><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">channel_guid</span><span class="Parameter_type__djM_s">string</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">Filter to return only links for the given channel GUID, can be provided, overrides all other parameters</div></div><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">custom_bitlink</span><span class="Parameter_type__djM_s">string</span></div><div class="Parameter_default__HHgG0 Parameter_spacer__JKXbH">Default: <span class="Parameter_label__DUY7G">"both"</span></div><div class="Parameter_enum__csO6P Parameter_spacer__JKXbH">Enum: <span class="Parameter_label__DUY7G">"on"</span><span class="Parameter_label__DUY7G">"off"</span><span class="Parameter_label__DUY7G">"both"</span></div></div><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">has_qr_codes</span><span class="Parameter_type__djM_s">string</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">a filter value if the resource has any QR codes</div><div class="Parameter_default__HHgG0 Parameter_spacer__JKXbH">Default: <span class="Parameter_label__DUY7G">"both"</span></div><div class="Parameter_enum__csO6P Parameter_spacer__JKXbH">Enum: <span class="Parameter_label__DUY7G">"on"</span><span class="Parameter_label__DUY7G">"off"</span><span class="Parameter_label__DUY7G">"both"</span></div></div><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">tags</span><span class="Parameter_type__djM_s">array</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">Filter by given tags</div></div><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">launchpad_ids</span><span class="Parameter_type__djM_s">array</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">Filter by launchpad id</div></div><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">encoding_login</span><span class="Parameter_type__djM_s">array</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">Filter by the login of the authenticated user that created the Bitlink</div></div></div></div><div class="MethodDetail_examples__8nXeM"><div><label class="CodeSyntaxSelector_header__6P_Jc CodeSyntaxSelector_headerDark__hI3A0"><span>Request</span><div class="CodeSyntaxSelector_header__6P_Jc CodeSyntaxSelector_headerDark__hI3A0"><div class="Select_wrapper__58utF Select_dark__KPIws"><select class="Select_select__qXz_Z Select_dark__KPIws" aria-label="Select" autoComplete="off"><option value="cURL" selected="">cURL</option><option value="Node">Node</option><option value="Browser">Browser</option><option value="Go">Go</option><option value="Python">Python</option></select><svg viewBox="0 0 8 14" xmlns="http://www.w3.org/2000/svg"><path d="M6.463 7 .987 1.66a.61.61 0 0 1 0-.878.648.648 0 0 1 .9 0L7.813 6.56a.61.61 0 0 1 0 .878l-5.926 5.78a.648.648 0 0 1-.9 0 .61.61 0 0 1 0-.879L6.463 7Z"></path></svg></div></div></label><div class="CodeSyntaxSelector_body__hBJ7j CodeSyntaxSelector_bodyDark__cizVw"><div class="CodeBlock_codeBlock__KlURa"><pre tabindex="0" style="color:#ffffff;font-family:ProximaNova, monospace;line-height:1.2;font-size:1rem"><code class="language-bash" style="white-space:pre"><span class="token token" style="color:#ee6123">curl</span><span> </span><span class="token token punctuation">\</span><span> </span><span>-H </span><span class="token token" style="color:#acda95">'Authorization: Bearer {TOKEN}'</span><span> </span><span class="token token punctuation">\</span><span> </span><span>-X GET </span><span class="token token punctuation">\</span><span> </span><span>https://api-ssl.bitly.com/v4/groups/Ba1bc23dE4F/bitlinks?size</span><span class="token token operator">=</span><span class="token token" style="color:#a1b8f3">10</span><span class="token token operator">&</span><span class="token token assign-left variable">search_after</span><span class="token token operator">=</span><span class="token token operator">&</span><span class="token token assign-left variable">query</span><span class="token token operator">=</span><span>api</span><span class="token token operator">&</span><span class="token token assign-left variable">created_before</span><span class="token token operator">=</span><span class="token token" style="color:#a1b8f3">1694529902</span><span class="token token operator">&</span><span class="token token assign-left variable">created_after</span><span class="token token operator">=</span><span class="token token" style="color:#a1b8f3">1694529902</span><span class="token token operator">&</span><span class="token token assign-left variable">archived</span><span class="token token operator">=</span><span>both</span><span class="token token operator">&</span><span class="token token assign-left variable">deeplinks</span><span class="token token operator">=</span><span>both</span><span class="token token operator">&</span><span class="token token assign-left variable">domain_deeplinks</span><span class="token token operator">=</span><span>both</span><span class="token token operator">&</span><span class="token token assign-left variable">campaign_guid</span><span class="token token operator">=</span><span>Ca1bcd2EFGh</span><span class="token token operator">&</span><span class="token token assign-left variable">channel_guid</span><span class="token token operator">=</span><span>Ha1bc2DefGh</span><span class="token token operator">&</span><span class="token token assign-left variable">custom_bitlink</span><span class="token token operator">=</span><span>both</span><span class="token token operator">&</span><span class="token token assign-left variable">has_qr_codes</span><span class="token token operator">=</span><span>both</span><span class="token token operator">&</span><span class="token token assign-left variable">tags</span><span class="token token operator">=</span><span>bitly</span><span class="token token operator">&</span><span class="token token assign-left variable">tags</span><span class="token token operator">=</span><span>api</span><span class="token token operator">&</span><span class="token token assign-left variable">launchpad_ids</span><span class="token token operator">=</span><span>M1234567890</span><span class="token token operator">&</span><span class="token token assign-left variable">encoding_login</span><span class="token token operator">=</span><span>chauncey</span></code></pre></div></div></div><div><label class="CodeSyntaxSelector_header__6P_Jc"><span>Response</span><div class="CodeSyntaxSelector_header__6P_Jc"><div class="Select_wrapper__58utF"><select class="Select_select__qXz_Z" aria-label="Select" autoComplete="off"><option value="200" selected="">200 SUCCESS</option><option value="403">403 FORBIDDEN</option><option value="404">404 NOT_FOUND</option><option value="500">500 INTERNAL_ERROR</option><option value="503">503 TEMPORARILY_UNAVAILABLE</option></select><svg viewBox="0 0 8 14" xmlns="http://www.w3.org/2000/svg"><path d="M6.463 7 .987 1.66a.61.61 0 0 1 0-.878.648.648 0 0 1 .9 0L7.813 6.56a.61.61 0 0 1 0 .878l-5.926 5.78a.648.648 0 0 1-.9 0 .61.61 0 0 1 0-.879L6.463 7Z"></path></svg></div></div></label><div class="CodeSyntaxSelector_body__hBJ7j"><div class="CodeBlock_codeBlock__KlURa"><pre tabindex="0" style="color:#36383b;font-family:ProximaNova, monospace;line-height:1.2;font-size:1rem"><code class="language-json" style="white-space:pre"><span class="token token punctuation">{</span><span> </span><span> </span><span class="token token property">"links"</span><span class="token token operator">:</span><span> </span><span class="token token punctuation">[</span><span> </span><span> </span><span class="token token punctuation">{</span><span> </span><span> </span><span class="token token property">"references"</span><span class="token token operator">:</span><span> </span><span class="token token punctuation">{</span><span> </span><span class="token token" style="color:#51763e">"any"</span><span> </span><span class="token token punctuation">}</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"link"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"id"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"long_url"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"title"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"archived"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"boolean"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"created_at"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"created_by"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"client_id"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"custom_bitlinks"</span><span class="token token operator">:</span><span> </span><span class="token token punctuation">[</span><span> </span><span> </span><span class="token token" style="color:#51763e">"string"</span><span> </span><span> </span><span class="token token punctuation">]</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"tags"</span><span class="token token operator">:</span><span> </span><span class="token token punctuation">[</span><span> </span><span> </span><span class="token token" style="color:#51763e">"string"</span><span> </span><span> </span><span class="token token punctuation">]</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"launchpad_ids"</span><span class="token token operator">:</span><span> </span><span class="token token punctuation">[</span><span> </span><span> </span><span class="token token" style="color:#51763e">"string"</span><span> </span><span> </span><span class="token token punctuation">]</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"qr_code_ids"</span><span class="token token operator">:</span><span> </span><span class="token token punctuation">[</span><span> </span><span> </span><span class="token token" style="color:#51763e">"string"</span><span> </span><span> </span><span class="token token punctuation">]</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"deeplinks"</span><span class="token token operator">:</span><span> </span><span class="token token punctuation">[</span><span> </span><span> </span><span class="token token punctuation">{</span><span> </span><span> </span><span class="token token property">"guid"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"bitlink"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"app_uri_path"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"install_url"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"app_guid"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"os"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"install_type"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"created"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"modified"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"brand_guid"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span> </span><span> </span><span class="token token punctuation">}</span><span> </span><span> </span><span class="token token punctuation">]</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"campaign_ids"</span><span class="token token operator">:</span><span> </span><span class="token token punctuation">[</span><span> </span><span> </span><span class="token token" style="color:#51763e">"string"</span><span> </span><span> </span><span class="token token punctuation">]</span><span> </span><span> </span><span class="token token punctuation">}</span><span> </span><span> </span><span class="token token punctuation">]</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"pagination"</span><span class="token token operator">:</span><span> </span><span class="token token punctuation">{</span><span> </span><span> </span><span class="token token property">"next"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"search_after"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"size"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"integer"</span><span> </span><span> </span><span class="token token punctuation">}</span><span> </span><span></span><span class="token token punctuation">}</span></code></pre></div></div></div></div></div><div class="MethodDetail_methodContainer__3EF7h" id="updateBitlinksByGroup"><div class="MethodDetail_method__fyEiw"><div><h3 class="MethodHeader_h3__seOfC">Bulk update bitlinks</h3><h4 class="MethodHeader_description__3_p_p"><div class="MethodHeader_iconStyle__x5Ow4"><svg viewBox="0 0 23 6" xmlns="http://www.w3.org/2000/svg" class="IconRest_restIcon__3pju8 patch"><title>Patch</title><path d="M1.095 5.885V3.898c.027.006.07.011.132.017a4.052 4.052 0 0 0 .372.016h.128c.277 0 .545-.037.803-.11.259-.075.49-.193.692-.355.202-.162.365-.368.487-.618.123-.25.184-.551.184-.903 0-.401-.07-.727-.212-.977a1.606 1.606 0 0 0-.547-.585 2.041 2.041 0 0 0-.756-.28 5.067 5.067 0 0 0-.835-.07c-.267 0-.534.012-.804.037C.47.095.224.13 0 .173v5.712h1.095Zm.472-2.934h-.1a2.448 2.448 0 0 1-.276-.017.853.853 0 0 1-.096-.016V1.047c.059-.011.136-.02.232-.03.096-.007.197-.012.304-.012.138 0 .274.014.408.042a.964.964 0 0 1 .355.148.801.801 0 0 1 .252.284.937.937 0 0 1 .096.45c0 .214-.033.387-.1.519a.787.787 0 0 1-.268.309 1.038 1.038 0 0 1-.38.152 2.235 2.235 0 0 1-.427.042Zm3.79 2.934.383-1.278h1.67l.4 1.278h1.152L7.163.115H6.068L4.26 5.885h1.095ZM7.194 3.7h-1.2l.56-1.929h.072l.568 1.929Zm5.668 2.184v-.907h-.903V1.022h.76v.997h.879V.115H9.218V2.02h.879v-.997h.767v3.956h-.91v.907h2.91Zm3.91.115c.276 0 .547-.036.81-.107.265-.072.482-.17.652-.297V3.948h-.88v.997c-.164.033-.335.05-.51.05-.246 0-.464-.049-.656-.145a1.383 1.383 0 0 1-.488-.408 1.881 1.881 0 0 1-.304-.63A2.973 2.973 0 0 1 15.293 3c0-.34.038-.636.112-.886.075-.25.179-.457.312-.622.133-.165.29-.287.468-.367.178-.08.371-.12.58-.12.175 0 .346.014.511.042v.94h.88V.271a2.727 2.727 0 0 0-.548-.19A3.419 3.419 0 0 0 16.796 0c-.303 0-.613.05-.927.152-.314.102-.6.27-.855.503a2.611 2.611 0 0 0-.628.923c-.163.382-.244.856-.244 1.422 0 .544.072 1.007.216 1.389.144.382.336.692.576.931.24.24.518.412.835.52.317.106.652.16 1.003.16Zm3.325-.115V3.47h1.807v2.415H23V.115h-1.095v2.35h-1.807V.114h-1.095v5.77h1.095Z"></path></svg></div> /v4/groups/{group_guid}/bitlinks</h4><p class="MethodHeader_description__3_p_p">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.</p></div><div><h4 class="ParameterList_h4__nH9G8 ParameterList_dividing__wRGRx">Path Parameters</h4><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">group_guid</span><span class="Parameter_type__djM_s">string</span><span class="Parameter_required__pcK_H">Required</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">A GUID for a Bitly group</div></div></div><div><h4 class="ParameterList_h4__nH9G8 ParameterList_dividing__wRGRx">Request Body Schema</h4><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">action</span><span class="Parameter_type__djM_s">string</span><span class="Parameter_required__pcK_H">Required</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">archive or edit_tags</div><div class="Parameter_enum__csO6P Parameter_spacer__JKXbH">Enum: <span class="Parameter_label__DUY7G">"archive"</span><span class="Parameter_label__DUY7G">"edit_tags"</span></div></div><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">archive</span><span class="Parameter_type__djM_s">boolean</span></div></div><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">add_tags</span><span class="Parameter_type__djM_s">array of string</span></div></div><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">remove_tags</span><span class="Parameter_type__djM_s">array of string</span></div></div><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">links</span><span class="Parameter_type__djM_s">array of string</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">this is limited to 100 bitlink ids</div></div></div></div><div class="MethodDetail_examples__8nXeM"><div><label class="CodeSyntaxSelector_header__6P_Jc CodeSyntaxSelector_headerDark__hI3A0"><span>Request</span><div class="CodeSyntaxSelector_header__6P_Jc CodeSyntaxSelector_headerDark__hI3A0"><div class="Select_wrapper__58utF Select_dark__KPIws"><select class="Select_select__qXz_Z Select_dark__KPIws" aria-label="Select" autoComplete="off"><option value="cURL" selected="">cURL</option><option value="Node">Node</option><option value="Browser">Browser</option><option value="Go">Go</option><option value="Python">Python</option></select><svg viewBox="0 0 8 14" xmlns="http://www.w3.org/2000/svg"><path d="M6.463 7 .987 1.66a.61.61 0 0 1 0-.878.648.648 0 0 1 .9 0L7.813 6.56a.61.61 0 0 1 0 .878l-5.926 5.78a.648.648 0 0 1-.9 0 .61.61 0 0 1 0-.879L6.463 7Z"></path></svg></div></div></label><div class="CodeSyntaxSelector_body__hBJ7j CodeSyntaxSelector_bodyDark__cizVw"><div class="CodeBlock_codeBlock__KlURa"><pre tabindex="0" style="color:#ffffff;font-family:ProximaNova, monospace;line-height:1.2;font-size:1rem"><code class="language-bash" style="white-space:pre"><span class="token token" style="color:#ee6123">curl</span><span> </span><span class="token token punctuation">\</span><span> </span><span>-H </span><span class="token token" style="color:#acda95">'Authorization: Bearer {TOKEN}'</span><span> </span><span class="token token punctuation">\</span><span> </span><span>-H </span><span class="token token" style="color:#acda95">'Content-Type: application/json'</span><span> </span><span class="token token punctuation">\</span><span> </span><span>-X PATCH </span><span class="token token punctuation">\</span><span> </span><span>-d </span><span class="token token" style="color:#acda95">'{ </span><span class="token token" style="color:#acda95"> "action": "edit_tags", </span><span class="token token" style="color:#acda95"> "add_tags": [ </span><span class="token token" style="color:#acda95"> "tag1", </span><span class="token token" style="color:#acda95"> "tag2" </span><span class="token token" style="color:#acda95"> ], </span><span class="token token" style="color:#acda95"> "links": [ </span><span class="token token" style="color:#acda95"> "bit.ly/1234abcd", </span><span class="token token" style="color:#acda95"> "bit.ly/5678efgh" </span><span class="token token" style="color:#acda95"> ] </span><span class="token token" style="color:#acda95">}'</span><span> </span><span class="token token punctuation">\</span><span> </span>https://api-ssl.bitly.com/v4/groups/Ba1bc23dE4F/bitlinks</code></pre></div></div></div><div><label class="CodeSyntaxSelector_header__6P_Jc"><span>Response</span><div class="CodeSyntaxSelector_header__6P_Jc"><div class="Select_wrapper__58utF"><select class="Select_select__qXz_Z" aria-label="Select" autoComplete="off"><option value="200" selected="">200 SUCCESS</option><option value="400">400 BAD_REQUEST</option><option value="403">403 FORBIDDEN</option><option value="404">404 NOT_FOUND</option><option value="422">422 UNPROCESSABLE_ENTITY</option><option value="500">500 INTERNAL_ERROR</option><option value="503">503 TEMPORARILY_UNAVAILABLE</option></select><svg viewBox="0 0 8 14" xmlns="http://www.w3.org/2000/svg"><path d="M6.463 7 .987 1.66a.61.61 0 0 1 0-.878.648.648 0 0 1 .9 0L7.813 6.56a.61.61 0 0 1 0 .878l-5.926 5.78a.648.648 0 0 1-.9 0 .61.61 0 0 1 0-.879L6.463 7Z"></path></svg></div></div></label><div class="CodeSyntaxSelector_body__hBJ7j"><div class="CodeBlock_codeBlock__KlURa"><pre tabindex="0" style="color:#36383b;font-family:ProximaNova, monospace;line-height:1.2;font-size:1rem"><code class="language-json" style="white-space:pre"><span class="token token punctuation">{</span><span> </span><span> </span><span class="token token property">"links"</span><span class="token token operator">:</span><span> </span><span class="token token punctuation">[</span><span> </span><span> </span><span class="token token" style="color:#51763e">"string"</span><span> </span><span> </span><span class="token token punctuation">]</span><span> </span><span></span><span class="token token punctuation">}</span></code></pre></div></div></div></div></div><div class="MethodDetail_methodContainer__3EF7h" id="getSortedBitlinks"><div class="MethodDetail_method__fyEiw"><div><h3 class="MethodHeader_h3__seOfC">Retrieve Sorted Bitlinks for Group</h3><h4 class="MethodHeader_description__3_p_p"><div class="MethodHeader_iconStyle__x5Ow4"><svg viewBox="0 0 14 6" xmlns="http://www.w3.org/2000/svg" class="IconRest_restIcon__3pju8 get"><title>Get</title><path d="M2.587 6c.307 0 .607-.044.9-.132.295-.088.533-.217.716-.387V2.876H2.271v.825h1.027v1.145a.772.772 0 0 1-.239.1 1.4 1.4 0 0 1-.383.049 1.338 1.338 0 0 1-1.083-.52c-.135-.17-.24-.379-.316-.626a2.879 2.879 0 0 1-.113-.84c0-.352.038-.655.113-.907.076-.253.182-.46.32-.623.137-.162.3-.281.488-.358a1.783 1.783 0 0 1 .97-.082l.13.032v.915h.889V.28a3.182 3.182 0 0 0-.59-.202A3.507 3.507 0 0 0 2.676 0c-.313 0-.628.055-.946.165a2.4 2.4 0 0 0-.861.523 2.707 2.707 0 0 0-.627.92C.081 1.98 0 2.433 0 2.966c0 .506.067.946.202 1.323.135.376.318.692.55.948a2.2 2.2 0 0 0 .82.572A2.7 2.7 0 0 0 2.587 6Zm6.24-.115V4.879H6.184V3.47h2.4V2.465h-2.4V1.121h2.602V.115h-3.71v5.77h3.75Zm4.43 0v-.907h-.914V1.022h.768v.997H14V.115H9.57V2.02h.89v-.997h.776v3.956h-.922v.907h2.942Z"></path></svg></div> /v4/groups/{group_guid}/bitlinks/{sort}</h4><p class="MethodHeader_description__3_p_p">Returns a list of Bitlinks sorted by group. The list of custom bitlinks has newest entries first.</p></div><div><h4 class="ParameterList_h4__nH9G8 ParameterList_dividing__wRGRx">Path Parameters</h4><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">group_guid</span><span class="Parameter_type__djM_s">string</span><span class="Parameter_required__pcK_H">Required</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">A GUID for a Bitly group</div></div><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">sort</span><span class="Parameter_type__djM_s">string</span><span class="Parameter_required__pcK_H">Required</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">The type of sorting that you would like to do</div><div class="Parameter_enum__csO6P Parameter_spacer__JKXbH">Enum: <span class="Parameter_label__DUY7G">"clicks"</span></div></div></div><div><h4 class="ParameterList_h4__nH9G8 ParameterList_dividing__wRGRx">Query Parameters</h4><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">unit</span><span class="Parameter_type__djM_s">string</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">A unit of time</div><div class="Parameter_default__HHgG0 Parameter_spacer__JKXbH">Default: <span class="Parameter_label__DUY7G">"day"</span></div><div class="Parameter_enum__csO6P Parameter_spacer__JKXbH">Enum: <span class="Parameter_label__DUY7G">"minute"</span><span class="Parameter_label__DUY7G">"hour"</span><span class="Parameter_label__DUY7G">"day"</span><span class="Parameter_label__DUY7G">"week"</span><span class="Parameter_label__DUY7G">"month"</span></div></div><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">units</span><span class="Parameter_type__djM_s">integer</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">An integer representing the time units to query data for. pass -1 to return all units of time.</div><div class="Parameter_default__HHgG0 Parameter_spacer__JKXbH">Default: <span class="Parameter_label__DUY7G">-1</span></div></div><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">unit_reference</span><span class="Parameter_type__djM_s">string</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">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)</div></div><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">size</span><span class="Parameter_type__djM_s">integer</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">The quantity of items to be be returned</div><div class="Parameter_default__HHgG0 Parameter_spacer__JKXbH">Default: <span class="Parameter_label__DUY7G">50</span></div></div></div></div><div class="MethodDetail_examples__8nXeM"><div><label class="CodeSyntaxSelector_header__6P_Jc CodeSyntaxSelector_headerDark__hI3A0"><span>Request</span><div class="CodeSyntaxSelector_header__6P_Jc CodeSyntaxSelector_headerDark__hI3A0"><div class="Select_wrapper__58utF Select_dark__KPIws"><select class="Select_select__qXz_Z Select_dark__KPIws" aria-label="Select" autoComplete="off"><option value="cURL" selected="">cURL</option><option value="Node">Node</option><option value="Browser">Browser</option><option value="Go">Go</option><option value="Python">Python</option></select><svg viewBox="0 0 8 14" xmlns="http://www.w3.org/2000/svg"><path d="M6.463 7 .987 1.66a.61.61 0 0 1 0-.878.648.648 0 0 1 .9 0L7.813 6.56a.61.61 0 0 1 0 .878l-5.926 5.78a.648.648 0 0 1-.9 0 .61.61 0 0 1 0-.879L6.463 7Z"></path></svg></div></div></label><div class="CodeSyntaxSelector_body__hBJ7j CodeSyntaxSelector_bodyDark__cizVw"><div class="CodeBlock_codeBlock__KlURa"><pre tabindex="0" style="color:#ffffff;font-family:ProximaNova, monospace;line-height:1.2;font-size:1rem"><code class="language-bash" style="white-space:pre"><span class="token token" style="color:#ee6123">curl</span><span> </span><span class="token token punctuation">\</span><span> </span><span>-H </span><span class="token token" style="color:#acda95">'Authorization: Bearer {TOKEN}'</span><span> </span><span class="token token punctuation">\</span><span> </span><span>-X GET </span><span class="token token punctuation">\</span><span> </span><span>https://api-ssl.bitly.com/v4/groups/Ba1bc23dE4F/bitlinks/clicks?unit</span><span class="token token operator">=</span><span>month</span><span class="token token operator">&</span><span class="token token assign-left variable">units</span><span class="token token operator">=</span><span class="token token" style="color:#a1b8f3">1</span><span class="token token operator">&</span><span class="token token assign-left variable">unit_reference</span><span class="token token operator">=</span><span class="token token" style="color:#a1b8f3">2006</span><span>-01-02T15%3A04%3A05-0700</span><span class="token token operator">&</span><span class="token token assign-left variable">size</span><span class="token token operator">=</span><span class="token token" style="color:#a1b8f3">10</span></code></pre></div></div></div><div><label class="CodeSyntaxSelector_header__6P_Jc"><span>Response</span><div class="CodeSyntaxSelector_header__6P_Jc"><div class="Select_wrapper__58utF"><select class="Select_select__qXz_Z" aria-label="Select" autoComplete="off"><option value="200" selected="">200 SUCCESS</option><option value="403">403 FORBIDDEN</option><option value="404">404 NOT_FOUND</option><option value="429">429 MONTHLY_LIMIT_EXCEEDED</option><option value="500">500 INTERNAL_ERROR</option><option value="503">503 TEMPORARILY_UNAVAILABLE</option></select><svg viewBox="0 0 8 14" xmlns="http://www.w3.org/2000/svg"><path d="M6.463 7 .987 1.66a.61.61 0 0 1 0-.878.648.648 0 0 1 .9 0L7.813 6.56a.61.61 0 0 1 0 .878l-5.926 5.78a.648.648 0 0 1-.9 0 .61.61 0 0 1 0-.879L6.463 7Z"></path></svg></div></div></label><div class="CodeSyntaxSelector_body__hBJ7j"><div class="CodeBlock_codeBlock__KlURa"><pre tabindex="0" style="color:#36383b;font-family:ProximaNova, monospace;line-height:1.2;font-size:1rem"><code class="language-json" style="white-space:pre"><span class="token token punctuation">{</span><span> </span><span> </span><span class="token token property">"links"</span><span class="token token operator">:</span><span> </span><span class="token token punctuation">[</span><span> </span><span> </span><span class="token token punctuation">{</span><span> </span><span> </span><span class="token token property">"references"</span><span class="token token operator">:</span><span> </span><span class="token token punctuation">{</span><span> </span><span class="token token" style="color:#51763e">"any"</span><span> </span><span class="token token punctuation">}</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"link"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"id"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"long_url"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"title"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"archived"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"boolean"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"created_at"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"created_by"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"client_id"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"custom_bitlinks"</span><span class="token token operator">:</span><span> </span><span class="token token punctuation">[</span><span> </span><span> </span><span class="token token" style="color:#51763e">"string"</span><span> </span><span> </span><span class="token token punctuation">]</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"tags"</span><span class="token token operator">:</span><span> </span><span class="token token punctuation">[</span><span> </span><span> </span><span class="token token" style="color:#51763e">"string"</span><span> </span><span> </span><span class="token token punctuation">]</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"launchpad_ids"</span><span class="token token operator">:</span><span> </span><span class="token token punctuation">[</span><span> </span><span> </span><span class="token token" style="color:#51763e">"string"</span><span> </span><span> </span><span class="token token punctuation">]</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"qr_code_ids"</span><span class="token token operator">:</span><span> </span><span class="token token punctuation">[</span><span> </span><span> </span><span class="token token" style="color:#51763e">"string"</span><span> </span><span> </span><span class="token token punctuation">]</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"deeplinks"</span><span class="token token operator">:</span><span> </span><span class="token token punctuation">[</span><span> </span><span> </span><span class="token token punctuation">{</span><span> </span><span> </span><span class="token token property">"guid"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"bitlink"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"app_uri_path"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"install_url"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"app_guid"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"os"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"install_type"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"created"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"modified"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"brand_guid"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span> </span><span> </span><span class="token token punctuation">}</span><span> </span><span> </span><span class="token token punctuation">]</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"campaign_ids"</span><span class="token token operator">:</span><span> </span><span class="token token punctuation">[</span><span> </span><span> </span><span class="token token" style="color:#51763e">"string"</span><span> </span><span> </span><span class="token token punctuation">]</span><span> </span><span> </span><span class="token token punctuation">}</span><span> </span><span> </span><span class="token token punctuation">]</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"sorted_links"</span><span class="token token operator">:</span><span> </span><span class="token token punctuation">[</span><span> </span><span> </span><span class="token token punctuation">{</span><span> </span><span> </span><span class="token token property">"clicks"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"integer"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"id"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span> </span><span> </span><span class="token token punctuation">}</span><span> </span><span> </span><span class="token token punctuation">]</span><span> </span><span></span><span class="token token punctuation">}</span></code></pre></div></div></div></div></div><div class="ApiReference_tagInfo__YVbgw"><h2 class="ApiReference_tagName__IJx2p">BSDs</h2><p class="ApiReference_tagDescription__8c1GM">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. </p></div><div class="MethodDetail_methodContainer__3EF7h" id="getBSDs"><div class="MethodDetail_method__fyEiw"><div><h3 class="MethodHeader_h3__seOfC">Get BSDs</h3><h4 class="MethodHeader_description__3_p_p"><div class="MethodHeader_iconStyle__x5Ow4"><svg viewBox="0 0 14 6" xmlns="http://www.w3.org/2000/svg" class="IconRest_restIcon__3pju8 get"><title>Get</title><path d="M2.587 6c.307 0 .607-.044.9-.132.295-.088.533-.217.716-.387V2.876H2.271v.825h1.027v1.145a.772.772 0 0 1-.239.1 1.4 1.4 0 0 1-.383.049 1.338 1.338 0 0 1-1.083-.52c-.135-.17-.24-.379-.316-.626a2.879 2.879 0 0 1-.113-.84c0-.352.038-.655.113-.907.076-.253.182-.46.32-.623.137-.162.3-.281.488-.358a1.783 1.783 0 0 1 .97-.082l.13.032v.915h.889V.28a3.182 3.182 0 0 0-.59-.202A3.507 3.507 0 0 0 2.676 0c-.313 0-.628.055-.946.165a2.4 2.4 0 0 0-.861.523 2.707 2.707 0 0 0-.627.92C.081 1.98 0 2.433 0 2.966c0 .506.067.946.202 1.323.135.376.318.692.55.948a2.2 2.2 0 0 0 .82.572A2.7 2.7 0 0 0 2.587 6Zm6.24-.115V4.879H6.184V3.47h2.4V2.465h-2.4V1.121h2.602V.115h-3.71v5.77h3.75Zm4.43 0v-.907h-.914V1.022h.768v.997H14V.115H9.57V2.02h.89v-.997h.776v3.956h-.922v.907h2.942Z"></path></svg></div> /v4/bsds</h4><p class="MethodHeader_description__3_p_p">Fetch all Branded Short Domains</p></div></div><div class="MethodDetail_examples__8nXeM"><div><label class="CodeSyntaxSelector_header__6P_Jc CodeSyntaxSelector_headerDark__hI3A0"><span>Request</span><div class="CodeSyntaxSelector_header__6P_Jc CodeSyntaxSelector_headerDark__hI3A0"><div class="Select_wrapper__58utF Select_dark__KPIws"><select class="Select_select__qXz_Z Select_dark__KPIws" aria-label="Select" autoComplete="off"><option value="cURL" selected="">cURL</option><option value="Node">Node</option><option value="Browser">Browser</option><option value="Go">Go</option><option value="Python">Python</option></select><svg viewBox="0 0 8 14" xmlns="http://www.w3.org/2000/svg"><path d="M6.463 7 .987 1.66a.61.61 0 0 1 0-.878.648.648 0 0 1 .9 0L7.813 6.56a.61.61 0 0 1 0 .878l-5.926 5.78a.648.648 0 0 1-.9 0 .61.61 0 0 1 0-.879L6.463 7Z"></path></svg></div></div></label><div class="CodeSyntaxSelector_body__hBJ7j CodeSyntaxSelector_bodyDark__cizVw"><div class="CodeBlock_codeBlock__KlURa"><pre tabindex="0" style="color:#ffffff;font-family:ProximaNova, monospace;line-height:1.2;font-size:1rem"><code class="language-bash" style="white-space:pre"><span class="token token" style="color:#ee6123">curl</span><span> </span><span class="token token punctuation">\</span><span> </span><span>-H </span><span class="token token" style="color:#acda95">'Authorization: Bearer {TOKEN}'</span><span> </span><span class="token token punctuation">\</span><span> </span><span>-X GET </span><span class="token token punctuation">\</span><span> </span>https://api-ssl.bitly.com/v4/bsds</code></pre></div></div></div><div><label class="CodeSyntaxSelector_header__6P_Jc"><span>Response</span><div class="CodeSyntaxSelector_header__6P_Jc"><div class="Select_wrapper__58utF"><select class="Select_select__qXz_Z" aria-label="Select" autoComplete="off"><option value="200" selected="">200 SUCCESS</option><option value="400">400 BAD_REQUEST</option><option value="403">403 FORBIDDEN</option><option value="500">500 INTERNAL_ERROR</option><option value="503">503 TEMPORARILY_UNAVAILABLE</option></select><svg viewBox="0 0 8 14" xmlns="http://www.w3.org/2000/svg"><path d="M6.463 7 .987 1.66a.61.61 0 0 1 0-.878.648.648 0 0 1 .9 0L7.813 6.56a.61.61 0 0 1 0 .878l-5.926 5.78a.648.648 0 0 1-.9 0 .61.61 0 0 1 0-.879L6.463 7Z"></path></svg></div></div></label><div class="CodeSyntaxSelector_body__hBJ7j"><div class="CodeBlock_codeBlock__KlURa"><pre tabindex="0" style="color:#36383b;font-family:ProximaNova, monospace;line-height:1.2;font-size:1rem"><code class="language-json" style="white-space:pre"><span class="token token punctuation">{</span><span> </span><span> </span><span class="token token property">"bsds"</span><span class="token token operator">:</span><span> </span><span class="token token punctuation">[</span><span> </span><span> </span><span class="token token" style="color:#51763e">"string"</span><span> </span><span> </span><span class="token token punctuation">]</span><span> </span><span></span><span class="token token punctuation">}</span></code></pre></div></div></div></div></div><div class="ApiReference_tagInfo__YVbgw"><h2 class="ApiReference_tagName__IJx2p">Campaigns</h2><p class="ApiReference_tagDescription__8c1GM">Bitly Campaigns are used to build and organize links and metrics for marketing campaigns. </p></div><div class="MethodDetail_methodContainer__3EF7h" id="getCampaigns"><div class="MethodDetail_method__fyEiw"><div><h3 class="MethodHeader_h3__seOfC">Retrieve Campaigns</h3><h4 class="MethodHeader_description__3_p_p"><div class="MethodHeader_iconStyle__x5Ow4"><svg viewBox="0 0 14 6" xmlns="http://www.w3.org/2000/svg" class="IconRest_restIcon__3pju8 get"><title>Get</title><path d="M2.587 6c.307 0 .607-.044.9-.132.295-.088.533-.217.716-.387V2.876H2.271v.825h1.027v1.145a.772.772 0 0 1-.239.1 1.4 1.4 0 0 1-.383.049 1.338 1.338 0 0 1-1.083-.52c-.135-.17-.24-.379-.316-.626a2.879 2.879 0 0 1-.113-.84c0-.352.038-.655.113-.907.076-.253.182-.46.32-.623.137-.162.3-.281.488-.358a1.783 1.783 0 0 1 .97-.082l.13.032v.915h.889V.28a3.182 3.182 0 0 0-.59-.202A3.507 3.507 0 0 0 2.676 0c-.313 0-.628.055-.946.165a2.4 2.4 0 0 0-.861.523 2.707 2.707 0 0 0-.627.92C.081 1.98 0 2.433 0 2.966c0 .506.067.946.202 1.323.135.376.318.692.55.948a2.2 2.2 0 0 0 .82.572A2.7 2.7 0 0 0 2.587 6Zm6.24-.115V4.879H6.184V3.47h2.4V2.465h-2.4V1.121h2.602V.115h-3.71v5.77h3.75Zm4.43 0v-.907h-.914V1.022h.768v.997H14V.115H9.57V2.02h.89v-.997h.776v3.956h-.922v.907h2.942Z"></path></svg></div> /v4/campaigns</h4><p class="MethodHeader_description__3_p_p">Returns the campaigns for the current authenticated user.</p></div><div><h4 class="ParameterList_h4__nH9G8 ParameterList_dividing__wRGRx">Query Parameters</h4><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">group_guid</span><span class="Parameter_type__djM_s">string</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">A GUID for a Bitly group</div></div></div></div><div class="MethodDetail_examples__8nXeM"><div><label class="CodeSyntaxSelector_header__6P_Jc CodeSyntaxSelector_headerDark__hI3A0"><span>Request</span><div class="CodeSyntaxSelector_header__6P_Jc CodeSyntaxSelector_headerDark__hI3A0"><div class="Select_wrapper__58utF Select_dark__KPIws"><select class="Select_select__qXz_Z Select_dark__KPIws" aria-label="Select" autoComplete="off"><option value="cURL" selected="">cURL</option><option value="Node">Node</option><option value="Browser">Browser</option><option value="Go">Go</option><option value="Python">Python</option></select><svg viewBox="0 0 8 14" xmlns="http://www.w3.org/2000/svg"><path d="M6.463 7 .987 1.66a.61.61 0 0 1 0-.878.648.648 0 0 1 .9 0L7.813 6.56a.61.61 0 0 1 0 .878l-5.926 5.78a.648.648 0 0 1-.9 0 .61.61 0 0 1 0-.879L6.463 7Z"></path></svg></div></div></label><div class="CodeSyntaxSelector_body__hBJ7j CodeSyntaxSelector_bodyDark__cizVw"><div class="CodeBlock_codeBlock__KlURa"><pre tabindex="0" style="color:#ffffff;font-family:ProximaNova, monospace;line-height:1.2;font-size:1rem"><code class="language-bash" style="white-space:pre"><span class="token token" style="color:#ee6123">curl</span><span> </span><span class="token token punctuation">\</span><span> </span><span>-H </span><span class="token token" style="color:#acda95">'Authorization: Bearer {TOKEN}'</span><span> </span><span class="token token punctuation">\</span><span> </span><span>-X GET </span><span class="token token punctuation">\</span><span> </span><span>https://api-ssl.bitly.com/v4/campaigns?group_guid</span><span class="token token operator">=</span><span>Ba1bc23dE4F</span></code></pre></div></div></div><div><label class="CodeSyntaxSelector_header__6P_Jc"><span>Response</span><div class="CodeSyntaxSelector_header__6P_Jc"><div class="Select_wrapper__58utF"><select class="Select_select__qXz_Z" aria-label="Select" autoComplete="off"><option value="200" selected="">200 SUCCESS</option><option value="400">400 BAD_REQUEST</option><option value="402">402 UPGRADE_REQUIRED</option><option value="403">403 FORBIDDEN</option><option value="404">404 NOT_FOUND</option><option value="500">500 INTERNAL_ERROR</option><option value="502">502 BAD_GATEWAY</option><option value="503">503 TEMPORARILY_UNAVAILABLE</option></select><svg viewBox="0 0 8 14" xmlns="http://www.w3.org/2000/svg"><path d="M6.463 7 .987 1.66a.61.61 0 0 1 0-.878.648.648 0 0 1 .9 0L7.813 6.56a.61.61 0 0 1 0 .878l-5.926 5.78a.648.648 0 0 1-.9 0 .61.61 0 0 1 0-.879L6.463 7Z"></path></svg></div></div></label><div class="CodeSyntaxSelector_body__hBJ7j"><div class="CodeBlock_codeBlock__KlURa"><pre tabindex="0" style="color:#36383b;font-family:ProximaNova, monospace;line-height:1.2;font-size:1rem"><code class="language-json" style="white-space:pre"><span class="token token punctuation">{</span><span> </span><span> </span><span class="token token property">"campaigns"</span><span class="token token operator">:</span><span> </span><span class="token token punctuation">[</span><span> </span><span> </span><span class="token token punctuation">{</span><span> </span><span> </span><span class="token token property">"references"</span><span class="token token operator">:</span><span> </span><span class="token token punctuation">{</span><span> </span><span class="token token" style="color:#51763e">"any"</span><span> </span><span class="token token punctuation">}</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"guid"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"group_guid"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"created_by"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"name"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"description"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"created"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"modified"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span> </span><span> </span><span class="token token punctuation">}</span><span> </span><span> </span><span class="token token punctuation">]</span><span> </span><span></span><span class="token token punctuation">}</span></code></pre></div></div></div></div></div><div class="MethodDetail_methodContainer__3EF7h" id="createCampaign"><div class="MethodDetail_method__fyEiw"><div><h3 class="MethodHeader_h3__seOfC">Create Campaign</h3><h4 class="MethodHeader_description__3_p_p"><div class="MethodHeader_iconStyle__x5Ow4"><svg viewBox="0 0 18 6" xmlns="http://www.w3.org/2000/svg" class="IconRest_restIcon__3pju8 post"><title>Post</title><path d="M1.072 5.885V3.898c.026.006.069.011.129.017a3.88 3.88 0 0 0 .364.016h.125c.27 0 .533-.037.786-.11.253-.075.478-.193.677-.355.198-.162.357-.368.477-.618s.18-.551.18-.903c0-.401-.07-.727-.208-.977a1.592 1.592 0 0 0-.536-.585 1.971 1.971 0 0 0-.739-.28 4.854 4.854 0 0 0-.817-.07C1.249.033.987.045.724.07.46.095.219.13 0 .173v5.712h1.072Zm.461-2.934h-.098a2.344 2.344 0 0 1-.27-.017.818.818 0 0 1-.093-.016V1.047c.057-.011.133-.02.227-.03.093-.007.193-.012.297-.012.135 0 .268.014.399.042.13.027.246.077.348.148a.796.796 0 0 1 .246.284.954.954 0 0 1 .094.45c0 .214-.032.387-.098.519a.782.782 0 0 1-.262.309c-.11.074-.233.125-.371.152a2.141 2.141 0 0 1-.419.042ZM6.47 6c.694 0 1.212-.265 1.553-.795.342-.53.513-1.265.513-2.205 0-.44-.038-.843-.114-1.212a2.872 2.872 0 0 0-.36-.947 1.78 1.78 0 0 0-.637-.618C7.163.074 6.844 0 6.469 0c-.35 0-.653.069-.911.206a1.78 1.78 0 0 0-.645.59c-.172.255-.3.57-.384.943A5.804 5.804 0 0 0 4.404 3c0 .44.037.843.11 1.212.073.368.191.684.356.947.164.264.378.47.641.618.263.149.583.223.958.223Zm0-1.005c-.203 0-.366-.053-.489-.157a.989.989 0 0 1-.281-.425 2.57 2.57 0 0 1-.133-.63A8.129 8.129 0 0 1 5.53 3c0-.66.065-1.157.195-1.492.13-.335.378-.503.743-.503.209 0 .376.054.501.161a1 1 0 0 1 .286.433c.065.181.106.393.125.635.018.241.027.497.027.766 0 .34-.014.636-.043.886-.029.25-.08.457-.152.622a.826.826 0 0 1-.29.367.803.803 0 0 1-.454.12ZM10.991 6c.297 0 .574-.037.83-.111.255-.074.476-.187.664-.338.188-.151.334-.338.438-.56.104-.223.157-.483.157-.78 0-.307-.067-.563-.2-.766a1.814 1.814 0 0 0-.493-.507 3.3 3.3 0 0 0-.641-.342 11.165 11.165 0 0 1-.642-.28 2.185 2.185 0 0 1-.493-.313.562.562 0 0 1-.199-.445c0-.176.072-.316.215-.42.144-.105.34-.157.59-.157a2.757 2.757 0 0 1 .767.107.14.14 0 0 0 .047.008v.915h.86V.338a2.45 2.45 0 0 0-.735-.247C11.85.03 11.536 0 11.218 0c-.282 0-.537.041-.767.124-.23.082-.426.197-.59.346A1.557 1.557 0 0 0 9.476 1a1.66 1.66 0 0 0-.137.68c0 .324.067.588.2.792.133.203.297.372.493.506.195.135.409.246.641.334.232.088.446.176.642.264.195.088.36.19.492.305.133.115.2.266.2.453 0 .209-.081.375-.243.499-.161.123-.388.185-.68.185-.162 0-.314-.018-.458-.053a2.256 2.256 0 0 1-.395-.136l-.047-.017v-.816h-.86V5.53c.067.039.156.085.266.14.11.055.236.107.379.157.143.05.3.09.47.124.169.033.353.049.55.049Zm6.29-.115v-.907h-.885V1.022h.744v.997H18V.115h-4.287V2.02h.86v-.997h.752v3.956h-.892v.907h2.847Z"></path></svg></div> /v4/campaigns</h4><p class="MethodHeader_description__3_p_p">Creates a new campaign.</p></div><div><h4 class="ParameterList_h4__nH9G8 ParameterList_dividing__wRGRx">Request Body Schema</h4><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">group_guid</span><span class="Parameter_type__djM_s">string</span></div></div><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">name</span><span class="Parameter_type__djM_s">string</span></div></div><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">description</span><span class="Parameter_type__djM_s">string</span></div></div><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">channel_guids</span><span class="Parameter_type__djM_s">array of string</span></div></div></div></div><div class="MethodDetail_examples__8nXeM"><div><label class="CodeSyntaxSelector_header__6P_Jc CodeSyntaxSelector_headerDark__hI3A0"><span>Request</span><div class="CodeSyntaxSelector_header__6P_Jc CodeSyntaxSelector_headerDark__hI3A0"><div class="Select_wrapper__58utF Select_dark__KPIws"><select class="Select_select__qXz_Z Select_dark__KPIws" aria-label="Select" autoComplete="off"><option value="cURL" selected="">cURL</option><option value="Node">Node</option><option value="Browser">Browser</option><option value="Go">Go</option><option value="Python">Python</option></select><svg viewBox="0 0 8 14" xmlns="http://www.w3.org/2000/svg"><path d="M6.463 7 .987 1.66a.61.61 0 0 1 0-.878.648.648 0 0 1 .9 0L7.813 6.56a.61.61 0 0 1 0 .878l-5.926 5.78a.648.648 0 0 1-.9 0 .61.61 0 0 1 0-.879L6.463 7Z"></path></svg></div></div></label><div class="CodeSyntaxSelector_body__hBJ7j CodeSyntaxSelector_bodyDark__cizVw"><div class="CodeBlock_codeBlock__KlURa"><pre tabindex="0" style="color:#ffffff;font-family:ProximaNova, monospace;line-height:1.2;font-size:1rem"><code class="language-bash" style="white-space:pre"><span class="token token" style="color:#ee6123">curl</span><span> </span><span class="token token punctuation">\</span><span> </span><span>-H </span><span class="token token" style="color:#acda95">'Authorization: Bearer {TOKEN}'</span><span> </span><span class="token token punctuation">\</span><span> </span><span>-H </span><span class="token token" style="color:#acda95">'Content-Type: application/json'</span><span> </span><span class="token token punctuation">\</span><span> </span><span>-X POST </span><span class="token token punctuation">\</span><span> </span><span>-d </span><span class="token token" style="color:#acda95">'{ </span><span class="token token" style="color:#acda95"> "group_guid": "Ba1bc23dE4F", </span><span class="token token" style="color:#acda95"> "name": "My Campaign", </span><span class="token token" style="color:#acda95"> "description": "my new campaign", </span><span class="token token" style="color:#acda95"> "channel_guids": [ </span><span class="token token" style="color:#acda95"> "Ha1bc2DefGj", </span><span class="token token" style="color:#acda95"> "Ha1bc2DefGk" </span><span class="token token" style="color:#acda95"> ] </span><span class="token token" style="color:#acda95">}'</span><span> </span><span class="token token punctuation">\</span><span> </span>https://api-ssl.bitly.com/v4/campaigns</code></pre></div></div></div><div><label class="CodeSyntaxSelector_header__6P_Jc"><span>Response</span><div class="CodeSyntaxSelector_header__6P_Jc"><div class="Select_wrapper__58utF"><select class="Select_select__qXz_Z" aria-label="Select" autoComplete="off"><option value="200" selected="">200 SUCCESS</option><option value="400">400 BAD_REQUEST</option><option value="402">402 UPGRADE_REQUIRED</option><option value="403">403 FORBIDDEN</option><option value="404">404 NOT_FOUND</option><option value="422">422 UNPROCESSABLE_ENTITY</option><option value="429">429 MONTHLY_LIMIT_EXCEEDED</option><option value="500">500 INTERNAL_ERROR</option><option value="503">503 TEMPORARILY_UNAVAILABLE</option></select><svg viewBox="0 0 8 14" xmlns="http://www.w3.org/2000/svg"><path d="M6.463 7 .987 1.66a.61.61 0 0 1 0-.878.648.648 0 0 1 .9 0L7.813 6.56a.61.61 0 0 1 0 .878l-5.926 5.78a.648.648 0 0 1-.9 0 .61.61 0 0 1 0-.879L6.463 7Z"></path></svg></div></div></label><div class="CodeSyntaxSelector_body__hBJ7j"><div class="CodeBlock_codeBlock__KlURa"><pre tabindex="0" style="color:#36383b;font-family:ProximaNova, monospace;line-height:1.2;font-size:1rem"><code class="language-json" style="white-space:pre"><span class="token token punctuation">{</span><span> </span><span> </span><span class="token token property">"references"</span><span class="token token operator">:</span><span> </span><span class="token token punctuation">{</span><span> </span><span class="token token" style="color:#51763e">"any"</span><span> </span><span class="token token punctuation">}</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"guid"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"group_guid"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"created_by"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"name"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"description"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"created"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"modified"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span> </span><span></span><span class="token token punctuation">}</span></code></pre></div></div></div></div></div><div class="MethodDetail_methodContainer__3EF7h" id="getCampaign"><div class="MethodDetail_method__fyEiw"><div><h3 class="MethodHeader_h3__seOfC">Retrieve a Campaign</h3><h4 class="MethodHeader_description__3_p_p"><div class="MethodHeader_iconStyle__x5Ow4"><svg viewBox="0 0 14 6" xmlns="http://www.w3.org/2000/svg" class="IconRest_restIcon__3pju8 get"><title>Get</title><path d="M2.587 6c.307 0 .607-.044.9-.132.295-.088.533-.217.716-.387V2.876H2.271v.825h1.027v1.145a.772.772 0 0 1-.239.1 1.4 1.4 0 0 1-.383.049 1.338 1.338 0 0 1-1.083-.52c-.135-.17-.24-.379-.316-.626a2.879 2.879 0 0 1-.113-.84c0-.352.038-.655.113-.907.076-.253.182-.46.32-.623.137-.162.3-.281.488-.358a1.783 1.783 0 0 1 .97-.082l.13.032v.915h.889V.28a3.182 3.182 0 0 0-.59-.202A3.507 3.507 0 0 0 2.676 0c-.313 0-.628.055-.946.165a2.4 2.4 0 0 0-.861.523 2.707 2.707 0 0 0-.627.92C.081 1.98 0 2.433 0 2.966c0 .506.067.946.202 1.323.135.376.318.692.55.948a2.2 2.2 0 0 0 .82.572A2.7 2.7 0 0 0 2.587 6Zm6.24-.115V4.879H6.184V3.47h2.4V2.465h-2.4V1.121h2.602V.115h-3.71v5.77h3.75Zm4.43 0v-.907h-.914V1.022h.768v.997H14V.115H9.57V2.02h.89v-.997h.776v3.956h-.922v.907h2.942Z"></path></svg></div> /v4/campaigns/{campaign_guid}</h4><p class="MethodHeader_description__3_p_p">Returns details for a campaign.</p></div><div><h4 class="ParameterList_h4__nH9G8 ParameterList_dividing__wRGRx">Path Parameters</h4><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">campaign_guid</span><span class="Parameter_type__djM_s">string</span><span class="Parameter_required__pcK_H">Required</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">A GUID for a Bitly campaign</div></div></div></div><div class="MethodDetail_examples__8nXeM"><div><label class="CodeSyntaxSelector_header__6P_Jc CodeSyntaxSelector_headerDark__hI3A0"><span>Request</span><div class="CodeSyntaxSelector_header__6P_Jc CodeSyntaxSelector_headerDark__hI3A0"><div class="Select_wrapper__58utF Select_dark__KPIws"><select class="Select_select__qXz_Z Select_dark__KPIws" aria-label="Select" autoComplete="off"><option value="cURL" selected="">cURL</option><option value="Node">Node</option><option value="Browser">Browser</option><option value="Go">Go</option><option value="Python">Python</option></select><svg viewBox="0 0 8 14" xmlns="http://www.w3.org/2000/svg"><path d="M6.463 7 .987 1.66a.61.61 0 0 1 0-.878.648.648 0 0 1 .9 0L7.813 6.56a.61.61 0 0 1 0 .878l-5.926 5.78a.648.648 0 0 1-.9 0 .61.61 0 0 1 0-.879L6.463 7Z"></path></svg></div></div></label><div class="CodeSyntaxSelector_body__hBJ7j CodeSyntaxSelector_bodyDark__cizVw"><div class="CodeBlock_codeBlock__KlURa"><pre tabindex="0" style="color:#ffffff;font-family:ProximaNova, monospace;line-height:1.2;font-size:1rem"><code class="language-bash" style="white-space:pre"><span class="token token" style="color:#ee6123">curl</span><span> </span><span class="token token punctuation">\</span><span> </span><span>-H </span><span class="token token" style="color:#acda95">'Authorization: Bearer {TOKEN}'</span><span> </span><span class="token token punctuation">\</span><span> </span><span>-X GET </span><span class="token token punctuation">\</span><span> </span>https://api-ssl.bitly.com/v4/campaigns/Ca1bcd2EFGh</code></pre></div></div></div><div><label class="CodeSyntaxSelector_header__6P_Jc"><span>Response</span><div class="CodeSyntaxSelector_header__6P_Jc"><div class="Select_wrapper__58utF"><select class="Select_select__qXz_Z" aria-label="Select" autoComplete="off"><option value="200" selected="">200 SUCCESS</option><option value="402">402 UPGRADE_REQUIRED</option><option value="403">403 FORBIDDEN</option><option value="404">404 NOT_FOUND</option><option value="429">429 MONTHLY_LIMIT_EXCEEDED</option><option value="500">500 INTERNAL_ERROR</option><option value="503">503 TEMPORARILY_UNAVAILABLE</option></select><svg viewBox="0 0 8 14" xmlns="http://www.w3.org/2000/svg"><path d="M6.463 7 .987 1.66a.61.61 0 0 1 0-.878.648.648 0 0 1 .9 0L7.813 6.56a.61.61 0 0 1 0 .878l-5.926 5.78a.648.648 0 0 1-.9 0 .61.61 0 0 1 0-.879L6.463 7Z"></path></svg></div></div></label><div class="CodeSyntaxSelector_body__hBJ7j"><div class="CodeBlock_codeBlock__KlURa"><pre tabindex="0" style="color:#36383b;font-family:ProximaNova, monospace;line-height:1.2;font-size:1rem"><code class="language-json" style="white-space:pre"><span class="token token punctuation">{</span><span> </span><span> </span><span class="token token property">"references"</span><span class="token token operator">:</span><span> </span><span class="token token punctuation">{</span><span> </span><span class="token token" style="color:#51763e">"any"</span><span> </span><span class="token token punctuation">}</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"guid"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"group_guid"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"created_by"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"name"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"description"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"created"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"modified"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span> </span><span></span><span class="token token punctuation">}</span></code></pre></div></div></div></div></div><div class="MethodDetail_methodContainer__3EF7h" id="updateCampaign"><div class="MethodDetail_method__fyEiw"><div><h3 class="MethodHeader_h3__seOfC">Update Campaign</h3><h4 class="MethodHeader_description__3_p_p"><div class="MethodHeader_iconStyle__x5Ow4"><svg viewBox="0 0 23 6" xmlns="http://www.w3.org/2000/svg" class="IconRest_restIcon__3pju8 patch"><title>Patch</title><path d="M1.095 5.885V3.898c.027.006.07.011.132.017a4.052 4.052 0 0 0 .372.016h.128c.277 0 .545-.037.803-.11.259-.075.49-.193.692-.355.202-.162.365-.368.487-.618.123-.25.184-.551.184-.903 0-.401-.07-.727-.212-.977a1.606 1.606 0 0 0-.547-.585 2.041 2.041 0 0 0-.756-.28 5.067 5.067 0 0 0-.835-.07c-.267 0-.534.012-.804.037C.47.095.224.13 0 .173v5.712h1.095Zm.472-2.934h-.1a2.448 2.448 0 0 1-.276-.017.853.853 0 0 1-.096-.016V1.047c.059-.011.136-.02.232-.03.096-.007.197-.012.304-.012.138 0 .274.014.408.042a.964.964 0 0 1 .355.148.801.801 0 0 1 .252.284.937.937 0 0 1 .096.45c0 .214-.033.387-.1.519a.787.787 0 0 1-.268.309 1.038 1.038 0 0 1-.38.152 2.235 2.235 0 0 1-.427.042Zm3.79 2.934.383-1.278h1.67l.4 1.278h1.152L7.163.115H6.068L4.26 5.885h1.095ZM7.194 3.7h-1.2l.56-1.929h.072l.568 1.929Zm5.668 2.184v-.907h-.903V1.022h.76v.997h.879V.115H9.218V2.02h.879v-.997h.767v3.956h-.91v.907h2.91Zm3.91.115c.276 0 .547-.036.81-.107.265-.072.482-.17.652-.297V3.948h-.88v.997c-.164.033-.335.05-.51.05-.246 0-.464-.049-.656-.145a1.383 1.383 0 0 1-.488-.408 1.881 1.881 0 0 1-.304-.63A2.973 2.973 0 0 1 15.293 3c0-.34.038-.636.112-.886.075-.25.179-.457.312-.622.133-.165.29-.287.468-.367.178-.08.371-.12.58-.12.175 0 .346.014.511.042v.94h.88V.271a2.727 2.727 0 0 0-.548-.19A3.419 3.419 0 0 0 16.796 0c-.303 0-.613.05-.927.152-.314.102-.6.27-.855.503a2.611 2.611 0 0 0-.628.923c-.163.382-.244.856-.244 1.422 0 .544.072 1.007.216 1.389.144.382.336.692.576.931.24.24.518.412.835.52.317.106.652.16 1.003.16Zm3.325-.115V3.47h1.807v2.415H23V.115h-1.095v2.35h-1.807V.114h-1.095v5.77h1.095Z"></path></svg></div> /v4/campaigns/{campaign_guid}</h4><p class="MethodHeader_description__3_p_p">Updates a campaign's details.</p></div><div><h4 class="ParameterList_h4__nH9G8 ParameterList_dividing__wRGRx">Path Parameters</h4><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">campaign_guid</span><span class="Parameter_type__djM_s">string</span><span class="Parameter_required__pcK_H">Required</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">A GUID for a Bitly campaign</div></div></div><div><h4 class="ParameterList_h4__nH9G8 ParameterList_dividing__wRGRx">Request Body Schema</h4><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">group_guid</span><span class="Parameter_type__djM_s">string</span></div></div><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">name</span><span class="Parameter_type__djM_s">string</span></div></div><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">description</span><span class="Parameter_type__djM_s">string</span></div></div><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">channel_guids</span><span class="Parameter_type__djM_s">array of string</span></div></div></div></div><div class="MethodDetail_examples__8nXeM"><div><label class="CodeSyntaxSelector_header__6P_Jc CodeSyntaxSelector_headerDark__hI3A0"><span>Request</span><div class="CodeSyntaxSelector_header__6P_Jc CodeSyntaxSelector_headerDark__hI3A0"><div class="Select_wrapper__58utF Select_dark__KPIws"><select class="Select_select__qXz_Z Select_dark__KPIws" aria-label="Select" autoComplete="off"><option value="cURL" selected="">cURL</option><option value="Node">Node</option><option value="Browser">Browser</option><option value="Go">Go</option><option value="Python">Python</option></select><svg viewBox="0 0 8 14" xmlns="http://www.w3.org/2000/svg"><path d="M6.463 7 .987 1.66a.61.61 0 0 1 0-.878.648.648 0 0 1 .9 0L7.813 6.56a.61.61 0 0 1 0 .878l-5.926 5.78a.648.648 0 0 1-.9 0 .61.61 0 0 1 0-.879L6.463 7Z"></path></svg></div></div></label><div class="CodeSyntaxSelector_body__hBJ7j CodeSyntaxSelector_bodyDark__cizVw"><div class="CodeBlock_codeBlock__KlURa"><pre tabindex="0" style="color:#ffffff;font-family:ProximaNova, monospace;line-height:1.2;font-size:1rem"><code class="language-bash" style="white-space:pre"><span class="token token" style="color:#ee6123">curl</span><span> </span><span class="token token punctuation">\</span><span> </span><span>-H </span><span class="token token" style="color:#acda95">'Authorization: Bearer {TOKEN}'</span><span> </span><span class="token token punctuation">\</span><span> </span><span>-H </span><span class="token token" style="color:#acda95">'Content-Type: application/json'</span><span> </span><span class="token token punctuation">\</span><span> </span><span>-X PATCH </span><span class="token token punctuation">\</span><span> </span><span>-d </span><span class="token token" style="color:#acda95">'{ </span><span class="token token" style="color:#acda95"> "group_guid": "Ba1bc23dE4F", </span><span class="token token" style="color:#acda95"> "name": "My Campaign", </span><span class="token token" style="color:#acda95"> "description": "my new campaign", </span><span class="token token" style="color:#acda95"> "channel_guids": [ </span><span class="token token" style="color:#acda95"> "Ha1bc2DefGj", </span><span class="token token" style="color:#acda95"> "Ha1bc2DefGk" </span><span class="token token" style="color:#acda95"> ] </span><span class="token token" style="color:#acda95">}'</span><span> </span><span class="token token punctuation">\</span><span> </span>https://api-ssl.bitly.com/v4/campaigns/Ca1bcd2EFGh</code></pre></div></div></div><div><label class="CodeSyntaxSelector_header__6P_Jc"><span>Response</span><div class="CodeSyntaxSelector_header__6P_Jc"><div class="Select_wrapper__58utF"><select class="Select_select__qXz_Z" aria-label="Select" autoComplete="off"><option value="200" selected="">200 SUCCESS</option><option value="400">400 BAD_REQUEST</option><option value="402">402 UPGRADE_REQUIRED</option><option value="403">403 FORBIDDEN</option><option value="404">404 NOT_FOUND</option><option value="422">422 UNPROCESSABLE_ENTITY</option><option value="429">429 MONTHLY_LIMIT_EXCEEDED</option><option value="500">500 INTERNAL_ERROR</option><option value="503">503 TEMPORARILY_UNAVAILABLE</option></select><svg viewBox="0 0 8 14" xmlns="http://www.w3.org/2000/svg"><path d="M6.463 7 .987 1.66a.61.61 0 0 1 0-.878.648.648 0 0 1 .9 0L7.813 6.56a.61.61 0 0 1 0 .878l-5.926 5.78a.648.648 0 0 1-.9 0 .61.61 0 0 1 0-.879L6.463 7Z"></path></svg></div></div></label><div class="CodeSyntaxSelector_body__hBJ7j"><div class="CodeBlock_codeBlock__KlURa"><pre tabindex="0" style="color:#36383b;font-family:ProximaNova, monospace;line-height:1.2;font-size:1rem"><code class="language-json" style="white-space:pre"><span class="token token punctuation">{</span><span> </span><span> </span><span class="token token property">"references"</span><span class="token token operator">:</span><span> </span><span class="token token punctuation">{</span><span> </span><span class="token token" style="color:#51763e">"any"</span><span> </span><span class="token token punctuation">}</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"guid"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"group_guid"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"created_by"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"name"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"description"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"created"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"modified"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span> </span><span></span><span class="token token punctuation">}</span></code></pre></div></div></div></div></div><div class="MethodDetail_methodContainer__3EF7h" id="getChannels"><div class="MethodDetail_method__fyEiw"><div><h3 class="MethodHeader_h3__seOfC">Retrieve Channels</h3><h4 class="MethodHeader_description__3_p_p"><div class="MethodHeader_iconStyle__x5Ow4"><svg viewBox="0 0 14 6" xmlns="http://www.w3.org/2000/svg" class="IconRest_restIcon__3pju8 get"><title>Get</title><path d="M2.587 6c.307 0 .607-.044.9-.132.295-.088.533-.217.716-.387V2.876H2.271v.825h1.027v1.145a.772.772 0 0 1-.239.1 1.4 1.4 0 0 1-.383.049 1.338 1.338 0 0 1-1.083-.52c-.135-.17-.24-.379-.316-.626a2.879 2.879 0 0 1-.113-.84c0-.352.038-.655.113-.907.076-.253.182-.46.32-.623.137-.162.3-.281.488-.358a1.783 1.783 0 0 1 .97-.082l.13.032v.915h.889V.28a3.182 3.182 0 0 0-.59-.202A3.507 3.507 0 0 0 2.676 0c-.313 0-.628.055-.946.165a2.4 2.4 0 0 0-.861.523 2.707 2.707 0 0 0-.627.92C.081 1.98 0 2.433 0 2.966c0 .506.067.946.202 1.323.135.376.318.692.55.948a2.2 2.2 0 0 0 .82.572A2.7 2.7 0 0 0 2.587 6Zm6.24-.115V4.879H6.184V3.47h2.4V2.465h-2.4V1.121h2.602V.115h-3.71v5.77h3.75Zm4.43 0v-.907h-.914V1.022h.768v.997H14V.115H9.57V2.02h.89v-.997h.776v3.956h-.922v.907h2.942Z"></path></svg></div> /v4/channels</h4><p class="MethodHeader_description__3_p_p">Returns the channels available to a user.</p></div><div><h4 class="ParameterList_h4__nH9G8 ParameterList_dividing__wRGRx">Query Parameters</h4><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">group_guid</span><span class="Parameter_type__djM_s">string</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">A GUID for a Bitly group</div></div><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">campaign_guid</span><span class="Parameter_type__djM_s">string</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">A GUID for a Bitly campaign</div></div></div></div><div class="MethodDetail_examples__8nXeM"><div><label class="CodeSyntaxSelector_header__6P_Jc CodeSyntaxSelector_headerDark__hI3A0"><span>Request</span><div class="CodeSyntaxSelector_header__6P_Jc CodeSyntaxSelector_headerDark__hI3A0"><div class="Select_wrapper__58utF Select_dark__KPIws"><select class="Select_select__qXz_Z Select_dark__KPIws" aria-label="Select" autoComplete="off"><option value="cURL" selected="">cURL</option><option value="Node">Node</option><option value="Browser">Browser</option><option value="Go">Go</option><option value="Python">Python</option></select><svg viewBox="0 0 8 14" xmlns="http://www.w3.org/2000/svg"><path d="M6.463 7 .987 1.66a.61.61 0 0 1 0-.878.648.648 0 0 1 .9 0L7.813 6.56a.61.61 0 0 1 0 .878l-5.926 5.78a.648.648 0 0 1-.9 0 .61.61 0 0 1 0-.879L6.463 7Z"></path></svg></div></div></label><div class="CodeSyntaxSelector_body__hBJ7j CodeSyntaxSelector_bodyDark__cizVw"><div class="CodeBlock_codeBlock__KlURa"><pre tabindex="0" style="color:#ffffff;font-family:ProximaNova, monospace;line-height:1.2;font-size:1rem"><code class="language-bash" style="white-space:pre"><span class="token token" style="color:#ee6123">curl</span><span> </span><span class="token token punctuation">\</span><span> </span><span>-H </span><span class="token token" style="color:#acda95">'Authorization: Bearer {TOKEN}'</span><span> </span><span class="token token punctuation">\</span><span> </span><span>-X GET </span><span class="token token punctuation">\</span><span> </span><span>https://api-ssl.bitly.com/v4/channels?group_guid</span><span class="token token operator">=</span><span>Ba1bc23dE4F</span><span class="token token operator">&</span><span class="token token assign-left variable">campaign_guid</span><span class="token token operator">=</span><span>Ca1bcd2EFGh</span></code></pre></div></div></div><div><label class="CodeSyntaxSelector_header__6P_Jc"><span>Response</span><div class="CodeSyntaxSelector_header__6P_Jc"><div class="Select_wrapper__58utF"><select class="Select_select__qXz_Z" aria-label="Select" autoComplete="off"><option value="200" selected="">200 SUCCESS</option><option value="402">402 UPGRADE_REQUIRED</option><option value="403">403 FORBIDDEN</option><option value="404">404 NOT_FOUND</option><option value="500">500 INTERNAL_ERROR</option><option value="503">503 TEMPORARILY_UNAVAILABLE</option></select><svg viewBox="0 0 8 14" xmlns="http://www.w3.org/2000/svg"><path d="M6.463 7 .987 1.66a.61.61 0 0 1 0-.878.648.648 0 0 1 .9 0L7.813 6.56a.61.61 0 0 1 0 .878l-5.926 5.78a.648.648 0 0 1-.9 0 .61.61 0 0 1 0-.879L6.463 7Z"></path></svg></div></div></label><div class="CodeSyntaxSelector_body__hBJ7j"><div class="CodeBlock_codeBlock__KlURa"><pre tabindex="0" style="color:#36383b;font-family:ProximaNova, monospace;line-height:1.2;font-size:1rem"><code class="language-json" style="white-space:pre"><span class="token token punctuation">{</span><span> </span><span> </span><span class="token token property">"channels"</span><span class="token token operator">:</span><span> </span><span class="token token punctuation">[</span><span> </span><span> </span><span class="token token punctuation">{</span><span> </span><span> </span><span class="token token property">"name"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"guid"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"created"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"modified"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"group_guid"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"references"</span><span class="token token operator">:</span><span> </span><span class="token token punctuation">{</span><span> </span><span class="token token" style="color:#51763e">"any"</span><span> </span><span class="token token punctuation">}</span><span> </span><span> </span><span class="token token punctuation">}</span><span> </span><span> </span><span class="token token punctuation">]</span><span> </span><span></span><span class="token token punctuation">}</span></code></pre></div></div></div></div></div><div class="MethodDetail_methodContainer__3EF7h" id="createChannel"><div class="MethodDetail_method__fyEiw"><div><h3 class="MethodHeader_h3__seOfC">Create Channel</h3><h4 class="MethodHeader_description__3_p_p"><div class="MethodHeader_iconStyle__x5Ow4"><svg viewBox="0 0 18 6" xmlns="http://www.w3.org/2000/svg" class="IconRest_restIcon__3pju8 post"><title>Post</title><path d="M1.072 5.885V3.898c.026.006.069.011.129.017a3.88 3.88 0 0 0 .364.016h.125c.27 0 .533-.037.786-.11.253-.075.478-.193.677-.355.198-.162.357-.368.477-.618s.18-.551.18-.903c0-.401-.07-.727-.208-.977a1.592 1.592 0 0 0-.536-.585 1.971 1.971 0 0 0-.739-.28 4.854 4.854 0 0 0-.817-.07C1.249.033.987.045.724.07.46.095.219.13 0 .173v5.712h1.072Zm.461-2.934h-.098a2.344 2.344 0 0 1-.27-.017.818.818 0 0 1-.093-.016V1.047c.057-.011.133-.02.227-.03.093-.007.193-.012.297-.012.135 0 .268.014.399.042.13.027.246.077.348.148a.796.796 0 0 1 .246.284.954.954 0 0 1 .094.45c0 .214-.032.387-.098.519a.782.782 0 0 1-.262.309c-.11.074-.233.125-.371.152a2.141 2.141 0 0 1-.419.042ZM6.47 6c.694 0 1.212-.265 1.553-.795.342-.53.513-1.265.513-2.205 0-.44-.038-.843-.114-1.212a2.872 2.872 0 0 0-.36-.947 1.78 1.78 0 0 0-.637-.618C7.163.074 6.844 0 6.469 0c-.35 0-.653.069-.911.206a1.78 1.78 0 0 0-.645.59c-.172.255-.3.57-.384.943A5.804 5.804 0 0 0 4.404 3c0 .44.037.843.11 1.212.073.368.191.684.356.947.164.264.378.47.641.618.263.149.583.223.958.223Zm0-1.005c-.203 0-.366-.053-.489-.157a.989.989 0 0 1-.281-.425 2.57 2.57 0 0 1-.133-.63A8.129 8.129 0 0 1 5.53 3c0-.66.065-1.157.195-1.492.13-.335.378-.503.743-.503.209 0 .376.054.501.161a1 1 0 0 1 .286.433c.065.181.106.393.125.635.018.241.027.497.027.766 0 .34-.014.636-.043.886-.029.25-.08.457-.152.622a.826.826 0 0 1-.29.367.803.803 0 0 1-.454.12ZM10.991 6c.297 0 .574-.037.83-.111.255-.074.476-.187.664-.338.188-.151.334-.338.438-.56.104-.223.157-.483.157-.78 0-.307-.067-.563-.2-.766a1.814 1.814 0 0 0-.493-.507 3.3 3.3 0 0 0-.641-.342 11.165 11.165 0 0 1-.642-.28 2.185 2.185 0 0 1-.493-.313.562.562 0 0 1-.199-.445c0-.176.072-.316.215-.42.144-.105.34-.157.59-.157a2.757 2.757 0 0 1 .767.107.14.14 0 0 0 .047.008v.915h.86V.338a2.45 2.45 0 0 0-.735-.247C11.85.03 11.536 0 11.218 0c-.282 0-.537.041-.767.124-.23.082-.426.197-.59.346A1.557 1.557 0 0 0 9.476 1a1.66 1.66 0 0 0-.137.68c0 .324.067.588.2.792.133.203.297.372.493.506.195.135.409.246.641.334.232.088.446.176.642.264.195.088.36.19.492.305.133.115.2.266.2.453 0 .209-.081.375-.243.499-.161.123-.388.185-.68.185-.162 0-.314-.018-.458-.053a2.256 2.256 0 0 1-.395-.136l-.047-.017v-.816h-.86V5.53c.067.039.156.085.266.14.11.055.236.107.379.157.143.05.3.09.47.124.169.033.353.049.55.049Zm6.29-.115v-.907h-.885V1.022h.744v.997H18V.115h-4.287V2.02h.86v-.997h.752v3.956h-.892v.907h2.847Z"></path></svg></div> /v4/channels</h4><p class="MethodHeader_description__3_p_p">Creates a new channel.</p></div><div><h4 class="ParameterList_h4__nH9G8 ParameterList_dividing__wRGRx">Request Body Schema</h4><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">name</span><span class="Parameter_type__djM_s">string</span></div></div><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">guid</span><span class="Parameter_type__djM_s">string</span></div></div><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">created</span><span class="Parameter_type__djM_s">string</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">ISO TIMESTAMP</div></div><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">modified</span><span class="Parameter_type__djM_s">string</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">ISO_TIMESTAMP</div></div><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">group_guid</span><span class="Parameter_type__djM_s">string</span></div></div><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">bitlinks</span><span class="Parameter_type__djM_s">array of object</span></div><div class="Parameter_nestedList__KmKgd"><div class="Parameter_nested__X3i_l"><div class="Parameter_parameter__J0LgW Parameter_compact__V5419"><div><span class="Parameter_name___UYgz">campaign_guid</span><span class="Parameter_type__djM_s">string</span></div></div></div><div class="Parameter_nested__X3i_l"><div class="Parameter_parameter__J0LgW Parameter_compact__V5419"><div><span class="Parameter_name___UYgz">bitlink_id</span><span class="Parameter_type__djM_s">string</span></div></div></div></div></div></div></div><div class="MethodDetail_examples__8nXeM"><div><label class="CodeSyntaxSelector_header__6P_Jc CodeSyntaxSelector_headerDark__hI3A0"><span>Request</span><div class="CodeSyntaxSelector_header__6P_Jc CodeSyntaxSelector_headerDark__hI3A0"><div class="Select_wrapper__58utF Select_dark__KPIws"><select class="Select_select__qXz_Z Select_dark__KPIws" aria-label="Select" autoComplete="off"><option value="cURL" selected="">cURL</option><option value="Node">Node</option><option value="Browser">Browser</option><option value="Go">Go</option><option value="Python">Python</option></select><svg viewBox="0 0 8 14" xmlns="http://www.w3.org/2000/svg"><path d="M6.463 7 .987 1.66a.61.61 0 0 1 0-.878.648.648 0 0 1 .9 0L7.813 6.56a.61.61 0 0 1 0 .878l-5.926 5.78a.648.648 0 0 1-.9 0 .61.61 0 0 1 0-.879L6.463 7Z"></path></svg></div></div></label><div class="CodeSyntaxSelector_body__hBJ7j CodeSyntaxSelector_bodyDark__cizVw"><div class="CodeBlock_codeBlock__KlURa"><pre tabindex="0" style="color:#ffffff;font-family:ProximaNova, monospace;line-height:1.2;font-size:1rem"><code class="language-bash" style="white-space:pre"><span class="token token" style="color:#ee6123">curl</span><span> </span><span class="token token punctuation">\</span><span> </span><span>-H </span><span class="token token" style="color:#acda95">'Authorization: Bearer {TOKEN}'</span><span> </span><span class="token token punctuation">\</span><span> </span><span>-H </span><span class="token token" style="color:#acda95">'Content-Type: application/json'</span><span> </span><span class="token token punctuation">\</span><span> </span><span>-X POST </span><span class="token token punctuation">\</span><span> </span><span>-d </span><span class="token token" style="color:#acda95">'{ </span><span class="token token" style="color:#acda95"> "name": "My Channel", </span><span class="token token" style="color:#acda95"> "guid": "Ha1bc2DefGh", </span><span class="token token" style="color:#acda95"> "group_guid": "Ba1bc23dE4F", </span><span class="token token" style="color:#acda95"> "bitlinks": [ </span><span class="token token" style="color:#acda95"> { </span><span class="token token" style="color:#acda95"> "campaign_guid": "Ca1bcd2EFGh", </span><span class="token token" style="color:#acda95"> "bitlink_id": "bit.ly/1234abcd" </span><span class="token token" style="color:#acda95"> } </span><span class="token token" style="color:#acda95"> ] </span><span class="token token" style="color:#acda95">}'</span><span> </span><span class="token token punctuation">\</span><span> </span>https://api-ssl.bitly.com/v4/channels</code></pre></div></div></div><div><label class="CodeSyntaxSelector_header__6P_Jc"><span>Response</span><div class="CodeSyntaxSelector_header__6P_Jc"><div class="Select_wrapper__58utF"><select class="Select_select__qXz_Z" aria-label="Select" autoComplete="off"><option value="200" selected="">200 SUCCESS</option><option value="400">400 BAD_REQUEST</option><option value="402">402 UPGRADE_REQUIRED</option><option value="403">403 FORBIDDEN</option><option value="404">404 NOT_FOUND</option><option value="422">422 UNPROCESSABLE_ENTITY</option><option value="429">429 MONTHLY_LIMIT_EXCEEDED</option><option value="500">500 INTERNAL_ERROR</option><option value="503">503 TEMPORARILY_UNAVAILABLE</option></select><svg viewBox="0 0 8 14" xmlns="http://www.w3.org/2000/svg"><path d="M6.463 7 .987 1.66a.61.61 0 0 1 0-.878.648.648 0 0 1 .9 0L7.813 6.56a.61.61 0 0 1 0 .878l-5.926 5.78a.648.648 0 0 1-.9 0 .61.61 0 0 1 0-.879L6.463 7Z"></path></svg></div></div></label><div class="CodeSyntaxSelector_body__hBJ7j"><div class="CodeBlock_codeBlock__KlURa"><pre tabindex="0" style="color:#36383b;font-family:ProximaNova, monospace;line-height:1.2;font-size:1rem"><code class="language-json" style="white-space:pre"><span class="token token punctuation">{</span><span> </span><span> </span><span class="token token property">"name"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"guid"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"created"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"modified"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"group_guid"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"references"</span><span class="token token operator">:</span><span> </span><span class="token token punctuation">{</span><span> </span><span class="token token" style="color:#51763e">"any"</span><span> </span><span class="token token punctuation">}</span><span> </span><span></span><span class="token token punctuation">}</span></code></pre></div></div></div></div></div><div class="MethodDetail_methodContainer__3EF7h" id="getChannel"><div class="MethodDetail_method__fyEiw"><div><h3 class="MethodHeader_h3__seOfC">Get a Channel</h3><h4 class="MethodHeader_description__3_p_p"><div class="MethodHeader_iconStyle__x5Ow4"><svg viewBox="0 0 14 6" xmlns="http://www.w3.org/2000/svg" class="IconRest_restIcon__3pju8 get"><title>Get</title><path d="M2.587 6c.307 0 .607-.044.9-.132.295-.088.533-.217.716-.387V2.876H2.271v.825h1.027v1.145a.772.772 0 0 1-.239.1 1.4 1.4 0 0 1-.383.049 1.338 1.338 0 0 1-1.083-.52c-.135-.17-.24-.379-.316-.626a2.879 2.879 0 0 1-.113-.84c0-.352.038-.655.113-.907.076-.253.182-.46.32-.623.137-.162.3-.281.488-.358a1.783 1.783 0 0 1 .97-.082l.13.032v.915h.889V.28a3.182 3.182 0 0 0-.59-.202A3.507 3.507 0 0 0 2.676 0c-.313 0-.628.055-.946.165a2.4 2.4 0 0 0-.861.523 2.707 2.707 0 0 0-.627.92C.081 1.98 0 2.433 0 2.966c0 .506.067.946.202 1.323.135.376.318.692.55.948a2.2 2.2 0 0 0 .82.572A2.7 2.7 0 0 0 2.587 6Zm6.24-.115V4.879H6.184V3.47h2.4V2.465h-2.4V1.121h2.602V.115h-3.71v5.77h3.75Zm4.43 0v-.907h-.914V1.022h.768v.997H14V.115H9.57V2.02h.89v-.997h.776v3.956h-.922v.907h2.942Z"></path></svg></div> /v4/channels/{channel_guid}</h4><p class="MethodHeader_description__3_p_p">Returns a channel's details.</p></div><div><h4 class="ParameterList_h4__nH9G8 ParameterList_dividing__wRGRx">Path Parameters</h4><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">channel_guid</span><span class="Parameter_type__djM_s">string</span><span class="Parameter_required__pcK_H">Required</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">A GUID for a Bitly Channel</div></div></div></div><div class="MethodDetail_examples__8nXeM"><div><label class="CodeSyntaxSelector_header__6P_Jc CodeSyntaxSelector_headerDark__hI3A0"><span>Request</span><div class="CodeSyntaxSelector_header__6P_Jc CodeSyntaxSelector_headerDark__hI3A0"><div class="Select_wrapper__58utF Select_dark__KPIws"><select class="Select_select__qXz_Z Select_dark__KPIws" aria-label="Select" autoComplete="off"><option value="cURL" selected="">cURL</option><option value="Node">Node</option><option value="Browser">Browser</option><option value="Go">Go</option><option value="Python">Python</option></select><svg viewBox="0 0 8 14" xmlns="http://www.w3.org/2000/svg"><path d="M6.463 7 .987 1.66a.61.61 0 0 1 0-.878.648.648 0 0 1 .9 0L7.813 6.56a.61.61 0 0 1 0 .878l-5.926 5.78a.648.648 0 0 1-.9 0 .61.61 0 0 1 0-.879L6.463 7Z"></path></svg></div></div></label><div class="CodeSyntaxSelector_body__hBJ7j CodeSyntaxSelector_bodyDark__cizVw"><div class="CodeBlock_codeBlock__KlURa"><pre tabindex="0" style="color:#ffffff;font-family:ProximaNova, monospace;line-height:1.2;font-size:1rem"><code class="language-bash" style="white-space:pre"><span class="token token" style="color:#ee6123">curl</span><span> </span><span class="token token punctuation">\</span><span> </span><span>-H </span><span class="token token" style="color:#acda95">'Authorization: Bearer {TOKEN}'</span><span> </span><span class="token token punctuation">\</span><span> </span><span>-X GET </span><span class="token token punctuation">\</span><span> </span>https://api-ssl.bitly.com/v4/channels/Ha1bc2DefGh</code></pre></div></div></div><div><label class="CodeSyntaxSelector_header__6P_Jc"><span>Response</span><div class="CodeSyntaxSelector_header__6P_Jc"><div class="Select_wrapper__58utF"><select class="Select_select__qXz_Z" aria-label="Select" autoComplete="off"><option value="200" selected="">200 SUCCESS</option><option value="402">402 UPGRADE_REQUIRED</option><option value="403">403 FORBIDDEN</option><option value="404">404 NOT_FOUND</option><option value="429">429 MONTHLY_LIMIT_EXCEEDED</option><option value="500">500 INTERNAL_ERROR</option><option value="503">503 TEMPORARILY_UNAVAILABLE</option></select><svg viewBox="0 0 8 14" xmlns="http://www.w3.org/2000/svg"><path d="M6.463 7 .987 1.66a.61.61 0 0 1 0-.878.648.648 0 0 1 .9 0L7.813 6.56a.61.61 0 0 1 0 .878l-5.926 5.78a.648.648 0 0 1-.9 0 .61.61 0 0 1 0-.879L6.463 7Z"></path></svg></div></div></label><div class="CodeSyntaxSelector_body__hBJ7j"><div class="CodeBlock_codeBlock__KlURa"><pre tabindex="0" style="color:#36383b;font-family:ProximaNova, monospace;line-height:1.2;font-size:1rem"><code class="language-json" style="white-space:pre"><span class="token token punctuation">{</span><span> </span><span> </span><span class="token token property">"name"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"guid"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"created"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"modified"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"group_guid"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"references"</span><span class="token token operator">:</span><span> </span><span class="token token punctuation">{</span><span> </span><span class="token token" style="color:#51763e">"any"</span><span> </span><span class="token token punctuation">}</span><span> </span><span></span><span class="token token punctuation">}</span></code></pre></div></div></div></div></div><div class="MethodDetail_methodContainer__3EF7h" id="updateChannel"><div class="MethodDetail_method__fyEiw"><div><h3 class="MethodHeader_h3__seOfC">Update a Channel</h3><h4 class="MethodHeader_description__3_p_p"><div class="MethodHeader_iconStyle__x5Ow4"><svg viewBox="0 0 23 6" xmlns="http://www.w3.org/2000/svg" class="IconRest_restIcon__3pju8 patch"><title>Patch</title><path d="M1.095 5.885V3.898c.027.006.07.011.132.017a4.052 4.052 0 0 0 .372.016h.128c.277 0 .545-.037.803-.11.259-.075.49-.193.692-.355.202-.162.365-.368.487-.618.123-.25.184-.551.184-.903 0-.401-.07-.727-.212-.977a1.606 1.606 0 0 0-.547-.585 2.041 2.041 0 0 0-.756-.28 5.067 5.067 0 0 0-.835-.07c-.267 0-.534.012-.804.037C.47.095.224.13 0 .173v5.712h1.095Zm.472-2.934h-.1a2.448 2.448 0 0 1-.276-.017.853.853 0 0 1-.096-.016V1.047c.059-.011.136-.02.232-.03.096-.007.197-.012.304-.012.138 0 .274.014.408.042a.964.964 0 0 1 .355.148.801.801 0 0 1 .252.284.937.937 0 0 1 .096.45c0 .214-.033.387-.1.519a.787.787 0 0 1-.268.309 1.038 1.038 0 0 1-.38.152 2.235 2.235 0 0 1-.427.042Zm3.79 2.934.383-1.278h1.67l.4 1.278h1.152L7.163.115H6.068L4.26 5.885h1.095ZM7.194 3.7h-1.2l.56-1.929h.072l.568 1.929Zm5.668 2.184v-.907h-.903V1.022h.76v.997h.879V.115H9.218V2.02h.879v-.997h.767v3.956h-.91v.907h2.91Zm3.91.115c.276 0 .547-.036.81-.107.265-.072.482-.17.652-.297V3.948h-.88v.997c-.164.033-.335.05-.51.05-.246 0-.464-.049-.656-.145a1.383 1.383 0 0 1-.488-.408 1.881 1.881 0 0 1-.304-.63A2.973 2.973 0 0 1 15.293 3c0-.34.038-.636.112-.886.075-.25.179-.457.312-.622.133-.165.29-.287.468-.367.178-.08.371-.12.58-.12.175 0 .346.014.511.042v.94h.88V.271a2.727 2.727 0 0 0-.548-.19A3.419 3.419 0 0 0 16.796 0c-.303 0-.613.05-.927.152-.314.102-.6.27-.855.503a2.611 2.611 0 0 0-.628.923c-.163.382-.244.856-.244 1.422 0 .544.072 1.007.216 1.389.144.382.336.692.576.931.24.24.518.412.835.52.317.106.652.16 1.003.16Zm3.325-.115V3.47h1.807v2.415H23V.115h-1.095v2.35h-1.807V.114h-1.095v5.77h1.095Z"></path></svg></div> /v4/channels/{channel_guid}</h4><p class="MethodHeader_description__3_p_p">Updates an existing channel.</p></div><div><h4 class="ParameterList_h4__nH9G8 ParameterList_dividing__wRGRx">Path Parameters</h4><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">channel_guid</span><span class="Parameter_type__djM_s">string</span><span class="Parameter_required__pcK_H">Required</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">A GUID for a Bitly Channel</div></div></div><div><h4 class="ParameterList_h4__nH9G8 ParameterList_dividing__wRGRx">Request Body Schema</h4><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">name</span><span class="Parameter_type__djM_s">string</span></div></div><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">guid</span><span class="Parameter_type__djM_s">string</span></div></div><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">created</span><span class="Parameter_type__djM_s">string</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">ISO TIMESTAMP</div></div><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">modified</span><span class="Parameter_type__djM_s">string</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">ISO_TIMESTAMP</div></div><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">group_guid</span><span class="Parameter_type__djM_s">string</span></div></div><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">bitlinks</span><span class="Parameter_type__djM_s">array of object</span></div><div class="Parameter_nestedList__KmKgd"><div class="Parameter_nested__X3i_l"><div class="Parameter_parameter__J0LgW Parameter_compact__V5419"><div><span class="Parameter_name___UYgz">campaign_guid</span><span class="Parameter_type__djM_s">string</span></div></div></div><div class="Parameter_nested__X3i_l"><div class="Parameter_parameter__J0LgW Parameter_compact__V5419"><div><span class="Parameter_name___UYgz">bitlink_id</span><span class="Parameter_type__djM_s">string</span></div></div></div></div></div></div></div><div class="MethodDetail_examples__8nXeM"><div><label class="CodeSyntaxSelector_header__6P_Jc CodeSyntaxSelector_headerDark__hI3A0"><span>Request</span><div class="CodeSyntaxSelector_header__6P_Jc CodeSyntaxSelector_headerDark__hI3A0"><div class="Select_wrapper__58utF Select_dark__KPIws"><select class="Select_select__qXz_Z Select_dark__KPIws" aria-label="Select" autoComplete="off"><option value="cURL" selected="">cURL</option><option value="Node">Node</option><option value="Browser">Browser</option><option value="Go">Go</option><option value="Python">Python</option></select><svg viewBox="0 0 8 14" xmlns="http://www.w3.org/2000/svg"><path d="M6.463 7 .987 1.66a.61.61 0 0 1 0-.878.648.648 0 0 1 .9 0L7.813 6.56a.61.61 0 0 1 0 .878l-5.926 5.78a.648.648 0 0 1-.9 0 .61.61 0 0 1 0-.879L6.463 7Z"></path></svg></div></div></label><div class="CodeSyntaxSelector_body__hBJ7j CodeSyntaxSelector_bodyDark__cizVw"><div class="CodeBlock_codeBlock__KlURa"><pre tabindex="0" style="color:#ffffff;font-family:ProximaNova, monospace;line-height:1.2;font-size:1rem"><code class="language-bash" style="white-space:pre"><span class="token token" style="color:#ee6123">curl</span><span> </span><span class="token token punctuation">\</span><span> </span><span>-H </span><span class="token token" style="color:#acda95">'Authorization: Bearer {TOKEN}'</span><span> </span><span class="token token punctuation">\</span><span> </span><span>-H </span><span class="token token" style="color:#acda95">'Content-Type: application/json'</span><span> </span><span class="token token punctuation">\</span><span> </span><span>-X PATCH </span><span class="token token punctuation">\</span><span> </span><span>-d </span><span class="token token" style="color:#acda95">'{ </span><span class="token token" style="color:#acda95"> "name": "My Channel", </span><span class="token token" style="color:#acda95"> "guid": "Ha1bc2DefGh", </span><span class="token token" style="color:#acda95"> "group_guid": "Ba1bc23dE4F", </span><span class="token token" style="color:#acda95"> "bitlinks": [ </span><span class="token token" style="color:#acda95"> { </span><span class="token token" style="color:#acda95"> "campaign_guid": "Ca1bcd2EFGh", </span><span class="token token" style="color:#acda95"> "bitlink_id": "bit.ly/1234abcd" </span><span class="token token" style="color:#acda95"> } </span><span class="token token" style="color:#acda95"> ] </span><span class="token token" style="color:#acda95">}'</span><span> </span><span class="token token punctuation">\</span><span> </span>https://api-ssl.bitly.com/v4/channels/Ha1bc2DefGh</code></pre></div></div></div><div><label class="CodeSyntaxSelector_header__6P_Jc"><span>Response</span><div class="CodeSyntaxSelector_header__6P_Jc"><div class="Select_wrapper__58utF"><select class="Select_select__qXz_Z" aria-label="Select" autoComplete="off"><option value="200" selected="">200 SUCCESS</option><option value="400">400 BAD_REQUEST</option><option value="402">402 UPGRADE_REQUIRED</option><option value="403">403 FORBIDDEN</option><option value="404">404 NOT_FOUND</option><option value="422">422 UNPROCESSABLE_ENTITY</option><option value="429">429 MONTHLY_LIMIT_EXCEEDED</option><option value="500">500 INTERNAL_ERROR</option><option value="503">503 TEMPORARILY_UNAVAILABLE</option></select><svg viewBox="0 0 8 14" xmlns="http://www.w3.org/2000/svg"><path d="M6.463 7 .987 1.66a.61.61 0 0 1 0-.878.648.648 0 0 1 .9 0L7.813 6.56a.61.61 0 0 1 0 .878l-5.926 5.78a.648.648 0 0 1-.9 0 .61.61 0 0 1 0-.879L6.463 7Z"></path></svg></div></div></label><div class="CodeSyntaxSelector_body__hBJ7j"><div class="CodeBlock_codeBlock__KlURa"><pre tabindex="0" style="color:#36383b;font-family:ProximaNova, monospace;line-height:1.2;font-size:1rem"><code class="language-json" style="white-space:pre"><span class="token token punctuation">{</span><span> </span><span> </span><span class="token token property">"name"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"guid"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"created"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"modified"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"group_guid"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"references"</span><span class="token token operator">:</span><span> </span><span class="token token punctuation">{</span><span> </span><span class="token token" style="color:#51763e">"any"</span><span> </span><span class="token token punctuation">}</span><span> </span><span></span><span class="token token punctuation">}</span></code></pre></div></div></div></div></div><div class="ApiReference_tagInfo__YVbgw"><h2 class="ApiReference_tagName__IJx2p">Custom Bitlinks</h2><p class="ApiReference_tagDescription__8c1GM">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. </p></div><div class="MethodDetail_methodContainer__3EF7h" id="addCustomBitlink"><div class="MethodDetail_method__fyEiw"><div><h3 class="MethodHeader_h3__seOfC">Add Custom Bitlink</h3><h4 class="MethodHeader_description__3_p_p"><div class="MethodHeader_iconStyle__x5Ow4"><svg viewBox="0 0 18 6" xmlns="http://www.w3.org/2000/svg" class="IconRest_restIcon__3pju8 post"><title>Post</title><path d="M1.072 5.885V3.898c.026.006.069.011.129.017a3.88 3.88 0 0 0 .364.016h.125c.27 0 .533-.037.786-.11.253-.075.478-.193.677-.355.198-.162.357-.368.477-.618s.18-.551.18-.903c0-.401-.07-.727-.208-.977a1.592 1.592 0 0 0-.536-.585 1.971 1.971 0 0 0-.739-.28 4.854 4.854 0 0 0-.817-.07C1.249.033.987.045.724.07.46.095.219.13 0 .173v5.712h1.072Zm.461-2.934h-.098a2.344 2.344 0 0 1-.27-.017.818.818 0 0 1-.093-.016V1.047c.057-.011.133-.02.227-.03.093-.007.193-.012.297-.012.135 0 .268.014.399.042.13.027.246.077.348.148a.796.796 0 0 1 .246.284.954.954 0 0 1 .094.45c0 .214-.032.387-.098.519a.782.782 0 0 1-.262.309c-.11.074-.233.125-.371.152a2.141 2.141 0 0 1-.419.042ZM6.47 6c.694 0 1.212-.265 1.553-.795.342-.53.513-1.265.513-2.205 0-.44-.038-.843-.114-1.212a2.872 2.872 0 0 0-.36-.947 1.78 1.78 0 0 0-.637-.618C7.163.074 6.844 0 6.469 0c-.35 0-.653.069-.911.206a1.78 1.78 0 0 0-.645.59c-.172.255-.3.57-.384.943A5.804 5.804 0 0 0 4.404 3c0 .44.037.843.11 1.212.073.368.191.684.356.947.164.264.378.47.641.618.263.149.583.223.958.223Zm0-1.005c-.203 0-.366-.053-.489-.157a.989.989 0 0 1-.281-.425 2.57 2.57 0 0 1-.133-.63A8.129 8.129 0 0 1 5.53 3c0-.66.065-1.157.195-1.492.13-.335.378-.503.743-.503.209 0 .376.054.501.161a1 1 0 0 1 .286.433c.065.181.106.393.125.635.018.241.027.497.027.766 0 .34-.014.636-.043.886-.029.25-.08.457-.152.622a.826.826 0 0 1-.29.367.803.803 0 0 1-.454.12ZM10.991 6c.297 0 .574-.037.83-.111.255-.074.476-.187.664-.338.188-.151.334-.338.438-.56.104-.223.157-.483.157-.78 0-.307-.067-.563-.2-.766a1.814 1.814 0 0 0-.493-.507 3.3 3.3 0 0 0-.641-.342 11.165 11.165 0 0 1-.642-.28 2.185 2.185 0 0 1-.493-.313.562.562 0 0 1-.199-.445c0-.176.072-.316.215-.42.144-.105.34-.157.59-.157a2.757 2.757 0 0 1 .767.107.14.14 0 0 0 .047.008v.915h.86V.338a2.45 2.45 0 0 0-.735-.247C11.85.03 11.536 0 11.218 0c-.282 0-.537.041-.767.124-.23.082-.426.197-.59.346A1.557 1.557 0 0 0 9.476 1a1.66 1.66 0 0 0-.137.68c0 .324.067.588.2.792.133.203.297.372.493.506.195.135.409.246.641.334.232.088.446.176.642.264.195.088.36.19.492.305.133.115.2.266.2.453 0 .209-.081.375-.243.499-.161.123-.388.185-.68.185-.162 0-.314-.018-.458-.053a2.256 2.256 0 0 1-.395-.136l-.047-.017v-.816h-.86V5.53c.067.039.156.085.266.14.11.055.236.107.379.157.143.05.3.09.47.124.169.033.353.049.55.049Zm6.29-.115v-.907h-.885V1.022h.744v.997H18V.115h-4.287V2.02h.86v-.997h.752v3.956h-.892v.907h2.847Z"></path></svg></div> /v4/custom_bitlinks</h4><p class="MethodHeader_description__3_p_p">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.</p></div><div><h4 class="ParameterList_h4__nH9G8 ParameterList_dividing__wRGRx">Request Body Schema</h4><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">custom_bitlink</span><span class="Parameter_type__djM_s">string</span></div></div><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">bitlink_id</span><span class="Parameter_type__djM_s">string</span></div></div></div></div><div class="MethodDetail_examples__8nXeM"><div><label class="CodeSyntaxSelector_header__6P_Jc CodeSyntaxSelector_headerDark__hI3A0"><span>Request</span><div class="CodeSyntaxSelector_header__6P_Jc CodeSyntaxSelector_headerDark__hI3A0"><div class="Select_wrapper__58utF Select_dark__KPIws"><select class="Select_select__qXz_Z Select_dark__KPIws" aria-label="Select" autoComplete="off"><option value="cURL" selected="">cURL</option><option value="Node">Node</option><option value="Browser">Browser</option><option value="Go">Go</option><option value="Python">Python</option></select><svg viewBox="0 0 8 14" xmlns="http://www.w3.org/2000/svg"><path d="M6.463 7 .987 1.66a.61.61 0 0 1 0-.878.648.648 0 0 1 .9 0L7.813 6.56a.61.61 0 0 1 0 .878l-5.926 5.78a.648.648 0 0 1-.9 0 .61.61 0 0 1 0-.879L6.463 7Z"></path></svg></div></div></label><div class="CodeSyntaxSelector_body__hBJ7j CodeSyntaxSelector_bodyDark__cizVw"><div class="CodeBlock_codeBlock__KlURa"><pre tabindex="0" style="color:#ffffff;font-family:ProximaNova, monospace;line-height:1.2;font-size:1rem"><code class="language-bash" style="white-space:pre"><span class="token token" style="color:#ee6123">curl</span><span> </span><span class="token token punctuation">\</span><span> </span><span>-H </span><span class="token token" style="color:#acda95">'Authorization: Bearer {TOKEN}'</span><span> </span><span class="token token punctuation">\</span><span> </span><span>-H </span><span class="token token" style="color:#acda95">'Content-Type: application/json'</span><span> </span><span class="token token punctuation">\</span><span> </span><span>-X POST </span><span class="token token punctuation">\</span><span> </span><span>-d </span><span class="token token" style="color:#acda95">'{ </span><span class="token token" style="color:#acda95"> "custom_bitlink": "chauncey.ly/documentation", </span><span class="token token" style="color:#acda95"> "bitlink_id": "chauncey.ly/1234abcd" </span><span class="token token" style="color:#acda95">}'</span><span> </span><span class="token token punctuation">\</span><span> </span>https://api-ssl.bitly.com/v4/custom_bitlinks</code></pre></div></div></div><div><label class="CodeSyntaxSelector_header__6P_Jc"><span>Response</span><div class="CodeSyntaxSelector_header__6P_Jc"><div class="Select_wrapper__58utF"><select class="Select_select__qXz_Z" aria-label="Select" autoComplete="off"><option value="200" selected="">200 SUCCESS</option><option value="400">400 BAD_REQUEST</option><option value="402">402 UPGRADE_REQUIRED</option><option value="403">403 FORBIDDEN</option><option value="404">404 NOT_FOUND</option><option value="409">409 Conflict</option><option value="422">422 UNPROCESSABLE_ENTITY</option><option value="429">429 MONTHLY_LIMIT_EXCEEDED</option><option value="500">500 INTERNAL_ERROR</option><option value="503">503 TEMPORARILY_UNAVAILABLE</option></select><svg viewBox="0 0 8 14" xmlns="http://www.w3.org/2000/svg"><path d="M6.463 7 .987 1.66a.61.61 0 0 1 0-.878.648.648 0 0 1 .9 0L7.813 6.56a.61.61 0 0 1 0 .878l-5.926 5.78a.648.648 0 0 1-.9 0 .61.61 0 0 1 0-.879L6.463 7Z"></path></svg></div></div></label><div class="CodeSyntaxSelector_body__hBJ7j"><div class="CodeBlock_codeBlock__KlURa"><pre tabindex="0" style="color:#36383b;font-family:ProximaNova, monospace;line-height:1.2;font-size:1rem"><code class="language-json" style="white-space:pre"><span class="token token punctuation">{</span><span> </span><span> </span><span class="token token property">"custom_bitlink"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"bitlink"</span><span class="token token operator">:</span><span> </span><span class="token token punctuation">{</span><span> </span><span> </span><span class="token token property">"references"</span><span class="token token operator">:</span><span> </span><span class="token token punctuation">{</span><span> </span><span class="token token" style="color:#51763e">"any"</span><span> </span><span class="token token punctuation">}</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"link"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"id"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"long_url"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"title"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"archived"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"boolean"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"created_at"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"created_by"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"client_id"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"custom_bitlinks"</span><span class="token token operator">:</span><span> </span><span class="token token punctuation">[</span><span> </span><span> </span><span class="token token" style="color:#51763e">"string"</span><span> </span><span> </span><span class="token token punctuation">]</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"tags"</span><span class="token token operator">:</span><span> </span><span class="token token punctuation">[</span><span> </span><span> </span><span class="token token" style="color:#51763e">"string"</span><span> </span><span> </span><span class="token token punctuation">]</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"launchpad_ids"</span><span class="token token operator">:</span><span> </span><span class="token token punctuation">[</span><span> </span><span> </span><span class="token token" style="color:#51763e">"string"</span><span> </span><span> </span><span class="token token punctuation">]</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"qr_code_ids"</span><span class="token token operator">:</span><span> </span><span class="token token punctuation">[</span><span> </span><span> </span><span class="token token" style="color:#51763e">"string"</span><span> </span><span> </span><span class="token token punctuation">]</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"deeplinks"</span><span class="token token operator">:</span><span> </span><span class="token token punctuation">[</span><span> </span><span> </span><span class="token token punctuation">{</span><span> </span><span> </span><span class="token token property">"guid"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"bitlink"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"app_uri_path"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"install_url"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"app_guid"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"os"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"install_type"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"created"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"modified"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"brand_guid"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span> </span><span> </span><span class="token token punctuation">}</span><span> </span><span> </span><span class="token token punctuation">]</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"campaign_ids"</span><span class="token token operator">:</span><span> </span><span class="token token punctuation">[</span><span> </span><span> </span><span class="token token" style="color:#51763e">"string"</span><span> </span><span> </span><span class="token token punctuation">]</span><span> </span><span> </span><span class="token token punctuation">}</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"bitlink_history"</span><span class="token token operator">:</span><span> </span><span class="token token punctuation">[</span><span> </span><span> </span><span class="token token punctuation">{</span><span> </span><span> </span><span class="token token property">"uuid"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"group_guid"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"keyword"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"bsd"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"hash"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"login"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"long_url"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"created"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"first_created"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"deactivated"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"is_active"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"boolean"</span><span> </span><span> </span><span class="token token punctuation">}</span><span> </span><span> </span><span class="token token punctuation">]</span><span> </span><span></span><span class="token token punctuation">}</span></code></pre></div></div></div></div></div><div class="MethodDetail_methodContainer__3EF7h" id="updateCustomBitlink"><div class="MethodDetail_method__fyEiw"><div><h3 class="MethodHeader_h3__seOfC">Update Custom Bitlink</h3><h4 class="MethodHeader_description__3_p_p"><div class="MethodHeader_iconStyle__x5Ow4"><svg viewBox="0 0 23 6" xmlns="http://www.w3.org/2000/svg" class="IconRest_restIcon__3pju8 patch"><title>Patch</title><path d="M1.095 5.885V3.898c.027.006.07.011.132.017a4.052 4.052 0 0 0 .372.016h.128c.277 0 .545-.037.803-.11.259-.075.49-.193.692-.355.202-.162.365-.368.487-.618.123-.25.184-.551.184-.903 0-.401-.07-.727-.212-.977a1.606 1.606 0 0 0-.547-.585 2.041 2.041 0 0 0-.756-.28 5.067 5.067 0 0 0-.835-.07c-.267 0-.534.012-.804.037C.47.095.224.13 0 .173v5.712h1.095Zm.472-2.934h-.1a2.448 2.448 0 0 1-.276-.017.853.853 0 0 1-.096-.016V1.047c.059-.011.136-.02.232-.03.096-.007.197-.012.304-.012.138 0 .274.014.408.042a.964.964 0 0 1 .355.148.801.801 0 0 1 .252.284.937.937 0 0 1 .096.45c0 .214-.033.387-.1.519a.787.787 0 0 1-.268.309 1.038 1.038 0 0 1-.38.152 2.235 2.235 0 0 1-.427.042Zm3.79 2.934.383-1.278h1.67l.4 1.278h1.152L7.163.115H6.068L4.26 5.885h1.095ZM7.194 3.7h-1.2l.56-1.929h.072l.568 1.929Zm5.668 2.184v-.907h-.903V1.022h.76v.997h.879V.115H9.218V2.02h.879v-.997h.767v3.956h-.91v.907h2.91Zm3.91.115c.276 0 .547-.036.81-.107.265-.072.482-.17.652-.297V3.948h-.88v.997c-.164.033-.335.05-.51.05-.246 0-.464-.049-.656-.145a1.383 1.383 0 0 1-.488-.408 1.881 1.881 0 0 1-.304-.63A2.973 2.973 0 0 1 15.293 3c0-.34.038-.636.112-.886.075-.25.179-.457.312-.622.133-.165.29-.287.468-.367.178-.08.371-.12.58-.12.175 0 .346.014.511.042v.94h.88V.271a2.727 2.727 0 0 0-.548-.19A3.419 3.419 0 0 0 16.796 0c-.303 0-.613.05-.927.152-.314.102-.6.27-.855.503a2.611 2.611 0 0 0-.628.923c-.163.382-.244.856-.244 1.422 0 .544.072 1.007.216 1.389.144.382.336.692.576.931.24.24.518.412.835.52.317.106.652.16 1.003.16Zm3.325-.115V3.47h1.807v2.415H23V.115h-1.095v2.35h-1.807V.114h-1.095v5.77h1.095Z"></path></svg></div> /v4/custom_bitlinks/{custom_bitlink}</h4><p class="MethodHeader_description__3_p_p">Move a keyword (or custom back-half) to a different Bitlink (domains must match).</p></div><div><h4 class="ParameterList_h4__nH9G8 ParameterList_dividing__wRGRx">Path Parameters</h4><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">custom_bitlink</span><span class="Parameter_type__djM_s">string</span><span class="Parameter_required__pcK_H">Required</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">A Custom Bitlink made of the domain and keyword</div></div></div><div><h4 class="ParameterList_h4__nH9G8 ParameterList_dividing__wRGRx">Request Body Schema</h4><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">bitlink_id</span><span class="Parameter_type__djM_s">string</span></div></div></div></div><div class="MethodDetail_examples__8nXeM"><div><label class="CodeSyntaxSelector_header__6P_Jc CodeSyntaxSelector_headerDark__hI3A0"><span>Request</span><div class="CodeSyntaxSelector_header__6P_Jc CodeSyntaxSelector_headerDark__hI3A0"><div class="Select_wrapper__58utF Select_dark__KPIws"><select class="Select_select__qXz_Z Select_dark__KPIws" aria-label="Select" autoComplete="off"><option value="cURL" selected="">cURL</option><option value="Node">Node</option><option value="Browser">Browser</option><option value="Go">Go</option><option value="Python">Python</option></select><svg viewBox="0 0 8 14" xmlns="http://www.w3.org/2000/svg"><path d="M6.463 7 .987 1.66a.61.61 0 0 1 0-.878.648.648 0 0 1 .9 0L7.813 6.56a.61.61 0 0 1 0 .878l-5.926 5.78a.648.648 0 0 1-.9 0 .61.61 0 0 1 0-.879L6.463 7Z"></path></svg></div></div></label><div class="CodeSyntaxSelector_body__hBJ7j CodeSyntaxSelector_bodyDark__cizVw"><div class="CodeBlock_codeBlock__KlURa"><pre tabindex="0" style="color:#ffffff;font-family:ProximaNova, monospace;line-height:1.2;font-size:1rem"><code class="language-bash" style="white-space:pre"><span class="token token" style="color:#ee6123">curl</span><span> </span><span class="token token punctuation">\</span><span> </span><span>-H </span><span class="token token" style="color:#acda95">'Authorization: Bearer {TOKEN}'</span><span> </span><span class="token token punctuation">\</span><span> </span><span>-H </span><span class="token token" style="color:#acda95">'Content-Type: application/json'</span><span> </span><span class="token token punctuation">\</span><span> </span><span>-X PATCH </span><span class="token token punctuation">\</span><span> </span><span>-d </span><span class="token token" style="color:#acda95">'{ </span><span class="token token" style="color:#acda95"> "bitlink_id": "chauncey.ly/1234abcd" </span><span class="token token" style="color:#acda95">}'</span><span> </span><span class="token token punctuation">\</span><span> </span>https://api-ssl.bitly.com/v4/custom_bitlinks/chauncey.ly/chauncey</code></pre></div></div></div><div><label class="CodeSyntaxSelector_header__6P_Jc"><span>Response</span><div class="CodeSyntaxSelector_header__6P_Jc"><div class="Select_wrapper__58utF"><select class="Select_select__qXz_Z" aria-label="Select" autoComplete="off"><option value="200" selected="">200 SUCCESS</option><option value="400">400 BAD_REQUEST</option><option value="402">402 UPGRADE_REQUIRED</option><option value="403">403 FORBIDDEN</option><option value="404">404 NOT_FOUND</option><option value="422">422 UNPROCESSABLE_ENTITY</option><option value="429">429 MONTHLY_LIMIT_EXCEEDED</option><option value="500">500 INTERNAL_ERROR</option><option value="503">503 TEMPORARILY_UNAVAILABLE</option></select><svg viewBox="0 0 8 14" xmlns="http://www.w3.org/2000/svg"><path d="M6.463 7 .987 1.66a.61.61 0 0 1 0-.878.648.648 0 0 1 .9 0L7.813 6.56a.61.61 0 0 1 0 .878l-5.926 5.78a.648.648 0 0 1-.9 0 .61.61 0 0 1 0-.879L6.463 7Z"></path></svg></div></div></label><div class="CodeSyntaxSelector_body__hBJ7j"><div class="CodeBlock_codeBlock__KlURa"><pre tabindex="0" style="color:#36383b;font-family:ProximaNova, monospace;line-height:1.2;font-size:1rem"><code class="language-json" style="white-space:pre"><span class="token token punctuation">{</span><span> </span><span> </span><span class="token token property">"custom_bitlink"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"bitlink"</span><span class="token token operator">:</span><span> </span><span class="token token punctuation">{</span><span> </span><span> </span><span class="token token property">"references"</span><span class="token token operator">:</span><span> </span><span class="token token punctuation">{</span><span> </span><span class="token token" style="color:#51763e">"any"</span><span> </span><span class="token token punctuation">}</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"link"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"id"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"long_url"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"title"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"archived"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"boolean"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"created_at"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"created_by"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"client_id"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"custom_bitlinks"</span><span class="token token operator">:</span><span> </span><span class="token token punctuation">[</span><span> </span><span> </span><span class="token token" style="color:#51763e">"string"</span><span> </span><span> </span><span class="token token punctuation">]</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"tags"</span><span class="token token operator">:</span><span> </span><span class="token token punctuation">[</span><span> </span><span> </span><span class="token token" style="color:#51763e">"string"</span><span> </span><span> </span><span class="token token punctuation">]</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"launchpad_ids"</span><span class="token token operator">:</span><span> </span><span class="token token punctuation">[</span><span> </span><span> </span><span class="token token" style="color:#51763e">"string"</span><span> </span><span> </span><span class="token token punctuation">]</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"qr_code_ids"</span><span class="token token operator">:</span><span> </span><span class="token token punctuation">[</span><span> </span><span> </span><span class="token token" style="color:#51763e">"string"</span><span> </span><span> </span><span class="token token punctuation">]</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"deeplinks"</span><span class="token token operator">:</span><span> </span><span class="token token punctuation">[</span><span> </span><span> </span><span class="token token punctuation">{</span><span> </span><span> </span><span class="token token property">"guid"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"bitlink"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"app_uri_path"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"install_url"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"app_guid"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"os"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"install_type"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"created"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"modified"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"brand_guid"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span> </span><span> </span><span class="token token punctuation">}</span><span> </span><span> </span><span class="token token punctuation">]</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"campaign_ids"</span><span class="token token operator">:</span><span> </span><span class="token token punctuation">[</span><span> </span><span> </span><span class="token token" style="color:#51763e">"string"</span><span> </span><span> </span><span class="token token punctuation">]</span><span> </span><span> </span><span class="token token punctuation">}</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"bitlink_history"</span><span class="token token operator">:</span><span> </span><span class="token token punctuation">[</span><span> </span><span> </span><span class="token token punctuation">{</span><span> </span><span> </span><span class="token token property">"uuid"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"group_guid"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"keyword"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"bsd"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"hash"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"login"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"long_url"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"created"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"first_created"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"deactivated"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"is_active"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"boolean"</span><span> </span><span> </span><span class="token token punctuation">}</span><span> </span><span> </span><span class="token token punctuation">]</span><span> </span><span></span><span class="token token punctuation">}</span></code></pre></div></div></div></div></div><div class="MethodDetail_methodContainer__3EF7h" id="getCustomBitlink"><div class="MethodDetail_method__fyEiw"><div><h3 class="MethodHeader_h3__seOfC">Retrieve Custom Bitlink</h3><h4 class="MethodHeader_description__3_p_p"><div class="MethodHeader_iconStyle__x5Ow4"><svg viewBox="0 0 14 6" xmlns="http://www.w3.org/2000/svg" class="IconRest_restIcon__3pju8 get"><title>Get</title><path d="M2.587 6c.307 0 .607-.044.9-.132.295-.088.533-.217.716-.387V2.876H2.271v.825h1.027v1.145a.772.772 0 0 1-.239.1 1.4 1.4 0 0 1-.383.049 1.338 1.338 0 0 1-1.083-.52c-.135-.17-.24-.379-.316-.626a2.879 2.879 0 0 1-.113-.84c0-.352.038-.655.113-.907.076-.253.182-.46.32-.623.137-.162.3-.281.488-.358a1.783 1.783 0 0 1 .97-.082l.13.032v.915h.889V.28a3.182 3.182 0 0 0-.59-.202A3.507 3.507 0 0 0 2.676 0c-.313 0-.628.055-.946.165a2.4 2.4 0 0 0-.861.523 2.707 2.707 0 0 0-.627.92C.081 1.98 0 2.433 0 2.966c0 .506.067.946.202 1.323.135.376.318.692.55.948a2.2 2.2 0 0 0 .82.572A2.7 2.7 0 0 0 2.587 6Zm6.24-.115V4.879H6.184V3.47h2.4V2.465h-2.4V1.121h2.602V.115h-3.71v5.77h3.75Zm4.43 0v-.907h-.914V1.022h.768v.997H14V.115H9.57V2.02h.89v-.997h.776v3.956h-.922v.907h2.942Z"></path></svg></div> /v4/custom_bitlinks/{custom_bitlink}</h4><p class="MethodHeader_description__3_p_p">Returns the details and history of the specified link.</p></div><div><h4 class="ParameterList_h4__nH9G8 ParameterList_dividing__wRGRx">Path Parameters</h4><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">custom_bitlink</span><span class="Parameter_type__djM_s">string</span><span class="Parameter_required__pcK_H">Required</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">A Custom Bitlink made of the domain and keyword</div></div></div></div><div class="MethodDetail_examples__8nXeM"><div><label class="CodeSyntaxSelector_header__6P_Jc CodeSyntaxSelector_headerDark__hI3A0"><span>Request</span><div class="CodeSyntaxSelector_header__6P_Jc CodeSyntaxSelector_headerDark__hI3A0"><div class="Select_wrapper__58utF Select_dark__KPIws"><select class="Select_select__qXz_Z Select_dark__KPIws" aria-label="Select" autoComplete="off"><option value="cURL" selected="">cURL</option><option value="Node">Node</option><option value="Browser">Browser</option><option value="Go">Go</option><option value="Python">Python</option></select><svg viewBox="0 0 8 14" xmlns="http://www.w3.org/2000/svg"><path d="M6.463 7 .987 1.66a.61.61 0 0 1 0-.878.648.648 0 0 1 .9 0L7.813 6.56a.61.61 0 0 1 0 .878l-5.926 5.78a.648.648 0 0 1-.9 0 .61.61 0 0 1 0-.879L6.463 7Z"></path></svg></div></div></label><div class="CodeSyntaxSelector_body__hBJ7j CodeSyntaxSelector_bodyDark__cizVw"><div class="CodeBlock_codeBlock__KlURa"><pre tabindex="0" style="color:#ffffff;font-family:ProximaNova, monospace;line-height:1.2;font-size:1rem"><code class="language-bash" style="white-space:pre"><span class="token token" style="color:#ee6123">curl</span><span> </span><span class="token token punctuation">\</span><span> </span><span>-H </span><span class="token token" style="color:#acda95">'Authorization: Bearer {TOKEN}'</span><span> </span><span class="token token punctuation">\</span><span> </span><span>-X GET </span><span class="token token punctuation">\</span><span> </span>https://api-ssl.bitly.com/v4/custom_bitlinks/chauncey.ly/chauncey</code></pre></div></div></div><div><label class="CodeSyntaxSelector_header__6P_Jc"><span>Response</span><div class="CodeSyntaxSelector_header__6P_Jc"><div class="Select_wrapper__58utF"><select class="Select_select__qXz_Z" aria-label="Select" autoComplete="off"><option value="200" selected="">200 SUCCESS</option><option value="402">402 UPGRADE_REQUIRED</option><option value="403">403 FORBIDDEN</option><option value="404">404 NOT_FOUND</option><option value="410">410 GONE</option><option value="429">429 MONTHLY_LIMIT_EXCEEDED</option><option value="500">500 INTERNAL_ERROR</option><option value="503">503 TEMPORARILY_UNAVAILABLE</option></select><svg viewBox="0 0 8 14" xmlns="http://www.w3.org/2000/svg"><path d="M6.463 7 .987 1.66a.61.61 0 0 1 0-.878.648.648 0 0 1 .9 0L7.813 6.56a.61.61 0 0 1 0 .878l-5.926 5.78a.648.648 0 0 1-.9 0 .61.61 0 0 1 0-.879L6.463 7Z"></path></svg></div></div></label><div class="CodeSyntaxSelector_body__hBJ7j"><div class="CodeBlock_codeBlock__KlURa"><pre tabindex="0" style="color:#36383b;font-family:ProximaNova, monospace;line-height:1.2;font-size:1rem"><code class="language-json" style="white-space:pre"><span class="token token punctuation">{</span><span> </span><span> </span><span class="token token property">"custom_bitlink"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"bitlink"</span><span class="token token operator">:</span><span> </span><span class="token token punctuation">{</span><span> </span><span> </span><span class="token token property">"references"</span><span class="token token operator">:</span><span> </span><span class="token token punctuation">{</span><span> </span><span class="token token" style="color:#51763e">"any"</span><span> </span><span class="token token punctuation">}</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"link"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"id"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"long_url"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"title"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"archived"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"boolean"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"created_at"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"created_by"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"client_id"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"custom_bitlinks"</span><span class="token token operator">:</span><span> </span><span class="token token punctuation">[</span><span> </span><span> </span><span class="token token" style="color:#51763e">"string"</span><span> </span><span> </span><span class="token token punctuation">]</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"tags"</span><span class="token token operator">:</span><span> </span><span class="token token punctuation">[</span><span> </span><span> </span><span class="token token" style="color:#51763e">"string"</span><span> </span><span> </span><span class="token token punctuation">]</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"launchpad_ids"</span><span class="token token operator">:</span><span> </span><span class="token token punctuation">[</span><span> </span><span> </span><span class="token token" style="color:#51763e">"string"</span><span> </span><span> </span><span class="token token punctuation">]</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"qr_code_ids"</span><span class="token token operator">:</span><span> </span><span class="token token punctuation">[</span><span> </span><span> </span><span class="token token" style="color:#51763e">"string"</span><span> </span><span> </span><span class="token token punctuation">]</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"deeplinks"</span><span class="token token operator">:</span><span> </span><span class="token token punctuation">[</span><span> </span><span> </span><span class="token token punctuation">{</span><span> </span><span> </span><span class="token token property">"guid"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"bitlink"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"app_uri_path"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"install_url"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"app_guid"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"os"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"install_type"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"created"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"modified"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"brand_guid"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span> </span><span> </span><span class="token token punctuation">}</span><span> </span><span> </span><span class="token token punctuation">]</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"campaign_ids"</span><span class="token token operator">:</span><span> </span><span class="token token punctuation">[</span><span> </span><span> </span><span class="token token" style="color:#51763e">"string"</span><span> </span><span> </span><span class="token token punctuation">]</span><span> </span><span> </span><span class="token token punctuation">}</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"bitlink_history"</span><span class="token token operator">:</span><span> </span><span class="token token punctuation">[</span><span> </span><span> </span><span class="token token punctuation">{</span><span> </span><span> </span><span class="token token property">"uuid"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"group_guid"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"keyword"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"bsd"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"hash"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"login"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"long_url"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"created"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"first_created"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"deactivated"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"is_active"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"boolean"</span><span> </span><span> </span><span class="token token punctuation">}</span><span> </span><span> </span><span class="token token punctuation">]</span><span> </span><span></span><span class="token token punctuation">}</span></code></pre></div></div></div></div></div><div class="MethodDetail_methodContainer__3EF7h" id="getCustomBitlinkMetricsByDestination"><div class="MethodDetail_method__fyEiw"><div><h3 class="MethodHeader_h3__seOfC">Get Metrics for a Custom Bitlink by Destination</h3><h4 class="MethodHeader_description__3_p_p"><div class="MethodHeader_iconStyle__x5Ow4"><svg viewBox="0 0 14 6" xmlns="http://www.w3.org/2000/svg" class="IconRest_restIcon__3pju8 get"><title>Get</title><path d="M2.587 6c.307 0 .607-.044.9-.132.295-.088.533-.217.716-.387V2.876H2.271v.825h1.027v1.145a.772.772 0 0 1-.239.1 1.4 1.4 0 0 1-.383.049 1.338 1.338 0 0 1-1.083-.52c-.135-.17-.24-.379-.316-.626a2.879 2.879 0 0 1-.113-.84c0-.352.038-.655.113-.907.076-.253.182-.46.32-.623.137-.162.3-.281.488-.358a1.783 1.783 0 0 1 .97-.082l.13.032v.915h.889V.28a3.182 3.182 0 0 0-.59-.202A3.507 3.507 0 0 0 2.676 0c-.313 0-.628.055-.946.165a2.4 2.4 0 0 0-.861.523 2.707 2.707 0 0 0-.627.92C.081 1.98 0 2.433 0 2.966c0 .506.067.946.202 1.323.135.376.318.692.55.948a2.2 2.2 0 0 0 .82.572A2.7 2.7 0 0 0 2.587 6Zm6.24-.115V4.879H6.184V3.47h2.4V2.465h-2.4V1.121h2.602V.115h-3.71v5.77h3.75Zm4.43 0v-.907h-.914V1.022h.768v.997H14V.115H9.57V2.02h.89v-.997h.776v3.956h-.922v.907h2.942Z"></path></svg></div> /v4/custom_bitlinks/{custom_bitlink}/clicks_by_destination</h4><p class="MethodHeader_description__3_p_p">Returns click metrics for the specified link by its historical destinations.</p></div><div><h4 class="ParameterList_h4__nH9G8 ParameterList_dividing__wRGRx">Path Parameters</h4><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">custom_bitlink</span><span class="Parameter_type__djM_s">string</span><span class="Parameter_required__pcK_H">Required</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">A Custom Bitlink made of the domain and keyword</div></div></div><div><h4 class="ParameterList_h4__nH9G8 ParameterList_dividing__wRGRx">Query Parameters</h4><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">unit</span><span class="Parameter_type__djM_s">string</span><span class="Parameter_required__pcK_H">Required</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">A unit of time</div><div class="Parameter_default__HHgG0 Parameter_spacer__JKXbH">Default: <span class="Parameter_label__DUY7G">"day"</span></div><div class="Parameter_enum__csO6P Parameter_spacer__JKXbH">Enum: <span class="Parameter_label__DUY7G">"minute"</span><span class="Parameter_label__DUY7G">"hour"</span><span class="Parameter_label__DUY7G">"day"</span><span class="Parameter_label__DUY7G">"week"</span><span class="Parameter_label__DUY7G">"month"</span></div></div><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">units</span><span class="Parameter_type__djM_s">integer</span><span class="Parameter_required__pcK_H">Required</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">An integer representing the time units to query data for. pass -1 to return all units of time</div><div class="Parameter_default__HHgG0 Parameter_spacer__JKXbH">Default: <span class="Parameter_label__DUY7G">-1</span></div></div><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">unit_reference</span><span class="Parameter_type__djM_s">string</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">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)</div></div></div></div><div class="MethodDetail_examples__8nXeM"><div><label class="CodeSyntaxSelector_header__6P_Jc CodeSyntaxSelector_headerDark__hI3A0"><span>Request</span><div class="CodeSyntaxSelector_header__6P_Jc CodeSyntaxSelector_headerDark__hI3A0"><div class="Select_wrapper__58utF Select_dark__KPIws"><select class="Select_select__qXz_Z Select_dark__KPIws" aria-label="Select" autoComplete="off"><option value="cURL" selected="">cURL</option><option value="Node">Node</option><option value="Browser">Browser</option><option value="Go">Go</option><option value="Python">Python</option></select><svg viewBox="0 0 8 14" xmlns="http://www.w3.org/2000/svg"><path d="M6.463 7 .987 1.66a.61.61 0 0 1 0-.878.648.648 0 0 1 .9 0L7.813 6.56a.61.61 0 0 1 0 .878l-5.926 5.78a.648.648 0 0 1-.9 0 .61.61 0 0 1 0-.879L6.463 7Z"></path></svg></div></div></label><div class="CodeSyntaxSelector_body__hBJ7j CodeSyntaxSelector_bodyDark__cizVw"><div class="CodeBlock_codeBlock__KlURa"><pre tabindex="0" style="color:#ffffff;font-family:ProximaNova, monospace;line-height:1.2;font-size:1rem"><code class="language-bash" style="white-space:pre"><span class="token token" style="color:#ee6123">curl</span><span> </span><span class="token token punctuation">\</span><span> </span><span>-H </span><span class="token token" style="color:#acda95">'Authorization: Bearer {TOKEN}'</span><span> </span><span class="token token punctuation">\</span><span> </span><span>-X GET </span><span class="token token punctuation">\</span><span> </span><span>https://api-ssl.bitly.com/v4/custom_bitlinks/chauncey.ly/chauncey/clicks_by_destination?unit</span><span class="token token operator">=</span><span>month</span><span class="token token operator">&</span><span class="token token assign-left variable">units</span><span class="token token operator">=</span><span class="token token" style="color:#a1b8f3">1</span><span class="token token operator">&</span><span class="token token assign-left variable">unit_reference</span><span class="token token operator">=</span><span class="token token" style="color:#a1b8f3">2006</span><span>-01-02T15%3A04%3A05-0700</span></code></pre></div></div></div><div><label class="CodeSyntaxSelector_header__6P_Jc"><span>Response</span><div class="CodeSyntaxSelector_header__6P_Jc"><div class="Select_wrapper__58utF"><select class="Select_select__qXz_Z" aria-label="Select" autoComplete="off"><option value="200" selected="">200 SUCCESS</option><option value="402">402 UPGRADE_REQUIRED</option><option value="403">403 FORBIDDEN</option><option value="404">404 NOT_FOUND</option><option value="410">410 GONE</option><option value="429">429 MONTHLY_LIMIT_EXCEEDED</option><option value="500">500 INTERNAL_ERROR</option><option value="503">503 TEMPORARILY_UNAVAILABLE</option></select><svg viewBox="0 0 8 14" xmlns="http://www.w3.org/2000/svg"><path d="M6.463 7 .987 1.66a.61.61 0 0 1 0-.878.648.648 0 0 1 .9 0L7.813 6.56a.61.61 0 0 1 0 .878l-5.926 5.78a.648.648 0 0 1-.9 0 .61.61 0 0 1 0-.879L6.463 7Z"></path></svg></div></div></label><div class="CodeSyntaxSelector_body__hBJ7j"><div class="CodeBlock_codeBlock__KlURa"><pre tabindex="0" style="color:#36383b;font-family:ProximaNova, monospace;line-height:1.2;font-size:1rem"><code class="language-json" style="white-space:pre"><span class="token token punctuation">{</span><span> </span><span> </span><span class="token token property">"unit"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"units"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"integer"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"facet"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"unit_reference"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"metrics"</span><span class="token token operator">:</span><span> </span><span class="token token punctuation">[</span><span> </span><span> </span><span class="token token punctuation">{</span><span> </span><span> </span><span class="token token property">"clicks"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"integer"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"value"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span> </span><span> </span><span class="token token punctuation">}</span><span> </span><span> </span><span class="token token punctuation">]</span><span> </span><span></span><span class="token token punctuation">}</span></code></pre></div></div></div></div></div><div class="MethodDetail_methodContainer__3EF7h" id="getClicksForCustomBitlink"><div class="MethodDetail_method__fyEiw"><div><h3 class="MethodHeader_h3__seOfC">Get Clicks for a Custom Bitlink's Entire History</h3><h4 class="MethodHeader_description__3_p_p"><div class="MethodHeader_iconStyle__x5Ow4"><svg viewBox="0 0 14 6" xmlns="http://www.w3.org/2000/svg" class="IconRest_restIcon__3pju8 get"><title>Get</title><path d="M2.587 6c.307 0 .607-.044.9-.132.295-.088.533-.217.716-.387V2.876H2.271v.825h1.027v1.145a.772.772 0 0 1-.239.1 1.4 1.4 0 0 1-.383.049 1.338 1.338 0 0 1-1.083-.52c-.135-.17-.24-.379-.316-.626a2.879 2.879 0 0 1-.113-.84c0-.352.038-.655.113-.907.076-.253.182-.46.32-.623.137-.162.3-.281.488-.358a1.783 1.783 0 0 1 .97-.082l.13.032v.915h.889V.28a3.182 3.182 0 0 0-.59-.202A3.507 3.507 0 0 0 2.676 0c-.313 0-.628.055-.946.165a2.4 2.4 0 0 0-.861.523 2.707 2.707 0 0 0-.627.92C.081 1.98 0 2.433 0 2.966c0 .506.067.946.202 1.323.135.376.318.692.55.948a2.2 2.2 0 0 0 .82.572A2.7 2.7 0 0 0 2.587 6Zm6.24-.115V4.879H6.184V3.47h2.4V2.465h-2.4V1.121h2.602V.115h-3.71v5.77h3.75Zm4.43 0v-.907h-.914V1.022h.768v.997H14V.115H9.57V2.02h.89v-.997h.776v3.956h-.922v.907h2.942Z"></path></svg></div> /v4/custom_bitlinks/{custom_bitlink}/clicks</h4><p class="MethodHeader_description__3_p_p">Returns the click counts for the specified link. This returns an array with clicks based on a date.</p></div><div><h4 class="ParameterList_h4__nH9G8 ParameterList_dividing__wRGRx">Path Parameters</h4><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">custom_bitlink</span><span class="Parameter_type__djM_s">string</span><span class="Parameter_required__pcK_H">Required</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">A Custom Bitlink made of the domain and keyword</div></div></div><div><h4 class="ParameterList_h4__nH9G8 ParameterList_dividing__wRGRx">Query Parameters</h4><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">unit</span><span class="Parameter_type__djM_s">string</span><span class="Parameter_required__pcK_H">Required</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">A unit of time</div><div class="Parameter_default__HHgG0 Parameter_spacer__JKXbH">Default: <span class="Parameter_label__DUY7G">"day"</span></div><div class="Parameter_enum__csO6P Parameter_spacer__JKXbH">Enum: <span class="Parameter_label__DUY7G">"minute"</span><span class="Parameter_label__DUY7G">"hour"</span><span class="Parameter_label__DUY7G">"day"</span><span class="Parameter_label__DUY7G">"week"</span><span class="Parameter_label__DUY7G">"month"</span></div></div><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">units</span><span class="Parameter_type__djM_s">integer</span><span class="Parameter_required__pcK_H">Required</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">An integer representing the time units to query data for. pass -1 to return all units of time</div><div class="Parameter_default__HHgG0 Parameter_spacer__JKXbH">Default: <span class="Parameter_label__DUY7G">-1</span></div></div><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">unit_reference</span><span class="Parameter_type__djM_s">string</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">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)</div></div></div></div><div class="MethodDetail_examples__8nXeM"><div><label class="CodeSyntaxSelector_header__6P_Jc CodeSyntaxSelector_headerDark__hI3A0"><span>Request</span><div class="CodeSyntaxSelector_header__6P_Jc CodeSyntaxSelector_headerDark__hI3A0"><div class="Select_wrapper__58utF Select_dark__KPIws"><select class="Select_select__qXz_Z Select_dark__KPIws" aria-label="Select" autoComplete="off"><option value="cURL" selected="">cURL</option><option value="Node">Node</option><option value="Browser">Browser</option><option value="Go">Go</option><option value="Python">Python</option></select><svg viewBox="0 0 8 14" xmlns="http://www.w3.org/2000/svg"><path d="M6.463 7 .987 1.66a.61.61 0 0 1 0-.878.648.648 0 0 1 .9 0L7.813 6.56a.61.61 0 0 1 0 .878l-5.926 5.78a.648.648 0 0 1-.9 0 .61.61 0 0 1 0-.879L6.463 7Z"></path></svg></div></div></label><div class="CodeSyntaxSelector_body__hBJ7j CodeSyntaxSelector_bodyDark__cizVw"><div class="CodeBlock_codeBlock__KlURa"><pre tabindex="0" style="color:#ffffff;font-family:ProximaNova, monospace;line-height:1.2;font-size:1rem"><code class="language-bash" style="white-space:pre"><span class="token token" style="color:#ee6123">curl</span><span> </span><span class="token token punctuation">\</span><span> </span><span>-H </span><span class="token token" style="color:#acda95">'Authorization: Bearer {TOKEN}'</span><span> </span><span class="token token punctuation">\</span><span> </span><span>-X GET </span><span class="token token punctuation">\</span><span> </span><span>https://api-ssl.bitly.com/v4/custom_bitlinks/chauncey.ly/chauncey/clicks?unit</span><span class="token token operator">=</span><span>month</span><span class="token token operator">&</span><span class="token token assign-left variable">units</span><span class="token token operator">=</span><span class="token token" style="color:#a1b8f3">1</span><span class="token token operator">&</span><span class="token token assign-left variable">unit_reference</span><span class="token token operator">=</span><span class="token token" style="color:#a1b8f3">2006</span><span>-01-02T15%3A04%3A05-0700</span></code></pre></div></div></div><div><label class="CodeSyntaxSelector_header__6P_Jc"><span>Response</span><div class="CodeSyntaxSelector_header__6P_Jc"><div class="Select_wrapper__58utF"><select class="Select_select__qXz_Z" aria-label="Select" autoComplete="off"><option value="200" selected="">200 SUCCESS</option><option value="400">400 BAD_REQUEST</option><option value="402">402 UPGRADE_REQUIRED</option><option value="403">403 FORBIDDEN</option><option value="404">404 NOT_FOUND</option><option value="410">410 GONE</option><option value="429">429 MONTHLY_LIMIT_EXCEEDED</option><option value="500">500 INTERNAL_ERROR</option><option value="503">503 TEMPORARILY_UNAVAILABLE</option></select><svg viewBox="0 0 8 14" xmlns="http://www.w3.org/2000/svg"><path d="M6.463 7 .987 1.66a.61.61 0 0 1 0-.878.648.648 0 0 1 .9 0L7.813 6.56a.61.61 0 0 1 0 .878l-5.926 5.78a.648.648 0 0 1-.9 0 .61.61 0 0 1 0-.879L6.463 7Z"></path></svg></div></div></label><div class="CodeSyntaxSelector_body__hBJ7j"><div class="CodeBlock_codeBlock__KlURa"><pre tabindex="0" style="color:#36383b;font-family:ProximaNova, monospace;line-height:1.2;font-size:1rem"><code class="language-json" style="white-space:pre"><span class="token token punctuation">{</span><span> </span><span> </span><span class="token token property">"link_clicks"</span><span class="token token operator">:</span><span> </span><span class="token token punctuation">[</span><span> </span><span> </span><span class="token token punctuation">{</span><span> </span><span> </span><span class="token token property">"clicks"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"integer"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"date"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span> </span><span> </span><span class="token token punctuation">}</span><span> </span><span> </span><span class="token token punctuation">]</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"units"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"integer"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"unit"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"unit_reference"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span> </span><span></span><span class="token token punctuation">}</span></code></pre></div></div></div></div></div><div class="ApiReference_tagInfo__YVbgw"><h2 class="ApiReference_tagName__IJx2p">Groups</h2><p class="ApiReference_tagDescription__8c1GM">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. </p></div><div class="MethodDetail_methodContainer__3EF7h" id="getGroups"><div class="MethodDetail_method__fyEiw"><div><h3 class="MethodHeader_h3__seOfC">Retrieve Groups</h3><h4 class="MethodHeader_description__3_p_p"><div class="MethodHeader_iconStyle__x5Ow4"><svg viewBox="0 0 14 6" xmlns="http://www.w3.org/2000/svg" class="IconRest_restIcon__3pju8 get"><title>Get</title><path d="M2.587 6c.307 0 .607-.044.9-.132.295-.088.533-.217.716-.387V2.876H2.271v.825h1.027v1.145a.772.772 0 0 1-.239.1 1.4 1.4 0 0 1-.383.049 1.338 1.338 0 0 1-1.083-.52c-.135-.17-.24-.379-.316-.626a2.879 2.879 0 0 1-.113-.84c0-.352.038-.655.113-.907.076-.253.182-.46.32-.623.137-.162.3-.281.488-.358a1.783 1.783 0 0 1 .97-.082l.13.032v.915h.889V.28a3.182 3.182 0 0 0-.59-.202A3.507 3.507 0 0 0 2.676 0c-.313 0-.628.055-.946.165a2.4 2.4 0 0 0-.861.523 2.707 2.707 0 0 0-.627.92C.081 1.98 0 2.433 0 2.966c0 .506.067.946.202 1.323.135.376.318.692.55.948a2.2 2.2 0 0 0 .82.572A2.7 2.7 0 0 0 2.587 6Zm6.24-.115V4.879H6.184V3.47h2.4V2.465h-2.4V1.121h2.602V.115h-3.71v5.77h3.75Zm4.43 0v-.907h-.914V1.022h.768v.997H14V.115H9.57V2.02h.89v-.997h.776v3.956h-.922v.907h2.942Z"></path></svg></div> /v4/groups</h4><p class="MethodHeader_description__3_p_p">Returns a list of groups in the organization.</p></div><div><h4 class="ParameterList_h4__nH9G8 ParameterList_dividing__wRGRx">Query Parameters</h4><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">organization_guid</span><span class="Parameter_type__djM_s">string</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">A GUID for a Bitly organization</div></div></div></div><div class="MethodDetail_examples__8nXeM"><div><label class="CodeSyntaxSelector_header__6P_Jc CodeSyntaxSelector_headerDark__hI3A0"><span>Request</span><div class="CodeSyntaxSelector_header__6P_Jc CodeSyntaxSelector_headerDark__hI3A0"><div class="Select_wrapper__58utF Select_dark__KPIws"><select class="Select_select__qXz_Z Select_dark__KPIws" aria-label="Select" autoComplete="off"><option value="cURL" selected="">cURL</option><option value="Node">Node</option><option value="Browser">Browser</option><option value="Go">Go</option><option value="Python">Python</option></select><svg viewBox="0 0 8 14" xmlns="http://www.w3.org/2000/svg"><path d="M6.463 7 .987 1.66a.61.61 0 0 1 0-.878.648.648 0 0 1 .9 0L7.813 6.56a.61.61 0 0 1 0 .878l-5.926 5.78a.648.648 0 0 1-.9 0 .61.61 0 0 1 0-.879L6.463 7Z"></path></svg></div></div></label><div class="CodeSyntaxSelector_body__hBJ7j CodeSyntaxSelector_bodyDark__cizVw"><div class="CodeBlock_codeBlock__KlURa"><pre tabindex="0" style="color:#ffffff;font-family:ProximaNova, monospace;line-height:1.2;font-size:1rem"><code class="language-bash" style="white-space:pre"><span class="token token" style="color:#ee6123">curl</span><span> </span><span class="token token punctuation">\</span><span> </span><span>-H </span><span class="token token" style="color:#acda95">'Authorization: Bearer {TOKEN}'</span><span> </span><span class="token token punctuation">\</span><span> </span><span>-X GET </span><span class="token token punctuation">\</span><span> </span><span>https://api-ssl.bitly.com/v4/groups?organization_guid</span><span class="token token operator">=</span><span>Oa1bcd234eF</span></code></pre></div></div></div><div><label class="CodeSyntaxSelector_header__6P_Jc"><span>Response</span><div class="CodeSyntaxSelector_header__6P_Jc"><div class="Select_wrapper__58utF"><select class="Select_select__qXz_Z" aria-label="Select" autoComplete="off"><option value="200" selected="">200 SUCCESS</option><option value="400">400 BAD_REQUEST</option><option value="403">403 FORBIDDEN</option><option value="404">404 NOT_FOUND</option><option value="422">422 UNPROCESSABLE_ENTITY</option><option value="429">429 MONTHLY_LIMIT_EXCEEDED</option><option value="500">500 INTERNAL_ERROR</option><option value="503">503 TEMPORARILY_UNAVAILABLE</option></select><svg viewBox="0 0 8 14" xmlns="http://www.w3.org/2000/svg"><path d="M6.463 7 .987 1.66a.61.61 0 0 1 0-.878.648.648 0 0 1 .9 0L7.813 6.56a.61.61 0 0 1 0 .878l-5.926 5.78a.648.648 0 0 1-.9 0 .61.61 0 0 1 0-.879L6.463 7Z"></path></svg></div></div></label><div class="CodeSyntaxSelector_body__hBJ7j"><div class="CodeBlock_codeBlock__KlURa"><pre tabindex="0" style="color:#36383b;font-family:ProximaNova, monospace;line-height:1.2;font-size:1rem"><code class="language-json" style="white-space:pre"><span class="token token punctuation">{</span><span> </span><span> </span><span class="token token property">"groups"</span><span class="token token operator">:</span><span> </span><span class="token token punctuation">[</span><span> </span><span> </span><span class="token token punctuation">{</span><span> </span><span> </span><span class="token token property">"references"</span><span class="token token operator">:</span><span> </span><span class="token token punctuation">{</span><span> </span><span class="token token" style="color:#51763e">"any"</span><span> </span><span class="token token punctuation">}</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"name"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"guid"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"created"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"modified"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"is_active"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"boolean"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"role"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"organization_guid"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"bsds"</span><span class="token token operator">:</span><span> </span><span class="token token punctuation">[</span><span> </span><span> </span><span class="token token" style="color:#51763e">"string"</span><span> </span><span> </span><span class="token token punctuation">]</span><span> </span><span> </span><span class="token token punctuation">}</span><span> </span><span> </span><span class="token token punctuation">]</span><span> </span><span></span><span class="token token punctuation">}</span></code></pre></div></div></div></div></div><div class="MethodDetail_methodContainer__3EF7h" id="updateGroup"><div class="MethodDetail_method__fyEiw"><div><h3 class="MethodHeader_h3__seOfC">Update a Group</h3><h4 class="MethodHeader_description__3_p_p"><div class="MethodHeader_iconStyle__x5Ow4"><svg viewBox="0 0 23 6" xmlns="http://www.w3.org/2000/svg" class="IconRest_restIcon__3pju8 patch"><title>Patch</title><path d="M1.095 5.885V3.898c.027.006.07.011.132.017a4.052 4.052 0 0 0 .372.016h.128c.277 0 .545-.037.803-.11.259-.075.49-.193.692-.355.202-.162.365-.368.487-.618.123-.25.184-.551.184-.903 0-.401-.07-.727-.212-.977a1.606 1.606 0 0 0-.547-.585 2.041 2.041 0 0 0-.756-.28 5.067 5.067 0 0 0-.835-.07c-.267 0-.534.012-.804.037C.47.095.224.13 0 .173v5.712h1.095Zm.472-2.934h-.1a2.448 2.448 0 0 1-.276-.017.853.853 0 0 1-.096-.016V1.047c.059-.011.136-.02.232-.03.096-.007.197-.012.304-.012.138 0 .274.014.408.042a.964.964 0 0 1 .355.148.801.801 0 0 1 .252.284.937.937 0 0 1 .096.45c0 .214-.033.387-.1.519a.787.787 0 0 1-.268.309 1.038 1.038 0 0 1-.38.152 2.235 2.235 0 0 1-.427.042Zm3.79 2.934.383-1.278h1.67l.4 1.278h1.152L7.163.115H6.068L4.26 5.885h1.095ZM7.194 3.7h-1.2l.56-1.929h.072l.568 1.929Zm5.668 2.184v-.907h-.903V1.022h.76v.997h.879V.115H9.218V2.02h.879v-.997h.767v3.956h-.91v.907h2.91Zm3.91.115c.276 0 .547-.036.81-.107.265-.072.482-.17.652-.297V3.948h-.88v.997c-.164.033-.335.05-.51.05-.246 0-.464-.049-.656-.145a1.383 1.383 0 0 1-.488-.408 1.881 1.881 0 0 1-.304-.63A2.973 2.973 0 0 1 15.293 3c0-.34.038-.636.112-.886.075-.25.179-.457.312-.622.133-.165.29-.287.468-.367.178-.08.371-.12.58-.12.175 0 .346.014.511.042v.94h.88V.271a2.727 2.727 0 0 0-.548-.19A3.419 3.419 0 0 0 16.796 0c-.303 0-.613.05-.927.152-.314.102-.6.27-.855.503a2.611 2.611 0 0 0-.628.923c-.163.382-.244.856-.244 1.422 0 .544.072 1.007.216 1.389.144.382.336.692.576.931.24.24.518.412.835.52.317.106.652.16 1.003.16Zm3.325-.115V3.47h1.807v2.415H23V.115h-1.095v2.35h-1.807V.114h-1.095v5.77h1.095Z"></path></svg></div> /v4/groups/{group_guid}</h4><p class="MethodHeader_description__3_p_p">Updates the details of a group.</p></div><div><h4 class="ParameterList_h4__nH9G8 ParameterList_dividing__wRGRx">Path Parameters</h4><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">group_guid</span><span class="Parameter_type__djM_s">string</span><span class="Parameter_required__pcK_H">Required</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">A GUID for a Bitly group</div></div></div><div><h4 class="ParameterList_h4__nH9G8 ParameterList_dividing__wRGRx">Request Body Schema</h4><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">name</span><span class="Parameter_type__djM_s">string</span></div></div><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">organization_guid</span><span class="Parameter_type__djM_s">string</span></div></div><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">bsds</span><span class="Parameter_type__djM_s">array of string</span></div></div></div></div><div class="MethodDetail_examples__8nXeM"><div><label class="CodeSyntaxSelector_header__6P_Jc CodeSyntaxSelector_headerDark__hI3A0"><span>Request</span><div class="CodeSyntaxSelector_header__6P_Jc CodeSyntaxSelector_headerDark__hI3A0"><div class="Select_wrapper__58utF Select_dark__KPIws"><select class="Select_select__qXz_Z Select_dark__KPIws" aria-label="Select" autoComplete="off"><option value="cURL" selected="">cURL</option><option value="Node">Node</option><option value="Browser">Browser</option><option value="Go">Go</option><option value="Python">Python</option></select><svg viewBox="0 0 8 14" xmlns="http://www.w3.org/2000/svg"><path d="M6.463 7 .987 1.66a.61.61 0 0 1 0-.878.648.648 0 0 1 .9 0L7.813 6.56a.61.61 0 0 1 0 .878l-5.926 5.78a.648.648 0 0 1-.9 0 .61.61 0 0 1 0-.879L6.463 7Z"></path></svg></div></div></label><div class="CodeSyntaxSelector_body__hBJ7j CodeSyntaxSelector_bodyDark__cizVw"><div class="CodeBlock_codeBlock__KlURa"><pre tabindex="0" style="color:#ffffff;font-family:ProximaNova, monospace;line-height:1.2;font-size:1rem"><code class="language-bash" style="white-space:pre"><span class="token token" style="color:#ee6123">curl</span><span> </span><span class="token token punctuation">\</span><span> </span><span>-H </span><span class="token token" style="color:#acda95">'Authorization: Bearer {TOKEN}'</span><span> </span><span class="token token punctuation">\</span><span> </span><span>-H </span><span class="token token" style="color:#acda95">'Content-Type: application/json'</span><span> </span><span class="token token punctuation">\</span><span> </span><span>-X PATCH </span><span class="token token punctuation">\</span><span> </span><span>-d </span><span class="token token" style="color:#acda95">'{ </span><span class="token token" style="color:#acda95"> "name": "My New Group", </span><span class="token token" style="color:#acda95"> "organization_guid": "Oa1bcd234eF", </span><span class="token token" style="color:#acda95"> "bsds": [ </span><span class="token token" style="color:#acda95"> "chauncey.ly" </span><span class="token token" style="color:#acda95"> ] </span><span class="token token" style="color:#acda95">}'</span><span> </span><span class="token token punctuation">\</span><span> </span>https://api-ssl.bitly.com/v4/groups/Ba1bc23dE4F</code></pre></div></div></div><div><label class="CodeSyntaxSelector_header__6P_Jc"><span>Response</span><div class="CodeSyntaxSelector_header__6P_Jc"><div class="Select_wrapper__58utF"><select class="Select_select__qXz_Z" aria-label="Select" autoComplete="off"><option value="200" selected="">200 SUCCESS</option><option value="400">400 BAD_REQUEST</option><option value="403">403 FORBIDDEN</option><option value="404">404 NOT_FOUND</option><option value="422">422 UNPROCESSABLE_ENTITY</option><option value="500">500 INTERNAL_ERROR</option><option value="503">503 TEMPORARILY_UNAVAILABLE</option></select><svg viewBox="0 0 8 14" xmlns="http://www.w3.org/2000/svg"><path d="M6.463 7 .987 1.66a.61.61 0 0 1 0-.878.648.648 0 0 1 .9 0L7.813 6.56a.61.61 0 0 1 0 .878l-5.926 5.78a.648.648 0 0 1-.9 0 .61.61 0 0 1 0-.879L6.463 7Z"></path></svg></div></div></label><div class="CodeSyntaxSelector_body__hBJ7j"><div class="CodeBlock_codeBlock__KlURa"><pre tabindex="0" style="color:#36383b;font-family:ProximaNova, monospace;line-height:1.2;font-size:1rem"><code class="language-json" style="white-space:pre"><span class="token token punctuation">{</span><span> </span><span> </span><span class="token token property">"references"</span><span class="token token operator">:</span><span> </span><span class="token token punctuation">{</span><span> </span><span class="token token" style="color:#51763e">"any"</span><span> </span><span class="token token punctuation">}</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"name"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"guid"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"created"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"modified"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"is_active"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"boolean"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"role"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"organization_guid"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"bsds"</span><span class="token token operator">:</span><span> </span><span class="token token punctuation">[</span><span> </span><span> </span><span class="token token" style="color:#51763e">"string"</span><span> </span><span> </span><span class="token token punctuation">]</span><span> </span><span></span><span class="token token punctuation">}</span></code></pre></div></div></div></div></div><div class="MethodDetail_methodContainer__3EF7h" id="getGroup"><div class="MethodDetail_method__fyEiw"><div><h3 class="MethodHeader_h3__seOfC">Retrieve a Group</h3><h4 class="MethodHeader_description__3_p_p"><div class="MethodHeader_iconStyle__x5Ow4"><svg viewBox="0 0 14 6" xmlns="http://www.w3.org/2000/svg" class="IconRest_restIcon__3pju8 get"><title>Get</title><path d="M2.587 6c.307 0 .607-.044.9-.132.295-.088.533-.217.716-.387V2.876H2.271v.825h1.027v1.145a.772.772 0 0 1-.239.1 1.4 1.4 0 0 1-.383.049 1.338 1.338 0 0 1-1.083-.52c-.135-.17-.24-.379-.316-.626a2.879 2.879 0 0 1-.113-.84c0-.352.038-.655.113-.907.076-.253.182-.46.32-.623.137-.162.3-.281.488-.358a1.783 1.783 0 0 1 .97-.082l.13.032v.915h.889V.28a3.182 3.182 0 0 0-.59-.202A3.507 3.507 0 0 0 2.676 0c-.313 0-.628.055-.946.165a2.4 2.4 0 0 0-.861.523 2.707 2.707 0 0 0-.627.92C.081 1.98 0 2.433 0 2.966c0 .506.067.946.202 1.323.135.376.318.692.55.948a2.2 2.2 0 0 0 .82.572A2.7 2.7 0 0 0 2.587 6Zm6.24-.115V4.879H6.184V3.47h2.4V2.465h-2.4V1.121h2.602V.115h-3.71v5.77h3.75Zm4.43 0v-.907h-.914V1.022h.768v.997H14V.115H9.57V2.02h.89v-.997h.776v3.956h-.922v.907h2.942Z"></path></svg></div> /v4/groups/{group_guid}</h4><p class="MethodHeader_description__3_p_p">Returns details for a group.</p></div><div><h4 class="ParameterList_h4__nH9G8 ParameterList_dividing__wRGRx">Path Parameters</h4><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">group_guid</span><span class="Parameter_type__djM_s">string</span><span class="Parameter_required__pcK_H">Required</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">A GUID for a Bitly group</div></div></div></div><div class="MethodDetail_examples__8nXeM"><div><label class="CodeSyntaxSelector_header__6P_Jc CodeSyntaxSelector_headerDark__hI3A0"><span>Request</span><div class="CodeSyntaxSelector_header__6P_Jc CodeSyntaxSelector_headerDark__hI3A0"><div class="Select_wrapper__58utF Select_dark__KPIws"><select class="Select_select__qXz_Z Select_dark__KPIws" aria-label="Select" autoComplete="off"><option value="cURL" selected="">cURL</option><option value="Node">Node</option><option value="Browser">Browser</option><option value="Go">Go</option><option value="Python">Python</option></select><svg viewBox="0 0 8 14" xmlns="http://www.w3.org/2000/svg"><path d="M6.463 7 .987 1.66a.61.61 0 0 1 0-.878.648.648 0 0 1 .9 0L7.813 6.56a.61.61 0 0 1 0 .878l-5.926 5.78a.648.648 0 0 1-.9 0 .61.61 0 0 1 0-.879L6.463 7Z"></path></svg></div></div></label><div class="CodeSyntaxSelector_body__hBJ7j CodeSyntaxSelector_bodyDark__cizVw"><div class="CodeBlock_codeBlock__KlURa"><pre tabindex="0" style="color:#ffffff;font-family:ProximaNova, monospace;line-height:1.2;font-size:1rem"><code class="language-bash" style="white-space:pre"><span class="token token" style="color:#ee6123">curl</span><span> </span><span class="token token punctuation">\</span><span> </span><span>-H </span><span class="token token" style="color:#acda95">'Authorization: Bearer {TOKEN}'</span><span> </span><span class="token token punctuation">\</span><span> </span><span>-X GET </span><span class="token token punctuation">\</span><span> </span>https://api-ssl.bitly.com/v4/groups/Ba1bc23dE4F</code></pre></div></div></div><div><label class="CodeSyntaxSelector_header__6P_Jc"><span>Response</span><div class="CodeSyntaxSelector_header__6P_Jc"><div class="Select_wrapper__58utF"><select class="Select_select__qXz_Z" aria-label="Select" autoComplete="off"><option value="200" selected="">200 SUCCESS</option><option value="403">403 FORBIDDEN</option><option value="404">404 NOT_FOUND</option><option value="429">429 MONTHLY_LIMIT_EXCEEDED</option><option value="500">500 INTERNAL_ERROR</option><option value="503">503 TEMPORARILY_UNAVAILABLE</option></select><svg viewBox="0 0 8 14" xmlns="http://www.w3.org/2000/svg"><path d="M6.463 7 .987 1.66a.61.61 0 0 1 0-.878.648.648 0 0 1 .9 0L7.813 6.56a.61.61 0 0 1 0 .878l-5.926 5.78a.648.648 0 0 1-.9 0 .61.61 0 0 1 0-.879L6.463 7Z"></path></svg></div></div></label><div class="CodeSyntaxSelector_body__hBJ7j"><div class="CodeBlock_codeBlock__KlURa"><pre tabindex="0" style="color:#36383b;font-family:ProximaNova, monospace;line-height:1.2;font-size:1rem"><code class="language-json" style="white-space:pre"><span class="token token punctuation">{</span><span> </span><span> </span><span class="token token property">"references"</span><span class="token token operator">:</span><span> </span><span class="token token punctuation">{</span><span> </span><span class="token token" style="color:#51763e">"any"</span><span> </span><span class="token token punctuation">}</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"name"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"guid"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"created"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"modified"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"is_active"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"boolean"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"role"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"organization_guid"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"bsds"</span><span class="token token operator">:</span><span> </span><span class="token token punctuation">[</span><span> </span><span> </span><span class="token token" style="color:#51763e">"string"</span><span> </span><span> </span><span class="token token punctuation">]</span><span> </span><span></span><span class="token token punctuation">}</span></code></pre></div></div></div></div></div><div class="MethodDetail_methodContainer__3EF7h" id="getGroupTags"><div class="MethodDetail_method__fyEiw"><div><h3 class="MethodHeader_h3__seOfC">Retrieve Tags by Group</h3><h4 class="MethodHeader_description__3_p_p"><div class="MethodHeader_iconStyle__x5Ow4"><svg viewBox="0 0 14 6" xmlns="http://www.w3.org/2000/svg" class="IconRest_restIcon__3pju8 get"><title>Get</title><path d="M2.587 6c.307 0 .607-.044.9-.132.295-.088.533-.217.716-.387V2.876H2.271v.825h1.027v1.145a.772.772 0 0 1-.239.1 1.4 1.4 0 0 1-.383.049 1.338 1.338 0 0 1-1.083-.52c-.135-.17-.24-.379-.316-.626a2.879 2.879 0 0 1-.113-.84c0-.352.038-.655.113-.907.076-.253.182-.46.32-.623.137-.162.3-.281.488-.358a1.783 1.783 0 0 1 .97-.082l.13.032v.915h.889V.28a3.182 3.182 0 0 0-.59-.202A3.507 3.507 0 0 0 2.676 0c-.313 0-.628.055-.946.165a2.4 2.4 0 0 0-.861.523 2.707 2.707 0 0 0-.627.92C.081 1.98 0 2.433 0 2.966c0 .506.067.946.202 1.323.135.376.318.692.55.948a2.2 2.2 0 0 0 .82.572A2.7 2.7 0 0 0 2.587 6Zm6.24-.115V4.879H6.184V3.47h2.4V2.465h-2.4V1.121h2.602V.115h-3.71v5.77h3.75Zm4.43 0v-.907h-.914V1.022h.768v.997H14V.115H9.57V2.02h.89v-.997h.776v3.956h-.922v.907h2.942Z"></path></svg></div> /v4/groups/{group_guid}/tags</h4><p class="MethodHeader_description__3_p_p">Returns the tags currently used in the specified group. Maximum 1000.</p></div><div><h4 class="ParameterList_h4__nH9G8 ParameterList_dividing__wRGRx">Path Parameters</h4><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">group_guid</span><span class="Parameter_type__djM_s">string</span><span class="Parameter_required__pcK_H">Required</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">A GUID for a Bitly group</div></div></div></div><div class="MethodDetail_examples__8nXeM"><div><label class="CodeSyntaxSelector_header__6P_Jc CodeSyntaxSelector_headerDark__hI3A0"><span>Request</span><div class="CodeSyntaxSelector_header__6P_Jc CodeSyntaxSelector_headerDark__hI3A0"><div class="Select_wrapper__58utF Select_dark__KPIws"><select class="Select_select__qXz_Z Select_dark__KPIws" aria-label="Select" autoComplete="off"><option value="cURL" selected="">cURL</option><option value="Node">Node</option><option value="Browser">Browser</option><option value="Go">Go</option><option value="Python">Python</option></select><svg viewBox="0 0 8 14" xmlns="http://www.w3.org/2000/svg"><path d="M6.463 7 .987 1.66a.61.61 0 0 1 0-.878.648.648 0 0 1 .9 0L7.813 6.56a.61.61 0 0 1 0 .878l-5.926 5.78a.648.648 0 0 1-.9 0 .61.61 0 0 1 0-.879L6.463 7Z"></path></svg></div></div></label><div class="CodeSyntaxSelector_body__hBJ7j CodeSyntaxSelector_bodyDark__cizVw"><div class="CodeBlock_codeBlock__KlURa"><pre tabindex="0" style="color:#ffffff;font-family:ProximaNova, monospace;line-height:1.2;font-size:1rem"><code class="language-bash" style="white-space:pre"><span class="token token" style="color:#ee6123">curl</span><span> </span><span class="token token punctuation">\</span><span> </span><span>-H </span><span class="token token" style="color:#acda95">'Authorization: Bearer {TOKEN}'</span><span> </span><span class="token token punctuation">\</span><span> </span><span>-X GET </span><span class="token token punctuation">\</span><span> </span>https://api-ssl.bitly.com/v4/groups/Ba1bc23dE4F/tags</code></pre></div></div></div><div><label class="CodeSyntaxSelector_header__6P_Jc"><span>Response</span><div class="CodeSyntaxSelector_header__6P_Jc"><div class="Select_wrapper__58utF"><select class="Select_select__qXz_Z" aria-label="Select" autoComplete="off"><option value="200" selected="">200 SUCCESS</option><option value="403">403 FORBIDDEN</option><option value="404">404 NOT_FOUND</option><option value="429">429 MONTHLY_LIMIT_EXCEEDED</option><option value="500">500 INTERNAL_ERROR</option><option value="503">503 TEMPORARILY_UNAVAILABLE</option></select><svg viewBox="0 0 8 14" xmlns="http://www.w3.org/2000/svg"><path d="M6.463 7 .987 1.66a.61.61 0 0 1 0-.878.648.648 0 0 1 .9 0L7.813 6.56a.61.61 0 0 1 0 .878l-5.926 5.78a.648.648 0 0 1-.9 0 .61.61 0 0 1 0-.879L6.463 7Z"></path></svg></div></div></label><div class="CodeSyntaxSelector_body__hBJ7j"><div class="CodeBlock_codeBlock__KlURa"><pre tabindex="0" style="color:#36383b;font-family:ProximaNova, monospace;line-height:1.2;font-size:1rem"><code class="language-json" style="white-space:pre"><span class="token token punctuation">{</span><span> </span><span> </span><span class="token token property">"tags"</span><span class="token token operator">:</span><span> </span><span class="token token punctuation">[</span><span> </span><span> </span><span class="token token" style="color:#51763e">"string"</span><span> </span><span> </span><span class="token token punctuation">]</span><span> </span><span></span><span class="token token punctuation">}</span></code></pre></div></div></div></div></div><div class="MethodDetail_methodContainer__3EF7h" id="getGroupPreferences"><div class="MethodDetail_method__fyEiw"><div><h3 class="MethodHeader_h3__seOfC">Retrieve Group Preferences</h3><h4 class="MethodHeader_description__3_p_p"><div class="MethodHeader_iconStyle__x5Ow4"><svg viewBox="0 0 14 6" xmlns="http://www.w3.org/2000/svg" class="IconRest_restIcon__3pju8 get"><title>Get</title><path d="M2.587 6c.307 0 .607-.044.9-.132.295-.088.533-.217.716-.387V2.876H2.271v.825h1.027v1.145a.772.772 0 0 1-.239.1 1.4 1.4 0 0 1-.383.049 1.338 1.338 0 0 1-1.083-.52c-.135-.17-.24-.379-.316-.626a2.879 2.879 0 0 1-.113-.84c0-.352.038-.655.113-.907.076-.253.182-.46.32-.623.137-.162.3-.281.488-.358a1.783 1.783 0 0 1 .97-.082l.13.032v.915h.889V.28a3.182 3.182 0 0 0-.59-.202A3.507 3.507 0 0 0 2.676 0c-.313 0-.628.055-.946.165a2.4 2.4 0 0 0-.861.523 2.707 2.707 0 0 0-.627.92C.081 1.98 0 2.433 0 2.966c0 .506.067.946.202 1.323.135.376.318.692.55.948a2.2 2.2 0 0 0 .82.572A2.7 2.7 0 0 0 2.587 6Zm6.24-.115V4.879H6.184V3.47h2.4V2.465h-2.4V1.121h2.602V.115h-3.71v5.77h3.75Zm4.43 0v-.907h-.914V1.022h.768v.997H14V.115H9.57V2.02h.89v-.997h.776v3.956h-.922v.907h2.942Z"></path></svg></div> /v4/groups/{group_guid}/preferences</h4><p class="MethodHeader_description__3_p_p">Returns preferences for the specified group.</p></div><div><h4 class="ParameterList_h4__nH9G8 ParameterList_dividing__wRGRx">Path Parameters</h4><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">group_guid</span><span class="Parameter_type__djM_s">string</span><span class="Parameter_required__pcK_H">Required</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">A GUID for a Bitly group</div></div></div></div><div class="MethodDetail_examples__8nXeM"><div><label class="CodeSyntaxSelector_header__6P_Jc CodeSyntaxSelector_headerDark__hI3A0"><span>Request</span><div class="CodeSyntaxSelector_header__6P_Jc CodeSyntaxSelector_headerDark__hI3A0"><div class="Select_wrapper__58utF Select_dark__KPIws"><select class="Select_select__qXz_Z Select_dark__KPIws" aria-label="Select" autoComplete="off"><option value="cURL" selected="">cURL</option><option value="Node">Node</option><option value="Browser">Browser</option><option value="Go">Go</option><option value="Python">Python</option></select><svg viewBox="0 0 8 14" xmlns="http://www.w3.org/2000/svg"><path d="M6.463 7 .987 1.66a.61.61 0 0 1 0-.878.648.648 0 0 1 .9 0L7.813 6.56a.61.61 0 0 1 0 .878l-5.926 5.78a.648.648 0 0 1-.9 0 .61.61 0 0 1 0-.879L6.463 7Z"></path></svg></div></div></label><div class="CodeSyntaxSelector_body__hBJ7j CodeSyntaxSelector_bodyDark__cizVw"><div class="CodeBlock_codeBlock__KlURa"><pre tabindex="0" style="color:#ffffff;font-family:ProximaNova, monospace;line-height:1.2;font-size:1rem"><code class="language-bash" style="white-space:pre"><span class="token token" style="color:#ee6123">curl</span><span> </span><span class="token token punctuation">\</span><span> </span><span>-H </span><span class="token token" style="color:#acda95">'Authorization: Bearer {TOKEN}'</span><span> </span><span class="token token punctuation">\</span><span> </span><span>-X GET </span><span class="token token punctuation">\</span><span> </span>https://api-ssl.bitly.com/v4/groups/Ba1bc23dE4F/preferences</code></pre></div></div></div><div><label class="CodeSyntaxSelector_header__6P_Jc"><span>Response</span><div class="CodeSyntaxSelector_header__6P_Jc"><div class="Select_wrapper__58utF"><select class="Select_select__qXz_Z" aria-label="Select" autoComplete="off"><option value="200" selected="">200 SUCCESS</option><option value="403">403 FORBIDDEN</option><option value="404">404 NOT_FOUND</option><option value="500">500 INTERNAL_ERROR</option><option value="503">503 TEMPORARILY_UNAVAILABLE</option></select><svg viewBox="0 0 8 14" xmlns="http://www.w3.org/2000/svg"><path d="M6.463 7 .987 1.66a.61.61 0 0 1 0-.878.648.648 0 0 1 .9 0L7.813 6.56a.61.61 0 0 1 0 .878l-5.926 5.78a.648.648 0 0 1-.9 0 .61.61 0 0 1 0-.879L6.463 7Z"></path></svg></div></div></label><div class="CodeSyntaxSelector_body__hBJ7j"><div class="CodeBlock_codeBlock__KlURa"><pre tabindex="0" style="color:#36383b;font-family:ProximaNova, monospace;line-height:1.2;font-size:1rem"><code class="language-json" style="white-space:pre"><span class="token token punctuation">{</span><span> </span><span> </span><span class="token token property">"group_guid"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"domain_preference"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span> </span><span></span><span class="token token punctuation">}</span></code></pre></div></div></div></div></div><div class="MethodDetail_methodContainer__3EF7h" id="updateGroupPreferences"><div class="MethodDetail_method__fyEiw"><div><h3 class="MethodHeader_h3__seOfC">Update Group Preferences</h3><h4 class="MethodHeader_description__3_p_p"><div class="MethodHeader_iconStyle__x5Ow4"><svg viewBox="0 0 23 6" xmlns="http://www.w3.org/2000/svg" class="IconRest_restIcon__3pju8 patch"><title>Patch</title><path d="M1.095 5.885V3.898c.027.006.07.011.132.017a4.052 4.052 0 0 0 .372.016h.128c.277 0 .545-.037.803-.11.259-.075.49-.193.692-.355.202-.162.365-.368.487-.618.123-.25.184-.551.184-.903 0-.401-.07-.727-.212-.977a1.606 1.606 0 0 0-.547-.585 2.041 2.041 0 0 0-.756-.28 5.067 5.067 0 0 0-.835-.07c-.267 0-.534.012-.804.037C.47.095.224.13 0 .173v5.712h1.095Zm.472-2.934h-.1a2.448 2.448 0 0 1-.276-.017.853.853 0 0 1-.096-.016V1.047c.059-.011.136-.02.232-.03.096-.007.197-.012.304-.012.138 0 .274.014.408.042a.964.964 0 0 1 .355.148.801.801 0 0 1 .252.284.937.937 0 0 1 .096.45c0 .214-.033.387-.1.519a.787.787 0 0 1-.268.309 1.038 1.038 0 0 1-.38.152 2.235 2.235 0 0 1-.427.042Zm3.79 2.934.383-1.278h1.67l.4 1.278h1.152L7.163.115H6.068L4.26 5.885h1.095ZM7.194 3.7h-1.2l.56-1.929h.072l.568 1.929Zm5.668 2.184v-.907h-.903V1.022h.76v.997h.879V.115H9.218V2.02h.879v-.997h.767v3.956h-.91v.907h2.91Zm3.91.115c.276 0 .547-.036.81-.107.265-.072.482-.17.652-.297V3.948h-.88v.997c-.164.033-.335.05-.51.05-.246 0-.464-.049-.656-.145a1.383 1.383 0 0 1-.488-.408 1.881 1.881 0 0 1-.304-.63A2.973 2.973 0 0 1 15.293 3c0-.34.038-.636.112-.886.075-.25.179-.457.312-.622.133-.165.29-.287.468-.367.178-.08.371-.12.58-.12.175 0 .346.014.511.042v.94h.88V.271a2.727 2.727 0 0 0-.548-.19A3.419 3.419 0 0 0 16.796 0c-.303 0-.613.05-.927.152-.314.102-.6.27-.855.503a2.611 2.611 0 0 0-.628.923c-.163.382-.244.856-.244 1.422 0 .544.072 1.007.216 1.389.144.382.336.692.576.931.24.24.518.412.835.52.317.106.652.16 1.003.16Zm3.325-.115V3.47h1.807v2.415H23V.115h-1.095v2.35h-1.807V.114h-1.095v5.77h1.095Z"></path></svg></div> /v4/groups/{group_guid}/preferences</h4><p class="MethodHeader_description__3_p_p">Updates preferences for a group.</p></div><div><h4 class="ParameterList_h4__nH9G8 ParameterList_dividing__wRGRx">Path Parameters</h4><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">group_guid</span><span class="Parameter_type__djM_s">string</span><span class="Parameter_required__pcK_H">Required</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">A GUID for a Bitly group</div></div></div><div><h4 class="ParameterList_h4__nH9G8 ParameterList_dividing__wRGRx">Request Body Schema</h4><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">group_guid</span><span class="Parameter_type__djM_s">string</span></div></div><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">domain_preference</span><span class="Parameter_type__djM_s">string</span></div></div></div></div><div class="MethodDetail_examples__8nXeM"><div><label class="CodeSyntaxSelector_header__6P_Jc CodeSyntaxSelector_headerDark__hI3A0"><span>Request</span><div class="CodeSyntaxSelector_header__6P_Jc CodeSyntaxSelector_headerDark__hI3A0"><div class="Select_wrapper__58utF Select_dark__KPIws"><select class="Select_select__qXz_Z Select_dark__KPIws" aria-label="Select" autoComplete="off"><option value="cURL" selected="">cURL</option><option value="Node">Node</option><option value="Browser">Browser</option><option value="Go">Go</option><option value="Python">Python</option></select><svg viewBox="0 0 8 14" xmlns="http://www.w3.org/2000/svg"><path d="M6.463 7 .987 1.66a.61.61 0 0 1 0-.878.648.648 0 0 1 .9 0L7.813 6.56a.61.61 0 0 1 0 .878l-5.926 5.78a.648.648 0 0 1-.9 0 .61.61 0 0 1 0-.879L6.463 7Z"></path></svg></div></div></label><div class="CodeSyntaxSelector_body__hBJ7j CodeSyntaxSelector_bodyDark__cizVw"><div class="CodeBlock_codeBlock__KlURa"><pre tabindex="0" style="color:#ffffff;font-family:ProximaNova, monospace;line-height:1.2;font-size:1rem"><code class="language-bash" style="white-space:pre"><span class="token token" style="color:#ee6123">curl</span><span> </span><span class="token token punctuation">\</span><span> </span><span>-H </span><span class="token token" style="color:#acda95">'Authorization: Bearer {TOKEN}'</span><span> </span><span class="token token punctuation">\</span><span> </span><span>-H </span><span class="token token" style="color:#acda95">'Content-Type: application/json'</span><span> </span><span class="token token punctuation">\</span><span> </span><span>-X PATCH </span><span class="token token punctuation">\</span><span> </span><span>-d </span><span class="token token" style="color:#acda95">'{ </span><span class="token token" style="color:#acda95"> "group_guid": "Ba1bc23dE4F", </span><span class="token token" style="color:#acda95"> "domain_preference": "chauncey.ly" </span><span class="token token" style="color:#acda95">}'</span><span> </span><span class="token token punctuation">\</span><span> </span>https://api-ssl.bitly.com/v4/groups/Ba1bc23dE4F/preferences</code></pre></div></div></div><div><label class="CodeSyntaxSelector_header__6P_Jc"><span>Response</span><div class="CodeSyntaxSelector_header__6P_Jc"><div class="Select_wrapper__58utF"><select class="Select_select__qXz_Z" aria-label="Select" autoComplete="off"><option value="200" selected="">200 SUCCESS</option><option value="400">400 BAD_REQUEST</option><option value="403">403 FORBIDDEN</option><option value="404">404 NOT_FOUND</option><option value="422">422 UNPROCESSABLE_ENTITY</option><option value="429">429 MONTHLY_LIMIT_EXCEEDED</option><option value="500">500 INTERNAL_ERROR</option><option value="503">503 TEMPORARILY_UNAVAILABLE</option></select><svg viewBox="0 0 8 14" xmlns="http://www.w3.org/2000/svg"><path d="M6.463 7 .987 1.66a.61.61 0 0 1 0-.878.648.648 0 0 1 .9 0L7.813 6.56a.61.61 0 0 1 0 .878l-5.926 5.78a.648.648 0 0 1-.9 0 .61.61 0 0 1 0-.879L6.463 7Z"></path></svg></div></div></label><div class="CodeSyntaxSelector_body__hBJ7j"><div class="CodeBlock_codeBlock__KlURa"><pre tabindex="0" style="color:#36383b;font-family:ProximaNova, monospace;line-height:1.2;font-size:1rem"><code class="language-json" style="white-space:pre"><span class="token token punctuation">{</span><span> </span><span> </span><span class="token token property">"group_guid"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"domain_preference"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span> </span><span></span><span class="token token punctuation">}</span></code></pre></div></div></div></div></div><div class="MethodDetail_methodContainer__3EF7h" id="getGroupShortenCounts"><div class="MethodDetail_method__fyEiw"><div><h3 class="MethodHeader_h3__seOfC">Retrieve Group Shorten Counts</h3><h4 class="MethodHeader_description__3_p_p"><div class="MethodHeader_iconStyle__x5Ow4"><svg viewBox="0 0 14 6" xmlns="http://www.w3.org/2000/svg" class="IconRest_restIcon__3pju8 get"><title>Get</title><path d="M2.587 6c.307 0 .607-.044.9-.132.295-.088.533-.217.716-.387V2.876H2.271v.825h1.027v1.145a.772.772 0 0 1-.239.1 1.4 1.4 0 0 1-.383.049 1.338 1.338 0 0 1-1.083-.52c-.135-.17-.24-.379-.316-.626a2.879 2.879 0 0 1-.113-.84c0-.352.038-.655.113-.907.076-.253.182-.46.32-.623.137-.162.3-.281.488-.358a1.783 1.783 0 0 1 .97-.082l.13.032v.915h.889V.28a3.182 3.182 0 0 0-.59-.202A3.507 3.507 0 0 0 2.676 0c-.313 0-.628.055-.946.165a2.4 2.4 0 0 0-.861.523 2.707 2.707 0 0 0-.627.92C.081 1.98 0 2.433 0 2.966c0 .506.067.946.202 1.323.135.376.318.692.55.948a2.2 2.2 0 0 0 .82.572A2.7 2.7 0 0 0 2.587 6Zm6.24-.115V4.879H6.184V3.47h2.4V2.465h-2.4V1.121h2.602V.115h-3.71v5.77h3.75Zm4.43 0v-.907h-.914V1.022h.768v.997H14V.115H9.57V2.02h.89v-.997h.776v3.956h-.922v.907h2.942Z"></path></svg></div> /v4/groups/{group_guid}/shorten_counts</h4><p class="MethodHeader_description__3_p_p">Returns all the shorten counts for a group.</p></div><div><h4 class="ParameterList_h4__nH9G8 ParameterList_dividing__wRGRx">Path Parameters</h4><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">group_guid</span><span class="Parameter_type__djM_s">string</span><span class="Parameter_required__pcK_H">Required</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">A GUID for a Bitly group</div></div></div><div><h4 class="ParameterList_h4__nH9G8 ParameterList_dividing__wRGRx">Query Parameters</h4><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">unit</span><span class="Parameter_type__djM_s">string</span><span class="Parameter_required__pcK_H">Required</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">A unit of time</div><div class="Parameter_default__HHgG0 Parameter_spacer__JKXbH">Default: <span class="Parameter_label__DUY7G">"day"</span></div><div class="Parameter_enum__csO6P Parameter_spacer__JKXbH">Enum: <span class="Parameter_label__DUY7G">"minute"</span><span class="Parameter_label__DUY7G">"hour"</span><span class="Parameter_label__DUY7G">"day"</span><span class="Parameter_label__DUY7G">"week"</span><span class="Parameter_label__DUY7G">"month"</span></div></div><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">units</span><span class="Parameter_type__djM_s">integer</span><span class="Parameter_required__pcK_H">Required</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">An integer representing the time units to query data for. pass -1 to return all units of time</div><div class="Parameter_default__HHgG0 Parameter_spacer__JKXbH">Default: <span class="Parameter_label__DUY7G">-1</span></div></div><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">unit_reference</span><span class="Parameter_type__djM_s">string</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">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)</div></div></div></div><div class="MethodDetail_examples__8nXeM"><div><label class="CodeSyntaxSelector_header__6P_Jc CodeSyntaxSelector_headerDark__hI3A0"><span>Request</span><div class="CodeSyntaxSelector_header__6P_Jc CodeSyntaxSelector_headerDark__hI3A0"><div class="Select_wrapper__58utF Select_dark__KPIws"><select class="Select_select__qXz_Z Select_dark__KPIws" aria-label="Select" autoComplete="off"><option value="cURL" selected="">cURL</option><option value="Node">Node</option><option value="Browser">Browser</option><option value="Go">Go</option><option value="Python">Python</option></select><svg viewBox="0 0 8 14" xmlns="http://www.w3.org/2000/svg"><path d="M6.463 7 .987 1.66a.61.61 0 0 1 0-.878.648.648 0 0 1 .9 0L7.813 6.56a.61.61 0 0 1 0 .878l-5.926 5.78a.648.648 0 0 1-.9 0 .61.61 0 0 1 0-.879L6.463 7Z"></path></svg></div></div></label><div class="CodeSyntaxSelector_body__hBJ7j CodeSyntaxSelector_bodyDark__cizVw"><div class="CodeBlock_codeBlock__KlURa"><pre tabindex="0" style="color:#ffffff;font-family:ProximaNova, monospace;line-height:1.2;font-size:1rem"><code class="language-bash" style="white-space:pre"><span class="token token" style="color:#ee6123">curl</span><span> </span><span class="token token punctuation">\</span><span> </span><span>-H </span><span class="token token" style="color:#acda95">'Authorization: Bearer {TOKEN}'</span><span> </span><span class="token token punctuation">\</span><span> </span><span>-X GET </span><span class="token token punctuation">\</span><span> </span><span>https://api-ssl.bitly.com/v4/groups/Ba1bc23dE4F/shorten_counts?unit</span><span class="token token operator">=</span><span>month</span><span class="token token operator">&</span><span class="token token assign-left variable">units</span><span class="token token operator">=</span><span class="token token" style="color:#a1b8f3">1</span><span class="token token operator">&</span><span class="token token assign-left variable">unit_reference</span><span class="token token operator">=</span><span class="token token" style="color:#a1b8f3">2006</span><span>-01-02T15%3A04%3A05-0700</span></code></pre></div></div></div><div><label class="CodeSyntaxSelector_header__6P_Jc"><span>Response</span><div class="CodeSyntaxSelector_header__6P_Jc"><div class="Select_wrapper__58utF"><select class="Select_select__qXz_Z" aria-label="Select" autoComplete="off"><option value="200" selected="">200 SUCCESS</option><option value="403">403 FORBIDDEN</option><option value="404">404 NOT_FOUND</option><option value="429">429 MONTHLY_LIMIT_EXCEEDED</option><option value="500">500 INTERNAL_ERROR</option><option value="503">503 TEMPORARILY_UNAVAILABLE</option></select><svg viewBox="0 0 8 14" xmlns="http://www.w3.org/2000/svg"><path d="M6.463 7 .987 1.66a.61.61 0 0 1 0-.878.648.648 0 0 1 .9 0L7.813 6.56a.61.61 0 0 1 0 .878l-5.926 5.78a.648.648 0 0 1-.9 0 .61.61 0 0 1 0-.879L6.463 7Z"></path></svg></div></div></label><div class="CodeSyntaxSelector_body__hBJ7j"><div class="CodeBlock_codeBlock__KlURa"><pre tabindex="0" style="color:#36383b;font-family:ProximaNova, monospace;line-height:1.2;font-size:1rem"><code class="language-json" style="white-space:pre"><span class="token token punctuation">{</span><span> </span><span> </span><span class="token token property">"unit"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"units"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"integer"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"facet"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"unit_reference"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"metrics"</span><span class="token token operator">:</span><span> </span><span class="token token punctuation">[</span><span> </span><span> </span><span class="token token punctuation">{</span><span> </span><span> </span><span class="token token property">"key"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"value"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"integer"</span><span> </span><span> </span><span class="token token punctuation">}</span><span> </span><span> </span><span class="token token punctuation">]</span><span> </span><span></span><span class="token token punctuation">}</span></code></pre></div></div></div></div></div><div class="MethodDetail_methodContainer__3EF7h" id="getGroupMetricsByCountries"><div class="MethodDetail_method__fyEiw"><div><h3 class="MethodHeader_h3__seOfC">Get Click Metrics for a Group by Country</h3><h4 class="MethodHeader_description__3_p_p"><div class="MethodHeader_iconStyle__x5Ow4"><svg viewBox="0 0 14 6" xmlns="http://www.w3.org/2000/svg" class="IconRest_restIcon__3pju8 get"><title>Get</title><path d="M2.587 6c.307 0 .607-.044.9-.132.295-.088.533-.217.716-.387V2.876H2.271v.825h1.027v1.145a.772.772 0 0 1-.239.1 1.4 1.4 0 0 1-.383.049 1.338 1.338 0 0 1-1.083-.52c-.135-.17-.24-.379-.316-.626a2.879 2.879 0 0 1-.113-.84c0-.352.038-.655.113-.907.076-.253.182-.46.32-.623.137-.162.3-.281.488-.358a1.783 1.783 0 0 1 .97-.082l.13.032v.915h.889V.28a3.182 3.182 0 0 0-.59-.202A3.507 3.507 0 0 0 2.676 0c-.313 0-.628.055-.946.165a2.4 2.4 0 0 0-.861.523 2.707 2.707 0 0 0-.627.92C.081 1.98 0 2.433 0 2.966c0 .506.067.946.202 1.323.135.376.318.692.55.948a2.2 2.2 0 0 0 .82.572A2.7 2.7 0 0 0 2.587 6Zm6.24-.115V4.879H6.184V3.47h2.4V2.465h-2.4V1.121h2.602V.115h-3.71v5.77h3.75Zm4.43 0v-.907h-.914V1.022h.768v.997H14V.115H9.57V2.02h.89v-.997h.776v3.956h-.922v.907h2.942Z"></path></svg></div> /v4/groups/{group_guid}/countries</h4><p class="MethodHeader_description__3_p_p">Returns the geographic origins of click traffic by country for the specified group.</p></div><div><h4 class="ParameterList_h4__nH9G8 ParameterList_dividing__wRGRx">Path Parameters</h4><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">group_guid</span><span class="Parameter_type__djM_s">string</span><span class="Parameter_required__pcK_H">Required</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">A GUID for a Bitly group</div></div></div><div><h4 class="ParameterList_h4__nH9G8 ParameterList_dividing__wRGRx">Query Parameters</h4><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">unit</span><span class="Parameter_type__djM_s">string</span><span class="Parameter_required__pcK_H">Required</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">A unit of time</div><div class="Parameter_default__HHgG0 Parameter_spacer__JKXbH">Default: <span class="Parameter_label__DUY7G">"day"</span></div><div class="Parameter_enum__csO6P Parameter_spacer__JKXbH">Enum: <span class="Parameter_label__DUY7G">"minute"</span><span class="Parameter_label__DUY7G">"hour"</span><span class="Parameter_label__DUY7G">"day"</span><span class="Parameter_label__DUY7G">"week"</span><span class="Parameter_label__DUY7G">"month"</span></div></div><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">units</span><span class="Parameter_type__djM_s">integer</span><span class="Parameter_required__pcK_H">Required</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">An integer representing the time units to query data for. pass -1 to return all units of time</div><div class="Parameter_default__HHgG0 Parameter_spacer__JKXbH">Default: <span class="Parameter_label__DUY7G">-1</span></div></div><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">size</span><span class="Parameter_type__djM_s">integer</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">The quantity of items to be be returned</div><div class="Parameter_default__HHgG0 Parameter_spacer__JKXbH">Default: <span class="Parameter_label__DUY7G">50</span></div></div><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">unit_reference</span><span class="Parameter_type__djM_s">string</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">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)</div></div></div></div><div class="MethodDetail_examples__8nXeM"><div><label class="CodeSyntaxSelector_header__6P_Jc CodeSyntaxSelector_headerDark__hI3A0"><span>Request</span><div class="CodeSyntaxSelector_header__6P_Jc CodeSyntaxSelector_headerDark__hI3A0"><div class="Select_wrapper__58utF Select_dark__KPIws"><select class="Select_select__qXz_Z Select_dark__KPIws" aria-label="Select" autoComplete="off"><option value="cURL" selected="">cURL</option><option value="Node">Node</option><option value="Browser">Browser</option><option value="Go">Go</option><option value="Python">Python</option></select><svg viewBox="0 0 8 14" xmlns="http://www.w3.org/2000/svg"><path d="M6.463 7 .987 1.66a.61.61 0 0 1 0-.878.648.648 0 0 1 .9 0L7.813 6.56a.61.61 0 0 1 0 .878l-5.926 5.78a.648.648 0 0 1-.9 0 .61.61 0 0 1 0-.879L6.463 7Z"></path></svg></div></div></label><div class="CodeSyntaxSelector_body__hBJ7j CodeSyntaxSelector_bodyDark__cizVw"><div class="CodeBlock_codeBlock__KlURa"><pre tabindex="0" style="color:#ffffff;font-family:ProximaNova, monospace;line-height:1.2;font-size:1rem"><code class="language-bash" style="white-space:pre"><span class="token token" style="color:#ee6123">curl</span><span> </span><span class="token token punctuation">\</span><span> </span><span>-H </span><span class="token token" style="color:#acda95">'Authorization: Bearer {TOKEN}'</span><span> </span><span class="token token punctuation">\</span><span> </span><span>-X GET </span><span class="token token punctuation">\</span><span> </span><span>https://api-ssl.bitly.com/v4/groups/Ba1bc23dE4F/countries?unit</span><span class="token token operator">=</span><span>month</span><span class="token token operator">&</span><span class="token token assign-left variable">units</span><span class="token token operator">=</span><span class="token token" style="color:#a1b8f3">1</span><span class="token token operator">&</span><span class="token token assign-left variable">size</span><span class="token token operator">=</span><span class="token token" style="color:#a1b8f3">10</span><span class="token token operator">&</span><span class="token token assign-left variable">unit_reference</span><span class="token token operator">=</span><span class="token token" style="color:#a1b8f3">2006</span><span>-01-02T15%3A04%3A05-0700</span></code></pre></div></div></div><div><label class="CodeSyntaxSelector_header__6P_Jc"><span>Response</span><div class="CodeSyntaxSelector_header__6P_Jc"><div class="Select_wrapper__58utF"><select class="Select_select__qXz_Z" aria-label="Select" autoComplete="off"><option value="200" selected="">200 SUCCESS</option><option value="403">403 FORBIDDEN</option><option value="404">404 NOT_FOUND</option><option value="429">429 MONTHLY_LIMIT_EXCEEDED</option><option value="500">500 INTERNAL_ERROR</option><option value="503">503 TEMPORARILY_UNAVAILABLE</option></select><svg viewBox="0 0 8 14" xmlns="http://www.w3.org/2000/svg"><path d="M6.463 7 .987 1.66a.61.61 0 0 1 0-.878.648.648 0 0 1 .9 0L7.813 6.56a.61.61 0 0 1 0 .878l-5.926 5.78a.648.648 0 0 1-.9 0 .61.61 0 0 1 0-.879L6.463 7Z"></path></svg></div></div></label><div class="CodeSyntaxSelector_body__hBJ7j"><div class="Response_formatSelect__Wt_qa"><div class="ButtonToggle_buttonToggle__6YJhd"><label class="ButtonToggle_label__ohGaG"><input class="ButtonToggle_input__vkfUm" name="getGroupMetricsByCountries" type="radio" checked=""/><span>json</span></label><label class="ButtonToggle_label__ohGaG"><input class="ButtonToggle_input__vkfUm" name="getGroupMetricsByCountries" type="radio"/><span>csv</span></label></div></div><div class="CodeBlock_codeBlock__KlURa"><pre tabindex="0" style="color:#36383b;font-family:ProximaNova, monospace;line-height:1.2;font-size:1rem"><code class="language-json" style="white-space:pre"><span class="token token punctuation">{</span><span> </span><span> </span><span class="token token property">"unit"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"units"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"integer"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"facet"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"unit_reference"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"metrics"</span><span class="token token operator">:</span><span> </span><span class="token token punctuation">[</span><span> </span><span> </span><span class="token token punctuation">{</span><span> </span><span> </span><span class="token token property">"clicks"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"integer"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"value"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span> </span><span> </span><span class="token token punctuation">}</span><span> </span><span> </span><span class="token token punctuation">]</span><span> </span><span></span><span class="token token punctuation">}</span></code></pre></div></div></div></div></div><div class="MethodDetail_methodContainer__3EF7h" id="getGroupMetricsByCities"><div class="MethodDetail_method__fyEiw"><div><h3 class="MethodHeader_h3__seOfC">Get Click Metrics for a Group by City</h3><h4 class="MethodHeader_description__3_p_p"><div class="MethodHeader_iconStyle__x5Ow4"><svg viewBox="0 0 14 6" xmlns="http://www.w3.org/2000/svg" class="IconRest_restIcon__3pju8 get"><title>Get</title><path d="M2.587 6c.307 0 .607-.044.9-.132.295-.088.533-.217.716-.387V2.876H2.271v.825h1.027v1.145a.772.772 0 0 1-.239.1 1.4 1.4 0 0 1-.383.049 1.338 1.338 0 0 1-1.083-.52c-.135-.17-.24-.379-.316-.626a2.879 2.879 0 0 1-.113-.84c0-.352.038-.655.113-.907.076-.253.182-.46.32-.623.137-.162.3-.281.488-.358a1.783 1.783 0 0 1 .97-.082l.13.032v.915h.889V.28a3.182 3.182 0 0 0-.59-.202A3.507 3.507 0 0 0 2.676 0c-.313 0-.628.055-.946.165a2.4 2.4 0 0 0-.861.523 2.707 2.707 0 0 0-.627.92C.081 1.98 0 2.433 0 2.966c0 .506.067.946.202 1.323.135.376.318.692.55.948a2.2 2.2 0 0 0 .82.572A2.7 2.7 0 0 0 2.587 6Zm6.24-.115V4.879H6.184V3.47h2.4V2.465h-2.4V1.121h2.602V.115h-3.71v5.77h3.75Zm4.43 0v-.907h-.914V1.022h.768v.997H14V.115H9.57V2.02h.89v-.997h.776v3.956h-.922v.907h2.942Z"></path></svg></div> /v4/groups/{group_guid}/cities</h4><p class="MethodHeader_description__3_p_p">Returns the geographic origins of click traffic by city for the specified group.</p></div><div><h4 class="ParameterList_h4__nH9G8 ParameterList_dividing__wRGRx">Path Parameters</h4><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">group_guid</span><span class="Parameter_type__djM_s">string</span><span class="Parameter_required__pcK_H">Required</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">A GUID for a Bitly group</div></div></div><div><h4 class="ParameterList_h4__nH9G8 ParameterList_dividing__wRGRx">Query Parameters</h4><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">unit</span><span class="Parameter_type__djM_s">string</span><span class="Parameter_required__pcK_H">Required</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">A unit of time</div><div class="Parameter_default__HHgG0 Parameter_spacer__JKXbH">Default: <span class="Parameter_label__DUY7G">"day"</span></div><div class="Parameter_enum__csO6P Parameter_spacer__JKXbH">Enum: <span class="Parameter_label__DUY7G">"minute"</span><span class="Parameter_label__DUY7G">"hour"</span><span class="Parameter_label__DUY7G">"day"</span><span class="Parameter_label__DUY7G">"week"</span><span class="Parameter_label__DUY7G">"month"</span></div></div><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">units</span><span class="Parameter_type__djM_s">integer</span><span class="Parameter_required__pcK_H">Required</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">An integer representing the time units to query data for. pass -1 to return all units of time</div><div class="Parameter_default__HHgG0 Parameter_spacer__JKXbH">Default: <span class="Parameter_label__DUY7G">-1</span></div></div><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">size</span><span class="Parameter_type__djM_s">integer</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">The quantity of items to be be returned</div><div class="Parameter_default__HHgG0 Parameter_spacer__JKXbH">Default: <span class="Parameter_label__DUY7G">50</span></div></div><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">unit_reference</span><span class="Parameter_type__djM_s">string</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">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)</div></div></div></div><div class="MethodDetail_examples__8nXeM"><div><label class="CodeSyntaxSelector_header__6P_Jc CodeSyntaxSelector_headerDark__hI3A0"><span>Request</span><div class="CodeSyntaxSelector_header__6P_Jc CodeSyntaxSelector_headerDark__hI3A0"><div class="Select_wrapper__58utF Select_dark__KPIws"><select class="Select_select__qXz_Z Select_dark__KPIws" aria-label="Select" autoComplete="off"><option value="cURL" selected="">cURL</option><option value="Node">Node</option><option value="Browser">Browser</option><option value="Go">Go</option><option value="Python">Python</option></select><svg viewBox="0 0 8 14" xmlns="http://www.w3.org/2000/svg"><path d="M6.463 7 .987 1.66a.61.61 0 0 1 0-.878.648.648 0 0 1 .9 0L7.813 6.56a.61.61 0 0 1 0 .878l-5.926 5.78a.648.648 0 0 1-.9 0 .61.61 0 0 1 0-.879L6.463 7Z"></path></svg></div></div></label><div class="CodeSyntaxSelector_body__hBJ7j CodeSyntaxSelector_bodyDark__cizVw"><div class="CodeBlock_codeBlock__KlURa"><pre tabindex="0" style="color:#ffffff;font-family:ProximaNova, monospace;line-height:1.2;font-size:1rem"><code class="language-bash" style="white-space:pre"><span class="token token" style="color:#ee6123">curl</span><span> </span><span class="token token punctuation">\</span><span> </span><span>-H </span><span class="token token" style="color:#acda95">'Authorization: Bearer {TOKEN}'</span><span> </span><span class="token token punctuation">\</span><span> </span><span>-X GET </span><span class="token token punctuation">\</span><span> </span><span>https://api-ssl.bitly.com/v4/groups/Ba1bc23dE4F/cities?unit</span><span class="token token operator">=</span><span>month</span><span class="token token operator">&</span><span class="token token assign-left variable">units</span><span class="token token operator">=</span><span class="token token" style="color:#a1b8f3">1</span><span class="token token operator">&</span><span class="token token assign-left variable">size</span><span class="token token operator">=</span><span class="token token" style="color:#a1b8f3">10</span><span class="token token operator">&</span><span class="token token assign-left variable">unit_reference</span><span class="token token operator">=</span><span class="token token" style="color:#a1b8f3">2006</span><span>-01-02T15%3A04%3A05-0700</span></code></pre></div></div></div><div><label class="CodeSyntaxSelector_header__6P_Jc"><span>Response</span><div class="CodeSyntaxSelector_header__6P_Jc"><div class="Select_wrapper__58utF"><select class="Select_select__qXz_Z" aria-label="Select" autoComplete="off"><option value="200" selected="">200 SUCCESS</option><option value="402">402 UPGRADE_REQUIRED</option><option value="403">403 FORBIDDEN</option><option value="404">404 NOT_FOUND</option><option value="429">429 MONTHLY_LIMIT_EXCEEDED</option><option value="500">500 INTERNAL_ERROR</option><option value="503">503 TEMPORARILY_UNAVAILABLE</option></select><svg viewBox="0 0 8 14" xmlns="http://www.w3.org/2000/svg"><path d="M6.463 7 .987 1.66a.61.61 0 0 1 0-.878.648.648 0 0 1 .9 0L7.813 6.56a.61.61 0 0 1 0 .878l-5.926 5.78a.648.648 0 0 1-.9 0 .61.61 0 0 1 0-.879L6.463 7Z"></path></svg></div></div></label><div class="CodeSyntaxSelector_body__hBJ7j"><div class="Response_formatSelect__Wt_qa"><div class="ButtonToggle_buttonToggle__6YJhd"><label class="ButtonToggle_label__ohGaG"><input class="ButtonToggle_input__vkfUm" name="getGroupMetricsByCities" type="radio" checked=""/><span>json</span></label><label class="ButtonToggle_label__ohGaG"><input class="ButtonToggle_input__vkfUm" name="getGroupMetricsByCities" type="radio"/><span>csv</span></label></div></div><div class="CodeBlock_codeBlock__KlURa"><pre tabindex="0" style="color:#36383b;font-family:ProximaNova, monospace;line-height:1.2;font-size:1rem"><code class="language-json" style="white-space:pre"><span class="token token punctuation">{</span><span> </span><span> </span><span class="token token property">"unit"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"units"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"integer"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"facet"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"unit_reference"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"metrics"</span><span class="token token operator">:</span><span> </span><span class="token token punctuation">[</span><span> </span><span> </span><span class="token token punctuation">{</span><span> </span><span> </span><span class="token token property">"clicks"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"integer"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"city"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"subregion"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"region"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"country"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span> </span><span> </span><span class="token token punctuation">}</span><span> </span><span> </span><span class="token token punctuation">]</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"other_metrics"</span><span class="token token operator">:</span><span> </span><span class="token token punctuation">{</span><span> </span><span> </span><span class="token token property">"other_city_clicks"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"integer"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"no_city_clicks"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"integer"</span><span> </span><span> </span><span class="token token punctuation">}</span><span> </span><span></span><span class="token token punctuation">}</span></code></pre></div></div></div></div></div><div class="MethodDetail_methodContainer__3EF7h" id="getGroupMetricsByDevices"><div class="MethodDetail_method__fyEiw"><div><h3 class="MethodHeader_h3__seOfC">Get Click Metrics for a Group by Device Type</h3><h4 class="MethodHeader_description__3_p_p"><div class="MethodHeader_iconStyle__x5Ow4"><svg viewBox="0 0 14 6" xmlns="http://www.w3.org/2000/svg" class="IconRest_restIcon__3pju8 get"><title>Get</title><path d="M2.587 6c.307 0 .607-.044.9-.132.295-.088.533-.217.716-.387V2.876H2.271v.825h1.027v1.145a.772.772 0 0 1-.239.1 1.4 1.4 0 0 1-.383.049 1.338 1.338 0 0 1-1.083-.52c-.135-.17-.24-.379-.316-.626a2.879 2.879 0 0 1-.113-.84c0-.352.038-.655.113-.907.076-.253.182-.46.32-.623.137-.162.3-.281.488-.358a1.783 1.783 0 0 1 .97-.082l.13.032v.915h.889V.28a3.182 3.182 0 0 0-.59-.202A3.507 3.507 0 0 0 2.676 0c-.313 0-.628.055-.946.165a2.4 2.4 0 0 0-.861.523 2.707 2.707 0 0 0-.627.92C.081 1.98 0 2.433 0 2.966c0 .506.067.946.202 1.323.135.376.318.692.55.948a2.2 2.2 0 0 0 .82.572A2.7 2.7 0 0 0 2.587 6Zm6.24-.115V4.879H6.184V3.47h2.4V2.465h-2.4V1.121h2.602V.115h-3.71v5.77h3.75Zm4.43 0v-.907h-.914V1.022h.768v.997H14V.115H9.57V2.02h.89v-.997h.776v3.956h-.922v.907h2.942Z"></path></svg></div> /v4/groups/{group_guid}/devices</h4><p class="MethodHeader_description__3_p_p">Returns the device types generating click traffic to the specified group's links.</p></div><div><h4 class="ParameterList_h4__nH9G8 ParameterList_dividing__wRGRx">Path Parameters</h4><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">group_guid</span><span class="Parameter_type__djM_s">string</span><span class="Parameter_required__pcK_H">Required</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">A GUID for a Bitly group</div></div></div><div><h4 class="ParameterList_h4__nH9G8 ParameterList_dividing__wRGRx">Query Parameters</h4><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">unit</span><span class="Parameter_type__djM_s">string</span><span class="Parameter_required__pcK_H">Required</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">A unit of time</div><div class="Parameter_default__HHgG0 Parameter_spacer__JKXbH">Default: <span class="Parameter_label__DUY7G">"day"</span></div><div class="Parameter_enum__csO6P Parameter_spacer__JKXbH">Enum: <span class="Parameter_label__DUY7G">"minute"</span><span class="Parameter_label__DUY7G">"hour"</span><span class="Parameter_label__DUY7G">"day"</span><span class="Parameter_label__DUY7G">"week"</span><span class="Parameter_label__DUY7G">"month"</span></div></div><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">units</span><span class="Parameter_type__djM_s">integer</span><span class="Parameter_required__pcK_H">Required</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">An integer representing the time units to query data for. pass -1 to return all units of time</div><div class="Parameter_default__HHgG0 Parameter_spacer__JKXbH">Default: <span class="Parameter_label__DUY7G">-1</span></div></div><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">size</span><span class="Parameter_type__djM_s">integer</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">The quantity of items to be be returned</div><div class="Parameter_default__HHgG0 Parameter_spacer__JKXbH">Default: <span class="Parameter_label__DUY7G">50</span></div></div><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">unit_reference</span><span class="Parameter_type__djM_s">string</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">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)</div></div></div></div><div class="MethodDetail_examples__8nXeM"><div><label class="CodeSyntaxSelector_header__6P_Jc CodeSyntaxSelector_headerDark__hI3A0"><span>Request</span><div class="CodeSyntaxSelector_header__6P_Jc CodeSyntaxSelector_headerDark__hI3A0"><div class="Select_wrapper__58utF Select_dark__KPIws"><select class="Select_select__qXz_Z Select_dark__KPIws" aria-label="Select" autoComplete="off"><option value="cURL" selected="">cURL</option><option value="Node">Node</option><option value="Browser">Browser</option><option value="Go">Go</option><option value="Python">Python</option></select><svg viewBox="0 0 8 14" xmlns="http://www.w3.org/2000/svg"><path d="M6.463 7 .987 1.66a.61.61 0 0 1 0-.878.648.648 0 0 1 .9 0L7.813 6.56a.61.61 0 0 1 0 .878l-5.926 5.78a.648.648 0 0 1-.9 0 .61.61 0 0 1 0-.879L6.463 7Z"></path></svg></div></div></label><div class="CodeSyntaxSelector_body__hBJ7j CodeSyntaxSelector_bodyDark__cizVw"><div class="CodeBlock_codeBlock__KlURa"><pre tabindex="0" style="color:#ffffff;font-family:ProximaNova, monospace;line-height:1.2;font-size:1rem"><code class="language-bash" style="white-space:pre"><span class="token token" style="color:#ee6123">curl</span><span> </span><span class="token token punctuation">\</span><span> </span><span>-H </span><span class="token token" style="color:#acda95">'Authorization: Bearer {TOKEN}'</span><span> </span><span class="token token punctuation">\</span><span> </span><span>-X GET </span><span class="token token punctuation">\</span><span> </span><span>https://api-ssl.bitly.com/v4/groups/Ba1bc23dE4F/devices?unit</span><span class="token token operator">=</span><span>month</span><span class="token token operator">&</span><span class="token token assign-left variable">units</span><span class="token token operator">=</span><span class="token token" style="color:#a1b8f3">1</span><span class="token token operator">&</span><span class="token token assign-left variable">size</span><span class="token token operator">=</span><span class="token token" style="color:#a1b8f3">10</span><span class="token token operator">&</span><span class="token token assign-left variable">unit_reference</span><span class="token token operator">=</span><span class="token token" style="color:#a1b8f3">2006</span><span>-01-02T15%3A04%3A05-0700</span></code></pre></div></div></div><div><label class="CodeSyntaxSelector_header__6P_Jc"><span>Response</span><div class="CodeSyntaxSelector_header__6P_Jc"><div class="Select_wrapper__58utF"><select class="Select_select__qXz_Z" aria-label="Select" autoComplete="off"><option value="200" selected="">200 SUCCESS</option><option value="402">402 UPGRADE_REQUIRED</option><option value="403">403 FORBIDDEN</option><option value="404">404 NOT_FOUND</option><option value="429">429 MONTHLY_LIMIT_EXCEEDED</option><option value="500">500 INTERNAL_ERROR</option><option value="503">503 TEMPORARILY_UNAVAILABLE</option></select><svg viewBox="0 0 8 14" xmlns="http://www.w3.org/2000/svg"><path d="M6.463 7 .987 1.66a.61.61 0 0 1 0-.878.648.648 0 0 1 .9 0L7.813 6.56a.61.61 0 0 1 0 .878l-5.926 5.78a.648.648 0 0 1-.9 0 .61.61 0 0 1 0-.879L6.463 7Z"></path></svg></div></div></label><div class="CodeSyntaxSelector_body__hBJ7j"><div class="Response_formatSelect__Wt_qa"><div class="ButtonToggle_buttonToggle__6YJhd"><label class="ButtonToggle_label__ohGaG"><input class="ButtonToggle_input__vkfUm" name="getGroupMetricsByDevices" type="radio" checked=""/><span>json</span></label><label class="ButtonToggle_label__ohGaG"><input class="ButtonToggle_input__vkfUm" name="getGroupMetricsByDevices" type="radio"/><span>csv</span></label></div></div><div class="CodeBlock_codeBlock__KlURa"><pre tabindex="0" style="color:#36383b;font-family:ProximaNova, monospace;line-height:1.2;font-size:1rem"><code class="language-json" style="white-space:pre"><span class="token token punctuation">{</span><span> </span><span> </span><span class="token token property">"unit"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"units"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"integer"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"facet"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"unit_reference"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"metrics"</span><span class="token token operator">:</span><span> </span><span class="token token punctuation">[</span><span> </span><span> </span><span class="token token punctuation">{</span><span> </span><span> </span><span class="token token property">"clicks"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"integer"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"device_type"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span> </span><span> </span><span class="token token punctuation">}</span><span> </span><span> </span><span class="token token punctuation">]</span><span> </span><span></span><span class="token token punctuation">}</span></code></pre></div></div></div></div></div><div class="MethodDetail_methodContainer__3EF7h" id="GetGroupMetricsByReferringNetworks"><div class="MethodDetail_method__fyEiw"><div><h3 class="MethodHeader_h3__seOfC">Get Click Metrics for a Group by Referring Networks</h3><h4 class="MethodHeader_description__3_p_p"><div class="MethodHeader_iconStyle__x5Ow4"><svg viewBox="0 0 14 6" xmlns="http://www.w3.org/2000/svg" class="IconRest_restIcon__3pju8 get"><title>Get</title><path d="M2.587 6c.307 0 .607-.044.9-.132.295-.088.533-.217.716-.387V2.876H2.271v.825h1.027v1.145a.772.772 0 0 1-.239.1 1.4 1.4 0 0 1-.383.049 1.338 1.338 0 0 1-1.083-.52c-.135-.17-.24-.379-.316-.626a2.879 2.879 0 0 1-.113-.84c0-.352.038-.655.113-.907.076-.253.182-.46.32-.623.137-.162.3-.281.488-.358a1.783 1.783 0 0 1 .97-.082l.13.032v.915h.889V.28a3.182 3.182 0 0 0-.59-.202A3.507 3.507 0 0 0 2.676 0c-.313 0-.628.055-.946.165a2.4 2.4 0 0 0-.861.523 2.707 2.707 0 0 0-.627.92C.081 1.98 0 2.433 0 2.966c0 .506.067.946.202 1.323.135.376.318.692.55.948a2.2 2.2 0 0 0 .82.572A2.7 2.7 0 0 0 2.587 6Zm6.24-.115V4.879H6.184V3.47h2.4V2.465h-2.4V1.121h2.602V.115h-3.71v5.77h3.75Zm4.43 0v-.907h-.914V1.022h.768v.997H14V.115H9.57V2.02h.89v-.997h.776v3.956h-.922v.907h2.942Z"></path></svg></div> /v4/groups/{group_guid}/referring_networks</h4><p class="MethodHeader_description__3_p_p">Returns metrics by referring networks for the specified group's links.</p></div><div><h4 class="ParameterList_h4__nH9G8 ParameterList_dividing__wRGRx">Path Parameters</h4><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">group_guid</span><span class="Parameter_type__djM_s">string</span><span class="Parameter_required__pcK_H">Required</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">A GUID for a Bitly group</div></div></div><div><h4 class="ParameterList_h4__nH9G8 ParameterList_dividing__wRGRx">Query Parameters</h4><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">unit</span><span class="Parameter_type__djM_s">string</span><span class="Parameter_required__pcK_H">Required</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">A unit of time</div><div class="Parameter_default__HHgG0 Parameter_spacer__JKXbH">Default: <span class="Parameter_label__DUY7G">"day"</span></div><div class="Parameter_enum__csO6P Parameter_spacer__JKXbH">Enum: <span class="Parameter_label__DUY7G">"minute"</span><span class="Parameter_label__DUY7G">"hour"</span><span class="Parameter_label__DUY7G">"day"</span><span class="Parameter_label__DUY7G">"week"</span><span class="Parameter_label__DUY7G">"month"</span></div></div><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">units</span><span class="Parameter_type__djM_s">integer</span><span class="Parameter_required__pcK_H">Required</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">An integer representing the time units to query data for. pass -1 to return all units of time</div><div class="Parameter_default__HHgG0 Parameter_spacer__JKXbH">Default: <span class="Parameter_label__DUY7G">-1</span></div></div><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">size</span><span class="Parameter_type__djM_s">integer</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">The quantity of items to be be returned</div><div class="Parameter_default__HHgG0 Parameter_spacer__JKXbH">Default: <span class="Parameter_label__DUY7G">50</span></div></div><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">unit_reference</span><span class="Parameter_type__djM_s">string</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">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)</div></div></div></div><div class="MethodDetail_examples__8nXeM"><div><label class="CodeSyntaxSelector_header__6P_Jc CodeSyntaxSelector_headerDark__hI3A0"><span>Request</span><div class="CodeSyntaxSelector_header__6P_Jc CodeSyntaxSelector_headerDark__hI3A0"><div class="Select_wrapper__58utF Select_dark__KPIws"><select class="Select_select__qXz_Z Select_dark__KPIws" aria-label="Select" autoComplete="off"><option value="cURL" selected="">cURL</option><option value="Node">Node</option><option value="Browser">Browser</option><option value="Go">Go</option><option value="Python">Python</option></select><svg viewBox="0 0 8 14" xmlns="http://www.w3.org/2000/svg"><path d="M6.463 7 .987 1.66a.61.61 0 0 1 0-.878.648.648 0 0 1 .9 0L7.813 6.56a.61.61 0 0 1 0 .878l-5.926 5.78a.648.648 0 0 1-.9 0 .61.61 0 0 1 0-.879L6.463 7Z"></path></svg></div></div></label><div class="CodeSyntaxSelector_body__hBJ7j CodeSyntaxSelector_bodyDark__cizVw"><div class="CodeBlock_codeBlock__KlURa"><pre tabindex="0" style="color:#ffffff;font-family:ProximaNova, monospace;line-height:1.2;font-size:1rem"><code class="language-bash" style="white-space:pre"><span class="token token" style="color:#ee6123">curl</span><span> </span><span class="token token punctuation">\</span><span> </span><span>-H </span><span class="token token" style="color:#acda95">'Authorization: Bearer {TOKEN}'</span><span> </span><span class="token token punctuation">\</span><span> </span><span>-X GET </span><span class="token token punctuation">\</span><span> </span><span>https://api-ssl.bitly.com/v4/groups/Ba1bc23dE4F/referring_networks?unit</span><span class="token token operator">=</span><span>month</span><span class="token token operator">&</span><span class="token token assign-left variable">units</span><span class="token token operator">=</span><span class="token token" style="color:#a1b8f3">1</span><span class="token token operator">&</span><span class="token token assign-left variable">size</span><span class="token token operator">=</span><span class="token token" style="color:#a1b8f3">10</span><span class="token token operator">&</span><span class="token token assign-left variable">unit_reference</span><span class="token token operator">=</span><span class="token token" style="color:#a1b8f3">2006</span><span>-01-02T15%3A04%3A05-0700</span></code></pre></div></div></div><div><label class="CodeSyntaxSelector_header__6P_Jc"><span>Response</span><div class="CodeSyntaxSelector_header__6P_Jc"><div class="Select_wrapper__58utF"><select class="Select_select__qXz_Z" aria-label="Select" autoComplete="off"><option value="200" selected="">200 SUCCESS</option><option value="403">403 FORBIDDEN</option><option value="404">404 NOT_FOUND</option><option value="500">500 INTERNAL_ERROR</option><option value="503">503 TEMPORARILY_UNAVAILABLE</option></select><svg viewBox="0 0 8 14" xmlns="http://www.w3.org/2000/svg"><path d="M6.463 7 .987 1.66a.61.61 0 0 1 0-.878.648.648 0 0 1 .9 0L7.813 6.56a.61.61 0 0 1 0 .878l-5.926 5.78a.648.648 0 0 1-.9 0 .61.61 0 0 1 0-.879L6.463 7Z"></path></svg></div></div></label><div class="CodeSyntaxSelector_body__hBJ7j"><div class="CodeBlock_codeBlock__KlURa"><pre tabindex="0" style="color:#36383b;font-family:ProximaNova, monospace;line-height:1.2;font-size:1rem"><code class="language-json" style="white-space:pre"><span class="token token punctuation">{</span><span> </span><span> </span><span class="token token property">"unit"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"units"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"integer"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"facet"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"unit_reference"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"metrics"</span><span class="token token operator">:</span><span> </span><span class="token token punctuation">[</span><span> </span><span> </span><span class="token token punctuation">{</span><span> </span><span> </span><span class="token token property">"clicks"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"integer"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"value"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span> </span><span> </span><span class="token token punctuation">}</span><span> </span><span> </span><span class="token token punctuation">]</span><span> </span><span></span><span class="token token punctuation">}</span></code></pre></div></div></div></div></div><div class="MethodDetail_methodContainer__3EF7h" id="GetGroupMetricsByReferrer"><div class="MethodDetail_method__fyEiw"><div><h3 class="MethodHeader_h3__seOfC">Get Click Metrics for a Group by Referrer</h3><h4 class="MethodHeader_description__3_p_p"><div class="MethodHeader_iconStyle__x5Ow4"><svg viewBox="0 0 14 6" xmlns="http://www.w3.org/2000/svg" class="IconRest_restIcon__3pju8 get"><title>Get</title><path d="M2.587 6c.307 0 .607-.044.9-.132.295-.088.533-.217.716-.387V2.876H2.271v.825h1.027v1.145a.772.772 0 0 1-.239.1 1.4 1.4 0 0 1-.383.049 1.338 1.338 0 0 1-1.083-.52c-.135-.17-.24-.379-.316-.626a2.879 2.879 0 0 1-.113-.84c0-.352.038-.655.113-.907.076-.253.182-.46.32-.623.137-.162.3-.281.488-.358a1.783 1.783 0 0 1 .97-.082l.13.032v.915h.889V.28a3.182 3.182 0 0 0-.59-.202A3.507 3.507 0 0 0 2.676 0c-.313 0-.628.055-.946.165a2.4 2.4 0 0 0-.861.523 2.707 2.707 0 0 0-.627.92C.081 1.98 0 2.433 0 2.966c0 .506.067.946.202 1.323.135.376.318.692.55.948a2.2 2.2 0 0 0 .82.572A2.7 2.7 0 0 0 2.587 6Zm6.24-.115V4.879H6.184V3.47h2.4V2.465h-2.4V1.121h2.602V.115h-3.71v5.77h3.75Zm4.43 0v-.907h-.914V1.022h.768v.997H14V.115H9.57V2.02h.89v-.997h.776v3.956h-.922v.907h2.942Z"></path></svg></div> /v4/groups/{group_guid}/referrers</h4><p class="MethodHeader_description__3_p_p">Returns metrics by referrer for the specified group's links.</p></div><div><h4 class="ParameterList_h4__nH9G8 ParameterList_dividing__wRGRx">Path Parameters</h4><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">group_guid</span><span class="Parameter_type__djM_s">string</span><span class="Parameter_required__pcK_H">Required</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">A GUID for a Bitly group</div></div></div><div><h4 class="ParameterList_h4__nH9G8 ParameterList_dividing__wRGRx">Query Parameters</h4><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">unit</span><span class="Parameter_type__djM_s">string</span><span class="Parameter_required__pcK_H">Required</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">A unit of time</div><div class="Parameter_default__HHgG0 Parameter_spacer__JKXbH">Default: <span class="Parameter_label__DUY7G">"day"</span></div><div class="Parameter_enum__csO6P Parameter_spacer__JKXbH">Enum: <span class="Parameter_label__DUY7G">"minute"</span><span class="Parameter_label__DUY7G">"hour"</span><span class="Parameter_label__DUY7G">"day"</span><span class="Parameter_label__DUY7G">"week"</span><span class="Parameter_label__DUY7G">"month"</span></div></div><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">units</span><span class="Parameter_type__djM_s">integer</span><span class="Parameter_required__pcK_H">Required</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">An integer representing the time units to query data for. pass -1 to return all units of time</div><div class="Parameter_default__HHgG0 Parameter_spacer__JKXbH">Default: <span class="Parameter_label__DUY7G">-1</span></div></div><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">size</span><span class="Parameter_type__djM_s">integer</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">The quantity of items to be be returned</div><div class="Parameter_default__HHgG0 Parameter_spacer__JKXbH">Default: <span class="Parameter_label__DUY7G">50</span></div></div><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">unit_reference</span><span class="Parameter_type__djM_s">string</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">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)</div></div></div></div><div class="MethodDetail_examples__8nXeM"><div><label class="CodeSyntaxSelector_header__6P_Jc CodeSyntaxSelector_headerDark__hI3A0"><span>Request</span><div class="CodeSyntaxSelector_header__6P_Jc CodeSyntaxSelector_headerDark__hI3A0"><div class="Select_wrapper__58utF Select_dark__KPIws"><select class="Select_select__qXz_Z Select_dark__KPIws" aria-label="Select" autoComplete="off"><option value="cURL" selected="">cURL</option><option value="Node">Node</option><option value="Browser">Browser</option><option value="Go">Go</option><option value="Python">Python</option></select><svg viewBox="0 0 8 14" xmlns="http://www.w3.org/2000/svg"><path d="M6.463 7 .987 1.66a.61.61 0 0 1 0-.878.648.648 0 0 1 .9 0L7.813 6.56a.61.61 0 0 1 0 .878l-5.926 5.78a.648.648 0 0 1-.9 0 .61.61 0 0 1 0-.879L6.463 7Z"></path></svg></div></div></label><div class="CodeSyntaxSelector_body__hBJ7j CodeSyntaxSelector_bodyDark__cizVw"><div class="CodeBlock_codeBlock__KlURa"><pre tabindex="0" style="color:#ffffff;font-family:ProximaNova, monospace;line-height:1.2;font-size:1rem"><code class="language-bash" style="white-space:pre"><span class="token token" style="color:#ee6123">curl</span><span> </span><span class="token token punctuation">\</span><span> </span><span>-H </span><span class="token token" style="color:#acda95">'Authorization: Bearer {TOKEN}'</span><span> </span><span class="token token punctuation">\</span><span> </span><span>-X GET </span><span class="token token punctuation">\</span><span> </span><span>https://api-ssl.bitly.com/v4/groups/Ba1bc23dE4F/referrers?unit</span><span class="token token operator">=</span><span>month</span><span class="token token operator">&</span><span class="token token assign-left variable">units</span><span class="token token operator">=</span><span class="token token" style="color:#a1b8f3">1</span><span class="token token operator">&</span><span class="token token assign-left variable">size</span><span class="token token operator">=</span><span class="token token" style="color:#a1b8f3">10</span><span class="token token operator">&</span><span class="token token assign-left variable">unit_reference</span><span class="token token operator">=</span><span class="token token" style="color:#a1b8f3">2006</span><span>-01-02T15%3A04%3A05-0700</span></code></pre></div></div></div><div><label class="CodeSyntaxSelector_header__6P_Jc"><span>Response</span><div class="CodeSyntaxSelector_header__6P_Jc"><div class="Select_wrapper__58utF"><select class="Select_select__qXz_Z" aria-label="Select" autoComplete="off"><option value="200" selected="">200 SUCCESS</option><option value="403">403 FORBIDDEN</option><option value="404">404 NOT_FOUND</option><option value="429">429 MONTHLY_LIMIT_EXCEEDED</option><option value="500">500 INTERNAL_ERROR</option><option value="503">503 TEMPORARILY_UNAVAILABLE</option></select><svg viewBox="0 0 8 14" xmlns="http://www.w3.org/2000/svg"><path d="M6.463 7 .987 1.66a.61.61 0 0 1 0-.878.648.648 0 0 1 .9 0L7.813 6.56a.61.61 0 0 1 0 .878l-5.926 5.78a.648.648 0 0 1-.9 0 .61.61 0 0 1 0-.879L6.463 7Z"></path></svg></div></div></label><div class="CodeSyntaxSelector_body__hBJ7j"><div class="Response_formatSelect__Wt_qa"><div class="ButtonToggle_buttonToggle__6YJhd"><label class="ButtonToggle_label__ohGaG"><input class="ButtonToggle_input__vkfUm" name="GetGroupMetricsByReferrer" type="radio" checked=""/><span>json</span></label><label class="ButtonToggle_label__ohGaG"><input class="ButtonToggle_input__vkfUm" name="GetGroupMetricsByReferrer" type="radio"/><span>csv</span></label></div></div><div class="CodeBlock_codeBlock__KlURa"><pre tabindex="0" style="color:#36383b;font-family:ProximaNova, monospace;line-height:1.2;font-size:1rem"><code class="language-json" style="white-space:pre"><span class="token token punctuation">{</span><span> </span><span> </span><span class="token token property">"unit"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"units"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"integer"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"facet"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"unit_reference"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"metrics"</span><span class="token token operator">:</span><span> </span><span class="token token punctuation">[</span><span> </span><span> </span><span class="token token punctuation">{</span><span> </span><span> </span><span class="token token property">"clicks"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"integer"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"value"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span> </span><span> </span><span class="token token punctuation">}</span><span> </span><span> </span><span class="token token punctuation">]</span><span> </span><span></span><span class="token token punctuation">}</span></code></pre></div></div></div></div></div><div class="MethodDetail_methodContainer__3EF7h" id="getGroupClicks"><div class="MethodDetail_method__fyEiw"><div><h3 class="MethodHeader_h3__seOfC">Get clicks by group</h3><h4 class="MethodHeader_description__3_p_p"><div class="MethodHeader_iconStyle__x5Ow4"><svg viewBox="0 0 14 6" xmlns="http://www.w3.org/2000/svg" class="IconRest_restIcon__3pju8 get"><title>Get</title><path d="M2.587 6c.307 0 .607-.044.9-.132.295-.088.533-.217.716-.387V2.876H2.271v.825h1.027v1.145a.772.772 0 0 1-.239.1 1.4 1.4 0 0 1-.383.049 1.338 1.338 0 0 1-1.083-.52c-.135-.17-.24-.379-.316-.626a2.879 2.879 0 0 1-.113-.84c0-.352.038-.655.113-.907.076-.253.182-.46.32-.623.137-.162.3-.281.488-.358a1.783 1.783 0 0 1 .97-.082l.13.032v.915h.889V.28a3.182 3.182 0 0 0-.59-.202A3.507 3.507 0 0 0 2.676 0c-.313 0-.628.055-.946.165a2.4 2.4 0 0 0-.861.523 2.707 2.707 0 0 0-.627.92C.081 1.98 0 2.433 0 2.966c0 .506.067.946.202 1.323.135.376.318.692.55.948a2.2 2.2 0 0 0 .82.572A2.7 2.7 0 0 0 2.587 6Zm6.24-.115V4.879H6.184V3.47h2.4V2.465h-2.4V1.121h2.602V.115h-3.71v5.77h3.75Zm4.43 0v-.907h-.914V1.022h.768v.997H14V.115H9.57V2.02h.89v-.997h.776v3.956h-.922v.907h2.942Z"></path></svg></div> /v4/groups/{group_guid}/clicks</h4><p class="MethodHeader_description__3_p_p">get number of clicks on bitlinks in a group</p></div><div><h4 class="ParameterList_h4__nH9G8 ParameterList_dividing__wRGRx">Path Parameters</h4><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">group_guid</span><span class="Parameter_type__djM_s">string</span><span class="Parameter_required__pcK_H">Required</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">A GUID for a Bitly group</div></div></div><div><h4 class="ParameterList_h4__nH9G8 ParameterList_dividing__wRGRx">Query Parameters</h4><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">unit</span><span class="Parameter_type__djM_s">string</span><span class="Parameter_required__pcK_H">Required</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">A unit of time</div><div class="Parameter_default__HHgG0 Parameter_spacer__JKXbH">Default: <span class="Parameter_label__DUY7G">"day"</span></div><div class="Parameter_enum__csO6P Parameter_spacer__JKXbH">Enum: <span class="Parameter_label__DUY7G">"minute"</span><span class="Parameter_label__DUY7G">"hour"</span><span class="Parameter_label__DUY7G">"day"</span><span class="Parameter_label__DUY7G">"week"</span><span class="Parameter_label__DUY7G">"month"</span></div></div><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">units</span><span class="Parameter_type__djM_s">integer</span><span class="Parameter_required__pcK_H">Required</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">An integer representing the time units to query data for. pass -1 to return all units of time</div><div class="Parameter_default__HHgG0 Parameter_spacer__JKXbH">Default: <span class="Parameter_label__DUY7G">-1</span></div></div><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">unit_reference</span><span class="Parameter_type__djM_s">string</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">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)</div></div></div></div><div class="MethodDetail_examples__8nXeM"><div><label class="CodeSyntaxSelector_header__6P_Jc CodeSyntaxSelector_headerDark__hI3A0"><span>Request</span><div class="CodeSyntaxSelector_header__6P_Jc CodeSyntaxSelector_headerDark__hI3A0"><div class="Select_wrapper__58utF Select_dark__KPIws"><select class="Select_select__qXz_Z Select_dark__KPIws" aria-label="Select" autoComplete="off"><option value="cURL" selected="">cURL</option><option value="Node">Node</option><option value="Browser">Browser</option><option value="Go">Go</option><option value="Python">Python</option></select><svg viewBox="0 0 8 14" xmlns="http://www.w3.org/2000/svg"><path d="M6.463 7 .987 1.66a.61.61 0 0 1 0-.878.648.648 0 0 1 .9 0L7.813 6.56a.61.61 0 0 1 0 .878l-5.926 5.78a.648.648 0 0 1-.9 0 .61.61 0 0 1 0-.879L6.463 7Z"></path></svg></div></div></label><div class="CodeSyntaxSelector_body__hBJ7j CodeSyntaxSelector_bodyDark__cizVw"><div class="CodeBlock_codeBlock__KlURa"><pre tabindex="0" style="color:#ffffff;font-family:ProximaNova, monospace;line-height:1.2;font-size:1rem"><code class="language-bash" style="white-space:pre"><span class="token token" style="color:#ee6123">curl</span><span> </span><span class="token token punctuation">\</span><span> </span><span>-H </span><span class="token token" style="color:#acda95">'Authorization: Bearer {TOKEN}'</span><span> </span><span class="token token punctuation">\</span><span> </span><span>-X GET </span><span class="token token punctuation">\</span><span> </span><span>https://api-ssl.bitly.com/v4/groups/Ba1bc23dE4F/clicks?unit</span><span class="token token operator">=</span><span>month</span><span class="token token operator">&</span><span class="token token assign-left variable">units</span><span class="token token operator">=</span><span class="token token" style="color:#a1b8f3">1</span><span class="token token operator">&</span><span class="token token assign-left variable">unit_reference</span><span class="token token operator">=</span><span class="token token" style="color:#a1b8f3">2006</span><span>-01-02T15%3A04%3A05-0700</span></code></pre></div></div></div><div><label class="CodeSyntaxSelector_header__6P_Jc"><span>Response</span><div class="CodeSyntaxSelector_header__6P_Jc"><div class="Select_wrapper__58utF"><select class="Select_select__qXz_Z" aria-label="Select" autoComplete="off"><option value="200" selected="">200 SUCCESS</option><option value="400">400 BAD_REQUEST</option><option value="402">402 UPGRADE_REQUIRED</option><option value="403">403 FORBIDDEN</option><option value="429">429 MONTHLY_LIMIT_EXCEEDED</option><option value="500">500 INTERNAL_ERROR</option><option value="503">503 TEMPORARILY_UNAVAILABLE</option></select><svg viewBox="0 0 8 14" xmlns="http://www.w3.org/2000/svg"><path d="M6.463 7 .987 1.66a.61.61 0 0 1 0-.878.648.648 0 0 1 .9 0L7.813 6.56a.61.61 0 0 1 0 .878l-5.926 5.78a.648.648 0 0 1-.9 0 .61.61 0 0 1 0-.879L6.463 7Z"></path></svg></div></div></label><div class="CodeSyntaxSelector_body__hBJ7j"><div class="CodeBlock_codeBlock__KlURa"><pre tabindex="0" style="color:#36383b;font-family:ProximaNova, monospace;line-height:1.2;font-size:1rem"><code class="language-json" style="white-space:pre"><span class="token token punctuation">{</span><span> </span><span> </span><span class="token token property">"unit"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"units"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"integer"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"unit_reference"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"data"</span><span class="token token operator">:</span><span> </span><span class="token token punctuation">[</span><span> </span><span> </span><span class="token token punctuation">{</span><span> </span><span> </span><span class="token token property">"ts"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"count"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"integer"</span><span> </span><span> </span><span class="token token punctuation">}</span><span> </span><span> </span><span class="token token punctuation">]</span><span> </span><span></span><span class="token token punctuation">}</span></code></pre></div></div></div></div></div><div class="MethodDetail_methodContainer__3EF7h" id="getGroupFeatureUsage"><div class="MethodDetail_method__fyEiw"><div><h3 class="MethodHeader_h3__seOfC">Get limit usage for a group</h3><h4 class="MethodHeader_description__3_p_p"><div class="MethodHeader_iconStyle__x5Ow4"><svg viewBox="0 0 14 6" xmlns="http://www.w3.org/2000/svg" class="IconRest_restIcon__3pju8 get"><title>Get</title><path d="M2.587 6c.307 0 .607-.044.9-.132.295-.088.533-.217.716-.387V2.876H2.271v.825h1.027v1.145a.772.772 0 0 1-.239.1 1.4 1.4 0 0 1-.383.049 1.338 1.338 0 0 1-1.083-.52c-.135-.17-.24-.379-.316-.626a2.879 2.879 0 0 1-.113-.84c0-.352.038-.655.113-.907.076-.253.182-.46.32-.623.137-.162.3-.281.488-.358a1.783 1.783 0 0 1 .97-.082l.13.032v.915h.889V.28a3.182 3.182 0 0 0-.59-.202A3.507 3.507 0 0 0 2.676 0c-.313 0-.628.055-.946.165a2.4 2.4 0 0 0-.861.523 2.707 2.707 0 0 0-.627.92C.081 1.98 0 2.433 0 2.966c0 .506.067.946.202 1.323.135.376.318.692.55.948a2.2 2.2 0 0 0 .82.572A2.7 2.7 0 0 0 2.587 6Zm6.24-.115V4.879H6.184V3.47h2.4V2.465h-2.4V1.121h2.602V.115h-3.71v5.77h3.75Zm4.43 0v-.907h-.914V1.022h.768v.997H14V.115H9.57V2.02h.89v-.997h.776v3.956h-.922v.907h2.942Z"></path></svg></div> /v4/groups/{group_guid}/feature_usage</h4><p class="MethodHeader_description__3_p_p">Get a group's current feature limit usage, optionally provide limit name(s) for usage on specific limit(s)</p></div><div><h4 class="ParameterList_h4__nH9G8 ParameterList_dividing__wRGRx">Path Parameters</h4><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">group_guid</span><span class="Parameter_type__djM_s">string</span><span class="Parameter_required__pcK_H">Required</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">A GUID for a Bitly group</div></div></div><div><h4 class="ParameterList_h4__nH9G8 ParameterList_dividing__wRGRx">Query Parameters</h4><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">name</span><span class="Parameter_type__djM_s">array</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">The limit name you would like usage for</div></div></div></div><div class="MethodDetail_examples__8nXeM"><div><label class="CodeSyntaxSelector_header__6P_Jc CodeSyntaxSelector_headerDark__hI3A0"><span>Request</span><div class="CodeSyntaxSelector_header__6P_Jc CodeSyntaxSelector_headerDark__hI3A0"><div class="Select_wrapper__58utF Select_dark__KPIws"><select class="Select_select__qXz_Z Select_dark__KPIws" aria-label="Select" autoComplete="off"><option value="cURL" selected="">cURL</option><option value="Node">Node</option><option value="Browser">Browser</option><option value="Go">Go</option><option value="Python">Python</option></select><svg viewBox="0 0 8 14" xmlns="http://www.w3.org/2000/svg"><path d="M6.463 7 .987 1.66a.61.61 0 0 1 0-.878.648.648 0 0 1 .9 0L7.813 6.56a.61.61 0 0 1 0 .878l-5.926 5.78a.648.648 0 0 1-.9 0 .61.61 0 0 1 0-.879L6.463 7Z"></path></svg></div></div></label><div class="CodeSyntaxSelector_body__hBJ7j CodeSyntaxSelector_bodyDark__cizVw"><div class="CodeBlock_codeBlock__KlURa"><pre tabindex="0" style="color:#ffffff;font-family:ProximaNova, monospace;line-height:1.2;font-size:1rem"><code class="language-bash" style="white-space:pre"><span class="token token" style="color:#ee6123">curl</span><span> </span><span class="token token punctuation">\</span><span> </span><span>-H </span><span class="token token" style="color:#acda95">'Authorization: Bearer {TOKEN}'</span><span> </span><span class="token token punctuation">\</span><span> </span><span>-X GET </span><span class="token token punctuation">\</span><span> </span><span>https://api-ssl.bitly.com/v4/groups/Ba1bc23dE4F/feature_usage?name</span><span class="token token operator">=</span><span>qr_codes</span></code></pre></div></div></div><div><label class="CodeSyntaxSelector_header__6P_Jc"><span>Response</span><div class="CodeSyntaxSelector_header__6P_Jc"><div class="Select_wrapper__58utF"><select class="Select_select__qXz_Z" aria-label="Select" autoComplete="off"><option value="200" selected="">200 SUCCESS</option><option value="400">400 BAD_REQUEST</option><option value="403">403 FORBIDDEN</option><option value="429">429 MONTHLY_LIMIT_EXCEEDED</option><option value="500">500 INTERNAL_ERROR</option></select><svg viewBox="0 0 8 14" xmlns="http://www.w3.org/2000/svg"><path d="M6.463 7 .987 1.66a.61.61 0 0 1 0-.878.648.648 0 0 1 .9 0L7.813 6.56a.61.61 0 0 1 0 .878l-5.926 5.78a.648.648 0 0 1-.9 0 .61.61 0 0 1 0-.879L6.463 7Z"></path></svg></div></div></label><div class="CodeSyntaxSelector_body__hBJ7j"><div class="CodeBlock_codeBlock__KlURa"><pre tabindex="0" style="color:#36383b;font-family:ProximaNova, monospace;line-height:1.2;font-size:1rem"><code class="language-json" style="white-space:pre"><span class="token token punctuation">{</span><span> </span><span> </span><span class="token token property">"group_guid"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"limit_usage"</span><span class="token token operator">:</span><span> </span><span class="token token punctuation">[</span><span> </span><span> </span><span class="token token punctuation">{</span><span> </span><span> </span><span class="token token property">"name"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"description"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"count"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"integer"</span><span> </span><span> </span><span class="token token punctuation">}</span><span> </span><span> </span><span class="token token punctuation">]</span><span> </span><span></span><span class="token token punctuation">}</span></code></pre></div></div></div></div></div><div class="MethodDetail_methodContainer__3EF7h" id="getGroupHistoricalUsage"><div class="MethodDetail_method__fyEiw"><div><h3 class="MethodHeader_h3__seOfC">Get historical usage for a group</h3><h4 class="MethodHeader_description__3_p_p"><div class="MethodHeader_iconStyle__x5Ow4"><svg viewBox="0 0 14 6" xmlns="http://www.w3.org/2000/svg" class="IconRest_restIcon__3pju8 get"><title>Get</title><path d="M2.587 6c.307 0 .607-.044.9-.132.295-.088.533-.217.716-.387V2.876H2.271v.825h1.027v1.145a.772.772 0 0 1-.239.1 1.4 1.4 0 0 1-.383.049 1.338 1.338 0 0 1-1.083-.52c-.135-.17-.24-.379-.316-.626a2.879 2.879 0 0 1-.113-.84c0-.352.038-.655.113-.907.076-.253.182-.46.32-.623.137-.162.3-.281.488-.358a1.783 1.783 0 0 1 .97-.082l.13.032v.915h.889V.28a3.182 3.182 0 0 0-.59-.202A3.507 3.507 0 0 0 2.676 0c-.313 0-.628.055-.946.165a2.4 2.4 0 0 0-.861.523 2.707 2.707 0 0 0-.627.92C.081 1.98 0 2.433 0 2.966c0 .506.067.946.202 1.323.135.376.318.692.55.948a2.2 2.2 0 0 0 .82.572A2.7 2.7 0 0 0 2.587 6Zm6.24-.115V4.879H6.184V3.47h2.4V2.465h-2.4V1.121h2.602V.115h-3.71v5.77h3.75Zm4.43 0v-.907h-.914V1.022h.768v.997H14V.115H9.57V2.02h.89v-.997h.776v3.956h-.922v.907h2.942Z"></path></svg></div> /v4/groups/{group_guid}/historical_usage</h4><p class="MethodHeader_description__3_p_p">Get a group's historical usage for specific limit(s) and date range. Refer to GET /v4/groups/{group_guid}/feature_usage endpoint response for available limit names.</p></div><div><h4 class="ParameterList_h4__nH9G8 ParameterList_dividing__wRGRx">Path Parameters</h4><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">group_guid</span><span class="Parameter_type__djM_s">string</span><span class="Parameter_required__pcK_H">Required</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">A GUID for a Bitly group</div></div></div><div><h4 class="ParameterList_h4__nH9G8 ParameterList_dividing__wRGRx">Query Parameters</h4><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">name</span><span class="Parameter_type__djM_s">array</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">The limit name you would like usage for</div></div><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">start_date</span><span class="Parameter_type__djM_s">string</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">The start date for the date range</div></div><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">end_date</span><span class="Parameter_type__djM_s">string</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">The end date for the date range</div></div><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">unit</span><span class="Parameter_type__djM_s">string</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">A unit of time (day, week, or month)</div><div class="Parameter_default__HHgG0 Parameter_spacer__JKXbH">Default: <span class="Parameter_label__DUY7G">"month"</span></div><div class="Parameter_enum__csO6P Parameter_spacer__JKXbH">Enum: <span class="Parameter_label__DUY7G">"day"</span><span class="Parameter_label__DUY7G">"week"</span><span class="Parameter_label__DUY7G">"month"</span></div></div></div></div><div class="MethodDetail_examples__8nXeM"><div><label class="CodeSyntaxSelector_header__6P_Jc CodeSyntaxSelector_headerDark__hI3A0"><span>Request</span><div class="CodeSyntaxSelector_header__6P_Jc CodeSyntaxSelector_headerDark__hI3A0"><div class="Select_wrapper__58utF Select_dark__KPIws"><select class="Select_select__qXz_Z Select_dark__KPIws" aria-label="Select" autoComplete="off"><option value="cURL" selected="">cURL</option><option value="Node">Node</option><option value="Browser">Browser</option><option value="Go">Go</option><option value="Python">Python</option></select><svg viewBox="0 0 8 14" xmlns="http://www.w3.org/2000/svg"><path d="M6.463 7 .987 1.66a.61.61 0 0 1 0-.878.648.648 0 0 1 .9 0L7.813 6.56a.61.61 0 0 1 0 .878l-5.926 5.78a.648.648 0 0 1-.9 0 .61.61 0 0 1 0-.879L6.463 7Z"></path></svg></div></div></label><div class="CodeSyntaxSelector_body__hBJ7j CodeSyntaxSelector_bodyDark__cizVw"><div class="CodeBlock_codeBlock__KlURa"><pre tabindex="0" style="color:#ffffff;font-family:ProximaNova, monospace;line-height:1.2;font-size:1rem"><code class="language-bash" style="white-space:pre"><span class="token token" style="color:#ee6123">curl</span><span> </span><span class="token token punctuation">\</span><span> </span><span>-H </span><span class="token token" style="color:#acda95">'Authorization: Bearer {TOKEN}'</span><span> </span><span class="token token punctuation">\</span><span> </span><span>-X GET </span><span class="token token punctuation">\</span><span> </span><span>https://api-ssl.bitly.com/v4/groups/Ba1bc23dE4F/historical_usage?name</span><span class="token token operator">=</span><span>qr_codes</span><span class="token token operator">&</span><span class="token token assign-left variable">start_date</span><span class="token token operator">=</span><span class="token token" style="color:#a1b8f3">2022</span><span>-02-02</span><span class="token token operator">&</span><span class="token token assign-left variable">end_date</span><span class="token token operator">=</span><span class="token token" style="color:#a1b8f3">2023</span><span>-10-04</span><span class="token token operator">&</span><span class="token token assign-left variable">unit</span><span class="token token operator">=</span><span>month</span></code></pre></div></div></div><div><label class="CodeSyntaxSelector_header__6P_Jc"><span>Response</span><div class="CodeSyntaxSelector_header__6P_Jc"><div class="Select_wrapper__58utF"><select class="Select_select__qXz_Z" aria-label="Select" autoComplete="off"><option value="200" selected="">200 SUCCESS</option><option value="400">400 BAD_REQUEST</option><option value="403">403 FORBIDDEN</option><option value="429">429 MONTHLY_LIMIT_EXCEEDED</option><option value="500">500 INTERNAL_ERROR</option></select><svg viewBox="0 0 8 14" xmlns="http://www.w3.org/2000/svg"><path d="M6.463 7 .987 1.66a.61.61 0 0 1 0-.878.648.648 0 0 1 .9 0L7.813 6.56a.61.61 0 0 1 0 .878l-5.926 5.78a.648.648 0 0 1-.9 0 .61.61 0 0 1 0-.879L6.463 7Z"></path></svg></div></div></label><div class="CodeSyntaxSelector_body__hBJ7j"><div class="CodeBlock_codeBlock__KlURa"><pre tabindex="0" style="color:#36383b;font-family:ProximaNova, monospace;line-height:1.2;font-size:1rem"><code class="language-json" style="white-space:pre"><span class="token token punctuation">{</span><span> </span><span> </span><span class="token token property">"group_guid"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"unit"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"start_date"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"end_date"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"historical_limit_usage"</span><span class="token token operator">:</span><span> </span><span class="token token punctuation">[</span><span> </span><span> </span><span class="token token punctuation">{</span><span> </span><span> </span><span class="token token property">"name"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"usage"</span><span class="token token operator">:</span><span> </span><span class="token token punctuation">[</span><span> </span><span> </span><span class="token token punctuation">{</span><span> </span><span> </span><span class="token token property">"count"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"integer"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"unit_start"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span> </span><span> </span><span class="token token punctuation">}</span><span> </span><span> </span><span class="token token punctuation">]</span><span> </span><span> </span><span class="token token punctuation">}</span><span> </span><span> </span><span class="token token punctuation">]</span><span> </span><span></span><span class="token token punctuation">}</span></code></pre></div></div></div></div></div><div class="ApiReference_tagInfo__YVbgw"><h2 class="ApiReference_tagName__IJx2p">Organizations</h2><p class="ApiReference_tagDescription__8c1GM">Organizations are equivalent to a Bitly account. Every plan limit, group, and user is tied to an organization. </p></div><div class="MethodDetail_methodContainer__3EF7h" id="getOrganizations"><div class="MethodDetail_method__fyEiw"><div><h3 class="MethodHeader_h3__seOfC">Retrieve Organizations</h3><h4 class="MethodHeader_description__3_p_p"><div class="MethodHeader_iconStyle__x5Ow4"><svg viewBox="0 0 14 6" xmlns="http://www.w3.org/2000/svg" class="IconRest_restIcon__3pju8 get"><title>Get</title><path d="M2.587 6c.307 0 .607-.044.9-.132.295-.088.533-.217.716-.387V2.876H2.271v.825h1.027v1.145a.772.772 0 0 1-.239.1 1.4 1.4 0 0 1-.383.049 1.338 1.338 0 0 1-1.083-.52c-.135-.17-.24-.379-.316-.626a2.879 2.879 0 0 1-.113-.84c0-.352.038-.655.113-.907.076-.253.182-.46.32-.623.137-.162.3-.281.488-.358a1.783 1.783 0 0 1 .97-.082l.13.032v.915h.889V.28a3.182 3.182 0 0 0-.59-.202A3.507 3.507 0 0 0 2.676 0c-.313 0-.628.055-.946.165a2.4 2.4 0 0 0-.861.523 2.707 2.707 0 0 0-.627.92C.081 1.98 0 2.433 0 2.966c0 .506.067.946.202 1.323.135.376.318.692.55.948a2.2 2.2 0 0 0 .82.572A2.7 2.7 0 0 0 2.587 6Zm6.24-.115V4.879H6.184V3.47h2.4V2.465h-2.4V1.121h2.602V.115h-3.71v5.77h3.75Zm4.43 0v-.907h-.914V1.022h.768v.997H14V.115H9.57V2.02h.89v-.997h.776v3.956h-.922v.907h2.942Z"></path></svg></div> /v4/organizations</h4><p class="MethodHeader_description__3_p_p">Retrieve a list of organizations.</p></div></div><div class="MethodDetail_examples__8nXeM"><div><label class="CodeSyntaxSelector_header__6P_Jc CodeSyntaxSelector_headerDark__hI3A0"><span>Request</span><div class="CodeSyntaxSelector_header__6P_Jc CodeSyntaxSelector_headerDark__hI3A0"><div class="Select_wrapper__58utF Select_dark__KPIws"><select class="Select_select__qXz_Z Select_dark__KPIws" aria-label="Select" autoComplete="off"><option value="cURL" selected="">cURL</option><option value="Node">Node</option><option value="Browser">Browser</option><option value="Go">Go</option><option value="Python">Python</option></select><svg viewBox="0 0 8 14" xmlns="http://www.w3.org/2000/svg"><path d="M6.463 7 .987 1.66a.61.61 0 0 1 0-.878.648.648 0 0 1 .9 0L7.813 6.56a.61.61 0 0 1 0 .878l-5.926 5.78a.648.648 0 0 1-.9 0 .61.61 0 0 1 0-.879L6.463 7Z"></path></svg></div></div></label><div class="CodeSyntaxSelector_body__hBJ7j CodeSyntaxSelector_bodyDark__cizVw"><div class="CodeBlock_codeBlock__KlURa"><pre tabindex="0" style="color:#ffffff;font-family:ProximaNova, monospace;line-height:1.2;font-size:1rem"><code class="language-bash" style="white-space:pre"><span class="token token" style="color:#ee6123">curl</span><span> </span><span class="token token punctuation">\</span><span> </span><span>-H </span><span class="token token" style="color:#acda95">'Authorization: Bearer {TOKEN}'</span><span> </span><span class="token token punctuation">\</span><span> </span><span>-X GET </span><span class="token token punctuation">\</span><span> </span>https://api-ssl.bitly.com/v4/organizations</code></pre></div></div></div><div><label class="CodeSyntaxSelector_header__6P_Jc"><span>Response</span><div class="CodeSyntaxSelector_header__6P_Jc"><div class="Select_wrapper__58utF"><select class="Select_select__qXz_Z" aria-label="Select" autoComplete="off"><option value="200" selected="">200 SUCCESS</option><option value="403">403 FORBIDDEN</option><option value="404">404 NOT_FOUND</option><option value="500">500 INTERNAL_ERROR</option><option value="503">503 TEMPORARILY_UNAVAILABLE</option></select><svg viewBox="0 0 8 14" xmlns="http://www.w3.org/2000/svg"><path d="M6.463 7 .987 1.66a.61.61 0 0 1 0-.878.648.648 0 0 1 .9 0L7.813 6.56a.61.61 0 0 1 0 .878l-5.926 5.78a.648.648 0 0 1-.9 0 .61.61 0 0 1 0-.879L6.463 7Z"></path></svg></div></div></label><div class="CodeSyntaxSelector_body__hBJ7j"><div class="CodeBlock_codeBlock__KlURa"><pre tabindex="0" style="color:#36383b;font-family:ProximaNova, monospace;line-height:1.2;font-size:1rem"><code class="language-json" style="white-space:pre"><span class="token token punctuation">{</span><span> </span><span> </span><span class="token token property">"organizations"</span><span class="token token operator">:</span><span> </span><span class="token token punctuation">[</span><span> </span><span> </span><span class="token token punctuation">{</span><span> </span><span> </span><span class="token token property">"references"</span><span class="token token operator">:</span><span> </span><span class="token token punctuation">{</span><span> </span><span class="token token" style="color:#51763e">"any"</span><span> </span><span class="token token punctuation">}</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"name"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"is_active"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"boolean"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"guid"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"tier"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"tier_family"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"tier_display_name"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"role"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"created"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"modified"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"bsds"</span><span class="token token operator">:</span><span> </span><span class="token token punctuation">[</span><span> </span><span> </span><span class="token token" style="color:#51763e">"string"</span><span> </span><span> </span><span class="token token punctuation">]</span><span> </span><span> </span><span class="token token punctuation">}</span><span> </span><span> </span><span class="token token punctuation">]</span><span> </span><span></span><span class="token token punctuation">}</span></code></pre></div></div></div></div></div><div class="MethodDetail_methodContainer__3EF7h" id="getOrganization"><div class="MethodDetail_method__fyEiw"><div><h3 class="MethodHeader_h3__seOfC">Retrieve an Organization</h3><h4 class="MethodHeader_description__3_p_p"><div class="MethodHeader_iconStyle__x5Ow4"><svg viewBox="0 0 14 6" xmlns="http://www.w3.org/2000/svg" class="IconRest_restIcon__3pju8 get"><title>Get</title><path d="M2.587 6c.307 0 .607-.044.9-.132.295-.088.533-.217.716-.387V2.876H2.271v.825h1.027v1.145a.772.772 0 0 1-.239.1 1.4 1.4 0 0 1-.383.049 1.338 1.338 0 0 1-1.083-.52c-.135-.17-.24-.379-.316-.626a2.879 2.879 0 0 1-.113-.84c0-.352.038-.655.113-.907.076-.253.182-.46.32-.623.137-.162.3-.281.488-.358a1.783 1.783 0 0 1 .97-.082l.13.032v.915h.889V.28a3.182 3.182 0 0 0-.59-.202A3.507 3.507 0 0 0 2.676 0c-.313 0-.628.055-.946.165a2.4 2.4 0 0 0-.861.523 2.707 2.707 0 0 0-.627.92C.081 1.98 0 2.433 0 2.966c0 .506.067.946.202 1.323.135.376.318.692.55.948a2.2 2.2 0 0 0 .82.572A2.7 2.7 0 0 0 2.587 6Zm6.24-.115V4.879H6.184V3.47h2.4V2.465h-2.4V1.121h2.602V.115h-3.71v5.77h3.75Zm4.43 0v-.907h-.914V1.022h.768v.997H14V.115H9.57V2.02h.89v-.997h.776v3.956h-.922v.907h2.942Z"></path></svg></div> /v4/organizations/{organization_guid}</h4><p class="MethodHeader_description__3_p_p">Retrive details for the specified organization.</p></div><div><h4 class="ParameterList_h4__nH9G8 ParameterList_dividing__wRGRx">Path Parameters</h4><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">organization_guid</span><span class="Parameter_type__djM_s">string</span><span class="Parameter_required__pcK_H">Required</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">A GUID for a Bitly organization</div></div></div></div><div class="MethodDetail_examples__8nXeM"><div><label class="CodeSyntaxSelector_header__6P_Jc CodeSyntaxSelector_headerDark__hI3A0"><span>Request</span><div class="CodeSyntaxSelector_header__6P_Jc CodeSyntaxSelector_headerDark__hI3A0"><div class="Select_wrapper__58utF Select_dark__KPIws"><select class="Select_select__qXz_Z Select_dark__KPIws" aria-label="Select" autoComplete="off"><option value="cURL" selected="">cURL</option><option value="Node">Node</option><option value="Browser">Browser</option><option value="Go">Go</option><option value="Python">Python</option></select><svg viewBox="0 0 8 14" xmlns="http://www.w3.org/2000/svg"><path d="M6.463 7 .987 1.66a.61.61 0 0 1 0-.878.648.648 0 0 1 .9 0L7.813 6.56a.61.61 0 0 1 0 .878l-5.926 5.78a.648.648 0 0 1-.9 0 .61.61 0 0 1 0-.879L6.463 7Z"></path></svg></div></div></label><div class="CodeSyntaxSelector_body__hBJ7j CodeSyntaxSelector_bodyDark__cizVw"><div class="CodeBlock_codeBlock__KlURa"><pre tabindex="0" style="color:#ffffff;font-family:ProximaNova, monospace;line-height:1.2;font-size:1rem"><code class="language-bash" style="white-space:pre"><span class="token token" style="color:#ee6123">curl</span><span> </span><span class="token token punctuation">\</span><span> </span><span>-H </span><span class="token token" style="color:#acda95">'Authorization: Bearer {TOKEN}'</span><span> </span><span class="token token punctuation">\</span><span> </span><span>-X GET </span><span class="token token punctuation">\</span><span> </span>https://api-ssl.bitly.com/v4/organizations/Oa1bcd234eF</code></pre></div></div></div><div><label class="CodeSyntaxSelector_header__6P_Jc"><span>Response</span><div class="CodeSyntaxSelector_header__6P_Jc"><div class="Select_wrapper__58utF"><select class="Select_select__qXz_Z" aria-label="Select" autoComplete="off"><option value="200" selected="">200 SUCCESS</option><option value="403">403 FORBIDDEN</option><option value="404">404 NOT_FOUND</option><option value="500">500 INTERNAL_ERROR</option><option value="503">503 TEMPORARILY_UNAVAILABLE</option></select><svg viewBox="0 0 8 14" xmlns="http://www.w3.org/2000/svg"><path d="M6.463 7 .987 1.66a.61.61 0 0 1 0-.878.648.648 0 0 1 .9 0L7.813 6.56a.61.61 0 0 1 0 .878l-5.926 5.78a.648.648 0 0 1-.9 0 .61.61 0 0 1 0-.879L6.463 7Z"></path></svg></div></div></label><div class="CodeSyntaxSelector_body__hBJ7j"><div class="CodeBlock_codeBlock__KlURa"><pre tabindex="0" style="color:#36383b;font-family:ProximaNova, monospace;line-height:1.2;font-size:1rem"><code class="language-json" style="white-space:pre"><span class="token token punctuation">{</span><span> </span><span> </span><span class="token token property">"references"</span><span class="token token operator">:</span><span> </span><span class="token token punctuation">{</span><span> </span><span class="token token" style="color:#51763e">"any"</span><span> </span><span class="token token punctuation">}</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"name"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"is_active"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"boolean"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"guid"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"tier"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"tier_family"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"tier_display_name"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"role"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"created"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"modified"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"bsds"</span><span class="token token operator">:</span><span> </span><span class="token token punctuation">[</span><span> </span><span> </span><span class="token token" style="color:#51763e">"string"</span><span> </span><span> </span><span class="token token punctuation">]</span><span> </span><span></span><span class="token token punctuation">}</span></code></pre></div></div></div></div></div><div class="MethodDetail_methodContainer__3EF7h" id="getOrganizationShortenCounts"><div class="MethodDetail_method__fyEiw"><div><h3 class="MethodHeader_h3__seOfC">Get Shorten Counts for an Organization</h3><h4 class="MethodHeader_description__3_p_p"><div class="MethodHeader_iconStyle__x5Ow4"><svg viewBox="0 0 14 6" xmlns="http://www.w3.org/2000/svg" class="IconRest_restIcon__3pju8 get"><title>Get</title><path d="M2.587 6c.307 0 .607-.044.9-.132.295-.088.533-.217.716-.387V2.876H2.271v.825h1.027v1.145a.772.772 0 0 1-.239.1 1.4 1.4 0 0 1-.383.049 1.338 1.338 0 0 1-1.083-.52c-.135-.17-.24-.379-.316-.626a2.879 2.879 0 0 1-.113-.84c0-.352.038-.655.113-.907.076-.253.182-.46.32-.623.137-.162.3-.281.488-.358a1.783 1.783 0 0 1 .97-.082l.13.032v.915h.889V.28a3.182 3.182 0 0 0-.59-.202A3.507 3.507 0 0 0 2.676 0c-.313 0-.628.055-.946.165a2.4 2.4 0 0 0-.861.523 2.707 2.707 0 0 0-.627.92C.081 1.98 0 2.433 0 2.966c0 .506.067.946.202 1.323.135.376.318.692.55.948a2.2 2.2 0 0 0 .82.572A2.7 2.7 0 0 0 2.587 6Zm6.24-.115V4.879H6.184V3.47h2.4V2.465h-2.4V1.121h2.602V.115h-3.71v5.77h3.75Zm4.43 0v-.907h-.914V1.022h.768v.997H14V.115H9.57V2.02h.89v-.997h.776v3.956h-.922v.907h2.942Z"></path></svg></div> /v4/organizations/{organization_guid}/shorten_counts</h4><p class="MethodHeader_description__3_p_p">Returns the shorten counts for a specific organization over a specified time period.</p></div><div><h4 class="ParameterList_h4__nH9G8 ParameterList_dividing__wRGRx">Path Parameters</h4><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">organization_guid</span><span class="Parameter_type__djM_s">string</span><span class="Parameter_required__pcK_H">Required</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">A GUID for a Bitly organization</div></div></div><div><h4 class="ParameterList_h4__nH9G8 ParameterList_dividing__wRGRx">Query Parameters</h4><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">unit</span><span class="Parameter_type__djM_s">string</span><span class="Parameter_required__pcK_H">Required</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">A unit of time</div><div class="Parameter_default__HHgG0 Parameter_spacer__JKXbH">Default: <span class="Parameter_label__DUY7G">"day"</span></div><div class="Parameter_enum__csO6P Parameter_spacer__JKXbH">Enum: <span class="Parameter_label__DUY7G">"minute"</span><span class="Parameter_label__DUY7G">"hour"</span><span class="Parameter_label__DUY7G">"day"</span><span class="Parameter_label__DUY7G">"week"</span><span class="Parameter_label__DUY7G">"month"</span></div></div><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">units</span><span class="Parameter_type__djM_s">integer</span><span class="Parameter_required__pcK_H">Required</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">An integer representing the time units to query data for. pass -1 to return all units of time</div><div class="Parameter_default__HHgG0 Parameter_spacer__JKXbH">Default: <span class="Parameter_label__DUY7G">-1</span></div></div><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">unit_reference</span><span class="Parameter_type__djM_s">string</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">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)</div></div></div></div><div class="MethodDetail_examples__8nXeM"><div><label class="CodeSyntaxSelector_header__6P_Jc CodeSyntaxSelector_headerDark__hI3A0"><span>Request</span><div class="CodeSyntaxSelector_header__6P_Jc CodeSyntaxSelector_headerDark__hI3A0"><div class="Select_wrapper__58utF Select_dark__KPIws"><select class="Select_select__qXz_Z Select_dark__KPIws" aria-label="Select" autoComplete="off"><option value="cURL" selected="">cURL</option><option value="Node">Node</option><option value="Browser">Browser</option><option value="Go">Go</option><option value="Python">Python</option></select><svg viewBox="0 0 8 14" xmlns="http://www.w3.org/2000/svg"><path d="M6.463 7 .987 1.66a.61.61 0 0 1 0-.878.648.648 0 0 1 .9 0L7.813 6.56a.61.61 0 0 1 0 .878l-5.926 5.78a.648.648 0 0 1-.9 0 .61.61 0 0 1 0-.879L6.463 7Z"></path></svg></div></div></label><div class="CodeSyntaxSelector_body__hBJ7j CodeSyntaxSelector_bodyDark__cizVw"><div class="CodeBlock_codeBlock__KlURa"><pre tabindex="0" style="color:#ffffff;font-family:ProximaNova, monospace;line-height:1.2;font-size:1rem"><code class="language-bash" style="white-space:pre"><span class="token token" style="color:#ee6123">curl</span><span> </span><span class="token token punctuation">\</span><span> </span><span>-H </span><span class="token token" style="color:#acda95">'Authorization: Bearer {TOKEN}'</span><span> </span><span class="token token punctuation">\</span><span> </span><span>-X GET </span><span class="token token punctuation">\</span><span> </span><span>https://api-ssl.bitly.com/v4/organizations/Oa1bcd234eF/shorten_counts?unit</span><span class="token token operator">=</span><span>month</span><span class="token token operator">&</span><span class="token token assign-left variable">units</span><span class="token token operator">=</span><span class="token token" style="color:#a1b8f3">1</span><span class="token token operator">&</span><span class="token token assign-left variable">unit_reference</span><span class="token token operator">=</span><span class="token token" style="color:#a1b8f3">2006</span><span>-01-02T15%3A04%3A05-0700</span></code></pre></div></div></div><div><label class="CodeSyntaxSelector_header__6P_Jc"><span>Response</span><div class="CodeSyntaxSelector_header__6P_Jc"><div class="Select_wrapper__58utF"><select class="Select_select__qXz_Z" aria-label="Select" autoComplete="off"><option value="200" selected="">200 SUCCESS</option><option value="403">403 FORBIDDEN</option><option value="404">404 NOT_FOUND</option><option value="500">500 INTERNAL_ERROR</option><option value="503">503 TEMPORARILY_UNAVAILABLE</option></select><svg viewBox="0 0 8 14" xmlns="http://www.w3.org/2000/svg"><path d="M6.463 7 .987 1.66a.61.61 0 0 1 0-.878.648.648 0 0 1 .9 0L7.813 6.56a.61.61 0 0 1 0 .878l-5.926 5.78a.648.648 0 0 1-.9 0 .61.61 0 0 1 0-.879L6.463 7Z"></path></svg></div></div></label><div class="CodeSyntaxSelector_body__hBJ7j"><div class="CodeBlock_codeBlock__KlURa"><pre tabindex="0" style="color:#36383b;font-family:ProximaNova, monospace;line-height:1.2;font-size:1rem"><code class="language-json" style="white-space:pre"><span class="token token punctuation">{</span><span> </span><span> </span><span class="token token property">"unit"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"units"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"integer"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"facet"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"unit_reference"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"metrics"</span><span class="token token operator">:</span><span> </span><span class="token token punctuation">[</span><span> </span><span> </span><span class="token token punctuation">{</span><span> </span><span> </span><span class="token token property">"key"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"value"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"integer"</span><span> </span><span> </span><span class="token token punctuation">}</span><span> </span><span> </span><span class="token token punctuation">]</span><span> </span><span></span><span class="token token punctuation">}</span></code></pre></div></div></div></div></div><div class="MethodDetail_methodContainer__3EF7h" id="getOrganizationShortenCountsByGroup"><div class="MethodDetail_method__fyEiw"><div><h3 class="MethodHeader_h3__seOfC">Get Shorten Counts for an Organization by Group</h3><h4 class="MethodHeader_description__3_p_p"><div class="MethodHeader_iconStyle__x5Ow4"><svg viewBox="0 0 14 6" xmlns="http://www.w3.org/2000/svg" class="IconRest_restIcon__3pju8 get"><title>Get</title><path d="M2.587 6c.307 0 .607-.044.9-.132.295-.088.533-.217.716-.387V2.876H2.271v.825h1.027v1.145a.772.772 0 0 1-.239.1 1.4 1.4 0 0 1-.383.049 1.338 1.338 0 0 1-1.083-.52c-.135-.17-.24-.379-.316-.626a2.879 2.879 0 0 1-.113-.84c0-.352.038-.655.113-.907.076-.253.182-.46.32-.623.137-.162.3-.281.488-.358a1.783 1.783 0 0 1 .97-.082l.13.032v.915h.889V.28a3.182 3.182 0 0 0-.59-.202A3.507 3.507 0 0 0 2.676 0c-.313 0-.628.055-.946.165a2.4 2.4 0 0 0-.861.523 2.707 2.707 0 0 0-.627.92C.081 1.98 0 2.433 0 2.966c0 .506.067.946.202 1.323.135.376.318.692.55.948a2.2 2.2 0 0 0 .82.572A2.7 2.7 0 0 0 2.587 6Zm6.24-.115V4.879H6.184V3.47h2.4V2.465h-2.4V1.121h2.602V.115h-3.71v5.77h3.75Zm4.43 0v-.907h-.914V1.022h.768v.997H14V.115H9.57V2.02h.89v-.997h.776v3.956h-.922v.907h2.942Z"></path></svg></div> /v4/organizations/{organization_guid}/shorten_counts_by_group</h4><p class="MethodHeader_description__3_p_p">Returns the shorten counts for a specific organization by group for the current month.</p></div><div><h4 class="ParameterList_h4__nH9G8 ParameterList_dividing__wRGRx">Path Parameters</h4><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">organization_guid</span><span class="Parameter_type__djM_s">string</span><span class="Parameter_required__pcK_H">Required</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">A GUID for a Bitly organization</div></div></div></div><div class="MethodDetail_examples__8nXeM"><div><label class="CodeSyntaxSelector_header__6P_Jc CodeSyntaxSelector_headerDark__hI3A0"><span>Request</span><div class="CodeSyntaxSelector_header__6P_Jc CodeSyntaxSelector_headerDark__hI3A0"><div class="Select_wrapper__58utF Select_dark__KPIws"><select class="Select_select__qXz_Z Select_dark__KPIws" aria-label="Select" autoComplete="off"><option value="cURL" selected="">cURL</option><option value="Node">Node</option><option value="Browser">Browser</option><option value="Go">Go</option><option value="Python">Python</option></select><svg viewBox="0 0 8 14" xmlns="http://www.w3.org/2000/svg"><path d="M6.463 7 .987 1.66a.61.61 0 0 1 0-.878.648.648 0 0 1 .9 0L7.813 6.56a.61.61 0 0 1 0 .878l-5.926 5.78a.648.648 0 0 1-.9 0 .61.61 0 0 1 0-.879L6.463 7Z"></path></svg></div></div></label><div class="CodeSyntaxSelector_body__hBJ7j CodeSyntaxSelector_bodyDark__cizVw"><div class="CodeBlock_codeBlock__KlURa"><pre tabindex="0" style="color:#ffffff;font-family:ProximaNova, monospace;line-height:1.2;font-size:1rem"><code class="language-bash" style="white-space:pre"><span class="token token" style="color:#ee6123">curl</span><span> </span><span class="token token punctuation">\</span><span> </span><span>-H </span><span class="token token" style="color:#acda95">'Authorization: Bearer {TOKEN}'</span><span> </span><span class="token token punctuation">\</span><span> </span><span>-X GET </span><span class="token token punctuation">\</span><span> </span>https://api-ssl.bitly.com/v4/organizations/Oa1bcd234eF/shorten_counts_by_group</code></pre></div></div></div><div><label class="CodeSyntaxSelector_header__6P_Jc"><span>Response</span><div class="CodeSyntaxSelector_header__6P_Jc"><div class="Select_wrapper__58utF"><select class="Select_select__qXz_Z" aria-label="Select" autoComplete="off"><option value="200" selected="">200 SUCCESS</option><option value="403">403 FORBIDDEN</option><option value="404">404 NOT_FOUND</option><option value="500">500 INTERNAL_ERROR</option><option value="503">503 TEMPORARILY_UNAVAILABLE</option></select><svg viewBox="0 0 8 14" xmlns="http://www.w3.org/2000/svg"><path d="M6.463 7 .987 1.66a.61.61 0 0 1 0-.878.648.648 0 0 1 .9 0L7.813 6.56a.61.61 0 0 1 0 .878l-5.926 5.78a.648.648 0 0 1-.9 0 .61.61 0 0 1 0-.879L6.463 7Z"></path></svg></div></div></label><div class="CodeSyntaxSelector_body__hBJ7j"><div class="CodeBlock_codeBlock__KlURa"><pre tabindex="0" style="color:#36383b;font-family:ProximaNova, monospace;line-height:1.2;font-size:1rem"><code class="language-json" style="white-space:pre"><span class="token token punctuation">{</span><span> </span><span> </span><span class="token token property">"unit"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"units"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"integer"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"facet"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"unit_reference"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"metrics"</span><span class="token token operator">:</span><span> </span><span class="token token punctuation">[</span><span> </span><span> </span><span class="token token punctuation">{</span><span> </span><span> </span><span class="token token property">"key"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"value"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"integer"</span><span> </span><span> </span><span class="token token punctuation">}</span><span> </span><span> </span><span class="token token punctuation">]</span><span> </span><span></span><span class="token token punctuation">}</span></code></pre></div></div></div></div></div><div class="MethodDetail_methodContainer__3EF7h" id="getPlanLimits"><div class="MethodDetail_method__fyEiw"><div><h3 class="MethodHeader_h3__seOfC">Get Plan Limits</h3><h4 class="MethodHeader_description__3_p_p"><div class="MethodHeader_iconStyle__x5Ow4"><svg viewBox="0 0 14 6" xmlns="http://www.w3.org/2000/svg" class="IconRest_restIcon__3pju8 get"><title>Get</title><path d="M2.587 6c.307 0 .607-.044.9-.132.295-.088.533-.217.716-.387V2.876H2.271v.825h1.027v1.145a.772.772 0 0 1-.239.1 1.4 1.4 0 0 1-.383.049 1.338 1.338 0 0 1-1.083-.52c-.135-.17-.24-.379-.316-.626a2.879 2.879 0 0 1-.113-.84c0-.352.038-.655.113-.907.076-.253.182-.46.32-.623.137-.162.3-.281.488-.358a1.783 1.783 0 0 1 .97-.082l.13.032v.915h.889V.28a3.182 3.182 0 0 0-.59-.202A3.507 3.507 0 0 0 2.676 0c-.313 0-.628.055-.946.165a2.4 2.4 0 0 0-.861.523 2.707 2.707 0 0 0-.627.92C.081 1.98 0 2.433 0 2.966c0 .506.067.946.202 1.323.135.376.318.692.55.948a2.2 2.2 0 0 0 .82.572A2.7 2.7 0 0 0 2.587 6Zm6.24-.115V4.879H6.184V3.47h2.4V2.465h-2.4V1.121h2.602V.115h-3.71v5.77h3.75Zm4.43 0v-.907h-.914V1.022h.768v.997H14V.115H9.57V2.02h.89v-.997h.776v3.956h-.922v.907h2.942Z"></path></svg></div> /v4/organizations/{organization_guid}/plan_limits</h4><p class="MethodHeader_description__3_p_p">Returns all plan limits and counts available for an organization.</p></div><div><h4 class="ParameterList_h4__nH9G8 ParameterList_dividing__wRGRx">Path Parameters</h4><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">organization_guid</span><span class="Parameter_type__djM_s">string</span><span class="Parameter_required__pcK_H">Required</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">A GUID for a Bitly organization</div></div></div></div><div class="MethodDetail_examples__8nXeM"><div><label class="CodeSyntaxSelector_header__6P_Jc CodeSyntaxSelector_headerDark__hI3A0"><span>Request</span><div class="CodeSyntaxSelector_header__6P_Jc CodeSyntaxSelector_headerDark__hI3A0"><div class="Select_wrapper__58utF Select_dark__KPIws"><select class="Select_select__qXz_Z Select_dark__KPIws" aria-label="Select" autoComplete="off"><option value="cURL" selected="">cURL</option><option value="Node">Node</option><option value="Browser">Browser</option><option value="Go">Go</option><option value="Python">Python</option></select><svg viewBox="0 0 8 14" xmlns="http://www.w3.org/2000/svg"><path d="M6.463 7 .987 1.66a.61.61 0 0 1 0-.878.648.648 0 0 1 .9 0L7.813 6.56a.61.61 0 0 1 0 .878l-5.926 5.78a.648.648 0 0 1-.9 0 .61.61 0 0 1 0-.879L6.463 7Z"></path></svg></div></div></label><div class="CodeSyntaxSelector_body__hBJ7j CodeSyntaxSelector_bodyDark__cizVw"><div class="CodeBlock_codeBlock__KlURa"><pre tabindex="0" style="color:#ffffff;font-family:ProximaNova, monospace;line-height:1.2;font-size:1rem"><code class="language-bash" style="white-space:pre"><span class="token token" style="color:#ee6123">curl</span><span> </span><span class="token token punctuation">\</span><span> </span><span>-H </span><span class="token token" style="color:#acda95">'Authorization: Bearer {TOKEN}'</span><span> </span><span class="token token punctuation">\</span><span> </span><span>-X GET </span><span class="token token punctuation">\</span><span> </span>https://api-ssl.bitly.com/v4/organizations/Oa1bcd234eF/plan_limits</code></pre></div></div></div><div><label class="CodeSyntaxSelector_header__6P_Jc"><span>Response</span><div class="CodeSyntaxSelector_header__6P_Jc"><div class="Select_wrapper__58utF"><select class="Select_select__qXz_Z" aria-label="Select" autoComplete="off"><option value="200" selected="">200 SUCCESS</option><option value="403">403 FORBIDDEN</option><option value="500">500 INTERNAL_ERROR</option><option value="503">503 TEMPORARILY_UNAVAILABLE</option></select><svg viewBox="0 0 8 14" xmlns="http://www.w3.org/2000/svg"><path d="M6.463 7 .987 1.66a.61.61 0 0 1 0-.878.648.648 0 0 1 .9 0L7.813 6.56a.61.61 0 0 1 0 .878l-5.926 5.78a.648.648 0 0 1-.9 0 .61.61 0 0 1 0-.879L6.463 7Z"></path></svg></div></div></label><div class="CodeSyntaxSelector_body__hBJ7j"><div class="CodeBlock_codeBlock__KlURa"><pre tabindex="0" style="color:#36383b;font-family:ProximaNova, monospace;line-height:1.2;font-size:1rem"><code class="language-json" style="white-space:pre"><span class="token token punctuation">{</span><span> </span><span> </span><span class="token token property">"references"</span><span class="token token operator">:</span><span> </span><span class="token token punctuation">{</span><span> </span><span class="token token" style="color:#51763e">"any"</span><span> </span><span class="token token punctuation">}</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"organization_guid"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"plan_limits"</span><span class="token token operator">:</span><span> </span><span class="token token punctuation">[</span><span> </span><span> </span><span class="token token punctuation">{</span><span> </span><span> </span><span class="token token property">"name"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"description"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"limit"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"integer"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"count"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"integer"</span><span> </span><span> </span><span class="token token punctuation">}</span><span> </span><span> </span><span class="token token punctuation">]</span><span> </span><span></span><span class="token token punctuation">}</span></code></pre></div></div></div></div></div><div class="ApiReference_tagInfo__YVbgw"><h2 class="ApiReference_tagName__IJx2p">QR Codes</h2><p class="ApiReference_tagDescription__8c1GM">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. </p></div><div class="MethodDetail_methodContainer__3EF7h" id="createQRCodePublic"><div class="MethodDetail_method__fyEiw"><div><h3 class="MethodHeader_h3__seOfC">Create a QR Code</h3><h4 class="MethodHeader_description__3_p_p"><div class="MethodHeader_iconStyle__x5Ow4"><svg viewBox="0 0 18 6" xmlns="http://www.w3.org/2000/svg" class="IconRest_restIcon__3pju8 post"><title>Post</title><path d="M1.072 5.885V3.898c.026.006.069.011.129.017a3.88 3.88 0 0 0 .364.016h.125c.27 0 .533-.037.786-.11.253-.075.478-.193.677-.355.198-.162.357-.368.477-.618s.18-.551.18-.903c0-.401-.07-.727-.208-.977a1.592 1.592 0 0 0-.536-.585 1.971 1.971 0 0 0-.739-.28 4.854 4.854 0 0 0-.817-.07C1.249.033.987.045.724.07.46.095.219.13 0 .173v5.712h1.072Zm.461-2.934h-.098a2.344 2.344 0 0 1-.27-.017.818.818 0 0 1-.093-.016V1.047c.057-.011.133-.02.227-.03.093-.007.193-.012.297-.012.135 0 .268.014.399.042.13.027.246.077.348.148a.796.796 0 0 1 .246.284.954.954 0 0 1 .094.45c0 .214-.032.387-.098.519a.782.782 0 0 1-.262.309c-.11.074-.233.125-.371.152a2.141 2.141 0 0 1-.419.042ZM6.47 6c.694 0 1.212-.265 1.553-.795.342-.53.513-1.265.513-2.205 0-.44-.038-.843-.114-1.212a2.872 2.872 0 0 0-.36-.947 1.78 1.78 0 0 0-.637-.618C7.163.074 6.844 0 6.469 0c-.35 0-.653.069-.911.206a1.78 1.78 0 0 0-.645.59c-.172.255-.3.57-.384.943A5.804 5.804 0 0 0 4.404 3c0 .44.037.843.11 1.212.073.368.191.684.356.947.164.264.378.47.641.618.263.149.583.223.958.223Zm0-1.005c-.203 0-.366-.053-.489-.157a.989.989 0 0 1-.281-.425 2.57 2.57 0 0 1-.133-.63A8.129 8.129 0 0 1 5.53 3c0-.66.065-1.157.195-1.492.13-.335.378-.503.743-.503.209 0 .376.054.501.161a1 1 0 0 1 .286.433c.065.181.106.393.125.635.018.241.027.497.027.766 0 .34-.014.636-.043.886-.029.25-.08.457-.152.622a.826.826 0 0 1-.29.367.803.803 0 0 1-.454.12ZM10.991 6c.297 0 .574-.037.83-.111.255-.074.476-.187.664-.338.188-.151.334-.338.438-.56.104-.223.157-.483.157-.78 0-.307-.067-.563-.2-.766a1.814 1.814 0 0 0-.493-.507 3.3 3.3 0 0 0-.641-.342 11.165 11.165 0 0 1-.642-.28 2.185 2.185 0 0 1-.493-.313.562.562 0 0 1-.199-.445c0-.176.072-.316.215-.42.144-.105.34-.157.59-.157a2.757 2.757 0 0 1 .767.107.14.14 0 0 0 .047.008v.915h.86V.338a2.45 2.45 0 0 0-.735-.247C11.85.03 11.536 0 11.218 0c-.282 0-.537.041-.767.124-.23.082-.426.197-.59.346A1.557 1.557 0 0 0 9.476 1a1.66 1.66 0 0 0-.137.68c0 .324.067.588.2.792.133.203.297.372.493.506.195.135.409.246.641.334.232.088.446.176.642.264.195.088.36.19.492.305.133.115.2.266.2.453 0 .209-.081.375-.243.499-.161.123-.388.185-.68.185-.162 0-.314-.018-.458-.053a2.256 2.256 0 0 1-.395-.136l-.047-.017v-.816h-.86V5.53c.067.039.156.085.266.14.11.055.236.107.379.157.143.05.3.09.47.124.169.033.353.049.55.049Zm6.29-.115v-.907h-.885V1.022h.744v.997H18V.115h-4.287V2.02h.86v-.997h.752v3.956h-.892v.907h2.847Z"></path></svg></div> /v4/qr-codes</h4><p class="MethodHeader_description__3_p_p">Create a new QR Code and return its metadata</p></div><div><h4 class="ParameterList_h4__nH9G8 ParameterList_dividing__wRGRx">Request Body Schema</h4><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">title</span><span class="Parameter_type__djM_s">string</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">The title of the QR Code</div></div><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">group_guid</span><span class="Parameter_type__djM_s">string</span><span class="Parameter_required__pcK_H">Required</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">Identify which group to place the QR Code.</div></div><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">render_customizations</span><span class="Parameter_type__djM_s">object</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">Options for customizing a QR Code's appearance</div><div class="Parameter_nestedList__KmKgd"><div class="Parameter_nested__X3i_l"><div class="Parameter_parameter__J0LgW Parameter_compact__V5419"><div><span class="Parameter_name___UYgz">background_color</span><span class="Parameter_type__djM_s">string</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">The QR code's background color in hex code format with values for alpha channel</div></div></div><div class="Parameter_nested__X3i_l"><div class="Parameter_parameter__J0LgW Parameter_compact__V5419"><div><span class="Parameter_name___UYgz">dot_pattern_color</span><span class="Parameter_type__djM_s">string</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">The QR code's dot pattern color in hex code format</div></div></div><div class="Parameter_nested__X3i_l"><div class="Parameter_parameter__J0LgW Parameter_compact__V5419"><div><span class="Parameter_name___UYgz">dot_pattern_type</span><span class="Parameter_type__djM_s">string</span></div><div class="Parameter_default__HHgG0 Parameter_spacer__JKXbH">Default: <span class="Parameter_label__DUY7G">"standard"</span></div><div class="Parameter_enum__csO6P Parameter_spacer__JKXbH">Enum: <span class="Parameter_label__DUY7G">"standard"</span><span class="Parameter_label__DUY7G">"circle"</span><span class="Parameter_label__DUY7G">"block"</span><span class="Parameter_label__DUY7G">"blob"</span><span class="Parameter_label__DUY7G">"rounded"</span><span class="Parameter_label__DUY7G">"vertical"</span><span class="Parameter_label__DUY7G">"horizontal"</span><span class="Parameter_label__DUY7G">"triangle"</span><span class="Parameter_label__DUY7G">"heart"</span><span class="Parameter_label__DUY7G">"star"</span><span class="Parameter_label__DUY7G">"diamond"</span></div></div></div><div class="Parameter_nested__X3i_l"><div class="Parameter_parameter__J0LgW Parameter_compact__V5419"><div><span class="Parameter_name___UYgz">corners</span><span class="Parameter_type__djM_s">object</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">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</div><div class="Parameter_nestedList__KmKgd"><div class="Parameter_nested__X3i_l"><div class="Parameter_parameter__J0LgW Parameter_compact__V5419"><div><span class="Parameter_name___UYgz">corner_1</span><span class="Parameter_type__djM_s">object</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">Represents one corner, both inner and outer, of a QR code, with color and shape values</div><div class="Parameter_nestedList__KmKgd"><div class="Parameter_nested__X3i_l"><div class="Parameter_parameter__J0LgW Parameter_compact__V5419"><div><span class="Parameter_name___UYgz">inner_color</span><span class="Parameter_type__djM_s">string</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">The inner color of a corner of the QR code in hex code format</div></div></div><div class="Parameter_nested__X3i_l"><div class="Parameter_parameter__J0LgW Parameter_compact__V5419"><div><span class="Parameter_name___UYgz">outer_color</span><span class="Parameter_type__djM_s">string</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">The outer color of a corner of the QR code in hex code format</div></div></div><div class="Parameter_nested__X3i_l"><div class="Parameter_parameter__J0LgW Parameter_compact__V5419"><div><span class="Parameter_name___UYgz">shape</span><span class="Parameter_type__djM_s">string</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">The shape one of the QR code's corners should take</div><div class="Parameter_default__HHgG0 Parameter_spacer__JKXbH">Default: <span class="Parameter_label__DUY7G">"standard"</span></div><div class="Parameter_enum__csO6P Parameter_spacer__JKXbH">Enum: <span class="Parameter_label__DUY7G">"standard"</span><span class="Parameter_label__DUY7G">"slightly_round"</span><span class="Parameter_label__DUY7G">"rounded"</span><span class="Parameter_label__DUY7G">"extra_round"</span><span class="Parameter_label__DUY7G">"leaf"</span><span class="Parameter_label__DUY7G">"leaf_inner"</span><span class="Parameter_label__DUY7G">"leaf_outer"</span><span class="Parameter_label__DUY7G">"target"</span><span class="Parameter_label__DUY7G">"concave"</span></div></div></div></div></div></div><div class="Parameter_nested__X3i_l"><div class="Parameter_parameter__J0LgW Parameter_compact__V5419"><div><span class="Parameter_name___UYgz">corner_2</span><span class="Parameter_type__djM_s">object</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">Represents one corner, both inner and outer, of a QR code, with color and shape values</div><div class="Parameter_nestedList__KmKgd"><div class="Parameter_nested__X3i_l"><div class="Parameter_parameter__J0LgW Parameter_compact__V5419"><div><span class="Parameter_name___UYgz">inner_color</span><span class="Parameter_type__djM_s">string</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">The inner color of a corner of the QR code in hex code format</div></div></div><div class="Parameter_nested__X3i_l"><div class="Parameter_parameter__J0LgW Parameter_compact__V5419"><div><span class="Parameter_name___UYgz">outer_color</span><span class="Parameter_type__djM_s">string</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">The outer color of a corner of the QR code in hex code format</div></div></div><div class="Parameter_nested__X3i_l"><div class="Parameter_parameter__J0LgW Parameter_compact__V5419"><div><span class="Parameter_name___UYgz">shape</span><span class="Parameter_type__djM_s">string</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">The shape one of the QR code's corners should take</div><div class="Parameter_default__HHgG0 Parameter_spacer__JKXbH">Default: <span class="Parameter_label__DUY7G">"standard"</span></div><div class="Parameter_enum__csO6P Parameter_spacer__JKXbH">Enum: <span class="Parameter_label__DUY7G">"standard"</span><span class="Parameter_label__DUY7G">"slightly_round"</span><span class="Parameter_label__DUY7G">"rounded"</span><span class="Parameter_label__DUY7G">"extra_round"</span><span class="Parameter_label__DUY7G">"leaf"</span><span class="Parameter_label__DUY7G">"leaf_inner"</span><span class="Parameter_label__DUY7G">"leaf_outer"</span><span class="Parameter_label__DUY7G">"target"</span><span class="Parameter_label__DUY7G">"concave"</span></div></div></div></div></div></div><div class="Parameter_nested__X3i_l"><div class="Parameter_parameter__J0LgW Parameter_compact__V5419"><div><span class="Parameter_name___UYgz">corner_3</span><span class="Parameter_type__djM_s">object</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">Represents one corner, both inner and outer, of a QR code, with color and shape values</div><div class="Parameter_nestedList__KmKgd"><div class="Parameter_nested__X3i_l"><div class="Parameter_parameter__J0LgW Parameter_compact__V5419"><div><span class="Parameter_name___UYgz">inner_color</span><span class="Parameter_type__djM_s">string</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">The inner color of a corner of the QR code in hex code format</div></div></div><div class="Parameter_nested__X3i_l"><div class="Parameter_parameter__J0LgW Parameter_compact__V5419"><div><span class="Parameter_name___UYgz">outer_color</span><span class="Parameter_type__djM_s">string</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">The outer color of a corner of the QR code in hex code format</div></div></div><div class="Parameter_nested__X3i_l"><div class="Parameter_parameter__J0LgW Parameter_compact__V5419"><div><span class="Parameter_name___UYgz">shape</span><span class="Parameter_type__djM_s">string</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">The shape one of the QR code's corners should take</div><div class="Parameter_default__HHgG0 Parameter_spacer__JKXbH">Default: <span class="Parameter_label__DUY7G">"standard"</span></div><div class="Parameter_enum__csO6P Parameter_spacer__JKXbH">Enum: <span class="Parameter_label__DUY7G">"standard"</span><span class="Parameter_label__DUY7G">"slightly_round"</span><span class="Parameter_label__DUY7G">"rounded"</span><span class="Parameter_label__DUY7G">"extra_round"</span><span class="Parameter_label__DUY7G">"leaf"</span><span class="Parameter_label__DUY7G">"leaf_inner"</span><span class="Parameter_label__DUY7G">"leaf_outer"</span><span class="Parameter_label__DUY7G">"target"</span><span class="Parameter_label__DUY7G">"concave"</span></div></div></div></div></div></div></div></div></div><div class="Parameter_nested__X3i_l"><div class="Parameter_parameter__J0LgW Parameter_compact__V5419"><div><span class="Parameter_name___UYgz">gradient</span><span class="Parameter_type__djM_s">object</span></div><div class="Parameter_nestedList__KmKgd"><div class="Parameter_nested__X3i_l"><div class="Parameter_parameter__J0LgW Parameter_compact__V5419"><div><span class="Parameter_name___UYgz">style</span><span class="Parameter_type__djM_s">string</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">The style of the gradient. Can be either linear or radial.</div><div class="Parameter_default__HHgG0 Parameter_spacer__JKXbH">Default: <span class="Parameter_label__DUY7G">"no_gradient"</span></div><div class="Parameter_enum__csO6P Parameter_spacer__JKXbH">Enum: <span class="Parameter_label__DUY7G">"no_gradient"</span><span class="Parameter_label__DUY7G">"linear"</span><span class="Parameter_label__DUY7G">"radial"</span></div></div></div><div class="Parameter_nested__X3i_l"><div class="Parameter_parameter__J0LgW Parameter_compact__V5419"><div><span class="Parameter_name___UYgz">angle</span><span class="Parameter_type__djM_s">number</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">The angle by which the gradient will be rotated. Only applies to linear gradients.</div></div></div><div class="Parameter_nested__X3i_l"><div class="Parameter_parameter__J0LgW Parameter_compact__V5419"><div><span class="Parameter_name___UYgz">colors</span><span class="Parameter_type__djM_s">array</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">The list of hex colors and their offsets to be used in the gradient.</div></div></div><div class="Parameter_nested__X3i_l"><div class="Parameter_parameter__J0LgW Parameter_compact__V5419"><div><span class="Parameter_name___UYgz">exclude_corners</span><span class="Parameter_type__djM_s">boolean</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">Ignore gradient mask on corners</div></div></div></div></div></div><div class="Parameter_nested__X3i_l"><div class="Parameter_parameter__J0LgW Parameter_compact__V5419"><div><span class="Parameter_name___UYgz">background_gradient</span><span class="Parameter_type__djM_s">object</span></div><div class="Parameter_nestedList__KmKgd"><div class="Parameter_nested__X3i_l"><div class="Parameter_parameter__J0LgW Parameter_compact__V5419"><div><span class="Parameter_name___UYgz">style</span><span class="Parameter_type__djM_s">string</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">The style of the gradient. Can be either linear or radial.</div><div class="Parameter_default__HHgG0 Parameter_spacer__JKXbH">Default: <span class="Parameter_label__DUY7G">"no_gradient"</span></div><div class="Parameter_enum__csO6P Parameter_spacer__JKXbH">Enum: <span class="Parameter_label__DUY7G">"no_gradient"</span><span class="Parameter_label__DUY7G">"linear"</span><span class="Parameter_label__DUY7G">"radial"</span></div></div></div><div class="Parameter_nested__X3i_l"><div class="Parameter_parameter__J0LgW Parameter_compact__V5419"><div><span class="Parameter_name___UYgz">angle</span><span class="Parameter_type__djM_s">number</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">The angle by which the gradient will be rotated. Only applies to linear gradients.</div></div></div><div class="Parameter_nested__X3i_l"><div class="Parameter_parameter__J0LgW Parameter_compact__V5419"><div><span class="Parameter_name___UYgz">colors</span><span class="Parameter_type__djM_s">array</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">The list of hex colors and their offsets to be used in the gradient.</div></div></div><div class="Parameter_nested__X3i_l"><div class="Parameter_parameter__J0LgW Parameter_compact__V5419"><div><span class="Parameter_name___UYgz">exclude_corners</span><span class="Parameter_type__djM_s">boolean</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">Ignore gradient mask on corners</div></div></div></div></div></div><div class="Parameter_nested__X3i_l"><div class="Parameter_parameter__J0LgW Parameter_compact__V5419"><div><span class="Parameter_name___UYgz">logo</span><span class="Parameter_type__djM_s">object</span></div><div class="Parameter_nestedList__KmKgd"><div class="Parameter_nested__X3i_l"><div class="Parameter_parameter__J0LgW Parameter_compact__V5419"><div><span class="Parameter_name___UYgz">image_guid</span><span class="Parameter_type__djM_s">string</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">A GUID for an image uploaded to Bitly</div></div></div></div></div></div><div class="Parameter_nested__X3i_l"><div class="Parameter_parameter__J0LgW Parameter_compact__V5419"><div><span class="Parameter_name___UYgz">frame</span><span class="Parameter_type__djM_s">object</span></div><div class="Parameter_nestedList__KmKgd"><div class="Parameter_nested__X3i_l"><div class="Parameter_parameter__J0LgW Parameter_compact__V5419"><div><span class="Parameter_name___UYgz">id</span><span class="Parameter_type__djM_s">string</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">The unique id of the selected frame</div><div class="Parameter_default__HHgG0 Parameter_spacer__JKXbH">Default: <span class="Parameter_label__DUY7G">"none"</span></div><div class="Parameter_enum__csO6P Parameter_spacer__JKXbH">Enum: <span class="Parameter_label__DUY7G">"none"</span><span class="Parameter_label__DUY7G">"border_only"</span><span class="Parameter_label__DUY7G">"text_bottom"</span><span class="Parameter_label__DUY7G">"tooltip_bottom"</span><span class="Parameter_label__DUY7G">"arrow"</span><span class="Parameter_label__DUY7G">"text_top"</span><span class="Parameter_label__DUY7G">"text_bottom_in_frame"</span><span class="Parameter_label__DUY7G">"script"</span><span class="Parameter_label__DUY7G">"text_top_and_bottom"</span><span class="Parameter_label__DUY7G">"url"</span><span class="Parameter_label__DUY7G">"instagram"</span></div></div></div><div class="Parameter_nested__X3i_l"><div class="Parameter_parameter__J0LgW Parameter_compact__V5419"><div><span class="Parameter_name___UYgz">colors</span><span class="Parameter_type__djM_s">object</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">An object of named colors denoting which color should go to which area of the frame</div><div class="Parameter_nestedList__KmKgd"><div class="Parameter_nested__X3i_l"><div class="Parameter_parameter__J0LgW Parameter_compact__V5419"><div><span class="Parameter_name___UYgz">primary</span><span class="Parameter_type__djM_s">string</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">The primary color of the frame in hex code format</div></div></div><div class="Parameter_nested__X3i_l"><div class="Parameter_parameter__J0LgW Parameter_compact__V5419"><div><span class="Parameter_name___UYgz">secondary</span><span class="Parameter_type__djM_s">string</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">The secondary color of the frame in hex code format</div></div></div><div class="Parameter_nested__X3i_l"><div class="Parameter_parameter__J0LgW Parameter_compact__V5419"><div><span class="Parameter_name___UYgz">background</span><span class="Parameter_type__djM_s">string</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">The background color of the frame in hex code format</div></div></div></div></div></div><div class="Parameter_nested__X3i_l"><div class="Parameter_parameter__J0LgW Parameter_compact__V5419"><div><span class="Parameter_name___UYgz">text</span><span class="Parameter_type__djM_s">object</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">The text to be inserted into the QR code's frame</div><div class="Parameter_nestedList__KmKgd"><div class="Parameter_nested__X3i_l"><div class="Parameter_parameter__J0LgW Parameter_compact__V5419"><div><span class="Parameter_name___UYgz">primary</span><span class="Parameter_type__djM_s">object</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">An object describing text with color</div><div class="Parameter_nestedList__KmKgd"><div class="Parameter_nested__X3i_l"><div class="Parameter_parameter__J0LgW Parameter_compact__V5419"><div><span class="Parameter_name___UYgz">content</span><span class="Parameter_type__djM_s">string</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">The text to be used</div></div></div><div class="Parameter_nested__X3i_l"><div class="Parameter_parameter__J0LgW Parameter_compact__V5419"><div><span class="Parameter_name___UYgz">color</span><span class="Parameter_type__djM_s">string</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">The color of the text in hex code format</div><div class="Parameter_default__HHgG0 Parameter_spacer__JKXbH">Default: <span class="Parameter_label__DUY7G">"#ffffff"</span></div></div></div></div></div></div><div class="Parameter_nested__X3i_l"><div class="Parameter_parameter__J0LgW Parameter_compact__V5419"><div><span class="Parameter_name___UYgz">secondary</span><span class="Parameter_type__djM_s">object</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">An object describing text with color</div><div class="Parameter_nestedList__KmKgd"><div class="Parameter_nested__X3i_l"><div class="Parameter_parameter__J0LgW Parameter_compact__V5419"><div><span class="Parameter_name___UYgz">content</span><span class="Parameter_type__djM_s">string</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">The text to be used</div></div></div><div class="Parameter_nested__X3i_l"><div class="Parameter_parameter__J0LgW Parameter_compact__V5419"><div><span class="Parameter_name___UYgz">color</span><span class="Parameter_type__djM_s">string</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">The color of the text in hex code format</div><div class="Parameter_default__HHgG0 Parameter_spacer__JKXbH">Default: <span class="Parameter_label__DUY7G">"#ffffff"</span></div></div></div></div></div></div></div></div></div></div></div></div><div class="Parameter_nested__X3i_l"><div class="Parameter_parameter__J0LgW Parameter_compact__V5419"><div><span class="Parameter_name___UYgz">text</span><span class="Parameter_type__djM_s">object</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">Contains the center, top, and bottom text to be used in the QR code</div><div class="Parameter_nestedList__KmKgd"><div class="Parameter_nested__X3i_l"><div class="Parameter_parameter__J0LgW Parameter_compact__V5419"><div><span class="Parameter_name___UYgz">center</span><span class="Parameter_type__djM_s">object</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">An object describing text with color</div><div class="Parameter_nestedList__KmKgd"><div class="Parameter_nested__X3i_l"><div class="Parameter_parameter__J0LgW Parameter_compact__V5419"><div><span class="Parameter_name___UYgz">content</span><span class="Parameter_type__djM_s">string</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">The text to be used</div></div></div><div class="Parameter_nested__X3i_l"><div class="Parameter_parameter__J0LgW Parameter_compact__V5419"><div><span class="Parameter_name___UYgz">color</span><span class="Parameter_type__djM_s">string</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">The color of the text in hex code format</div><div class="Parameter_default__HHgG0 Parameter_spacer__JKXbH">Default: <span class="Parameter_label__DUY7G">"#ffffff"</span></div></div></div></div></div></div><div class="Parameter_nested__X3i_l"><div class="Parameter_parameter__J0LgW Parameter_compact__V5419"><div><span class="Parameter_name___UYgz">top</span><span class="Parameter_type__djM_s">object</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">An object describing text with color</div><div class="Parameter_nestedList__KmKgd"><div class="Parameter_nested__X3i_l"><div class="Parameter_parameter__J0LgW Parameter_compact__V5419"><div><span class="Parameter_name___UYgz">content</span><span class="Parameter_type__djM_s">string</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">The text to be used</div></div></div><div class="Parameter_nested__X3i_l"><div class="Parameter_parameter__J0LgW Parameter_compact__V5419"><div><span class="Parameter_name___UYgz">color</span><span class="Parameter_type__djM_s">string</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">The color of the text in hex code format</div><div class="Parameter_default__HHgG0 Parameter_spacer__JKXbH">Default: <span class="Parameter_label__DUY7G">"#ffffff"</span></div></div></div></div></div></div><div class="Parameter_nested__X3i_l"><div class="Parameter_parameter__J0LgW Parameter_compact__V5419"><div><span class="Parameter_name___UYgz">bottom</span><span class="Parameter_type__djM_s">object</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">An object describing text with color</div><div class="Parameter_nestedList__KmKgd"><div class="Parameter_nested__X3i_l"><div class="Parameter_parameter__J0LgW Parameter_compact__V5419"><div><span class="Parameter_name___UYgz">content</span><span class="Parameter_type__djM_s">string</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">The text to be used</div></div></div><div class="Parameter_nested__X3i_l"><div class="Parameter_parameter__J0LgW Parameter_compact__V5419"><div><span class="Parameter_name___UYgz">color</span><span class="Parameter_type__djM_s">string</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">The color of the text in hex code format</div><div class="Parameter_default__HHgG0 Parameter_spacer__JKXbH">Default: <span class="Parameter_label__DUY7G">"#ffffff"</span></div></div></div></div></div></div></div></div></div><div class="Parameter_nested__X3i_l"><div class="Parameter_parameter__J0LgW Parameter_compact__V5419"><div><span class="Parameter_name___UYgz">branding</span><span class="Parameter_type__djM_s">object</span></div><div class="Parameter_nestedList__KmKgd"><div class="Parameter_nested__X3i_l"><div class="Parameter_parameter__J0LgW Parameter_compact__V5419"><div><span class="Parameter_name___UYgz">bitly_brand</span><span class="Parameter_type__djM_s">boolean</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">A boolean that determines if the QR code should have the bitly brand in its bottom right corner</div></div></div></div></div></div><div class="Parameter_nested__X3i_l"><div class="Parameter_parameter__J0LgW Parameter_compact__V5419"><div><span class="Parameter_name___UYgz">spec_settings</span><span class="Parameter_type__djM_s">object</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">The QR code's editable spec settings, which for now is just the error correction</div><div class="Parameter_nestedList__KmKgd"><div class="Parameter_nested__X3i_l"><div class="Parameter_parameter__J0LgW Parameter_compact__V5419"><div><span class="Parameter_name___UYgz">error_correction</span><span class="Parameter_type__djM_s">integer</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">The amount of error correction that the QR code was generated with</div></div></div></div></div></div></div></div><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">archived</span><span class="Parameter_type__djM_s">boolean</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">A boolean representing if the QR code should be archived (hidden from the UI) upon creation</div></div><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">destination</span><span class="Parameter_type__djM_s">object</span><span class="Parameter_required__pcK_H">Required</span></div><div class="Parameter_nestedList__KmKgd"><div class="Parameter_nested__X3i_l"><div class="Parameter_parameter__J0LgW Parameter_compact__V5419"><div><span class="Parameter_name___UYgz">bitlink_id</span><span class="Parameter_type__djM_s">string</span></div></div></div><div class="Parameter_nested__X3i_l"><div class="Parameter_parameter__J0LgW Parameter_compact__V5419"><div><span class="Parameter_name___UYgz">long_url</span><span class="Parameter_type__djM_s">string</span></div></div></div><div class="Parameter_nested__X3i_l"><div class="Parameter_parameter__J0LgW Parameter_compact__V5419"><div><span class="Parameter_name___UYgz">site_id</span><span class="Parameter_type__djM_s">string</span></div></div></div></div></div><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">gs1</span><span class="Parameter_type__djM_s">object</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">Contains GS1 related metadata</div><div class="Parameter_nestedList__KmKgd"><div class="Parameter_nested__X3i_l"><div class="Parameter_parameter__J0LgW Parameter_compact__V5419"><div><span class="Parameter_name___UYgz">values</span><span class="Parameter_type__djM_s">array</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">A list of GS1 application identifiers and their values</div></div></div></div></div></div></div><div class="MethodDetail_examples__8nXeM"><div><label class="CodeSyntaxSelector_header__6P_Jc CodeSyntaxSelector_headerDark__hI3A0"><span>Request</span><div class="CodeSyntaxSelector_header__6P_Jc CodeSyntaxSelector_headerDark__hI3A0"><div class="Select_wrapper__58utF Select_dark__KPIws"><select class="Select_select__qXz_Z Select_dark__KPIws" aria-label="Select" autoComplete="off"><option value="Default" selected="">Default</option><option value="Minimal">Minimal</option><option value="Link in Bio">Link in Bio</option><option value="Complex">Complex</option><option value="Gradients">Gradients</option><option value="Framed">Framed</option><option value="Lowest Error Correction">Lowest Error Correction</option><option value="GS1">GS1</option></select><svg viewBox="0 0 8 14" xmlns="http://www.w3.org/2000/svg"><path d="M6.463 7 .987 1.66a.61.61 0 0 1 0-.878.648.648 0 0 1 .9 0L7.813 6.56a.61.61 0 0 1 0 .878l-5.926 5.78a.648.648 0 0 1-.9 0 .61.61 0 0 1 0-.879L6.463 7Z"></path></svg></div><div class="Select_wrapper__58utF Select_dark__KPIws"><select class="Select_select__qXz_Z Select_dark__KPIws" aria-label="Select" autoComplete="off"><option value="cURL" selected="">cURL</option><option value="Node">Node</option><option value="Browser">Browser</option><option value="Go">Go</option><option value="Python">Python</option></select><svg viewBox="0 0 8 14" xmlns="http://www.w3.org/2000/svg"><path d="M6.463 7 .987 1.66a.61.61 0 0 1 0-.878.648.648 0 0 1 .9 0L7.813 6.56a.61.61 0 0 1 0 .878l-5.926 5.78a.648.648 0 0 1-.9 0 .61.61 0 0 1 0-.879L6.463 7Z"></path></svg></div></div></label><div class="CodeSyntaxSelector_body__hBJ7j CodeSyntaxSelector_bodyDark__cizVw"><div class="CodeBlock_codeBlock__KlURa"><pre tabindex="0" style="color:#ffffff;font-family:ProximaNova, monospace;line-height:1.2;font-size:1rem"><code class="language-bash" style="white-space:pre"><span class="token token" style="color:#ee6123">curl</span><span> </span><span class="token token punctuation">\</span><span> </span><span>-H </span><span class="token token" style="color:#acda95">'Authorization: Bearer {TOKEN}'</span><span> </span><span class="token token punctuation">\</span><span> </span><span>-H </span><span class="token token" style="color:#acda95">'Content-Type: application/json'</span><span> </span><span class="token token punctuation">\</span><span> </span><span>-X POST </span><span class="token token punctuation">\</span><span> </span><span>-d </span><span class="token token" style="color:#acda95">'{ </span><span class="token token" style="color:#acda95"> "title": "Default QR Code", </span><span class="token token" style="color:#acda95"> "group_guid": "Ba1bc23dE4F", </span><span class="token token" style="color:#acda95"> "destination": { </span><span class="token token" style="color:#acda95"> "bitlink_id": "bit.ly/abc123" </span><span class="token token" style="color:#acda95"> }, </span><span class="token token" style="color:#acda95"> "archived": false, </span><span class="token token" style="color:#acda95"> "render_customizations": { </span><span class="token token" style="color:#acda95"> "background_color": "#ffffff", </span><span class="token token" style="color:#acda95"> "dot_pattern_color": "#000000", </span><span class="token token" style="color:#acda95"> "dot_pattern_type": "standard", </span><span class="token token" style="color:#acda95"> "corners": { </span><span class="token token" style="color:#acda95"> "corner_1": { </span><span class="token token" style="color:#acda95"> "inner_color": "#000000", </span><span class="token token" style="color:#acda95"> "outer_color": "#000000", </span><span class="token token" style="color:#acda95"> "shape": "standard" </span><span class="token token" style="color:#acda95"> }, </span><span class="token token" style="color:#acda95"> "corner_2": { </span><span class="token token" style="color:#acda95"> "inner_color": "#000000", </span><span class="token token" style="color:#acda95"> "outer_color": "#000000", </span><span class="token token" style="color:#acda95"> "shape": "standard" </span><span class="token token" style="color:#acda95"> }, </span><span class="token token" style="color:#acda95"> "corner_3": { </span><span class="token token" style="color:#acda95"> "inner_color": "#000000", </span><span class="token token" style="color:#acda95"> "outer_color": "#000000", </span><span class="token token" style="color:#acda95"> "shape": "standard" </span><span class="token token" style="color:#acda95"> } </span><span class="token token" style="color:#acda95"> }, </span><span class="token token" style="color:#acda95"> "branding": { </span><span class="token token" style="color:#acda95"> "bitly_brand": true </span><span class="token token" style="color:#acda95"> }, </span><span class="token token" style="color:#acda95"> "spec_settings": { </span><span class="token token" style="color:#acda95"> "error_correction": 4 </span><span class="token token" style="color:#acda95"> } </span><span class="token token" style="color:#acda95"> } </span><span class="token token" style="color:#acda95">}'</span><span> </span><span class="token token punctuation">\</span><span> </span>https://api-ssl.bitly.com/v4/qr-codes</code></pre></div></div></div><div><label class="CodeSyntaxSelector_header__6P_Jc"><span>Response</span><div class="CodeSyntaxSelector_header__6P_Jc"><div class="Select_wrapper__58utF"><select class="Select_select__qXz_Z" aria-label="Select" autoComplete="off"><option value="201" selected="">201 CREATED</option><option value="400">400 BAD_REQUEST</option><option value="402">402 UPGRADE_REQUIRED</option><option value="403">403 FORBIDDEN</option><option value="404">404 NOT_FOUND</option><option value="410">410 GONE</option><option value="429">429 MONTHLY_LIMIT_EXCEEDED</option><option value="500">500 INTERNAL_ERROR</option></select><svg viewBox="0 0 8 14" xmlns="http://www.w3.org/2000/svg"><path d="M6.463 7 .987 1.66a.61.61 0 0 1 0-.878.648.648 0 0 1 .9 0L7.813 6.56a.61.61 0 0 1 0 .878l-5.926 5.78a.648.648 0 0 1-.9 0 .61.61 0 0 1 0-.879L6.463 7Z"></path></svg></div></div></label><div class="CodeSyntaxSelector_body__hBJ7j"><div class="CodeBlock_codeBlock__KlURa"><pre tabindex="0" style="color:#36383b;font-family:ProximaNova, monospace;line-height:1.2;font-size:1rem"><code class="language-json" style="white-space:pre"><span class="token token punctuation">{</span><span> </span><span> </span><span class="token token property">"qrcode_id"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"group_guid"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"title"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"is_customized"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"boolean"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"serialized_content"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"qr_code_type"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"long_urls"</span><span class="token token operator">:</span><span> </span><span class="token token punctuation">[</span><span> </span><span> </span><span class="token token" style="color:#51763e">"string"</span><span> </span><span> </span><span class="token token punctuation">]</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"bitlink_id"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"is_gs1"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"boolean"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"created_by"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"archived"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"boolean"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"created"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"modified"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span> </span><span></span><span class="token token punctuation">}</span></code></pre></div></div></div></div></div><div class="MethodDetail_methodContainer__3EF7h" id="getQRCodeImagePublic"><div class="MethodDetail_method__fyEiw"><div><h3 class="MethodHeader_h3__seOfC">Retrieve a QR Code image</h3><h4 class="MethodHeader_description__3_p_p"><div class="MethodHeader_iconStyle__x5Ow4"><svg viewBox="0 0 14 6" xmlns="http://www.w3.org/2000/svg" class="IconRest_restIcon__3pju8 get"><title>Get</title><path d="M2.587 6c.307 0 .607-.044.9-.132.295-.088.533-.217.716-.387V2.876H2.271v.825h1.027v1.145a.772.772 0 0 1-.239.1 1.4 1.4 0 0 1-.383.049 1.338 1.338 0 0 1-1.083-.52c-.135-.17-.24-.379-.316-.626a2.879 2.879 0 0 1-.113-.84c0-.352.038-.655.113-.907.076-.253.182-.46.32-.623.137-.162.3-.281.488-.358a1.783 1.783 0 0 1 .97-.082l.13.032v.915h.889V.28a3.182 3.182 0 0 0-.59-.202A3.507 3.507 0 0 0 2.676 0c-.313 0-.628.055-.946.165a2.4 2.4 0 0 0-.861.523 2.707 2.707 0 0 0-.627.92C.081 1.98 0 2.433 0 2.966c0 .506.067.946.202 1.323.135.376.318.692.55.948a2.2 2.2 0 0 0 .82.572A2.7 2.7 0 0 0 2.587 6Zm6.24-.115V4.879H6.184V3.47h2.4V2.465h-2.4V1.121h2.602V.115h-3.71v5.77h3.75Zm4.43 0v-.907h-.914V1.022h.768v.997H14V.115H9.57V2.02h.89v-.997h.776v3.956h-.922v.907h2.942Z"></path></svg></div> /v4/qr-codes/{qrcode_id}/image</h4><p class="MethodHeader_description__3_p_p">Get the image of a given QR Code. The Accept header controls how this is returned (options are "application/json", "image/svg+xml", and "image/png"). If the Accept header is "application/json" the format query parameter will determine the image format inside of the json (which will be base64 encoded and prefixed with its mime type as would be suitable for a HTML image src tag). To Return the QR Code image itself, set the Accept header to "image/svg+xml" or "image/png", or remove the Accept header and set the format query parameter to “svg” or “png” (if no format is specified the default will be “svg”). </p></div><div><h4 class="ParameterList_h4__nH9G8 ParameterList_dividing__wRGRx">Path Parameters</h4><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">qrcode_id</span><span class="Parameter_type__djM_s">string</span><span class="Parameter_required__pcK_H">Required</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">The QR Code ID</div></div></div><div><h4 class="ParameterList_h4__nH9G8 ParameterList_dividing__wRGRx">Query Parameters</h4><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">format</span><span class="Parameter_type__djM_s">string</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">The format type of the image. If there is an image format in the header it takes precedence.</div><div class="Parameter_default__HHgG0 Parameter_spacer__JKXbH">Default: <span class="Parameter_label__DUY7G">"svg"</span></div><div class="Parameter_enum__csO6P Parameter_spacer__JKXbH">Enum: <span class="Parameter_label__DUY7G">"svg"</span><span class="Parameter_label__DUY7G">"png"</span></div></div></div></div><div class="MethodDetail_examples__8nXeM"><div><label class="CodeSyntaxSelector_header__6P_Jc CodeSyntaxSelector_headerDark__hI3A0"><span>Request</span><div class="CodeSyntaxSelector_header__6P_Jc CodeSyntaxSelector_headerDark__hI3A0"><div class="Select_wrapper__58utF Select_dark__KPIws"><select class="Select_select__qXz_Z Select_dark__KPIws" aria-label="Select" autoComplete="off"><option value="cURL" selected="">cURL</option><option value="Node">Node</option><option value="Browser">Browser</option><option value="Go">Go</option><option value="Python">Python</option></select><svg viewBox="0 0 8 14" xmlns="http://www.w3.org/2000/svg"><path d="M6.463 7 .987 1.66a.61.61 0 0 1 0-.878.648.648 0 0 1 .9 0L7.813 6.56a.61.61 0 0 1 0 .878l-5.926 5.78a.648.648 0 0 1-.9 0 .61.61 0 0 1 0-.879L6.463 7Z"></path></svg></div></div></label><div class="CodeSyntaxSelector_body__hBJ7j CodeSyntaxSelector_bodyDark__cizVw"><div class="CodeBlock_codeBlock__KlURa"><pre tabindex="0" style="color:#ffffff;font-family:ProximaNova, monospace;line-height:1.2;font-size:1rem"><code class="language-bash" style="white-space:pre"><span class="token token" style="color:#ee6123">curl</span><span> </span><span class="token token punctuation">\</span><span> </span><span>-H </span><span class="token token" style="color:#acda95">'Authorization: Bearer {TOKEN}'</span><span> </span><span class="token token punctuation">\</span><span> </span><span>-X GET </span><span class="token token punctuation">\</span><span> </span><span>https://api-ssl.bitly.com/v4/qr-codes/Qabcde12345/image?format</span><span class="token token operator">=</span></code></pre></div></div></div><div><label class="CodeSyntaxSelector_header__6P_Jc"><span>Response</span><div class="CodeSyntaxSelector_header__6P_Jc"><div class="Select_wrapper__58utF"><select class="Select_select__qXz_Z" aria-label="Select" autoComplete="off"><option value="200" selected="">200 SUCCESS</option><option value="400">400 BAD_REQUEST</option><option value="403">403 FORBIDDEN</option><option value="404">404 NOT_FOUND</option><option value="410">410 GONE</option><option value="500">500 INTERNAL_ERROR</option></select><svg viewBox="0 0 8 14" xmlns="http://www.w3.org/2000/svg"><path d="M6.463 7 .987 1.66a.61.61 0 0 1 0-.878.648.648 0 0 1 .9 0L7.813 6.56a.61.61 0 0 1 0 .878l-5.926 5.78a.648.648 0 0 1-.9 0 .61.61 0 0 1 0-.879L6.463 7Z"></path></svg></div></div></label><div class="CodeSyntaxSelector_body__hBJ7j"><div class="CodeBlock_codeBlock__KlURa"><pre tabindex="0" style="color:#36383b;font-family:ProximaNova, monospace;line-height:1.2;font-size:1rem"><code class="language-json" style="white-space:pre"><span class="token token punctuation">{</span><span> </span><span> </span><span class="token token property">"qr_code_image"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span> </span><span></span><span class="token token punctuation">}</span></code></pre></div></div></div></div></div><div class="MethodDetail_methodContainer__3EF7h" id="updateQRCodePublic"><div class="MethodDetail_method__fyEiw"><div><h3 class="MethodHeader_h3__seOfC">Update a QR Code</h3><h4 class="MethodHeader_description__3_p_p"><div class="MethodHeader_iconStyle__x5Ow4"><svg viewBox="0 0 23 6" xmlns="http://www.w3.org/2000/svg" class="IconRest_restIcon__3pju8 patch"><title>Patch</title><path d="M1.095 5.885V3.898c.027.006.07.011.132.017a4.052 4.052 0 0 0 .372.016h.128c.277 0 .545-.037.803-.11.259-.075.49-.193.692-.355.202-.162.365-.368.487-.618.123-.25.184-.551.184-.903 0-.401-.07-.727-.212-.977a1.606 1.606 0 0 0-.547-.585 2.041 2.041 0 0 0-.756-.28 5.067 5.067 0 0 0-.835-.07c-.267 0-.534.012-.804.037C.47.095.224.13 0 .173v5.712h1.095Zm.472-2.934h-.1a2.448 2.448 0 0 1-.276-.017.853.853 0 0 1-.096-.016V1.047c.059-.011.136-.02.232-.03.096-.007.197-.012.304-.012.138 0 .274.014.408.042a.964.964 0 0 1 .355.148.801.801 0 0 1 .252.284.937.937 0 0 1 .096.45c0 .214-.033.387-.1.519a.787.787 0 0 1-.268.309 1.038 1.038 0 0 1-.38.152 2.235 2.235 0 0 1-.427.042Zm3.79 2.934.383-1.278h1.67l.4 1.278h1.152L7.163.115H6.068L4.26 5.885h1.095ZM7.194 3.7h-1.2l.56-1.929h.072l.568 1.929Zm5.668 2.184v-.907h-.903V1.022h.76v.997h.879V.115H9.218V2.02h.879v-.997h.767v3.956h-.91v.907h2.91Zm3.91.115c.276 0 .547-.036.81-.107.265-.072.482-.17.652-.297V3.948h-.88v.997c-.164.033-.335.05-.51.05-.246 0-.464-.049-.656-.145a1.383 1.383 0 0 1-.488-.408 1.881 1.881 0 0 1-.304-.63A2.973 2.973 0 0 1 15.293 3c0-.34.038-.636.112-.886.075-.25.179-.457.312-.622.133-.165.29-.287.468-.367.178-.08.371-.12.58-.12.175 0 .346.014.511.042v.94h.88V.271a2.727 2.727 0 0 0-.548-.19A3.419 3.419 0 0 0 16.796 0c-.303 0-.613.05-.927.152-.314.102-.6.27-.855.503a2.611 2.611 0 0 0-.628.923c-.163.382-.244.856-.244 1.422 0 .544.072 1.007.216 1.389.144.382.336.692.576.931.24.24.518.412.835.52.317.106.652.16 1.003.16Zm3.325-.115V3.47h1.807v2.415H23V.115h-1.095v2.35h-1.807V.114h-1.095v5.77h1.095Z"></path></svg></div> /v4/qr-codes/{qrcode_id}</h4><p class="MethodHeader_description__3_p_p">Updates the QR code with a matching id and returns it.</p></div><div><h4 class="ParameterList_h4__nH9G8 ParameterList_dividing__wRGRx">Path Parameters</h4><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">qrcode_id</span><span class="Parameter_type__djM_s">string</span><span class="Parameter_required__pcK_H">Required</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">The QR code ID</div></div></div><div><h4 class="ParameterList_h4__nH9G8 ParameterList_dividing__wRGRx">Request Body Schema</h4><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">title</span><span class="Parameter_type__djM_s">string</span></div></div><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">render_customizations</span><span class="Parameter_type__djM_s">object</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">Options for customizing a QR Code's appearance</div><div class="Parameter_nestedList__KmKgd"><div class="Parameter_nested__X3i_l"><div class="Parameter_parameter__J0LgW Parameter_compact__V5419"><div><span class="Parameter_name___UYgz">background_color</span><span class="Parameter_type__djM_s">string</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">The QR code's background color in hex code format with values for alpha channel</div></div></div><div class="Parameter_nested__X3i_l"><div class="Parameter_parameter__J0LgW Parameter_compact__V5419"><div><span class="Parameter_name___UYgz">dot_pattern_color</span><span class="Parameter_type__djM_s">string</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">The QR code's dot pattern color in hex code format</div></div></div><div class="Parameter_nested__X3i_l"><div class="Parameter_parameter__J0LgW Parameter_compact__V5419"><div><span class="Parameter_name___UYgz">dot_pattern_type</span><span class="Parameter_type__djM_s">string</span></div><div class="Parameter_default__HHgG0 Parameter_spacer__JKXbH">Default: <span class="Parameter_label__DUY7G">"standard"</span></div><div class="Parameter_enum__csO6P Parameter_spacer__JKXbH">Enum: <span class="Parameter_label__DUY7G">"standard"</span><span class="Parameter_label__DUY7G">"circle"</span><span class="Parameter_label__DUY7G">"block"</span><span class="Parameter_label__DUY7G">"blob"</span><span class="Parameter_label__DUY7G">"rounded"</span><span class="Parameter_label__DUY7G">"vertical"</span><span class="Parameter_label__DUY7G">"horizontal"</span><span class="Parameter_label__DUY7G">"triangle"</span><span class="Parameter_label__DUY7G">"heart"</span><span class="Parameter_label__DUY7G">"star"</span><span class="Parameter_label__DUY7G">"diamond"</span></div></div></div><div class="Parameter_nested__X3i_l"><div class="Parameter_parameter__J0LgW Parameter_compact__V5419"><div><span class="Parameter_name___UYgz">corners</span><span class="Parameter_type__djM_s">object</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">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</div><div class="Parameter_nestedList__KmKgd"><div class="Parameter_nested__X3i_l"><div class="Parameter_parameter__J0LgW Parameter_compact__V5419"><div><span class="Parameter_name___UYgz">corner_1</span><span class="Parameter_type__djM_s">object</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">Represents one corner, both inner and outer, of a QR code, with color and shape values</div><div class="Parameter_nestedList__KmKgd"><div class="Parameter_nested__X3i_l"><div class="Parameter_parameter__J0LgW Parameter_compact__V5419"><div><span class="Parameter_name___UYgz">inner_color</span><span class="Parameter_type__djM_s">string</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">The inner color of a corner of the QR code in hex code format</div></div></div><div class="Parameter_nested__X3i_l"><div class="Parameter_parameter__J0LgW Parameter_compact__V5419"><div><span class="Parameter_name___UYgz">outer_color</span><span class="Parameter_type__djM_s">string</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">The outer color of a corner of the QR code in hex code format</div></div></div><div class="Parameter_nested__X3i_l"><div class="Parameter_parameter__J0LgW Parameter_compact__V5419"><div><span class="Parameter_name___UYgz">shape</span><span class="Parameter_type__djM_s">string</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">The shape one of the QR code's corners should take</div><div class="Parameter_default__HHgG0 Parameter_spacer__JKXbH">Default: <span class="Parameter_label__DUY7G">"standard"</span></div><div class="Parameter_enum__csO6P Parameter_spacer__JKXbH">Enum: <span class="Parameter_label__DUY7G">"standard"</span><span class="Parameter_label__DUY7G">"slightly_round"</span><span class="Parameter_label__DUY7G">"rounded"</span><span class="Parameter_label__DUY7G">"extra_round"</span><span class="Parameter_label__DUY7G">"leaf"</span><span class="Parameter_label__DUY7G">"leaf_inner"</span><span class="Parameter_label__DUY7G">"leaf_outer"</span><span class="Parameter_label__DUY7G">"target"</span><span class="Parameter_label__DUY7G">"concave"</span></div></div></div></div></div></div><div class="Parameter_nested__X3i_l"><div class="Parameter_parameter__J0LgW Parameter_compact__V5419"><div><span class="Parameter_name___UYgz">corner_2</span><span class="Parameter_type__djM_s">object</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">Represents one corner, both inner and outer, of a QR code, with color and shape values</div><div class="Parameter_nestedList__KmKgd"><div class="Parameter_nested__X3i_l"><div class="Parameter_parameter__J0LgW Parameter_compact__V5419"><div><span class="Parameter_name___UYgz">inner_color</span><span class="Parameter_type__djM_s">string</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">The inner color of a corner of the QR code in hex code format</div></div></div><div class="Parameter_nested__X3i_l"><div class="Parameter_parameter__J0LgW Parameter_compact__V5419"><div><span class="Parameter_name___UYgz">outer_color</span><span class="Parameter_type__djM_s">string</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">The outer color of a corner of the QR code in hex code format</div></div></div><div class="Parameter_nested__X3i_l"><div class="Parameter_parameter__J0LgW Parameter_compact__V5419"><div><span class="Parameter_name___UYgz">shape</span><span class="Parameter_type__djM_s">string</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">The shape one of the QR code's corners should take</div><div class="Parameter_default__HHgG0 Parameter_spacer__JKXbH">Default: <span class="Parameter_label__DUY7G">"standard"</span></div><div class="Parameter_enum__csO6P Parameter_spacer__JKXbH">Enum: <span class="Parameter_label__DUY7G">"standard"</span><span class="Parameter_label__DUY7G">"slightly_round"</span><span class="Parameter_label__DUY7G">"rounded"</span><span class="Parameter_label__DUY7G">"extra_round"</span><span class="Parameter_label__DUY7G">"leaf"</span><span class="Parameter_label__DUY7G">"leaf_inner"</span><span class="Parameter_label__DUY7G">"leaf_outer"</span><span class="Parameter_label__DUY7G">"target"</span><span class="Parameter_label__DUY7G">"concave"</span></div></div></div></div></div></div><div class="Parameter_nested__X3i_l"><div class="Parameter_parameter__J0LgW Parameter_compact__V5419"><div><span class="Parameter_name___UYgz">corner_3</span><span class="Parameter_type__djM_s">object</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">Represents one corner, both inner and outer, of a QR code, with color and shape values</div><div class="Parameter_nestedList__KmKgd"><div class="Parameter_nested__X3i_l"><div class="Parameter_parameter__J0LgW Parameter_compact__V5419"><div><span class="Parameter_name___UYgz">inner_color</span><span class="Parameter_type__djM_s">string</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">The inner color of a corner of the QR code in hex code format</div></div></div><div class="Parameter_nested__X3i_l"><div class="Parameter_parameter__J0LgW Parameter_compact__V5419"><div><span class="Parameter_name___UYgz">outer_color</span><span class="Parameter_type__djM_s">string</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">The outer color of a corner of the QR code in hex code format</div></div></div><div class="Parameter_nested__X3i_l"><div class="Parameter_parameter__J0LgW Parameter_compact__V5419"><div><span class="Parameter_name___UYgz">shape</span><span class="Parameter_type__djM_s">string</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">The shape one of the QR code's corners should take</div><div class="Parameter_default__HHgG0 Parameter_spacer__JKXbH">Default: <span class="Parameter_label__DUY7G">"standard"</span></div><div class="Parameter_enum__csO6P Parameter_spacer__JKXbH">Enum: <span class="Parameter_label__DUY7G">"standard"</span><span class="Parameter_label__DUY7G">"slightly_round"</span><span class="Parameter_label__DUY7G">"rounded"</span><span class="Parameter_label__DUY7G">"extra_round"</span><span class="Parameter_label__DUY7G">"leaf"</span><span class="Parameter_label__DUY7G">"leaf_inner"</span><span class="Parameter_label__DUY7G">"leaf_outer"</span><span class="Parameter_label__DUY7G">"target"</span><span class="Parameter_label__DUY7G">"concave"</span></div></div></div></div></div></div></div></div></div><div class="Parameter_nested__X3i_l"><div class="Parameter_parameter__J0LgW Parameter_compact__V5419"><div><span class="Parameter_name___UYgz">gradient</span><span class="Parameter_type__djM_s">object</span></div><div class="Parameter_nestedList__KmKgd"><div class="Parameter_nested__X3i_l"><div class="Parameter_parameter__J0LgW Parameter_compact__V5419"><div><span class="Parameter_name___UYgz">style</span><span class="Parameter_type__djM_s">string</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">The style of the gradient. Can be either linear or radial.</div><div class="Parameter_default__HHgG0 Parameter_spacer__JKXbH">Default: <span class="Parameter_label__DUY7G">"no_gradient"</span></div><div class="Parameter_enum__csO6P Parameter_spacer__JKXbH">Enum: <span class="Parameter_label__DUY7G">"no_gradient"</span><span class="Parameter_label__DUY7G">"linear"</span><span class="Parameter_label__DUY7G">"radial"</span></div></div></div><div class="Parameter_nested__X3i_l"><div class="Parameter_parameter__J0LgW Parameter_compact__V5419"><div><span class="Parameter_name___UYgz">angle</span><span class="Parameter_type__djM_s">number</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">The angle by which the gradient will be rotated. Only applies to linear gradients.</div></div></div><div class="Parameter_nested__X3i_l"><div class="Parameter_parameter__J0LgW Parameter_compact__V5419"><div><span class="Parameter_name___UYgz">colors</span><span class="Parameter_type__djM_s">array</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">The list of hex colors and their offsets to be used in the gradient.</div></div></div><div class="Parameter_nested__X3i_l"><div class="Parameter_parameter__J0LgW Parameter_compact__V5419"><div><span class="Parameter_name___UYgz">exclude_corners</span><span class="Parameter_type__djM_s">boolean</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">Ignore gradient mask on corners</div></div></div></div></div></div><div class="Parameter_nested__X3i_l"><div class="Parameter_parameter__J0LgW Parameter_compact__V5419"><div><span class="Parameter_name___UYgz">background_gradient</span><span class="Parameter_type__djM_s">object</span></div><div class="Parameter_nestedList__KmKgd"><div class="Parameter_nested__X3i_l"><div class="Parameter_parameter__J0LgW Parameter_compact__V5419"><div><span class="Parameter_name___UYgz">style</span><span class="Parameter_type__djM_s">string</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">The style of the gradient. Can be either linear or radial.</div><div class="Parameter_default__HHgG0 Parameter_spacer__JKXbH">Default: <span class="Parameter_label__DUY7G">"no_gradient"</span></div><div class="Parameter_enum__csO6P Parameter_spacer__JKXbH">Enum: <span class="Parameter_label__DUY7G">"no_gradient"</span><span class="Parameter_label__DUY7G">"linear"</span><span class="Parameter_label__DUY7G">"radial"</span></div></div></div><div class="Parameter_nested__X3i_l"><div class="Parameter_parameter__J0LgW Parameter_compact__V5419"><div><span class="Parameter_name___UYgz">angle</span><span class="Parameter_type__djM_s">number</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">The angle by which the gradient will be rotated. Only applies to linear gradients.</div></div></div><div class="Parameter_nested__X3i_l"><div class="Parameter_parameter__J0LgW Parameter_compact__V5419"><div><span class="Parameter_name___UYgz">colors</span><span class="Parameter_type__djM_s">array</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">The list of hex colors and their offsets to be used in the gradient.</div></div></div><div class="Parameter_nested__X3i_l"><div class="Parameter_parameter__J0LgW Parameter_compact__V5419"><div><span class="Parameter_name___UYgz">exclude_corners</span><span class="Parameter_type__djM_s">boolean</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">Ignore gradient mask on corners</div></div></div></div></div></div><div class="Parameter_nested__X3i_l"><div class="Parameter_parameter__J0LgW Parameter_compact__V5419"><div><span class="Parameter_name___UYgz">logo</span><span class="Parameter_type__djM_s">object</span></div><div class="Parameter_nestedList__KmKgd"><div class="Parameter_nested__X3i_l"><div class="Parameter_parameter__J0LgW Parameter_compact__V5419"><div><span class="Parameter_name___UYgz">image_guid</span><span class="Parameter_type__djM_s">string</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">A GUID for an image uploaded to Bitly</div></div></div></div></div></div><div class="Parameter_nested__X3i_l"><div class="Parameter_parameter__J0LgW Parameter_compact__V5419"><div><span class="Parameter_name___UYgz">frame</span><span class="Parameter_type__djM_s">object</span></div><div class="Parameter_nestedList__KmKgd"><div class="Parameter_nested__X3i_l"><div class="Parameter_parameter__J0LgW Parameter_compact__V5419"><div><span class="Parameter_name___UYgz">id</span><span class="Parameter_type__djM_s">string</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">The unique id of the selected frame</div><div class="Parameter_default__HHgG0 Parameter_spacer__JKXbH">Default: <span class="Parameter_label__DUY7G">"none"</span></div><div class="Parameter_enum__csO6P Parameter_spacer__JKXbH">Enum: <span class="Parameter_label__DUY7G">"none"</span><span class="Parameter_label__DUY7G">"border_only"</span><span class="Parameter_label__DUY7G">"text_bottom"</span><span class="Parameter_label__DUY7G">"tooltip_bottom"</span><span class="Parameter_label__DUY7G">"arrow"</span><span class="Parameter_label__DUY7G">"text_top"</span><span class="Parameter_label__DUY7G">"text_bottom_in_frame"</span><span class="Parameter_label__DUY7G">"script"</span><span class="Parameter_label__DUY7G">"text_top_and_bottom"</span><span class="Parameter_label__DUY7G">"url"</span><span class="Parameter_label__DUY7G">"instagram"</span></div></div></div><div class="Parameter_nested__X3i_l"><div class="Parameter_parameter__J0LgW Parameter_compact__V5419"><div><span class="Parameter_name___UYgz">colors</span><span class="Parameter_type__djM_s">object</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">An object of named colors denoting which color should go to which area of the frame</div><div class="Parameter_nestedList__KmKgd"><div class="Parameter_nested__X3i_l"><div class="Parameter_parameter__J0LgW Parameter_compact__V5419"><div><span class="Parameter_name___UYgz">primary</span><span class="Parameter_type__djM_s">string</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">The primary color of the frame in hex code format</div></div></div><div class="Parameter_nested__X3i_l"><div class="Parameter_parameter__J0LgW Parameter_compact__V5419"><div><span class="Parameter_name___UYgz">secondary</span><span class="Parameter_type__djM_s">string</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">The secondary color of the frame in hex code format</div></div></div><div class="Parameter_nested__X3i_l"><div class="Parameter_parameter__J0LgW Parameter_compact__V5419"><div><span class="Parameter_name___UYgz">background</span><span class="Parameter_type__djM_s">string</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">The background color of the frame in hex code format</div></div></div></div></div></div><div class="Parameter_nested__X3i_l"><div class="Parameter_parameter__J0LgW Parameter_compact__V5419"><div><span class="Parameter_name___UYgz">text</span><span class="Parameter_type__djM_s">object</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">The text to be inserted into the QR code's frame</div><div class="Parameter_nestedList__KmKgd"><div class="Parameter_nested__X3i_l"><div class="Parameter_parameter__J0LgW Parameter_compact__V5419"><div><span class="Parameter_name___UYgz">primary</span><span class="Parameter_type__djM_s">object</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">An object describing text with color</div><div class="Parameter_nestedList__KmKgd"><div class="Parameter_nested__X3i_l"><div class="Parameter_parameter__J0LgW Parameter_compact__V5419"><div><span class="Parameter_name___UYgz">content</span><span class="Parameter_type__djM_s">string</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">The text to be used</div></div></div><div class="Parameter_nested__X3i_l"><div class="Parameter_parameter__J0LgW Parameter_compact__V5419"><div><span class="Parameter_name___UYgz">color</span><span class="Parameter_type__djM_s">string</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">The color of the text in hex code format</div><div class="Parameter_default__HHgG0 Parameter_spacer__JKXbH">Default: <span class="Parameter_label__DUY7G">"#ffffff"</span></div></div></div></div></div></div><div class="Parameter_nested__X3i_l"><div class="Parameter_parameter__J0LgW Parameter_compact__V5419"><div><span class="Parameter_name___UYgz">secondary</span><span class="Parameter_type__djM_s">object</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">An object describing text with color</div><div class="Parameter_nestedList__KmKgd"><div class="Parameter_nested__X3i_l"><div class="Parameter_parameter__J0LgW Parameter_compact__V5419"><div><span class="Parameter_name___UYgz">content</span><span class="Parameter_type__djM_s">string</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">The text to be used</div></div></div><div class="Parameter_nested__X3i_l"><div class="Parameter_parameter__J0LgW Parameter_compact__V5419"><div><span class="Parameter_name___UYgz">color</span><span class="Parameter_type__djM_s">string</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">The color of the text in hex code format</div><div class="Parameter_default__HHgG0 Parameter_spacer__JKXbH">Default: <span class="Parameter_label__DUY7G">"#ffffff"</span></div></div></div></div></div></div></div></div></div></div></div></div><div class="Parameter_nested__X3i_l"><div class="Parameter_parameter__J0LgW Parameter_compact__V5419"><div><span class="Parameter_name___UYgz">text</span><span class="Parameter_type__djM_s">object</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">Contains the center, top, and bottom text to be used in the QR code</div><div class="Parameter_nestedList__KmKgd"><div class="Parameter_nested__X3i_l"><div class="Parameter_parameter__J0LgW Parameter_compact__V5419"><div><span class="Parameter_name___UYgz">center</span><span class="Parameter_type__djM_s">object</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">An object describing text with color</div><div class="Parameter_nestedList__KmKgd"><div class="Parameter_nested__X3i_l"><div class="Parameter_parameter__J0LgW Parameter_compact__V5419"><div><span class="Parameter_name___UYgz">content</span><span class="Parameter_type__djM_s">string</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">The text to be used</div></div></div><div class="Parameter_nested__X3i_l"><div class="Parameter_parameter__J0LgW Parameter_compact__V5419"><div><span class="Parameter_name___UYgz">color</span><span class="Parameter_type__djM_s">string</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">The color of the text in hex code format</div><div class="Parameter_default__HHgG0 Parameter_spacer__JKXbH">Default: <span class="Parameter_label__DUY7G">"#ffffff"</span></div></div></div></div></div></div><div class="Parameter_nested__X3i_l"><div class="Parameter_parameter__J0LgW Parameter_compact__V5419"><div><span class="Parameter_name___UYgz">top</span><span class="Parameter_type__djM_s">object</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">An object describing text with color</div><div class="Parameter_nestedList__KmKgd"><div class="Parameter_nested__X3i_l"><div class="Parameter_parameter__J0LgW Parameter_compact__V5419"><div><span class="Parameter_name___UYgz">content</span><span class="Parameter_type__djM_s">string</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">The text to be used</div></div></div><div class="Parameter_nested__X3i_l"><div class="Parameter_parameter__J0LgW Parameter_compact__V5419"><div><span class="Parameter_name___UYgz">color</span><span class="Parameter_type__djM_s">string</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">The color of the text in hex code format</div><div class="Parameter_default__HHgG0 Parameter_spacer__JKXbH">Default: <span class="Parameter_label__DUY7G">"#ffffff"</span></div></div></div></div></div></div><div class="Parameter_nested__X3i_l"><div class="Parameter_parameter__J0LgW Parameter_compact__V5419"><div><span class="Parameter_name___UYgz">bottom</span><span class="Parameter_type__djM_s">object</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">An object describing text with color</div><div class="Parameter_nestedList__KmKgd"><div class="Parameter_nested__X3i_l"><div class="Parameter_parameter__J0LgW Parameter_compact__V5419"><div><span class="Parameter_name___UYgz">content</span><span class="Parameter_type__djM_s">string</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">The text to be used</div></div></div><div class="Parameter_nested__X3i_l"><div class="Parameter_parameter__J0LgW Parameter_compact__V5419"><div><span class="Parameter_name___UYgz">color</span><span class="Parameter_type__djM_s">string</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">The color of the text in hex code format</div><div class="Parameter_default__HHgG0 Parameter_spacer__JKXbH">Default: <span class="Parameter_label__DUY7G">"#ffffff"</span></div></div></div></div></div></div></div></div></div><div class="Parameter_nested__X3i_l"><div class="Parameter_parameter__J0LgW Parameter_compact__V5419"><div><span class="Parameter_name___UYgz">branding</span><span class="Parameter_type__djM_s">object</span></div><div class="Parameter_nestedList__KmKgd"><div class="Parameter_nested__X3i_l"><div class="Parameter_parameter__J0LgW Parameter_compact__V5419"><div><span class="Parameter_name___UYgz">bitly_brand</span><span class="Parameter_type__djM_s">boolean</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">A boolean that determines if the QR code should have the bitly brand in its bottom right corner</div></div></div></div></div></div><div class="Parameter_nested__X3i_l"><div class="Parameter_parameter__J0LgW Parameter_compact__V5419"><div><span class="Parameter_name___UYgz">spec_settings</span><span class="Parameter_type__djM_s">object</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">The QR code's editable spec settings, which for now is just the error correction</div><div class="Parameter_nestedList__KmKgd"><div class="Parameter_nested__X3i_l"><div class="Parameter_parameter__J0LgW Parameter_compact__V5419"><div><span class="Parameter_name___UYgz">error_correction</span><span class="Parameter_type__djM_s">integer</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">The amount of error correction that the QR code was generated with</div></div></div></div></div></div></div></div><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">archived</span><span class="Parameter_type__djM_s">boolean</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">A boolean representing if the QR code has been archived</div></div></div></div><div class="MethodDetail_examples__8nXeM"><div><label class="CodeSyntaxSelector_header__6P_Jc CodeSyntaxSelector_headerDark__hI3A0"><span>Request</span><div class="CodeSyntaxSelector_header__6P_Jc CodeSyntaxSelector_headerDark__hI3A0"><div class="Select_wrapper__58utF Select_dark__KPIws"><select class="Select_select__qXz_Z Select_dark__KPIws" aria-label="Select" autoComplete="off"><option value="Default" selected="">Default</option><option value="Minimal">Minimal</option><option value="Complex">Complex</option><option value="Gradients">Gradients</option><option value="Framed">Framed</option><option value="Lowest Error Correction">Lowest Error Correction</option></select><svg viewBox="0 0 8 14" xmlns="http://www.w3.org/2000/svg"><path d="M6.463 7 .987 1.66a.61.61 0 0 1 0-.878.648.648 0 0 1 .9 0L7.813 6.56a.61.61 0 0 1 0 .878l-5.926 5.78a.648.648 0 0 1-.9 0 .61.61 0 0 1 0-.879L6.463 7Z"></path></svg></div><div class="Select_wrapper__58utF Select_dark__KPIws"><select class="Select_select__qXz_Z Select_dark__KPIws" aria-label="Select" autoComplete="off"><option value="cURL" selected="">cURL</option><option value="Node">Node</option><option value="Browser">Browser</option><option value="Go">Go</option><option value="Python">Python</option></select><svg viewBox="0 0 8 14" xmlns="http://www.w3.org/2000/svg"><path d="M6.463 7 .987 1.66a.61.61 0 0 1 0-.878.648.648 0 0 1 .9 0L7.813 6.56a.61.61 0 0 1 0 .878l-5.926 5.78a.648.648 0 0 1-.9 0 .61.61 0 0 1 0-.879L6.463 7Z"></path></svg></div></div></label><div class="CodeSyntaxSelector_body__hBJ7j CodeSyntaxSelector_bodyDark__cizVw"><div class="CodeBlock_codeBlock__KlURa"><pre tabindex="0" style="color:#ffffff;font-family:ProximaNova, monospace;line-height:1.2;font-size:1rem"><code class="language-bash" style="white-space:pre"><span class="token token" style="color:#ee6123">curl</span><span> </span><span class="token token punctuation">\</span><span> </span><span>-H </span><span class="token token" style="color:#acda95">'Authorization: Bearer {TOKEN}'</span><span> </span><span class="token token punctuation">\</span><span> </span><span>-H </span><span class="token token" style="color:#acda95">'Content-Type: application/json'</span><span> </span><span class="token token punctuation">\</span><span> </span><span>-X PATCH </span><span class="token token punctuation">\</span><span> </span><span>-d </span><span class="token token" style="color:#acda95">'{ </span><span class="token token" style="color:#acda95"> "title": "Default QR Code Updated", </span><span class="token token" style="color:#acda95"> "archived": false, </span><span class="token token" style="color:#acda95"> "render_customizations": { </span><span class="token token" style="color:#acda95"> "background_color": "#ffffff", </span><span class="token token" style="color:#acda95"> "dot_pattern_color": "#000000", </span><span class="token token" style="color:#acda95"> "dot_pattern_type": "standard", </span><span class="token token" style="color:#acda95"> "corners": { </span><span class="token token" style="color:#acda95"> "corner_1": { </span><span class="token token" style="color:#acda95"> "inner_color": "#000000", </span><span class="token token" style="color:#acda95"> "outer_color": "#000000", </span><span class="token token" style="color:#acda95"> "shape": "standard" </span><span class="token token" style="color:#acda95"> }, </span><span class="token token" style="color:#acda95"> "corner_2": { </span><span class="token token" style="color:#acda95"> "inner_color": "#000000", </span><span class="token token" style="color:#acda95"> "outer_color": "#000000", </span><span class="token token" style="color:#acda95"> "shape": "standard" </span><span class="token token" style="color:#acda95"> }, </span><span class="token token" style="color:#acda95"> "corner_3": { </span><span class="token token" style="color:#acda95"> "inner_color": "#000000", </span><span class="token token" style="color:#acda95"> "outer_color": "#000000", </span><span class="token token" style="color:#acda95"> "shape": "standard" </span><span class="token token" style="color:#acda95"> } </span><span class="token token" style="color:#acda95"> }, </span><span class="token token" style="color:#acda95"> "branding": { </span><span class="token token" style="color:#acda95"> "bitly_brand": true </span><span class="token token" style="color:#acda95"> }, </span><span class="token token" style="color:#acda95"> "spec_settings": { </span><span class="token token" style="color:#acda95"> "error_correction": 4 </span><span class="token token" style="color:#acda95"> } </span><span class="token token" style="color:#acda95"> } </span><span class="token token" style="color:#acda95">}'</span><span> </span><span class="token token punctuation">\</span><span> </span>https://api-ssl.bitly.com/v4/qr-codes/Qabc123</code></pre></div></div></div><div><label class="CodeSyntaxSelector_header__6P_Jc"><span>Response</span><div class="CodeSyntaxSelector_header__6P_Jc"><div class="Select_wrapper__58utF"><select class="Select_select__qXz_Z" aria-label="Select" autoComplete="off"><option value="200" selected="">200 SUCCESS</option><option value="400">400 BAD_REQUEST</option><option value="403">403 FORBIDDEN</option><option value="404">404 NOT_FOUND</option><option value="410">410 GONE</option><option value="500">500 INTERNAL_ERROR</option></select><svg viewBox="0 0 8 14" xmlns="http://www.w3.org/2000/svg"><path d="M6.463 7 .987 1.66a.61.61 0 0 1 0-.878.648.648 0 0 1 .9 0L7.813 6.56a.61.61 0 0 1 0 .878l-5.926 5.78a.648.648 0 0 1-.9 0 .61.61 0 0 1 0-.879L6.463 7Z"></path></svg></div></div></label><div class="CodeSyntaxSelector_body__hBJ7j"><div class="CodeBlock_codeBlock__KlURa"><pre tabindex="0" style="color:#36383b;font-family:ProximaNova, monospace;line-height:1.2;font-size:1rem"><code class="language-json" style="white-space:pre"><span class="token token punctuation">{</span><span> </span><span> </span><span class="token token property">"qrcode_id"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"group_guid"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"title"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"is_customized"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"boolean"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"serialized_content"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"qr_code_type"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"long_urls"</span><span class="token token operator">:</span><span> </span><span class="token token punctuation">[</span><span> </span><span> </span><span class="token token" style="color:#51763e">"string"</span><span> </span><span> </span><span class="token token punctuation">]</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"bitlink_id"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"is_gs1"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"boolean"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"created_by"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"archived"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"boolean"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"created"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"modified"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span> </span><span></span><span class="token token punctuation">}</span></code></pre></div></div></div></div></div><div class="MethodDetail_methodContainer__3EF7h" id="getQRCodeByIdPublic"><div class="MethodDetail_method__fyEiw"><div><h3 class="MethodHeader_h3__seOfC">Retrieve a QR Code</h3><h4 class="MethodHeader_description__3_p_p"><div class="MethodHeader_iconStyle__x5Ow4"><svg viewBox="0 0 14 6" xmlns="http://www.w3.org/2000/svg" class="IconRest_restIcon__3pju8 get"><title>Get</title><path d="M2.587 6c.307 0 .607-.044.9-.132.295-.088.533-.217.716-.387V2.876H2.271v.825h1.027v1.145a.772.772 0 0 1-.239.1 1.4 1.4 0 0 1-.383.049 1.338 1.338 0 0 1-1.083-.52c-.135-.17-.24-.379-.316-.626a2.879 2.879 0 0 1-.113-.84c0-.352.038-.655.113-.907.076-.253.182-.46.32-.623.137-.162.3-.281.488-.358a1.783 1.783 0 0 1 .97-.082l.13.032v.915h.889V.28a3.182 3.182 0 0 0-.59-.202A3.507 3.507 0 0 0 2.676 0c-.313 0-.628.055-.946.165a2.4 2.4 0 0 0-.861.523 2.707 2.707 0 0 0-.627.92C.081 1.98 0 2.433 0 2.966c0 .506.067.946.202 1.323.135.376.318.692.55.948a2.2 2.2 0 0 0 .82.572A2.7 2.7 0 0 0 2.587 6Zm6.24-.115V4.879H6.184V3.47h2.4V2.465h-2.4V1.121h2.602V.115h-3.71v5.77h3.75Zm4.43 0v-.907h-.914V1.022h.768v.997H14V.115H9.57V2.02h.89v-.997h.776v3.956h-.922v.907h2.942Z"></path></svg></div> /v4/qr-codes/{qrcode_id}</h4><p class="MethodHeader_description__3_p_p">Gets the QR code with a matching id.</p></div><div><h4 class="ParameterList_h4__nH9G8 ParameterList_dividing__wRGRx">Path Parameters</h4><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">qrcode_id</span><span class="Parameter_type__djM_s">string</span><span class="Parameter_required__pcK_H">Required</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">The QR Code ID</div></div></div></div><div class="MethodDetail_examples__8nXeM"><div><label class="CodeSyntaxSelector_header__6P_Jc CodeSyntaxSelector_headerDark__hI3A0"><span>Request</span><div class="CodeSyntaxSelector_header__6P_Jc CodeSyntaxSelector_headerDark__hI3A0"><div class="Select_wrapper__58utF Select_dark__KPIws"><select class="Select_select__qXz_Z Select_dark__KPIws" aria-label="Select" autoComplete="off"><option value="cURL" selected="">cURL</option><option value="Node">Node</option><option value="Browser">Browser</option><option value="Go">Go</option><option value="Python">Python</option></select><svg viewBox="0 0 8 14" xmlns="http://www.w3.org/2000/svg"><path d="M6.463 7 .987 1.66a.61.61 0 0 1 0-.878.648.648 0 0 1 .9 0L7.813 6.56a.61.61 0 0 1 0 .878l-5.926 5.78a.648.648 0 0 1-.9 0 .61.61 0 0 1 0-.879L6.463 7Z"></path></svg></div></div></label><div class="CodeSyntaxSelector_body__hBJ7j CodeSyntaxSelector_bodyDark__cizVw"><div class="CodeBlock_codeBlock__KlURa"><pre tabindex="0" style="color:#ffffff;font-family:ProximaNova, monospace;line-height:1.2;font-size:1rem"><code class="language-bash" style="white-space:pre"><span class="token token" style="color:#ee6123">curl</span><span> </span><span class="token token punctuation">\</span><span> </span><span>-H </span><span class="token token" style="color:#acda95">'Authorization: Bearer {TOKEN}'</span><span> </span><span class="token token punctuation">\</span><span> </span><span>-X GET </span><span class="token token punctuation">\</span><span> </span>https://api-ssl.bitly.com/v4/qr-codes/Qabcde12345</code></pre></div></div></div><div><label class="CodeSyntaxSelector_header__6P_Jc"><span>Response</span><div class="CodeSyntaxSelector_header__6P_Jc"><div class="Select_wrapper__58utF"><select class="Select_select__qXz_Z" aria-label="Select" autoComplete="off"><option value="200" selected="">200 SUCCESS</option><option value="400">400 BAD_REQUEST</option><option value="403">403 FORBIDDEN</option><option value="404">404 NOT_FOUND</option><option value="410">410 GONE</option><option value="500">500 INTERNAL_ERROR</option></select><svg viewBox="0 0 8 14" xmlns="http://www.w3.org/2000/svg"><path d="M6.463 7 .987 1.66a.61.61 0 0 1 0-.878.648.648 0 0 1 .9 0L7.813 6.56a.61.61 0 0 1 0 .878l-5.926 5.78a.648.648 0 0 1-.9 0 .61.61 0 0 1 0-.879L6.463 7Z"></path></svg></div></div></label><div class="CodeSyntaxSelector_body__hBJ7j"><div class="CodeBlock_codeBlock__KlURa"><pre tabindex="0" style="color:#36383b;font-family:ProximaNova, monospace;line-height:1.2;font-size:1rem"><code class="language-json" style="white-space:pre"><span class="token token punctuation">{</span><span> </span><span> </span><span class="token token property">"qrcode_id"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"group_guid"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"title"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"gs1"</span><span class="token token operator">:</span><span> </span><span class="token token punctuation">{</span><span> </span><span> </span><span class="token token property">"values"</span><span class="token token operator">:</span><span> </span><span class="token token punctuation">[</span><span> </span><span> </span><span class="token token punctuation">{</span><span> </span><span> </span><span class="token token property">"key"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"value"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span> </span><span> </span><span class="token token punctuation">}</span><span> </span><span> </span><span class="token token punctuation">]</span><span> </span><span> </span><span class="token token punctuation">}</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"render_customizations"</span><span class="token token operator">:</span><span> </span><span class="token token punctuation">{</span><span> </span><span> </span><span class="token token property">"background_color"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"dot_pattern_color"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"dot_pattern_type"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"corners"</span><span class="token token operator">:</span><span> </span><span class="token token punctuation">{</span><span> </span><span> </span><span class="token token property">"corner_1"</span><span class="token token operator">:</span><span> </span><span class="token token punctuation">{</span><span> </span><span> </span><span class="token token property">"inner_color"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"outer_color"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"shape"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span> </span><span> </span><span class="token token punctuation">}</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"corner_2"</span><span class="token token operator">:</span><span> </span><span class="token token punctuation">{</span><span> </span><span> </span><span class="token token property">"inner_color"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"outer_color"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"shape"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span> </span><span> </span><span class="token token punctuation">}</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"corner_3"</span><span class="token token operator">:</span><span> </span><span class="token token punctuation">{</span><span> </span><span> </span><span class="token token property">"inner_color"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"outer_color"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"shape"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span> </span><span> </span><span class="token token punctuation">}</span><span> </span><span> </span><span class="token token punctuation">}</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"gradient"</span><span class="token token operator">:</span><span> </span><span class="token token punctuation">{</span><span> </span><span> </span><span class="token token property">"style"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"angle"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"number"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"colors"</span><span class="token token operator">:</span><span> </span><span class="token token punctuation">[</span><span> </span><span> </span><span class="token token punctuation">{</span><span> </span><span> </span><span class="token token property">"color"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"offset"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"integer"</span><span> </span><span> </span><span class="token token punctuation">}</span><span> </span><span> </span><span class="token token punctuation">]</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"exclude_corners"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"boolean"</span><span> </span><span> </span><span class="token token punctuation">}</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"background_gradient"</span><span class="token token operator">:</span><span> </span><span class="token token punctuation">{</span><span> </span><span> </span><span class="token token property">"style"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"angle"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"number"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"colors"</span><span class="token token operator">:</span><span> </span><span class="token token punctuation">[</span><span> </span><span> </span><span class="token token punctuation">{</span><span> </span><span> </span><span class="token token property">"color"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"offset"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"integer"</span><span> </span><span> </span><span class="token token punctuation">}</span><span> </span><span> </span><span class="token token punctuation">]</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"exclude_corners"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"boolean"</span><span> </span><span> </span><span class="token token punctuation">}</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"logo"</span><span class="token token operator">:</span><span> </span><span class="token token punctuation">{</span><span> </span><span> </span><span class="token token property">"image_guid"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span> </span><span> </span><span class="token token punctuation">}</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"frame"</span><span class="token token operator">:</span><span> </span><span class="token token punctuation">{</span><span> </span><span> </span><span class="token token property">"id"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"colors"</span><span class="token token operator">:</span><span> </span><span class="token token punctuation">{</span><span> </span><span> </span><span class="token token property">"primary"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"secondary"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"background"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span> </span><span> </span><span class="token token punctuation">}</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"text"</span><span class="token token operator">:</span><span> </span><span class="token token punctuation">{</span><span> </span><span> </span><span class="token token property">"primary"</span><span class="token token operator">:</span><span> </span><span class="token token punctuation">{</span><span> </span><span> </span><span class="token token property">"content"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"color"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span> </span><span> </span><span class="token token punctuation">}</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"secondary"</span><span class="token token operator">:</span><span> </span><span class="token token punctuation">{</span><span> </span><span> </span><span class="token token property">"content"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"color"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span> </span><span> </span><span class="token token punctuation">}</span><span> </span><span> </span><span class="token token punctuation">}</span><span> </span><span> </span><span class="token token punctuation">}</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"text"</span><span class="token token operator">:</span><span> </span><span class="token token punctuation">{</span><span> </span><span> </span><span class="token token property">"center"</span><span class="token token operator">:</span><span> </span><span class="token token punctuation">{</span><span> </span><span> </span><span class="token token property">"content"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"color"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span> </span><span> </span><span class="token token punctuation">}</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"top"</span><span class="token token operator">:</span><span> </span><span class="token token punctuation">{</span><span> </span><span> </span><span class="token token property">"content"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"color"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span> </span><span> </span><span class="token token punctuation">}</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"bottom"</span><span class="token token operator">:</span><span> </span><span class="token token punctuation">{</span><span> </span><span> </span><span class="token token property">"content"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"color"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span> </span><span> </span><span class="token token punctuation">}</span><span> </span><span> </span><span class="token token punctuation">}</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"branding"</span><span class="token token operator">:</span><span> </span><span class="token token punctuation">{</span><span> </span><span> </span><span class="token token property">"bitly_brand"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"boolean"</span><span> </span><span> </span><span class="token token punctuation">}</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"spec_settings"</span><span class="token token operator">:</span><span> </span><span class="token token punctuation">{</span><span> </span><span> </span><span class="token token property">"error_correction"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"integer"</span><span> </span><span> </span><span class="token token punctuation">}</span><span> </span><span> </span><span class="token token punctuation">}</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"qr_code_type"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"bitlink_id"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"long_urls"</span><span class="token token operator">:</span><span> </span><span class="token token punctuation">[</span><span> </span><span> </span><span class="token token" style="color:#51763e">"string"</span><span> </span><span> </span><span class="token token punctuation">]</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"serialized_content"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"archived"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"boolean"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"created"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"modified"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span> </span><span></span><span class="token token punctuation">}</span></code></pre></div></div></div></div></div><div class="MethodDetail_methodContainer__3EF7h" id="listQRMinimal"><div class="MethodDetail_method__fyEiw"><div><h3 class="MethodHeader_h3__seOfC">Retrieve QR Codes by Group</h3><h4 class="MethodHeader_description__3_p_p"><div class="MethodHeader_iconStyle__x5Ow4"><svg viewBox="0 0 14 6" xmlns="http://www.w3.org/2000/svg" class="IconRest_restIcon__3pju8 get"><title>Get</title><path d="M2.587 6c.307 0 .607-.044.9-.132.295-.088.533-.217.716-.387V2.876H2.271v.825h1.027v1.145a.772.772 0 0 1-.239.1 1.4 1.4 0 0 1-.383.049 1.338 1.338 0 0 1-1.083-.52c-.135-.17-.24-.379-.316-.626a2.879 2.879 0 0 1-.113-.84c0-.352.038-.655.113-.907.076-.253.182-.46.32-.623.137-.162.3-.281.488-.358a1.783 1.783 0 0 1 .97-.082l.13.032v.915h.889V.28a3.182 3.182 0 0 0-.59-.202A3.507 3.507 0 0 0 2.676 0c-.313 0-.628.055-.946.165a2.4 2.4 0 0 0-.861.523 2.707 2.707 0 0 0-.627.92C.081 1.98 0 2.433 0 2.966c0 .506.067.946.202 1.323.135.376.318.692.55.948a2.2 2.2 0 0 0 .82.572A2.7 2.7 0 0 0 2.587 6Zm6.24-.115V4.879H6.184V3.47h2.4V2.465h-2.4V1.121h2.602V.115h-3.71v5.77h3.75Zm4.43 0v-.907h-.914V1.022h.768v.997H14V.115H9.57V2.02h.89v-.997h.776v3.956h-.922v.907h2.942Z"></path></svg></div> /v4/groups/{group_guid}/qr-codes</h4><p class="MethodHeader_description__3_p_p">Retrieves a list of QR codes matching the filter settings. Values are in reverse chronological order. The pagination occurs by calling the next link in the pagination response object. </p></div><div><h4 class="ParameterList_h4__nH9G8 ParameterList_dividing__wRGRx">Path Parameters</h4><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">group_guid</span><span class="Parameter_type__djM_s">string</span><span class="Parameter_required__pcK_H">Required</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">A GUID for a Bitly group</div></div></div><div><h4 class="ParameterList_h4__nH9G8 ParameterList_dividing__wRGRx">Query Parameters</h4><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">has_render_customizations</span><span class="Parameter_type__djM_s">string</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">Whether or not QRCode has any render customizations (like color or shape changes)</div><div class="Parameter_default__HHgG0 Parameter_spacer__JKXbH">Default: <span class="Parameter_label__DUY7G">"both"</span></div><div class="Parameter_enum__csO6P Parameter_spacer__JKXbH">Enum: <span class="Parameter_label__DUY7G">"on"</span><span class="Parameter_label__DUY7G">"off"</span><span class="Parameter_label__DUY7G">"both"</span></div></div><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">size</span><span class="Parameter_type__djM_s">integer</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">The quantity of items to be be returned</div><div class="Parameter_default__HHgG0 Parameter_spacer__JKXbH">Default: <span class="Parameter_label__DUY7G">50</span></div></div><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">search_after</span><span class="Parameter_type__djM_s">string</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">Token used to search next batch of qr codes, only use response from API as input value.</div></div><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">query</span><span class="Parameter_type__djM_s">string</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">The value that you would like to search</div></div><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">created_before</span><span class="Parameter_type__djM_s">integer</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">Timestamp as an integer unix epoch (seconds only)</div></div><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">created_after</span><span class="Parameter_type__djM_s">integer</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">Timestamp as an integer unix epoch (seconds only)</div></div><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">archived</span><span class="Parameter_type__djM_s">string</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">Whether or not to include archived resources</div><div class="Parameter_default__HHgG0 Parameter_spacer__JKXbH">Default: <span class="Parameter_label__DUY7G">"off"</span></div><div class="Parameter_enum__csO6P Parameter_spacer__JKXbH">Enum: <span class="Parameter_label__DUY7G">"on"</span><span class="Parameter_label__DUY7G">"off"</span><span class="Parameter_label__DUY7G">"both"</span></div></div><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">creating_login</span><span class="Parameter_type__djM_s">array</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">Filter by the login of the authenticated user that created the QR Code</div></div><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">qrc_type</span><span class="Parameter_type__djM_s">array</span></div><div class="Parameter_default__HHgG0 Parameter_spacer__JKXbH">Default: <span class="Parameter_label__DUY7G">["bitlink", "long_url"]</span></div></div><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">is_gs1</span><span class="Parameter_type__djM_s">string</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">a filter value if the resource is a GS1 QR code</div><div class="Parameter_default__HHgG0 Parameter_spacer__JKXbH">Default: <span class="Parameter_label__DUY7G">"both"</span></div><div class="Parameter_enum__csO6P Parameter_spacer__JKXbH">Enum: <span class="Parameter_label__DUY7G">"on"</span><span class="Parameter_label__DUY7G">"off"</span><span class="Parameter_label__DUY7G">"both"</span></div></div></div></div><div class="MethodDetail_examples__8nXeM"><div><label class="CodeSyntaxSelector_header__6P_Jc CodeSyntaxSelector_headerDark__hI3A0"><span>Request</span><div class="CodeSyntaxSelector_header__6P_Jc CodeSyntaxSelector_headerDark__hI3A0"><div class="Select_wrapper__58utF Select_dark__KPIws"><select class="Select_select__qXz_Z Select_dark__KPIws" aria-label="Select" autoComplete="off"><option value="cURL" selected="">cURL</option><option value="Node">Node</option><option value="Browser">Browser</option><option value="Go">Go</option><option value="Python">Python</option></select><svg viewBox="0 0 8 14" xmlns="http://www.w3.org/2000/svg"><path d="M6.463 7 .987 1.66a.61.61 0 0 1 0-.878.648.648 0 0 1 .9 0L7.813 6.56a.61.61 0 0 1 0 .878l-5.926 5.78a.648.648 0 0 1-.9 0 .61.61 0 0 1 0-.879L6.463 7Z"></path></svg></div></div></label><div class="CodeSyntaxSelector_body__hBJ7j CodeSyntaxSelector_bodyDark__cizVw"><div class="CodeBlock_codeBlock__KlURa"><pre tabindex="0" style="color:#ffffff;font-family:ProximaNova, monospace;line-height:1.2;font-size:1rem"><code class="language-bash" style="white-space:pre"><span class="token token" style="color:#ee6123">curl</span><span> </span><span class="token token punctuation">\</span><span> </span><span>-H </span><span class="token token" style="color:#acda95">'Authorization: Bearer {TOKEN}'</span><span> </span><span class="token token punctuation">\</span><span> </span><span>-X GET </span><span class="token token punctuation">\</span><span> </span><span>https://api-ssl.bitly.com/v4/groups/Ba1bc23dE4F/qr-codes?has_render_customizations</span><span class="token token operator">=</span><span>both</span><span class="token token operator">&</span><span class="token token assign-left variable">size</span><span class="token token operator">=</span><span class="token token" style="color:#a1b8f3">10</span><span class="token token operator">&</span><span class="token token assign-left variable">search_after</span><span class="token token operator">=</span><span class="token token operator">&</span><span class="token token assign-left variable">query</span><span class="token token operator">=</span><span>api</span><span class="token token operator">&</span><span class="token token assign-left variable">created_before</span><span class="token token operator">=</span><span class="token token" style="color:#a1b8f3">1694529902</span><span class="token token operator">&</span><span class="token token assign-left variable">created_after</span><span class="token token operator">=</span><span class="token token" style="color:#a1b8f3">1694529902</span><span class="token token operator">&</span><span class="token token assign-left variable">archived</span><span class="token token operator">=</span><span>both</span><span class="token token operator">&</span><span class="token token assign-left variable">creating_login</span><span class="token token operator">=</span><span>chauncey</span><span class="token token operator">&</span><span class="token token assign-left variable">qrc_type</span><span class="token token operator">=</span><span class="token token operator">&</span><span class="token token assign-left variable">is_gs1</span><span class="token token operator">=</span><span>both</span></code></pre></div></div></div><div><label class="CodeSyntaxSelector_header__6P_Jc"><span>Response</span><div class="CodeSyntaxSelector_header__6P_Jc"><div class="Select_wrapper__58utF"><select class="Select_select__qXz_Z" aria-label="Select" autoComplete="off"><option value="200" selected="">200 SUCCESS</option><option value="403">403 FORBIDDEN</option><option value="429">429 MONTHLY_LIMIT_EXCEEDED</option><option value="500">500 INTERNAL_ERROR</option></select><svg viewBox="0 0 8 14" xmlns="http://www.w3.org/2000/svg"><path d="M6.463 7 .987 1.66a.61.61 0 0 1 0-.878.648.648 0 0 1 .9 0L7.813 6.56a.61.61 0 0 1 0 .878l-5.926 5.78a.648.648 0 0 1-.9 0 .61.61 0 0 1 0-.879L6.463 7Z"></path></svg></div></div></label><div class="CodeSyntaxSelector_body__hBJ7j"><div class="CodeBlock_codeBlock__KlURa"><pre tabindex="0" style="color:#36383b;font-family:ProximaNova, monospace;line-height:1.2;font-size:1rem"><code class="language-json" style="white-space:pre"><span class="token token punctuation">{</span><span> </span><span> </span><span class="token token property">"qr_codes"</span><span class="token token operator">:</span><span> </span><span class="token token punctuation">[</span><span> </span><span> </span><span class="token token punctuation">{</span><span> </span><span> </span><span class="token token property">"qrcode_id"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"group_guid"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"title"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"is_customized"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"boolean"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"serialized_content"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"qr_code_type"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"long_urls"</span><span class="token token operator">:</span><span> </span><span class="token token punctuation">[</span><span> </span><span> </span><span class="token token" style="color:#51763e">"string"</span><span> </span><span> </span><span class="token token punctuation">]</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"bitlink_id"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"is_gs1"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"boolean"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"created_by"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"archived"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"boolean"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"created"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"modified"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span> </span><span> </span><span class="token token punctuation">}</span><span> </span><span> </span><span class="token token punctuation">]</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"pagination"</span><span class="token token operator">:</span><span> </span><span class="token token punctuation">{</span><span> </span><span> </span><span class="token token property">"next"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"search_after"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"size"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"integer"</span><span> </span><span> </span><span class="token token punctuation">}</span><span> </span><span></span><span class="token token punctuation">}</span></code></pre></div></div></div></div></div><div class="MethodDetail_methodContainer__3EF7h" id="getScanMetricsForQRCode"><div class="MethodDetail_method__fyEiw"><div><h3 class="MethodHeader_h3__seOfC">Get Scans for a QR Code</h3><h4 class="MethodHeader_description__3_p_p"><div class="MethodHeader_iconStyle__x5Ow4"><svg viewBox="0 0 14 6" xmlns="http://www.w3.org/2000/svg" class="IconRest_restIcon__3pju8 get"><title>Get</title><path d="M2.587 6c.307 0 .607-.044.9-.132.295-.088.533-.217.716-.387V2.876H2.271v.825h1.027v1.145a.772.772 0 0 1-.239.1 1.4 1.4 0 0 1-.383.049 1.338 1.338 0 0 1-1.083-.52c-.135-.17-.24-.379-.316-.626a2.879 2.879 0 0 1-.113-.84c0-.352.038-.655.113-.907.076-.253.182-.46.32-.623.137-.162.3-.281.488-.358a1.783 1.783 0 0 1 .97-.082l.13.032v.915h.889V.28a3.182 3.182 0 0 0-.59-.202A3.507 3.507 0 0 0 2.676 0c-.313 0-.628.055-.946.165a2.4 2.4 0 0 0-.861.523 2.707 2.707 0 0 0-.627.92C.081 1.98 0 2.433 0 2.966c0 .506.067.946.202 1.323.135.376.318.692.55.948a2.2 2.2 0 0 0 .82.572A2.7 2.7 0 0 0 2.587 6Zm6.24-.115V4.879H6.184V3.47h2.4V2.465h-2.4V1.121h2.602V.115h-3.71v5.77h3.75Zm4.43 0v-.907h-.914V1.022h.768v.997H14V.115H9.57V2.02h.89v-.997h.776v3.956h-.922v.907h2.942Z"></path></svg></div> /v4/qr-codes/{qrcode_id}/scans</h4><p class="MethodHeader_description__3_p_p">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.</p></div><div><h4 class="ParameterList_h4__nH9G8 ParameterList_dividing__wRGRx">Path Parameters</h4><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">qrcode_id</span><span class="Parameter_type__djM_s">string</span><span class="Parameter_required__pcK_H">Required</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">The QR Code ID</div></div></div><div><h4 class="ParameterList_h4__nH9G8 ParameterList_dividing__wRGRx">Query Parameters</h4><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">unit</span><span class="Parameter_type__djM_s">string</span><span class="Parameter_required__pcK_H">Required</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">A unit of time</div><div class="Parameter_default__HHgG0 Parameter_spacer__JKXbH">Default: <span class="Parameter_label__DUY7G">"day"</span></div><div class="Parameter_enum__csO6P Parameter_spacer__JKXbH">Enum: <span class="Parameter_label__DUY7G">"minute"</span><span class="Parameter_label__DUY7G">"hour"</span><span class="Parameter_label__DUY7G">"day"</span><span class="Parameter_label__DUY7G">"week"</span><span class="Parameter_label__DUY7G">"month"</span></div></div><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">units</span><span class="Parameter_type__djM_s">integer</span><span class="Parameter_required__pcK_H">Required</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">An integer representing the time units to query data for. pass -1 to return all units of time</div><div class="Parameter_default__HHgG0 Parameter_spacer__JKXbH">Default: <span class="Parameter_label__DUY7G">-1</span></div></div><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">unit_reference</span><span class="Parameter_type__djM_s">string</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">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)</div></div></div></div><div class="MethodDetail_examples__8nXeM"><div><label class="CodeSyntaxSelector_header__6P_Jc CodeSyntaxSelector_headerDark__hI3A0"><span>Request</span><div class="CodeSyntaxSelector_header__6P_Jc CodeSyntaxSelector_headerDark__hI3A0"><div class="Select_wrapper__58utF Select_dark__KPIws"><select class="Select_select__qXz_Z Select_dark__KPIws" aria-label="Select" autoComplete="off"><option value="cURL" selected="">cURL</option><option value="Node">Node</option><option value="Browser">Browser</option><option value="Go">Go</option><option value="Python">Python</option></select><svg viewBox="0 0 8 14" xmlns="http://www.w3.org/2000/svg"><path d="M6.463 7 .987 1.66a.61.61 0 0 1 0-.878.648.648 0 0 1 .9 0L7.813 6.56a.61.61 0 0 1 0 .878l-5.926 5.78a.648.648 0 0 1-.9 0 .61.61 0 0 1 0-.879L6.463 7Z"></path></svg></div></div></label><div class="CodeSyntaxSelector_body__hBJ7j CodeSyntaxSelector_bodyDark__cizVw"><div class="CodeBlock_codeBlock__KlURa"><pre tabindex="0" style="color:#ffffff;font-family:ProximaNova, monospace;line-height:1.2;font-size:1rem"><code class="language-bash" style="white-space:pre"><span class="token token" style="color:#ee6123">curl</span><span> </span><span class="token token punctuation">\</span><span> </span><span>-H </span><span class="token token" style="color:#acda95">'Authorization: Bearer {TOKEN}'</span><span> </span><span class="token token punctuation">\</span><span> </span><span>-X GET </span><span class="token token punctuation">\</span><span> </span><span>https://api-ssl.bitly.com/v4/qr-codes/Qabcde12345/scans?unit</span><span class="token token operator">=</span><span>month</span><span class="token token operator">&</span><span class="token token assign-left variable">units</span><span class="token token operator">=</span><span class="token token" style="color:#a1b8f3">1</span><span class="token token operator">&</span><span class="token token assign-left variable">unit_reference</span><span class="token token operator">=</span><span class="token token" style="color:#a1b8f3">2006</span><span>-01-02T15%3A04%3A05-0700</span></code></pre></div></div></div><div><label class="CodeSyntaxSelector_header__6P_Jc"><span>Response</span><div class="CodeSyntaxSelector_header__6P_Jc"><div class="Select_wrapper__58utF"><select class="Select_select__qXz_Z" aria-label="Select" autoComplete="off"><option value="200" selected="">200 SUCCESS</option><option value="400">400 BAD_REQUEST</option><option value="403">403 FORBIDDEN</option><option value="404">404 NOT_FOUND</option><option value="410">410 GONE</option><option value="500">500 INTERNAL_ERROR</option><option value="503">503 TEMPORARILY_UNAVAILABLE</option></select><svg viewBox="0 0 8 14" xmlns="http://www.w3.org/2000/svg"><path d="M6.463 7 .987 1.66a.61.61 0 0 1 0-.878.648.648 0 0 1 .9 0L7.813 6.56a.61.61 0 0 1 0 .878l-5.926 5.78a.648.648 0 0 1-.9 0 .61.61 0 0 1 0-.879L6.463 7Z"></path></svg></div></div></label><div class="CodeSyntaxSelector_body__hBJ7j"><div class="CodeBlock_codeBlock__KlURa"><pre tabindex="0" style="color:#36383b;font-family:ProximaNova, monospace;line-height:1.2;font-size:1rem"><code class="language-json" style="white-space:pre"><span class="token token punctuation">{</span><span> </span><span> </span><span class="token token property">"scans"</span><span class="token token operator">:</span><span> </span><span class="token token punctuation">[</span><span> </span><span> </span><span class="token token punctuation">{</span><span> </span><span> </span><span class="token token property">"scans"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"integer"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"date"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span> </span><span> </span><span class="token token punctuation">}</span><span> </span><span> </span><span class="token token punctuation">]</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"units"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"integer"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"unit"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"unit_reference"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span> </span><span></span><span class="token token punctuation">}</span></code></pre></div></div></div></div></div><div class="MethodDetail_methodContainer__3EF7h" id="getScanMetricsSummaryForQRCode"><div class="MethodDetail_method__fyEiw"><div><h3 class="MethodHeader_h3__seOfC">Get Scans Summary for a QR Code</h3><h4 class="MethodHeader_description__3_p_p"><div class="MethodHeader_iconStyle__x5Ow4"><svg viewBox="0 0 14 6" xmlns="http://www.w3.org/2000/svg" class="IconRest_restIcon__3pju8 get"><title>Get</title><path d="M2.587 6c.307 0 .607-.044.9-.132.295-.088.533-.217.716-.387V2.876H2.271v.825h1.027v1.145a.772.772 0 0 1-.239.1 1.4 1.4 0 0 1-.383.049 1.338 1.338 0 0 1-1.083-.52c-.135-.17-.24-.379-.316-.626a2.879 2.879 0 0 1-.113-.84c0-.352.038-.655.113-.907.076-.253.182-.46.32-.623.137-.162.3-.281.488-.358a1.783 1.783 0 0 1 .97-.082l.13.032v.915h.889V.28a3.182 3.182 0 0 0-.59-.202A3.507 3.507 0 0 0 2.676 0c-.313 0-.628.055-.946.165a2.4 2.4 0 0 0-.861.523 2.707 2.707 0 0 0-.627.92C.081 1.98 0 2.433 0 2.966c0 .506.067.946.202 1.323.135.376.318.692.55.948a2.2 2.2 0 0 0 .82.572A2.7 2.7 0 0 0 2.587 6Zm6.24-.115V4.879H6.184V3.47h2.4V2.465h-2.4V1.121h2.602V.115h-3.71v5.77h3.75Zm4.43 0v-.907h-.914V1.022h.768v.997H14V.115H9.57V2.02h.89v-.997h.776v3.956h-.922v.907h2.942Z"></path></svg></div> /v4/qr-codes/{qrcode_id}/scans/summary</h4><p class="MethodHeader_description__3_p_p">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.</p></div><div><h4 class="ParameterList_h4__nH9G8 ParameterList_dividing__wRGRx">Path Parameters</h4><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">qrcode_id</span><span class="Parameter_type__djM_s">string</span><span class="Parameter_required__pcK_H">Required</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">The QR Code ID</div></div></div><div><h4 class="ParameterList_h4__nH9G8 ParameterList_dividing__wRGRx">Query Parameters</h4><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">unit</span><span class="Parameter_type__djM_s">string</span><span class="Parameter_required__pcK_H">Required</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">A unit of time</div><div class="Parameter_default__HHgG0 Parameter_spacer__JKXbH">Default: <span class="Parameter_label__DUY7G">"day"</span></div><div class="Parameter_enum__csO6P Parameter_spacer__JKXbH">Enum: <span class="Parameter_label__DUY7G">"minute"</span><span class="Parameter_label__DUY7G">"hour"</span><span class="Parameter_label__DUY7G">"day"</span><span class="Parameter_label__DUY7G">"week"</span><span class="Parameter_label__DUY7G">"month"</span></div></div><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">units</span><span class="Parameter_type__djM_s">integer</span><span class="Parameter_required__pcK_H">Required</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">An integer representing the time units to query data for. pass -1 to return all units of time</div><div class="Parameter_default__HHgG0 Parameter_spacer__JKXbH">Default: <span class="Parameter_label__DUY7G">-1</span></div></div><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">unit_reference</span><span class="Parameter_type__djM_s">string</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">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)</div></div></div></div><div class="MethodDetail_examples__8nXeM"><div><label class="CodeSyntaxSelector_header__6P_Jc CodeSyntaxSelector_headerDark__hI3A0"><span>Request</span><div class="CodeSyntaxSelector_header__6P_Jc CodeSyntaxSelector_headerDark__hI3A0"><div class="Select_wrapper__58utF Select_dark__KPIws"><select class="Select_select__qXz_Z Select_dark__KPIws" aria-label="Select" autoComplete="off"><option value="cURL" selected="">cURL</option><option value="Node">Node</option><option value="Browser">Browser</option><option value="Go">Go</option><option value="Python">Python</option></select><svg viewBox="0 0 8 14" xmlns="http://www.w3.org/2000/svg"><path d="M6.463 7 .987 1.66a.61.61 0 0 1 0-.878.648.648 0 0 1 .9 0L7.813 6.56a.61.61 0 0 1 0 .878l-5.926 5.78a.648.648 0 0 1-.9 0 .61.61 0 0 1 0-.879L6.463 7Z"></path></svg></div></div></label><div class="CodeSyntaxSelector_body__hBJ7j CodeSyntaxSelector_bodyDark__cizVw"><div class="CodeBlock_codeBlock__KlURa"><pre tabindex="0" style="color:#ffffff;font-family:ProximaNova, monospace;line-height:1.2;font-size:1rem"><code class="language-bash" style="white-space:pre"><span class="token token" style="color:#ee6123">curl</span><span> </span><span class="token token punctuation">\</span><span> </span><span>-H </span><span class="token token" style="color:#acda95">'Authorization: Bearer {TOKEN}'</span><span> </span><span class="token token punctuation">\</span><span> </span><span>-X GET </span><span class="token token punctuation">\</span><span> </span><span>https://api-ssl.bitly.com/v4/qr-codes/Qabcde12345/scans/summary?unit</span><span class="token token operator">=</span><span>month</span><span class="token token operator">&</span><span class="token token assign-left variable">units</span><span class="token token operator">=</span><span class="token token" style="color:#a1b8f3">1</span><span class="token token operator">&</span><span class="token token assign-left variable">unit_reference</span><span class="token token operator">=</span><span class="token token" style="color:#a1b8f3">2006</span><span>-01-02T15%3A04%3A05-0700</span></code></pre></div></div></div><div><label class="CodeSyntaxSelector_header__6P_Jc"><span>Response</span><div class="CodeSyntaxSelector_header__6P_Jc"><div class="Select_wrapper__58utF"><select class="Select_select__qXz_Z" aria-label="Select" autoComplete="off"><option value="200" selected="">200 SUCCESS</option><option value="400">400 BAD_REQUEST</option><option value="403">403 FORBIDDEN</option><option value="404">404 NOT_FOUND</option><option value="410">410 GONE</option><option value="500">500 INTERNAL_ERROR</option><option value="503">503 TEMPORARILY_UNAVAILABLE</option></select><svg viewBox="0 0 8 14" xmlns="http://www.w3.org/2000/svg"><path d="M6.463 7 .987 1.66a.61.61 0 0 1 0-.878.648.648 0 0 1 .9 0L7.813 6.56a.61.61 0 0 1 0 .878l-5.926 5.78a.648.648 0 0 1-.9 0 .61.61 0 0 1 0-.879L6.463 7Z"></path></svg></div></div></label><div class="CodeSyntaxSelector_body__hBJ7j"><div class="CodeBlock_codeBlock__KlURa"><pre tabindex="0" style="color:#36383b;font-family:ProximaNova, monospace;line-height:1.2;font-size:1rem"><code class="language-json" style="white-space:pre"><span class="token token punctuation">{</span><span> </span><span> </span><span class="token token property">"total_scans"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"integer"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"units"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"integer"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"unit"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"unit_reference"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span> </span><span></span><span class="token token punctuation">}</span></code></pre></div></div></div></div></div><div class="MethodDetail_methodContainer__3EF7h" id="getScanMetricsForQRCodeByCountries"><div class="MethodDetail_method__fyEiw"><div><h3 class="MethodHeader_h3__seOfC">Get Scans for a QR Code by Country</h3><h4 class="MethodHeader_description__3_p_p"><div class="MethodHeader_iconStyle__x5Ow4"><svg viewBox="0 0 14 6" xmlns="http://www.w3.org/2000/svg" class="IconRest_restIcon__3pju8 get"><title>Get</title><path d="M2.587 6c.307 0 .607-.044.9-.132.295-.088.533-.217.716-.387V2.876H2.271v.825h1.027v1.145a.772.772 0 0 1-.239.1 1.4 1.4 0 0 1-.383.049 1.338 1.338 0 0 1-1.083-.52c-.135-.17-.24-.379-.316-.626a2.879 2.879 0 0 1-.113-.84c0-.352.038-.655.113-.907.076-.253.182-.46.32-.623.137-.162.3-.281.488-.358a1.783 1.783 0 0 1 .97-.082l.13.032v.915h.889V.28a3.182 3.182 0 0 0-.59-.202A3.507 3.507 0 0 0 2.676 0c-.313 0-.628.055-.946.165a2.4 2.4 0 0 0-.861.523 2.707 2.707 0 0 0-.627.92C.081 1.98 0 2.433 0 2.966c0 .506.067.946.202 1.323.135.376.318.692.55.948a2.2 2.2 0 0 0 .82.572A2.7 2.7 0 0 0 2.587 6Zm6.24-.115V4.879H6.184V3.47h2.4V2.465h-2.4V1.121h2.602V.115h-3.71v5.77h3.75Zm4.43 0v-.907h-.914V1.022h.768v.997H14V.115H9.57V2.02h.89v-.997h.776v3.956h-.922v.907h2.942Z"></path></svg></div> /v4/qr-codes/{qrcode_id}/scans/countries</h4><p class="MethodHeader_description__3_p_p">Returns the country origins of scan traffic for the specified QR Code.</p></div><div><h4 class="ParameterList_h4__nH9G8 ParameterList_dividing__wRGRx">Path Parameters</h4><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">qrcode_id</span><span class="Parameter_type__djM_s">string</span><span class="Parameter_required__pcK_H">Required</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">The QR Code ID</div></div></div><div><h4 class="ParameterList_h4__nH9G8 ParameterList_dividing__wRGRx">Query Parameters</h4><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">unit</span><span class="Parameter_type__djM_s">string</span><span class="Parameter_required__pcK_H">Required</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">A unit of time</div><div class="Parameter_default__HHgG0 Parameter_spacer__JKXbH">Default: <span class="Parameter_label__DUY7G">"day"</span></div><div class="Parameter_enum__csO6P Parameter_spacer__JKXbH">Enum: <span class="Parameter_label__DUY7G">"minute"</span><span class="Parameter_label__DUY7G">"hour"</span><span class="Parameter_label__DUY7G">"day"</span><span class="Parameter_label__DUY7G">"week"</span><span class="Parameter_label__DUY7G">"month"</span></div></div><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">units</span><span class="Parameter_type__djM_s">integer</span><span class="Parameter_required__pcK_H">Required</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">An integer representing the time units to query data for. pass -1 to return all units of time</div><div class="Parameter_default__HHgG0 Parameter_spacer__JKXbH">Default: <span class="Parameter_label__DUY7G">-1</span></div></div><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">size</span><span class="Parameter_type__djM_s">integer</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">The quantity of items to be be returned</div><div class="Parameter_default__HHgG0 Parameter_spacer__JKXbH">Default: <span class="Parameter_label__DUY7G">50</span></div></div><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">unit_reference</span><span class="Parameter_type__djM_s">string</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">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)</div></div></div></div><div class="MethodDetail_examples__8nXeM"><div><label class="CodeSyntaxSelector_header__6P_Jc CodeSyntaxSelector_headerDark__hI3A0"><span>Request</span><div class="CodeSyntaxSelector_header__6P_Jc CodeSyntaxSelector_headerDark__hI3A0"><div class="Select_wrapper__58utF Select_dark__KPIws"><select class="Select_select__qXz_Z Select_dark__KPIws" aria-label="Select" autoComplete="off"><option value="cURL" selected="">cURL</option><option value="Node">Node</option><option value="Browser">Browser</option><option value="Go">Go</option><option value="Python">Python</option></select><svg viewBox="0 0 8 14" xmlns="http://www.w3.org/2000/svg"><path d="M6.463 7 .987 1.66a.61.61 0 0 1 0-.878.648.648 0 0 1 .9 0L7.813 6.56a.61.61 0 0 1 0 .878l-5.926 5.78a.648.648 0 0 1-.9 0 .61.61 0 0 1 0-.879L6.463 7Z"></path></svg></div></div></label><div class="CodeSyntaxSelector_body__hBJ7j CodeSyntaxSelector_bodyDark__cizVw"><div class="CodeBlock_codeBlock__KlURa"><pre tabindex="0" style="color:#ffffff;font-family:ProximaNova, monospace;line-height:1.2;font-size:1rem"><code class="language-bash" style="white-space:pre"><span class="token token" style="color:#ee6123">curl</span><span> </span><span class="token token punctuation">\</span><span> </span><span>-H </span><span class="token token" style="color:#acda95">'Authorization: Bearer {TOKEN}'</span><span> </span><span class="token token punctuation">\</span><span> </span><span>-X GET </span><span class="token token punctuation">\</span><span> </span><span>https://api-ssl.bitly.com/v4/qr-codes/Qabcde12345/scans/countries?unit</span><span class="token token operator">=</span><span>month</span><span class="token token operator">&</span><span class="token token assign-left variable">units</span><span class="token token operator">=</span><span class="token token" style="color:#a1b8f3">1</span><span class="token token operator">&</span><span class="token token assign-left variable">size</span><span class="token token operator">=</span><span class="token token" style="color:#a1b8f3">10</span><span class="token token operator">&</span><span class="token token assign-left variable">unit_reference</span><span class="token token operator">=</span><span class="token token" style="color:#a1b8f3">2006</span><span>-01-02T15%3A04%3A05-0700</span></code></pre></div></div></div><div><label class="CodeSyntaxSelector_header__6P_Jc"><span>Response</span><div class="CodeSyntaxSelector_header__6P_Jc"><div class="Select_wrapper__58utF"><select class="Select_select__qXz_Z" aria-label="Select" autoComplete="off"><option value="200" selected="">200 SUCCESS</option><option value="400">400 BAD_REQUEST</option><option value="403">403 FORBIDDEN</option><option value="404">404 NOT_FOUND</option><option value="410">410 GONE</option><option value="500">500 INTERNAL_ERROR</option><option value="503">503 TEMPORARILY_UNAVAILABLE</option></select><svg viewBox="0 0 8 14" xmlns="http://www.w3.org/2000/svg"><path d="M6.463 7 .987 1.66a.61.61 0 0 1 0-.878.648.648 0 0 1 .9 0L7.813 6.56a.61.61 0 0 1 0 .878l-5.926 5.78a.648.648 0 0 1-.9 0 .61.61 0 0 1 0-.879L6.463 7Z"></path></svg></div></div></label><div class="CodeSyntaxSelector_body__hBJ7j"><div class="Response_formatSelect__Wt_qa"><div class="ButtonToggle_buttonToggle__6YJhd"><label class="ButtonToggle_label__ohGaG"><input class="ButtonToggle_input__vkfUm" name="getScanMetricsForQRCodeByCountries" type="radio" checked=""/><span>json</span></label><label class="ButtonToggle_label__ohGaG"><input class="ButtonToggle_input__vkfUm" name="getScanMetricsForQRCodeByCountries" type="radio"/><span>csv</span></label></div></div><div class="CodeBlock_codeBlock__KlURa"><pre tabindex="0" style="color:#36383b;font-family:ProximaNova, monospace;line-height:1.2;font-size:1rem"><code class="language-json" style="white-space:pre"><span class="token token punctuation">{</span><span> </span><span> </span><span class="token token property">"unit"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"units"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"integer"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"facet"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"unit_reference"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"metrics"</span><span class="token token operator">:</span><span> </span><span class="token token punctuation">[</span><span> </span><span> </span><span class="token token punctuation">{</span><span> </span><span> </span><span class="token token property">"scans"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"integer"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"value"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span> </span><span> </span><span class="token token punctuation">}</span><span> </span><span> </span><span class="token token punctuation">]</span><span> </span><span></span><span class="token token punctuation">}</span></code></pre></div></div></div></div></div><div class="MethodDetail_methodContainer__3EF7h" id="getScanMetricsForQRCodeByCities"><div class="MethodDetail_method__fyEiw"><div><h3 class="MethodHeader_h3__seOfC">Get Metrics for a QR Code by City</h3><h4 class="MethodHeader_description__3_p_p"><div class="MethodHeader_iconStyle__x5Ow4"><svg viewBox="0 0 14 6" xmlns="http://www.w3.org/2000/svg" class="IconRest_restIcon__3pju8 get"><title>Get</title><path d="M2.587 6c.307 0 .607-.044.9-.132.295-.088.533-.217.716-.387V2.876H2.271v.825h1.027v1.145a.772.772 0 0 1-.239.1 1.4 1.4 0 0 1-.383.049 1.338 1.338 0 0 1-1.083-.52c-.135-.17-.24-.379-.316-.626a2.879 2.879 0 0 1-.113-.84c0-.352.038-.655.113-.907.076-.253.182-.46.32-.623.137-.162.3-.281.488-.358a1.783 1.783 0 0 1 .97-.082l.13.032v.915h.889V.28a3.182 3.182 0 0 0-.59-.202A3.507 3.507 0 0 0 2.676 0c-.313 0-.628.055-.946.165a2.4 2.4 0 0 0-.861.523 2.707 2.707 0 0 0-.627.92C.081 1.98 0 2.433 0 2.966c0 .506.067.946.202 1.323.135.376.318.692.55.948a2.2 2.2 0 0 0 .82.572A2.7 2.7 0 0 0 2.587 6Zm6.24-.115V4.879H6.184V3.47h2.4V2.465h-2.4V1.121h2.602V.115h-3.71v5.77h3.75Zm4.43 0v-.907h-.914V1.022h.768v.997H14V.115H9.57V2.02h.89v-.997h.776v3.956h-.922v.907h2.942Z"></path></svg></div> /v4/qr-codes/{qrcode_id}/scans/cities</h4><p class="MethodHeader_description__3_p_p">Returns the city origins of scan traffic for the specified QR Code.</p></div><div><h4 class="ParameterList_h4__nH9G8 ParameterList_dividing__wRGRx">Path Parameters</h4><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">qrcode_id</span><span class="Parameter_type__djM_s">string</span><span class="Parameter_required__pcK_H">Required</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">The QR Code ID</div></div></div><div><h4 class="ParameterList_h4__nH9G8 ParameterList_dividing__wRGRx">Query Parameters</h4><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">unit</span><span class="Parameter_type__djM_s">string</span><span class="Parameter_required__pcK_H">Required</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">A unit of time</div><div class="Parameter_default__HHgG0 Parameter_spacer__JKXbH">Default: <span class="Parameter_label__DUY7G">"day"</span></div><div class="Parameter_enum__csO6P Parameter_spacer__JKXbH">Enum: <span class="Parameter_label__DUY7G">"minute"</span><span class="Parameter_label__DUY7G">"hour"</span><span class="Parameter_label__DUY7G">"day"</span><span class="Parameter_label__DUY7G">"week"</span><span class="Parameter_label__DUY7G">"month"</span></div></div><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">units</span><span class="Parameter_type__djM_s">integer</span><span class="Parameter_required__pcK_H">Required</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">An integer representing the time units to query data for. pass -1 to return all units of time</div><div class="Parameter_default__HHgG0 Parameter_spacer__JKXbH">Default: <span class="Parameter_label__DUY7G">-1</span></div></div><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">size</span><span class="Parameter_type__djM_s">integer</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">The quantity of items to be be returned</div><div class="Parameter_default__HHgG0 Parameter_spacer__JKXbH">Default: <span class="Parameter_label__DUY7G">50</span></div></div><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">unit_reference</span><span class="Parameter_type__djM_s">string</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">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)</div></div></div></div><div class="MethodDetail_examples__8nXeM"><div><label class="CodeSyntaxSelector_header__6P_Jc CodeSyntaxSelector_headerDark__hI3A0"><span>Request</span><div class="CodeSyntaxSelector_header__6P_Jc CodeSyntaxSelector_headerDark__hI3A0"><div class="Select_wrapper__58utF Select_dark__KPIws"><select class="Select_select__qXz_Z Select_dark__KPIws" aria-label="Select" autoComplete="off"><option value="cURL" selected="">cURL</option><option value="Node">Node</option><option value="Browser">Browser</option><option value="Go">Go</option><option value="Python">Python</option></select><svg viewBox="0 0 8 14" xmlns="http://www.w3.org/2000/svg"><path d="M6.463 7 .987 1.66a.61.61 0 0 1 0-.878.648.648 0 0 1 .9 0L7.813 6.56a.61.61 0 0 1 0 .878l-5.926 5.78a.648.648 0 0 1-.9 0 .61.61 0 0 1 0-.879L6.463 7Z"></path></svg></div></div></label><div class="CodeSyntaxSelector_body__hBJ7j CodeSyntaxSelector_bodyDark__cizVw"><div class="CodeBlock_codeBlock__KlURa"><pre tabindex="0" style="color:#ffffff;font-family:ProximaNova, monospace;line-height:1.2;font-size:1rem"><code class="language-bash" style="white-space:pre"><span class="token token" style="color:#ee6123">curl</span><span> </span><span class="token token punctuation">\</span><span> </span><span>-H </span><span class="token token" style="color:#acda95">'Authorization: Bearer {TOKEN}'</span><span> </span><span class="token token punctuation">\</span><span> </span><span>-X GET </span><span class="token token punctuation">\</span><span> </span><span>https://api-ssl.bitly.com/v4/qr-codes/Qabcde12345/scans/cities?unit</span><span class="token token operator">=</span><span>month</span><span class="token token operator">&</span><span class="token token assign-left variable">units</span><span class="token token operator">=</span><span class="token token" style="color:#a1b8f3">1</span><span class="token token operator">&</span><span class="token token assign-left variable">size</span><span class="token token operator">=</span><span class="token token" style="color:#a1b8f3">10</span><span class="token token operator">&</span><span class="token token assign-left variable">unit_reference</span><span class="token token operator">=</span><span class="token token" style="color:#a1b8f3">2006</span><span>-01-02T15%3A04%3A05-0700</span></code></pre></div></div></div><div><label class="CodeSyntaxSelector_header__6P_Jc"><span>Response</span><div class="CodeSyntaxSelector_header__6P_Jc"><div class="Select_wrapper__58utF"><select class="Select_select__qXz_Z" aria-label="Select" autoComplete="off"><option value="200" selected="">200 SUCCESS</option><option value="400">400 BAD_REQUEST</option><option value="402">402 UPGRADE_REQUIRED</option><option value="403">403 FORBIDDEN</option><option value="404">404 NOT_FOUND</option><option value="410">410 GONE</option><option value="500">500 INTERNAL_ERROR</option><option value="503">503 TEMPORARILY_UNAVAILABLE</option></select><svg viewBox="0 0 8 14" xmlns="http://www.w3.org/2000/svg"><path d="M6.463 7 .987 1.66a.61.61 0 0 1 0-.878.648.648 0 0 1 .9 0L7.813 6.56a.61.61 0 0 1 0 .878l-5.926 5.78a.648.648 0 0 1-.9 0 .61.61 0 0 1 0-.879L6.463 7Z"></path></svg></div></div></label><div class="CodeSyntaxSelector_body__hBJ7j"><div class="Response_formatSelect__Wt_qa"><div class="ButtonToggle_buttonToggle__6YJhd"><label class="ButtonToggle_label__ohGaG"><input class="ButtonToggle_input__vkfUm" name="getScanMetricsForQRCodeByCities" type="radio" checked=""/><span>json</span></label><label class="ButtonToggle_label__ohGaG"><input class="ButtonToggle_input__vkfUm" name="getScanMetricsForQRCodeByCities" type="radio"/><span>csv</span></label></div></div><div class="CodeBlock_codeBlock__KlURa"><pre tabindex="0" style="color:#36383b;font-family:ProximaNova, monospace;line-height:1.2;font-size:1rem"><code class="language-json" style="white-space:pre"><span class="token token punctuation">{</span><span> </span><span> </span><span class="token token property">"unit"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"units"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"integer"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"facet"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"unit_reference"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"metrics"</span><span class="token token operator">:</span><span> </span><span class="token token punctuation">[</span><span> </span><span> </span><span class="token token punctuation">{</span><span> </span><span> </span><span class="token token property">"scans"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"integer"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"city"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"subregion"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"region"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"country"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span> </span><span> </span><span class="token token punctuation">}</span><span> </span><span> </span><span class="token token punctuation">]</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"other_metrics"</span><span class="token token operator">:</span><span> </span><span class="token token punctuation">{</span><span> </span><span> </span><span class="token token property">"other_city_scans"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"integer"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"no_city_scans"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"integer"</span><span> </span><span> </span><span class="token token punctuation">}</span><span> </span><span></span><span class="token token punctuation">}</span></code></pre></div></div></div></div></div><div class="MethodDetail_methodContainer__3EF7h" id="getScanMetricsForQRCodeByDevicesOS"><div class="MethodDetail_method__fyEiw"><div><h3 class="MethodHeader_h3__seOfC">Get Scans for a QR Code by Device OS</h3><h4 class="MethodHeader_description__3_p_p"><div class="MethodHeader_iconStyle__x5Ow4"><svg viewBox="0 0 14 6" xmlns="http://www.w3.org/2000/svg" class="IconRest_restIcon__3pju8 get"><title>Get</title><path d="M2.587 6c.307 0 .607-.044.9-.132.295-.088.533-.217.716-.387V2.876H2.271v.825h1.027v1.145a.772.772 0 0 1-.239.1 1.4 1.4 0 0 1-.383.049 1.338 1.338 0 0 1-1.083-.52c-.135-.17-.24-.379-.316-.626a2.879 2.879 0 0 1-.113-.84c0-.352.038-.655.113-.907.076-.253.182-.46.32-.623.137-.162.3-.281.488-.358a1.783 1.783 0 0 1 .97-.082l.13.032v.915h.889V.28a3.182 3.182 0 0 0-.59-.202A3.507 3.507 0 0 0 2.676 0c-.313 0-.628.055-.946.165a2.4 2.4 0 0 0-.861.523 2.707 2.707 0 0 0-.627.92C.081 1.98 0 2.433 0 2.966c0 .506.067.946.202 1.323.135.376.318.692.55.948a2.2 2.2 0 0 0 .82.572A2.7 2.7 0 0 0 2.587 6Zm6.24-.115V4.879H6.184V3.47h2.4V2.465h-2.4V1.121h2.602V.115h-3.71v5.77h3.75Zm4.43 0v-.907h-.914V1.022h.768v.997H14V.115H9.57V2.02h.89v-.997h.776v3.956h-.922v.907h2.942Z"></path></svg></div> /v4/qr-codes/{qrcode_id}/scans/device_os</h4><p class="MethodHeader_description__3_p_p">Returns the device os generating scan traffic for the specified QR Code.</p></div><div><h4 class="ParameterList_h4__nH9G8 ParameterList_dividing__wRGRx">Path Parameters</h4><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">qrcode_id</span><span class="Parameter_type__djM_s">string</span><span class="Parameter_required__pcK_H">Required</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">The QR Code ID</div></div></div><div><h4 class="ParameterList_h4__nH9G8 ParameterList_dividing__wRGRx">Query Parameters</h4><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">unit</span><span class="Parameter_type__djM_s">string</span><span class="Parameter_required__pcK_H">Required</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">A unit of time</div><div class="Parameter_default__HHgG0 Parameter_spacer__JKXbH">Default: <span class="Parameter_label__DUY7G">"day"</span></div><div class="Parameter_enum__csO6P Parameter_spacer__JKXbH">Enum: <span class="Parameter_label__DUY7G">"minute"</span><span class="Parameter_label__DUY7G">"hour"</span><span class="Parameter_label__DUY7G">"day"</span><span class="Parameter_label__DUY7G">"week"</span><span class="Parameter_label__DUY7G">"month"</span></div></div><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">units</span><span class="Parameter_type__djM_s">integer</span><span class="Parameter_required__pcK_H">Required</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">An integer representing the time units to query data for. pass -1 to return all units of time</div><div class="Parameter_default__HHgG0 Parameter_spacer__JKXbH">Default: <span class="Parameter_label__DUY7G">-1</span></div></div><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">size</span><span class="Parameter_type__djM_s">integer</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">The quantity of items to be be returned</div><div class="Parameter_default__HHgG0 Parameter_spacer__JKXbH">Default: <span class="Parameter_label__DUY7G">50</span></div></div><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">unit_reference</span><span class="Parameter_type__djM_s">string</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">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)</div></div></div></div><div class="MethodDetail_examples__8nXeM"><div><label class="CodeSyntaxSelector_header__6P_Jc CodeSyntaxSelector_headerDark__hI3A0"><span>Request</span><div class="CodeSyntaxSelector_header__6P_Jc CodeSyntaxSelector_headerDark__hI3A0"><div class="Select_wrapper__58utF Select_dark__KPIws"><select class="Select_select__qXz_Z Select_dark__KPIws" aria-label="Select" autoComplete="off"><option value="cURL" selected="">cURL</option><option value="Node">Node</option><option value="Browser">Browser</option><option value="Go">Go</option><option value="Python">Python</option></select><svg viewBox="0 0 8 14" xmlns="http://www.w3.org/2000/svg"><path d="M6.463 7 .987 1.66a.61.61 0 0 1 0-.878.648.648 0 0 1 .9 0L7.813 6.56a.61.61 0 0 1 0 .878l-5.926 5.78a.648.648 0 0 1-.9 0 .61.61 0 0 1 0-.879L6.463 7Z"></path></svg></div></div></label><div class="CodeSyntaxSelector_body__hBJ7j CodeSyntaxSelector_bodyDark__cizVw"><div class="CodeBlock_codeBlock__KlURa"><pre tabindex="0" style="color:#ffffff;font-family:ProximaNova, monospace;line-height:1.2;font-size:1rem"><code class="language-bash" style="white-space:pre"><span class="token token" style="color:#ee6123">curl</span><span> </span><span class="token token punctuation">\</span><span> </span><span>-H </span><span class="token token" style="color:#acda95">'Authorization: Bearer {TOKEN}'</span><span> </span><span class="token token punctuation">\</span><span> </span><span>-X GET </span><span class="token token punctuation">\</span><span> </span><span>https://api-ssl.bitly.com/v4/qr-codes/Qabcde12345/scans/device_os?unit</span><span class="token token operator">=</span><span>month</span><span class="token token operator">&</span><span class="token token assign-left variable">units</span><span class="token token operator">=</span><span class="token token" style="color:#a1b8f3">1</span><span class="token token operator">&</span><span class="token token assign-left variable">size</span><span class="token token operator">=</span><span class="token token" style="color:#a1b8f3">10</span><span class="token token operator">&</span><span class="token token assign-left variable">unit_reference</span><span class="token token operator">=</span><span class="token token" style="color:#a1b8f3">2006</span><span>-01-02T15%3A04%3A05-0700</span></code></pre></div></div></div><div><label class="CodeSyntaxSelector_header__6P_Jc"><span>Response</span><div class="CodeSyntaxSelector_header__6P_Jc"><div class="Select_wrapper__58utF"><select class="Select_select__qXz_Z" aria-label="Select" autoComplete="off"><option value="200" selected="">200 SUCCESS</option><option value="400">400 BAD_REQUEST</option><option value="402">402 UPGRADE_REQUIRED</option><option value="403">403 FORBIDDEN</option><option value="404">404 NOT_FOUND</option><option value="410">410 GONE</option><option value="500">500 INTERNAL_ERROR</option><option value="503">503 TEMPORARILY_UNAVAILABLE</option></select><svg viewBox="0 0 8 14" xmlns="http://www.w3.org/2000/svg"><path d="M6.463 7 .987 1.66a.61.61 0 0 1 0-.878.648.648 0 0 1 .9 0L7.813 6.56a.61.61 0 0 1 0 .878l-5.926 5.78a.648.648 0 0 1-.9 0 .61.61 0 0 1 0-.879L6.463 7Z"></path></svg></div></div></label><div class="CodeSyntaxSelector_body__hBJ7j"><div class="Response_formatSelect__Wt_qa"><div class="ButtonToggle_buttonToggle__6YJhd"><label class="ButtonToggle_label__ohGaG"><input class="ButtonToggle_input__vkfUm" name="getScanMetricsForQRCodeByDevicesOS" type="radio" checked=""/><span>json</span></label><label class="ButtonToggle_label__ohGaG"><input class="ButtonToggle_input__vkfUm" name="getScanMetricsForQRCodeByDevicesOS" type="radio"/><span>csv</span></label></div></div><div class="CodeBlock_codeBlock__KlURa"><pre tabindex="0" style="color:#36383b;font-family:ProximaNova, monospace;line-height:1.2;font-size:1rem"><code class="language-json" style="white-space:pre"><span class="token token punctuation">{</span><span> </span><span> </span><span class="token token property">"unit"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"units"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"integer"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"facet"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"unit_reference"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"metrics"</span><span class="token token operator">:</span><span> </span><span class="token token punctuation">[</span><span> </span><span> </span><span class="token token punctuation">{</span><span> </span><span> </span><span class="token token property">"scans"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"integer"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"value"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span> </span><span> </span><span class="token token punctuation">}</span><span> </span><span> </span><span class="token token punctuation">]</span><span> </span><span></span><span class="token token punctuation">}</span></code></pre></div></div></div></div></div><div class="MethodDetail_methodContainer__3EF7h" id="getScanMetricsForQRCodeByBrowser"><div class="MethodDetail_method__fyEiw"><div><h3 class="MethodHeader_h3__seOfC">Get Scans for a QR Code by Browser</h3><h4 class="MethodHeader_description__3_p_p"><div class="MethodHeader_iconStyle__x5Ow4"><svg viewBox="0 0 14 6" xmlns="http://www.w3.org/2000/svg" class="IconRest_restIcon__3pju8 get"><title>Get</title><path d="M2.587 6c.307 0 .607-.044.9-.132.295-.088.533-.217.716-.387V2.876H2.271v.825h1.027v1.145a.772.772 0 0 1-.239.1 1.4 1.4 0 0 1-.383.049 1.338 1.338 0 0 1-1.083-.52c-.135-.17-.24-.379-.316-.626a2.879 2.879 0 0 1-.113-.84c0-.352.038-.655.113-.907.076-.253.182-.46.32-.623.137-.162.3-.281.488-.358a1.783 1.783 0 0 1 .97-.082l.13.032v.915h.889V.28a3.182 3.182 0 0 0-.59-.202A3.507 3.507 0 0 0 2.676 0c-.313 0-.628.055-.946.165a2.4 2.4 0 0 0-.861.523 2.707 2.707 0 0 0-.627.92C.081 1.98 0 2.433 0 2.966c0 .506.067.946.202 1.323.135.376.318.692.55.948a2.2 2.2 0 0 0 .82.572A2.7 2.7 0 0 0 2.587 6Zm6.24-.115V4.879H6.184V3.47h2.4V2.465h-2.4V1.121h2.602V.115h-3.71v5.77h3.75Zm4.43 0v-.907h-.914V1.022h.768v.997H14V.115H9.57V2.02h.89v-.997h.776v3.956h-.922v.907h2.942Z"></path></svg></div> /v4/qr-codes/{qrcode_id}/scans/browsers</h4><p class="MethodHeader_description__3_p_p">Returns the browsers generating scan traffic to the specified QR Code.</p></div><div><h4 class="ParameterList_h4__nH9G8 ParameterList_dividing__wRGRx">Path Parameters</h4><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">qrcode_id</span><span class="Parameter_type__djM_s">string</span><span class="Parameter_required__pcK_H">Required</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">The QR Code ID</div></div></div><div><h4 class="ParameterList_h4__nH9G8 ParameterList_dividing__wRGRx">Query Parameters</h4><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">unit</span><span class="Parameter_type__djM_s">string</span><span class="Parameter_required__pcK_H">Required</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">A unit of time</div><div class="Parameter_default__HHgG0 Parameter_spacer__JKXbH">Default: <span class="Parameter_label__DUY7G">"day"</span></div><div class="Parameter_enum__csO6P Parameter_spacer__JKXbH">Enum: <span class="Parameter_label__DUY7G">"minute"</span><span class="Parameter_label__DUY7G">"hour"</span><span class="Parameter_label__DUY7G">"day"</span><span class="Parameter_label__DUY7G">"week"</span><span class="Parameter_label__DUY7G">"month"</span></div></div><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">units</span><span class="Parameter_type__djM_s">integer</span><span class="Parameter_required__pcK_H">Required</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">An integer representing the time units to query data for. pass -1 to return all units of time</div><div class="Parameter_default__HHgG0 Parameter_spacer__JKXbH">Default: <span class="Parameter_label__DUY7G">-1</span></div></div><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">size</span><span class="Parameter_type__djM_s">integer</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">The quantity of items to be be returned</div><div class="Parameter_default__HHgG0 Parameter_spacer__JKXbH">Default: <span class="Parameter_label__DUY7G">50</span></div></div><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">unit_reference</span><span class="Parameter_type__djM_s">string</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">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)</div></div></div></div><div class="MethodDetail_examples__8nXeM"><div><label class="CodeSyntaxSelector_header__6P_Jc CodeSyntaxSelector_headerDark__hI3A0"><span>Request</span><div class="CodeSyntaxSelector_header__6P_Jc CodeSyntaxSelector_headerDark__hI3A0"><div class="Select_wrapper__58utF Select_dark__KPIws"><select class="Select_select__qXz_Z Select_dark__KPIws" aria-label="Select" autoComplete="off"><option value="cURL" selected="">cURL</option><option value="Node">Node</option><option value="Browser">Browser</option><option value="Go">Go</option><option value="Python">Python</option></select><svg viewBox="0 0 8 14" xmlns="http://www.w3.org/2000/svg"><path d="M6.463 7 .987 1.66a.61.61 0 0 1 0-.878.648.648 0 0 1 .9 0L7.813 6.56a.61.61 0 0 1 0 .878l-5.926 5.78a.648.648 0 0 1-.9 0 .61.61 0 0 1 0-.879L6.463 7Z"></path></svg></div></div></label><div class="CodeSyntaxSelector_body__hBJ7j CodeSyntaxSelector_bodyDark__cizVw"><div class="CodeBlock_codeBlock__KlURa"><pre tabindex="0" style="color:#ffffff;font-family:ProximaNova, monospace;line-height:1.2;font-size:1rem"><code class="language-bash" style="white-space:pre"><span class="token token" style="color:#ee6123">curl</span><span> </span><span class="token token punctuation">\</span><span> </span><span>-H </span><span class="token token" style="color:#acda95">'Authorization: Bearer {TOKEN}'</span><span> </span><span class="token token punctuation">\</span><span> </span><span>-X GET </span><span class="token token punctuation">\</span><span> </span><span>https://api-ssl.bitly.com/v4/qr-codes/Qabcde12345/scans/browsers?unit</span><span class="token token operator">=</span><span>month</span><span class="token token operator">&</span><span class="token token assign-left variable">units</span><span class="token token operator">=</span><span class="token token" style="color:#a1b8f3">1</span><span class="token token operator">&</span><span class="token token assign-left variable">size</span><span class="token token operator">=</span><span class="token token" style="color:#a1b8f3">10</span><span class="token token operator">&</span><span class="token token assign-left variable">unit_reference</span><span class="token token operator">=</span><span class="token token" style="color:#a1b8f3">2006</span><span>-01-02T15%3A04%3A05-0700</span></code></pre></div></div></div><div><label class="CodeSyntaxSelector_header__6P_Jc"><span>Response</span><div class="CodeSyntaxSelector_header__6P_Jc"><div class="Select_wrapper__58utF"><select class="Select_select__qXz_Z" aria-label="Select" autoComplete="off"><option value="200" selected="">200 SUCCESS</option><option value="400">400 BAD_REQUEST</option><option value="402">402 UPGRADE_REQUIRED</option><option value="403">403 FORBIDDEN</option><option value="404">404 NOT_FOUND</option><option value="410">410 GONE</option><option value="500">500 INTERNAL_ERROR</option><option value="503">503 TEMPORARILY_UNAVAILABLE</option></select><svg viewBox="0 0 8 14" xmlns="http://www.w3.org/2000/svg"><path d="M6.463 7 .987 1.66a.61.61 0 0 1 0-.878.648.648 0 0 1 .9 0L7.813 6.56a.61.61 0 0 1 0 .878l-5.926 5.78a.648.648 0 0 1-.9 0 .61.61 0 0 1 0-.879L6.463 7Z"></path></svg></div></div></label><div class="CodeSyntaxSelector_body__hBJ7j"><div class="Response_formatSelect__Wt_qa"><div class="ButtonToggle_buttonToggle__6YJhd"><label class="ButtonToggle_label__ohGaG"><input class="ButtonToggle_input__vkfUm" name="getScanMetricsForQRCodeByBrowser" type="radio" checked=""/><span>json</span></label><label class="ButtonToggle_label__ohGaG"><input class="ButtonToggle_input__vkfUm" name="getScanMetricsForQRCodeByBrowser" type="radio"/><span>csv</span></label></div></div><div class="CodeBlock_codeBlock__KlURa"><pre tabindex="0" style="color:#36383b;font-family:ProximaNova, monospace;line-height:1.2;font-size:1rem"><code class="language-json" style="white-space:pre"><span class="token token punctuation">{</span><span> </span><span> </span><span class="token token property">"unit"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"units"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"integer"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"facet"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"unit_reference"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"metrics"</span><span class="token token operator">:</span><span> </span><span class="token token punctuation">[</span><span> </span><span> </span><span class="token token punctuation">{</span><span> </span><span> </span><span class="token token property">"scans"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"integer"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"value"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span> </span><span> </span><span class="token token punctuation">}</span><span> </span><span> </span><span class="token token punctuation">]</span><span> </span><span></span><span class="token token punctuation">}</span></code></pre></div></div></div></div></div><div class="ApiReference_tagInfo__YVbgw"><h2 class="ApiReference_tagName__IJx2p">User</h2><p class="ApiReference_tagDescription__8c1GM">Some subscription plans allow multiple users. Only one user is used for authenticating a call, and these operations apply only to the authenticated user. </p></div><div class="MethodDetail_methodContainer__3EF7h" id="updateUser"><div class="MethodDetail_method__fyEiw"><div><h3 class="MethodHeader_h3__seOfC">Update a User</h3><h4 class="MethodHeader_description__3_p_p"><div class="MethodHeader_iconStyle__x5Ow4"><svg viewBox="0 0 23 6" xmlns="http://www.w3.org/2000/svg" class="IconRest_restIcon__3pju8 patch"><title>Patch</title><path d="M1.095 5.885V3.898c.027.006.07.011.132.017a4.052 4.052 0 0 0 .372.016h.128c.277 0 .545-.037.803-.11.259-.075.49-.193.692-.355.202-.162.365-.368.487-.618.123-.25.184-.551.184-.903 0-.401-.07-.727-.212-.977a1.606 1.606 0 0 0-.547-.585 2.041 2.041 0 0 0-.756-.28 5.067 5.067 0 0 0-.835-.07c-.267 0-.534.012-.804.037C.47.095.224.13 0 .173v5.712h1.095Zm.472-2.934h-.1a2.448 2.448 0 0 1-.276-.017.853.853 0 0 1-.096-.016V1.047c.059-.011.136-.02.232-.03.096-.007.197-.012.304-.012.138 0 .274.014.408.042a.964.964 0 0 1 .355.148.801.801 0 0 1 .252.284.937.937 0 0 1 .096.45c0 .214-.033.387-.1.519a.787.787 0 0 1-.268.309 1.038 1.038 0 0 1-.38.152 2.235 2.235 0 0 1-.427.042Zm3.79 2.934.383-1.278h1.67l.4 1.278h1.152L7.163.115H6.068L4.26 5.885h1.095ZM7.194 3.7h-1.2l.56-1.929h.072l.568 1.929Zm5.668 2.184v-.907h-.903V1.022h.76v.997h.879V.115H9.218V2.02h.879v-.997h.767v3.956h-.91v.907h2.91Zm3.91.115c.276 0 .547-.036.81-.107.265-.072.482-.17.652-.297V3.948h-.88v.997c-.164.033-.335.05-.51.05-.246 0-.464-.049-.656-.145a1.383 1.383 0 0 1-.488-.408 1.881 1.881 0 0 1-.304-.63A2.973 2.973 0 0 1 15.293 3c0-.34.038-.636.112-.886.075-.25.179-.457.312-.622.133-.165.29-.287.468-.367.178-.08.371-.12.58-.12.175 0 .346.014.511.042v.94h.88V.271a2.727 2.727 0 0 0-.548-.19A3.419 3.419 0 0 0 16.796 0c-.303 0-.613.05-.927.152-.314.102-.6.27-.855.503a2.611 2.611 0 0 0-.628.923c-.163.382-.244.856-.244 1.422 0 .544.072 1.007.216 1.389.144.382.336.692.576.931.24.24.518.412.835.52.317.106.652.16 1.003.16Zm3.325-.115V3.47h1.807v2.415H23V.115h-1.095v2.35h-1.807V.114h-1.095v5.77h1.095Z"></path></svg></div> /v4/user</h4><p class="MethodHeader_description__3_p_p">Update fields in the user</p></div><div><h4 class="ParameterList_h4__nH9G8 ParameterList_dividing__wRGRx">Request Body Schema</h4><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">name</span><span class="Parameter_type__djM_s">string</span></div></div><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">default_group_guid</span><span class="Parameter_type__djM_s">string</span></div></div></div></div><div class="MethodDetail_examples__8nXeM"><div><label class="CodeSyntaxSelector_header__6P_Jc CodeSyntaxSelector_headerDark__hI3A0"><span>Request</span><div class="CodeSyntaxSelector_header__6P_Jc CodeSyntaxSelector_headerDark__hI3A0"><div class="Select_wrapper__58utF Select_dark__KPIws"><select class="Select_select__qXz_Z Select_dark__KPIws" aria-label="Select" autoComplete="off"><option value="cURL" selected="">cURL</option><option value="Node">Node</option><option value="Browser">Browser</option><option value="Go">Go</option><option value="Python">Python</option></select><svg viewBox="0 0 8 14" xmlns="http://www.w3.org/2000/svg"><path d="M6.463 7 .987 1.66a.61.61 0 0 1 0-.878.648.648 0 0 1 .9 0L7.813 6.56a.61.61 0 0 1 0 .878l-5.926 5.78a.648.648 0 0 1-.9 0 .61.61 0 0 1 0-.879L6.463 7Z"></path></svg></div></div></label><div class="CodeSyntaxSelector_body__hBJ7j CodeSyntaxSelector_bodyDark__cizVw"><div class="CodeBlock_codeBlock__KlURa"><pre tabindex="0" style="color:#ffffff;font-family:ProximaNova, monospace;line-height:1.2;font-size:1rem"><code class="language-bash" style="white-space:pre"><span class="token token" style="color:#ee6123">curl</span><span> </span><span class="token token punctuation">\</span><span> </span><span>-H </span><span class="token token" style="color:#acda95">'Authorization: Bearer {TOKEN}'</span><span> </span><span class="token token punctuation">\</span><span> </span><span>-H </span><span class="token token" style="color:#acda95">'Content-Type: application/json'</span><span> </span><span class="token token punctuation">\</span><span> </span><span>-X PATCH </span><span class="token token punctuation">\</span><span> </span><span>-d </span><span class="token token" style="color:#acda95">'{ </span><span class="token token" style="color:#acda95"> "name": "Chauncey McPufferson", </span><span class="token token" style="color:#acda95"> "default_group_guid": "Ba1bc23dE4F" </span><span class="token token" style="color:#acda95">}'</span><span> </span><span class="token token punctuation">\</span><span> </span>https://api-ssl.bitly.com/v4/user</code></pre></div></div></div><div><label class="CodeSyntaxSelector_header__6P_Jc"><span>Response</span><div class="CodeSyntaxSelector_header__6P_Jc"><div class="Select_wrapper__58utF"><select class="Select_select__qXz_Z" aria-label="Select" autoComplete="off"><option value="200" selected="">200 SUCCESS</option><option value="400">400 BAD_REQUEST</option><option value="403">403 FORBIDDEN</option><option value="404">404 NOT_FOUND</option><option value="422">422 UNPROCESSABLE_ENTITY</option><option value="500">500 INTERNAL_ERROR</option><option value="503">503 TEMPORARILY_UNAVAILABLE</option></select><svg viewBox="0 0 8 14" xmlns="http://www.w3.org/2000/svg"><path d="M6.463 7 .987 1.66a.61.61 0 0 1 0-.878.648.648 0 0 1 .9 0L7.813 6.56a.61.61 0 0 1 0 .878l-5.926 5.78a.648.648 0 0 1-.9 0 .61.61 0 0 1 0-.879L6.463 7Z"></path></svg></div></div></label><div class="CodeSyntaxSelector_body__hBJ7j"><div class="CodeBlock_codeBlock__KlURa"><pre tabindex="0" style="color:#36383b;font-family:ProximaNova, monospace;line-height:1.2;font-size:1rem"><code class="language-json" style="white-space:pre"><span class="token token punctuation">{</span><span> </span><span> </span><span class="token token property">"login"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"name"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"is_active"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"boolean"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"created"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"modified"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"is_sso_user"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"boolean"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"emails"</span><span class="token token operator">:</span><span> </span><span class="token token punctuation">[</span><span> </span><span> </span><span class="token token punctuation">{</span><span> </span><span> </span><span class="token token property">"email"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"is_primary"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"boolean"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"is_verified"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"boolean"</span><span> </span><span> </span><span class="token token punctuation">}</span><span> </span><span> </span><span class="token token punctuation">]</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"is_2fa_enabled"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"boolean"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"default_group_guid"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span> </span><span></span><span class="token token punctuation">}</span></code></pre></div></div></div></div></div><div class="MethodDetail_methodContainer__3EF7h" id="getUser"><div class="MethodDetail_method__fyEiw"><div><h3 class="MethodHeader_h3__seOfC">Retrieve a User</h3><h4 class="MethodHeader_description__3_p_p"><div class="MethodHeader_iconStyle__x5Ow4"><svg viewBox="0 0 14 6" xmlns="http://www.w3.org/2000/svg" class="IconRest_restIcon__3pju8 get"><title>Get</title><path d="M2.587 6c.307 0 .607-.044.9-.132.295-.088.533-.217.716-.387V2.876H2.271v.825h1.027v1.145a.772.772 0 0 1-.239.1 1.4 1.4 0 0 1-.383.049 1.338 1.338 0 0 1-1.083-.52c-.135-.17-.24-.379-.316-.626a2.879 2.879 0 0 1-.113-.84c0-.352.038-.655.113-.907.076-.253.182-.46.32-.623.137-.162.3-.281.488-.358a1.783 1.783 0 0 1 .97-.082l.13.032v.915h.889V.28a3.182 3.182 0 0 0-.59-.202A3.507 3.507 0 0 0 2.676 0c-.313 0-.628.055-.946.165a2.4 2.4 0 0 0-.861.523 2.707 2.707 0 0 0-.627.92C.081 1.98 0 2.433 0 2.966c0 .506.067.946.202 1.323.135.376.318.692.55.948a2.2 2.2 0 0 0 .82.572A2.7 2.7 0 0 0 2.587 6Zm6.24-.115V4.879H6.184V3.47h2.4V2.465h-2.4V1.121h2.602V.115h-3.71v5.77h3.75Zm4.43 0v-.907h-.914V1.022h.768v.997H14V.115H9.57V2.02h.89v-.997h.776v3.956h-.922v.907h2.942Z"></path></svg></div> /v4/user</h4><p class="MethodHeader_description__3_p_p">Returns information for the current authenticated user.</p></div></div><div class="MethodDetail_examples__8nXeM"><div><label class="CodeSyntaxSelector_header__6P_Jc CodeSyntaxSelector_headerDark__hI3A0"><span>Request</span><div class="CodeSyntaxSelector_header__6P_Jc CodeSyntaxSelector_headerDark__hI3A0"><div class="Select_wrapper__58utF Select_dark__KPIws"><select class="Select_select__qXz_Z Select_dark__KPIws" aria-label="Select" autoComplete="off"><option value="cURL" selected="">cURL</option><option value="Node">Node</option><option value="Browser">Browser</option><option value="Go">Go</option><option value="Python">Python</option></select><svg viewBox="0 0 8 14" xmlns="http://www.w3.org/2000/svg"><path d="M6.463 7 .987 1.66a.61.61 0 0 1 0-.878.648.648 0 0 1 .9 0L7.813 6.56a.61.61 0 0 1 0 .878l-5.926 5.78a.648.648 0 0 1-.9 0 .61.61 0 0 1 0-.879L6.463 7Z"></path></svg></div></div></label><div class="CodeSyntaxSelector_body__hBJ7j CodeSyntaxSelector_bodyDark__cizVw"><div class="CodeBlock_codeBlock__KlURa"><pre tabindex="0" style="color:#ffffff;font-family:ProximaNova, monospace;line-height:1.2;font-size:1rem"><code class="language-bash" style="white-space:pre"><span class="token token" style="color:#ee6123">curl</span><span> </span><span class="token token punctuation">\</span><span> </span><span>-H </span><span class="token token" style="color:#acda95">'Authorization: Bearer {TOKEN}'</span><span> </span><span class="token token punctuation">\</span><span> </span><span>-X GET </span><span class="token token punctuation">\</span><span> </span>https://api-ssl.bitly.com/v4/user</code></pre></div></div></div><div><label class="CodeSyntaxSelector_header__6P_Jc"><span>Response</span><div class="CodeSyntaxSelector_header__6P_Jc"><div class="Select_wrapper__58utF"><select class="Select_select__qXz_Z" aria-label="Select" autoComplete="off"><option value="200" selected="">200 SUCCESS</option><option value="403">403 FORBIDDEN</option><option value="404">404 NOT_FOUND</option><option value="500">500 INTERNAL_ERROR</option><option value="503">503 TEMPORARILY_UNAVAILABLE</option></select><svg viewBox="0 0 8 14" xmlns="http://www.w3.org/2000/svg"><path d="M6.463 7 .987 1.66a.61.61 0 0 1 0-.878.648.648 0 0 1 .9 0L7.813 6.56a.61.61 0 0 1 0 .878l-5.926 5.78a.648.648 0 0 1-.9 0 .61.61 0 0 1 0-.879L6.463 7Z"></path></svg></div></div></label><div class="CodeSyntaxSelector_body__hBJ7j"><div class="CodeBlock_codeBlock__KlURa"><pre tabindex="0" style="color:#36383b;font-family:ProximaNova, monospace;line-height:1.2;font-size:1rem"><code class="language-json" style="white-space:pre"><span class="token token punctuation">{</span><span> </span><span> </span><span class="token token property">"login"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"name"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"is_active"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"boolean"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"created"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"modified"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"is_sso_user"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"boolean"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"emails"</span><span class="token token operator">:</span><span> </span><span class="token token punctuation">[</span><span> </span><span> </span><span class="token token punctuation">{</span><span> </span><span> </span><span class="token token property">"email"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"is_primary"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"boolean"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"is_verified"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"boolean"</span><span> </span><span> </span><span class="token token punctuation">}</span><span> </span><span> </span><span class="token token punctuation">]</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"is_2fa_enabled"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"boolean"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"default_group_guid"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span> </span><span></span><span class="token token punctuation">}</span></code></pre></div></div></div></div></div><div class="MethodDetail_methodContainer__3EF7h" id="getPlatformLimits"><div class="MethodDetail_method__fyEiw"><div><h3 class="MethodHeader_h3__seOfC">Get Platform Limits</h3><h4 class="MethodHeader_description__3_p_p"><div class="MethodHeader_iconStyle__x5Ow4"><svg viewBox="0 0 14 6" xmlns="http://www.w3.org/2000/svg" class="IconRest_restIcon__3pju8 get"><title>Get</title><path d="M2.587 6c.307 0 .607-.044.9-.132.295-.088.533-.217.716-.387V2.876H2.271v.825h1.027v1.145a.772.772 0 0 1-.239.1 1.4 1.4 0 0 1-.383.049 1.338 1.338 0 0 1-1.083-.52c-.135-.17-.24-.379-.316-.626a2.879 2.879 0 0 1-.113-.84c0-.352.038-.655.113-.907.076-.253.182-.46.32-.623.137-.162.3-.281.488-.358a1.783 1.783 0 0 1 .97-.082l.13.032v.915h.889V.28a3.182 3.182 0 0 0-.59-.202A3.507 3.507 0 0 0 2.676 0c-.313 0-.628.055-.946.165a2.4 2.4 0 0 0-.861.523 2.707 2.707 0 0 0-.627.92C.081 1.98 0 2.433 0 2.966c0 .506.067.946.202 1.323.135.376.318.692.55.948a2.2 2.2 0 0 0 .82.572A2.7 2.7 0 0 0 2.587 6Zm6.24-.115V4.879H6.184V3.47h2.4V2.465h-2.4V1.121h2.602V.115h-3.71v5.77h3.75Zm4.43 0v-.907h-.914V1.022h.768v.997H14V.115H9.57V2.02h.89v-.997h.776v3.956h-.922v.907h2.942Z"></path></svg></div> /v4/user/platform_limits</h4><p class="MethodHeader_description__3_p_p">Fetch all platform limits and counts available for an organization</p></div><div><h4 class="ParameterList_h4__nH9G8 ParameterList_dividing__wRGRx">Query Parameters</h4><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">path</span><span class="Parameter_type__djM_s">string</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">The specific path for which information is requested</div></div></div></div><div class="MethodDetail_examples__8nXeM"><div><label class="CodeSyntaxSelector_header__6P_Jc CodeSyntaxSelector_headerDark__hI3A0"><span>Request</span><div class="CodeSyntaxSelector_header__6P_Jc CodeSyntaxSelector_headerDark__hI3A0"><div class="Select_wrapper__58utF Select_dark__KPIws"><select class="Select_select__qXz_Z Select_dark__KPIws" aria-label="Select" autoComplete="off"><option value="cURL" selected="">cURL</option><option value="Node">Node</option><option value="Browser">Browser</option><option value="Go">Go</option><option value="Python">Python</option></select><svg viewBox="0 0 8 14" xmlns="http://www.w3.org/2000/svg"><path d="M6.463 7 .987 1.66a.61.61 0 0 1 0-.878.648.648 0 0 1 .9 0L7.813 6.56a.61.61 0 0 1 0 .878l-5.926 5.78a.648.648 0 0 1-.9 0 .61.61 0 0 1 0-.879L6.463 7Z"></path></svg></div></div></label><div class="CodeSyntaxSelector_body__hBJ7j CodeSyntaxSelector_bodyDark__cizVw"><div class="CodeBlock_codeBlock__KlURa"><pre tabindex="0" style="color:#ffffff;font-family:ProximaNova, monospace;line-height:1.2;font-size:1rem"><code class="language-bash" style="white-space:pre"><span class="token token" style="color:#ee6123">curl</span><span> </span><span class="token token punctuation">\</span><span> </span><span>-H </span><span class="token token" style="color:#acda95">'Authorization: Bearer {TOKEN}'</span><span> </span><span class="token token punctuation">\</span><span> </span><span>-X GET </span><span class="token token punctuation">\</span><span> </span><span>https://api-ssl.bitly.com/v4/user/platform_limits?path</span><span class="token token operator">=</span><span>%2Forganizations%2F%7Borganization_guid%7D</span></code></pre></div></div></div><div><label class="CodeSyntaxSelector_header__6P_Jc"><span>Response</span><div class="CodeSyntaxSelector_header__6P_Jc"><div class="Select_wrapper__58utF"><select class="Select_select__qXz_Z" aria-label="Select" autoComplete="off"><option value="200" selected="">200 SUCCESS</option><option value="403">403 FORBIDDEN</option><option value="404">404 NOT_FOUND</option><option value="500">500 INTERNAL_ERROR</option><option value="503">503 TEMPORARILY_UNAVAILABLE</option></select><svg viewBox="0 0 8 14" xmlns="http://www.w3.org/2000/svg"><path d="M6.463 7 .987 1.66a.61.61 0 0 1 0-.878.648.648 0 0 1 .9 0L7.813 6.56a.61.61 0 0 1 0 .878l-5.926 5.78a.648.648 0 0 1-.9 0 .61.61 0 0 1 0-.879L6.463 7Z"></path></svg></div></div></label><div class="CodeSyntaxSelector_body__hBJ7j"><div class="CodeBlock_codeBlock__KlURa"><pre tabindex="0" style="color:#36383b;font-family:ProximaNova, monospace;line-height:1.2;font-size:1rem"><code class="language-json" style="white-space:pre"><span class="token token punctuation">{</span><span> </span><span> </span><span class="token token property">"platform_limits"</span><span class="token token operator">:</span><span> </span><span class="token token punctuation">[</span><span> </span><span> </span><span class="token token punctuation">{</span><span> </span><span> </span><span class="token token property">"endpoint"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"methods"</span><span class="token token operator">:</span><span> </span><span class="token token punctuation">[</span><span> </span><span> </span><span class="token token punctuation">{</span><span> </span><span> </span><span class="token token property">"name"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"limit"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"integer"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"count"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"integer"</span><span> </span><span> </span><span class="token token punctuation">}</span><span> </span><span> </span><span class="token token punctuation">]</span><span> </span><span> </span><span class="token token punctuation">}</span><span> </span><span> </span><span class="token token punctuation">]</span><span> </span><span></span><span class="token token punctuation">}</span></code></pre></div></div></div></div></div><div class="ApiReference_tagInfo__YVbgw"><h2 class="ApiReference_tagName__IJx2p">Webhooks</h2><p class="ApiReference_tagDescription__8c1GM">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. </p></div><div class="MethodDetail_methodContainer__3EF7h" id="getWebhooks"><div class="MethodDetail_method__fyEiw"><div><h3 class="MethodHeader_h3__seOfC">Get Webhooks</h3><h4 class="MethodHeader_description__3_p_p"><div class="MethodHeader_iconStyle__x5Ow4"><svg viewBox="0 0 14 6" xmlns="http://www.w3.org/2000/svg" class="IconRest_restIcon__3pju8 get"><title>Get</title><path d="M2.587 6c.307 0 .607-.044.9-.132.295-.088.533-.217.716-.387V2.876H2.271v.825h1.027v1.145a.772.772 0 0 1-.239.1 1.4 1.4 0 0 1-.383.049 1.338 1.338 0 0 1-1.083-.52c-.135-.17-.24-.379-.316-.626a2.879 2.879 0 0 1-.113-.84c0-.352.038-.655.113-.907.076-.253.182-.46.32-.623.137-.162.3-.281.488-.358a1.783 1.783 0 0 1 .97-.082l.13.032v.915h.889V.28a3.182 3.182 0 0 0-.59-.202A3.507 3.507 0 0 0 2.676 0c-.313 0-.628.055-.946.165a2.4 2.4 0 0 0-.861.523 2.707 2.707 0 0 0-.627.92C.081 1.98 0 2.433 0 2.966c0 .506.067.946.202 1.323.135.376.318.692.55.948a2.2 2.2 0 0 0 .82.572A2.7 2.7 0 0 0 2.587 6Zm6.24-.115V4.879H6.184V3.47h2.4V2.465h-2.4V1.121h2.602V.115h-3.71v5.77h3.75Zm4.43 0v-.907h-.914V1.022h.768v.997H14V.115H9.57V2.02h.89v-.997h.776v3.956h-.922v.907h2.942Z"></path></svg></div> /v4/organizations/{organization_guid}/webhooks</h4><p class="MethodHeader_description__3_p_p">Fetch all webhooks available for an Organization</p></div><div><h4 class="ParameterList_h4__nH9G8 ParameterList_dividing__wRGRx">Path Parameters</h4><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">organization_guid</span><span class="Parameter_type__djM_s">string</span><span class="Parameter_required__pcK_H">Required</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">A GUID for a Bitly organization</div></div></div></div><div class="MethodDetail_examples__8nXeM"><div><label class="CodeSyntaxSelector_header__6P_Jc CodeSyntaxSelector_headerDark__hI3A0"><span>Request</span><div class="CodeSyntaxSelector_header__6P_Jc CodeSyntaxSelector_headerDark__hI3A0"><div class="Select_wrapper__58utF Select_dark__KPIws"><select class="Select_select__qXz_Z Select_dark__KPIws" aria-label="Select" autoComplete="off"><option value="cURL" selected="">cURL</option><option value="Node">Node</option><option value="Browser">Browser</option><option value="Go">Go</option><option value="Python">Python</option></select><svg viewBox="0 0 8 14" xmlns="http://www.w3.org/2000/svg"><path d="M6.463 7 .987 1.66a.61.61 0 0 1 0-.878.648.648 0 0 1 .9 0L7.813 6.56a.61.61 0 0 1 0 .878l-5.926 5.78a.648.648 0 0 1-.9 0 .61.61 0 0 1 0-.879L6.463 7Z"></path></svg></div></div></label><div class="CodeSyntaxSelector_body__hBJ7j CodeSyntaxSelector_bodyDark__cizVw"><div class="CodeBlock_codeBlock__KlURa"><pre tabindex="0" style="color:#ffffff;font-family:ProximaNova, monospace;line-height:1.2;font-size:1rem"><code class="language-bash" style="white-space:pre"><span class="token token" style="color:#ee6123">curl</span><span> </span><span class="token token punctuation">\</span><span> </span><span>-H </span><span class="token token" style="color:#acda95">'Authorization: Bearer {TOKEN}'</span><span> </span><span class="token token punctuation">\</span><span> </span><span>-X GET </span><span class="token token punctuation">\</span><span> </span>https://api-ssl.bitly.com/v4/organizations/Oa1bcd234eF/webhooks</code></pre></div></div></div><div><label class="CodeSyntaxSelector_header__6P_Jc"><span>Response</span><div class="CodeSyntaxSelector_header__6P_Jc"><div class="Select_wrapper__58utF"><select class="Select_select__qXz_Z" aria-label="Select" autoComplete="off"><option value="200" selected="">200 SUCCESS</option><option value="402">402 UPGRADE_REQUIRED</option><option value="403">403 FORBIDDEN</option><option value="404">404 NOT_FOUND</option><option value="429">429 MONTHLY_LIMIT_EXCEEDED</option><option value="500">500 INTERNAL_ERROR</option><option value="503">503 TEMPORARILY_UNAVAILABLE</option></select><svg viewBox="0 0 8 14" xmlns="http://www.w3.org/2000/svg"><path d="M6.463 7 .987 1.66a.61.61 0 0 1 0-.878.648.648 0 0 1 .9 0L7.813 6.56a.61.61 0 0 1 0 .878l-5.926 5.78a.648.648 0 0 1-.9 0 .61.61 0 0 1 0-.879L6.463 7Z"></path></svg></div></div></label><div class="CodeSyntaxSelector_body__hBJ7j"><div class="CodeBlock_codeBlock__KlURa"><pre tabindex="0" style="color:#36383b;font-family:ProximaNova, monospace;line-height:1.2;font-size:1rem"><code class="language-json" style="white-space:pre"><span class="token token punctuation">{</span><span> </span><span> </span><span class="token token property">"webhooks"</span><span class="token token operator">:</span><span> </span><span class="token token punctuation">[</span><span> </span><span> </span><span class="token token punctuation">{</span><span> </span><span> </span><span class="token token property">"references"</span><span class="token token operator">:</span><span> </span><span class="token token punctuation">{</span><span> </span><span class="token token" style="color:#51763e">"any"</span><span> </span><span class="token token punctuation">}</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"guid"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"created"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"modified"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"modified_by"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"alerted"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"deactivated"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"is_active"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"boolean"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"is_alert"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"boolean"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"organization_guid"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"group_guid"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"name"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"event"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"url"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"status"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"oauth_url"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"client_id"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"client_secret"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"fetch_tags"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"boolean"</span><span> </span><span> </span><span class="token token punctuation">}</span><span> </span><span> </span><span class="token token punctuation">]</span><span> </span><span></span><span class="token token punctuation">}</span></code></pre></div></div></div></div></div><div class="MethodDetail_methodContainer__3EF7h" id="createWebhook"><div class="MethodDetail_method__fyEiw"><div><h3 class="MethodHeader_h3__seOfC">Create Webhook</h3><h4 class="MethodHeader_description__3_p_p"><div class="MethodHeader_iconStyle__x5Ow4"><svg viewBox="0 0 18 6" xmlns="http://www.w3.org/2000/svg" class="IconRest_restIcon__3pju8 post"><title>Post</title><path d="M1.072 5.885V3.898c.026.006.069.011.129.017a3.88 3.88 0 0 0 .364.016h.125c.27 0 .533-.037.786-.11.253-.075.478-.193.677-.355.198-.162.357-.368.477-.618s.18-.551.18-.903c0-.401-.07-.727-.208-.977a1.592 1.592 0 0 0-.536-.585 1.971 1.971 0 0 0-.739-.28 4.854 4.854 0 0 0-.817-.07C1.249.033.987.045.724.07.46.095.219.13 0 .173v5.712h1.072Zm.461-2.934h-.098a2.344 2.344 0 0 1-.27-.017.818.818 0 0 1-.093-.016V1.047c.057-.011.133-.02.227-.03.093-.007.193-.012.297-.012.135 0 .268.014.399.042.13.027.246.077.348.148a.796.796 0 0 1 .246.284.954.954 0 0 1 .094.45c0 .214-.032.387-.098.519a.782.782 0 0 1-.262.309c-.11.074-.233.125-.371.152a2.141 2.141 0 0 1-.419.042ZM6.47 6c.694 0 1.212-.265 1.553-.795.342-.53.513-1.265.513-2.205 0-.44-.038-.843-.114-1.212a2.872 2.872 0 0 0-.36-.947 1.78 1.78 0 0 0-.637-.618C7.163.074 6.844 0 6.469 0c-.35 0-.653.069-.911.206a1.78 1.78 0 0 0-.645.59c-.172.255-.3.57-.384.943A5.804 5.804 0 0 0 4.404 3c0 .44.037.843.11 1.212.073.368.191.684.356.947.164.264.378.47.641.618.263.149.583.223.958.223Zm0-1.005c-.203 0-.366-.053-.489-.157a.989.989 0 0 1-.281-.425 2.57 2.57 0 0 1-.133-.63A8.129 8.129 0 0 1 5.53 3c0-.66.065-1.157.195-1.492.13-.335.378-.503.743-.503.209 0 .376.054.501.161a1 1 0 0 1 .286.433c.065.181.106.393.125.635.018.241.027.497.027.766 0 .34-.014.636-.043.886-.029.25-.08.457-.152.622a.826.826 0 0 1-.29.367.803.803 0 0 1-.454.12ZM10.991 6c.297 0 .574-.037.83-.111.255-.074.476-.187.664-.338.188-.151.334-.338.438-.56.104-.223.157-.483.157-.78 0-.307-.067-.563-.2-.766a1.814 1.814 0 0 0-.493-.507 3.3 3.3 0 0 0-.641-.342 11.165 11.165 0 0 1-.642-.28 2.185 2.185 0 0 1-.493-.313.562.562 0 0 1-.199-.445c0-.176.072-.316.215-.42.144-.105.34-.157.59-.157a2.757 2.757 0 0 1 .767.107.14.14 0 0 0 .047.008v.915h.86V.338a2.45 2.45 0 0 0-.735-.247C11.85.03 11.536 0 11.218 0c-.282 0-.537.041-.767.124-.23.082-.426.197-.59.346A1.557 1.557 0 0 0 9.476 1a1.66 1.66 0 0 0-.137.68c0 .324.067.588.2.792.133.203.297.372.493.506.195.135.409.246.641.334.232.088.446.176.642.264.195.088.36.19.492.305.133.115.2.266.2.453 0 .209-.081.375-.243.499-.161.123-.388.185-.68.185-.162 0-.314-.018-.458-.053a2.256 2.256 0 0 1-.395-.136l-.047-.017v-.816h-.86V5.53c.067.039.156.085.266.14.11.055.236.107.379.157.143.05.3.09.47.124.169.033.353.049.55.049Zm6.29-.115v-.907h-.885V1.022h.744v.997H18V.115h-4.287V2.02h.86v-.997h.752v3.956h-.892v.907h2.847Z"></path></svg></div> /v4/webhooks</h4><p class="MethodHeader_description__3_p_p">Creates a webhook.</p></div><div><h4 class="ParameterList_h4__nH9G8 ParameterList_dividing__wRGRx">Request Body Schema</h4><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">is_active</span><span class="Parameter_type__djM_s">boolean</span></div></div><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">organization_guid</span><span class="Parameter_type__djM_s">string</span><span class="Parameter_required__pcK_H">Required</span></div></div><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">group_guid</span><span class="Parameter_type__djM_s">string</span></div></div><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">name</span><span class="Parameter_type__djM_s">string</span><span class="Parameter_required__pcK_H">Required</span></div></div><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">event</span><span class="Parameter_type__djM_s">string</span><span class="Parameter_required__pcK_H">Required</span></div></div><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">url</span><span class="Parameter_type__djM_s">string</span><span class="Parameter_required__pcK_H">Required</span></div></div><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">oauth_url</span><span class="Parameter_type__djM_s">string</span></div></div><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">client_id</span><span class="Parameter_type__djM_s">string</span></div></div><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">client_secret</span><span class="Parameter_type__djM_s">string</span></div></div><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">fetch_tags</span><span class="Parameter_type__djM_s">boolean</span></div></div></div></div><div class="MethodDetail_examples__8nXeM"><div><label class="CodeSyntaxSelector_header__6P_Jc CodeSyntaxSelector_headerDark__hI3A0"><span>Request</span><div class="CodeSyntaxSelector_header__6P_Jc CodeSyntaxSelector_headerDark__hI3A0"><div class="Select_wrapper__58utF Select_dark__KPIws"><select class="Select_select__qXz_Z Select_dark__KPIws" aria-label="Select" autoComplete="off"><option value="cURL" selected="">cURL</option><option value="Node">Node</option><option value="Browser">Browser</option><option value="Go">Go</option><option value="Python">Python</option></select><svg viewBox="0 0 8 14" xmlns="http://www.w3.org/2000/svg"><path d="M6.463 7 .987 1.66a.61.61 0 0 1 0-.878.648.648 0 0 1 .9 0L7.813 6.56a.61.61 0 0 1 0 .878l-5.926 5.78a.648.648 0 0 1-.9 0 .61.61 0 0 1 0-.879L6.463 7Z"></path></svg></div></div></label><div class="CodeSyntaxSelector_body__hBJ7j CodeSyntaxSelector_bodyDark__cizVw"><div class="CodeBlock_codeBlock__KlURa"><pre tabindex="0" style="color:#ffffff;font-family:ProximaNova, monospace;line-height:1.2;font-size:1rem"><code class="language-bash" style="white-space:pre"><span class="token token" style="color:#ee6123">curl</span><span> </span><span class="token token punctuation">\</span><span> </span><span>-H </span><span class="token token" style="color:#acda95">'Authorization: Bearer {TOKEN}'</span><span> </span><span class="token token punctuation">\</span><span> </span><span>-H </span><span class="token token" style="color:#acda95">'Content-Type: application/json'</span><span> </span><span class="token token punctuation">\</span><span> </span><span>-X POST </span><span class="token token punctuation">\</span><span> </span><span>-d </span><span class="token token" style="color:#acda95">'{ </span><span class="token token" style="color:#acda95"> "is_active": true, </span><span class="token token" style="color:#acda95"> "organization_guid": "Oa1bcd234eF", </span><span class="token token" style="color:#acda95"> "group_guid": "Ba1bc23dE4F", </span><span class="token token" style="color:#acda95"> "name": "My Webhook", </span><span class="token token" style="color:#acda95"> "event": "decodes", </span><span class="token token" style="color:#acda95"> "url": "https://bitly.com/webhooks", </span><span class="token token" style="color:#acda95"> "oauth_url": "https://fake.com/oauth", </span><span class="token token" style="color:#acda95"> "client_id": "fakeclientid123", </span><span class="token token" style="color:#acda95"> "client_secret": "itsasecreticanttellyou" </span><span class="token token" style="color:#acda95">}'</span><span> </span><span class="token token punctuation">\</span><span> </span>https://api-ssl.bitly.com/v4/webhooks</code></pre></div></div></div><div><label class="CodeSyntaxSelector_header__6P_Jc"><span>Response</span><div class="CodeSyntaxSelector_header__6P_Jc"><div class="Select_wrapper__58utF"><select class="Select_select__qXz_Z" aria-label="Select" autoComplete="off"><option value="201" selected="">201 CREATED</option><option value="400">400 BAD_REQUEST</option><option value="402">402 UPGRADE_REQUIRED</option><option value="403">403 FORBIDDEN</option><option value="404">404 NOT_FOUND</option><option value="422">422 UNPROCESSABLE_ENTITY</option><option value="429">429 MONTHLY_LIMIT_EXCEEDED</option><option value="500">500 INTERNAL_ERROR</option><option value="503">503 TEMPORARILY_UNAVAILABLE</option></select><svg viewBox="0 0 8 14" xmlns="http://www.w3.org/2000/svg"><path d="M6.463 7 .987 1.66a.61.61 0 0 1 0-.878.648.648 0 0 1 .9 0L7.813 6.56a.61.61 0 0 1 0 .878l-5.926 5.78a.648.648 0 0 1-.9 0 .61.61 0 0 1 0-.879L6.463 7Z"></path></svg></div></div></label><div class="CodeSyntaxSelector_body__hBJ7j"><div class="CodeBlock_codeBlock__KlURa"><pre tabindex="0" style="color:#36383b;font-family:ProximaNova, monospace;line-height:1.2;font-size:1rem"><code class="language-json" style="white-space:pre"><span class="token token punctuation">{</span><span> </span><span> </span><span class="token token property">"references"</span><span class="token token operator">:</span><span> </span><span class="token token punctuation">{</span><span> </span><span class="token token" style="color:#51763e">"any"</span><span> </span><span class="token token punctuation">}</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"guid"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"created"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"modified"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"modified_by"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"alerted"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"deactivated"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"is_active"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"boolean"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"is_alert"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"boolean"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"organization_guid"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"group_guid"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"name"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"event"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"url"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"status"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"oauth_url"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"client_id"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"client_secret"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"fetch_tags"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"boolean"</span><span> </span><span></span><span class="token token punctuation">}</span></code></pre></div></div></div></div></div><div class="MethodDetail_methodContainer__3EF7h" id="getWebhook"><div class="MethodDetail_method__fyEiw"><div><h3 class="MethodHeader_h3__seOfC">Retrieve Webhook</h3><h4 class="MethodHeader_description__3_p_p"><div class="MethodHeader_iconStyle__x5Ow4"><svg viewBox="0 0 14 6" xmlns="http://www.w3.org/2000/svg" class="IconRest_restIcon__3pju8 get"><title>Get</title><path d="M2.587 6c.307 0 .607-.044.9-.132.295-.088.533-.217.716-.387V2.876H2.271v.825h1.027v1.145a.772.772 0 0 1-.239.1 1.4 1.4 0 0 1-.383.049 1.338 1.338 0 0 1-1.083-.52c-.135-.17-.24-.379-.316-.626a2.879 2.879 0 0 1-.113-.84c0-.352.038-.655.113-.907.076-.253.182-.46.32-.623.137-.162.3-.281.488-.358a1.783 1.783 0 0 1 .97-.082l.13.032v.915h.889V.28a3.182 3.182 0 0 0-.59-.202A3.507 3.507 0 0 0 2.676 0c-.313 0-.628.055-.946.165a2.4 2.4 0 0 0-.861.523 2.707 2.707 0 0 0-.627.92C.081 1.98 0 2.433 0 2.966c0 .506.067.946.202 1.323.135.376.318.692.55.948a2.2 2.2 0 0 0 .82.572A2.7 2.7 0 0 0 2.587 6Zm6.24-.115V4.879H6.184V3.47h2.4V2.465h-2.4V1.121h2.602V.115h-3.71v5.77h3.75Zm4.43 0v-.907h-.914V1.022h.768v.997H14V.115H9.57V2.02h.89v-.997h.776v3.956h-.922v.907h2.942Z"></path></svg></div> /v4/webhooks/{webhook_guid}</h4><p class="MethodHeader_description__3_p_p">Returns a webhook.</p></div><div><h4 class="ParameterList_h4__nH9G8 ParameterList_dividing__wRGRx">Path Parameters</h4><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">webhook_guid</span><span class="Parameter_type__djM_s">string</span><span class="Parameter_required__pcK_H">Required</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">A GUID for a Bitly webhook</div></div></div></div><div class="MethodDetail_examples__8nXeM"><div><label class="CodeSyntaxSelector_header__6P_Jc CodeSyntaxSelector_headerDark__hI3A0"><span>Request</span><div class="CodeSyntaxSelector_header__6P_Jc CodeSyntaxSelector_headerDark__hI3A0"><div class="Select_wrapper__58utF Select_dark__KPIws"><select class="Select_select__qXz_Z Select_dark__KPIws" aria-label="Select" autoComplete="off"><option value="cURL" selected="">cURL</option><option value="Node">Node</option><option value="Browser">Browser</option><option value="Go">Go</option><option value="Python">Python</option></select><svg viewBox="0 0 8 14" xmlns="http://www.w3.org/2000/svg"><path d="M6.463 7 .987 1.66a.61.61 0 0 1 0-.878.648.648 0 0 1 .9 0L7.813 6.56a.61.61 0 0 1 0 .878l-5.926 5.78a.648.648 0 0 1-.9 0 .61.61 0 0 1 0-.879L6.463 7Z"></path></svg></div></div></label><div class="CodeSyntaxSelector_body__hBJ7j CodeSyntaxSelector_bodyDark__cizVw"><div class="CodeBlock_codeBlock__KlURa"><pre tabindex="0" style="color:#ffffff;font-family:ProximaNova, monospace;line-height:1.2;font-size:1rem"><code class="language-bash" style="white-space:pre"><span class="token token" style="color:#ee6123">curl</span><span> </span><span class="token token punctuation">\</span><span> </span><span>-H </span><span class="token token" style="color:#acda95">'Authorization: Bearer {TOKEN}'</span><span> </span><span class="token token punctuation">\</span><span> </span><span>-X GET </span><span class="token token punctuation">\</span><span> </span>https://api-ssl.bitly.com/v4/webhooks/Wa1bcDefG23</code></pre></div></div></div><div><label class="CodeSyntaxSelector_header__6P_Jc"><span>Response</span><div class="CodeSyntaxSelector_header__6P_Jc"><div class="Select_wrapper__58utF"><select class="Select_select__qXz_Z" aria-label="Select" autoComplete="off"><option value="200" selected="">200 SUCCESS</option><option value="400">400 BAD_REQUEST</option><option value="402">402 UPGRADE_REQUIRED</option><option value="403">403 FORBIDDEN</option><option value="404">404 NOT_FOUND</option><option value="429">429 MONTHLY_LIMIT_EXCEEDED</option><option value="500">500 INTERNAL_ERROR</option><option value="503">503 TEMPORARILY_UNAVAILABLE</option></select><svg viewBox="0 0 8 14" xmlns="http://www.w3.org/2000/svg"><path d="M6.463 7 .987 1.66a.61.61 0 0 1 0-.878.648.648 0 0 1 .9 0L7.813 6.56a.61.61 0 0 1 0 .878l-5.926 5.78a.648.648 0 0 1-.9 0 .61.61 0 0 1 0-.879L6.463 7Z"></path></svg></div></div></label><div class="CodeSyntaxSelector_body__hBJ7j"><div class="CodeBlock_codeBlock__KlURa"><pre tabindex="0" style="color:#36383b;font-family:ProximaNova, monospace;line-height:1.2;font-size:1rem"><code class="language-json" style="white-space:pre"><span class="token token punctuation">{</span><span> </span><span> </span><span class="token token property">"references"</span><span class="token token operator">:</span><span> </span><span class="token token punctuation">{</span><span> </span><span class="token token" style="color:#51763e">"any"</span><span> </span><span class="token token punctuation">}</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"guid"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"created"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"modified"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"modified_by"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"alerted"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"deactivated"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"is_active"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"boolean"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"is_alert"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"boolean"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"organization_guid"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"group_guid"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"name"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"event"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"url"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"status"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"oauth_url"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"client_id"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"client_secret"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"fetch_tags"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"boolean"</span><span> </span><span></span><span class="token token punctuation">}</span></code></pre></div></div></div></div></div><div class="MethodDetail_methodContainer__3EF7h" id="updateWebhook"><div class="MethodDetail_method__fyEiw"><div><h3 class="MethodHeader_h3__seOfC">Update Webhook</h3><h4 class="MethodHeader_description__3_p_p"><div class="MethodHeader_iconStyle__x5Ow4"><svg viewBox="0 0 23 6" xmlns="http://www.w3.org/2000/svg" class="IconRest_restIcon__3pju8 patch"><title>Patch</title><path d="M1.095 5.885V3.898c.027.006.07.011.132.017a4.052 4.052 0 0 0 .372.016h.128c.277 0 .545-.037.803-.11.259-.075.49-.193.692-.355.202-.162.365-.368.487-.618.123-.25.184-.551.184-.903 0-.401-.07-.727-.212-.977a1.606 1.606 0 0 0-.547-.585 2.041 2.041 0 0 0-.756-.28 5.067 5.067 0 0 0-.835-.07c-.267 0-.534.012-.804.037C.47.095.224.13 0 .173v5.712h1.095Zm.472-2.934h-.1a2.448 2.448 0 0 1-.276-.017.853.853 0 0 1-.096-.016V1.047c.059-.011.136-.02.232-.03.096-.007.197-.012.304-.012.138 0 .274.014.408.042a.964.964 0 0 1 .355.148.801.801 0 0 1 .252.284.937.937 0 0 1 .096.45c0 .214-.033.387-.1.519a.787.787 0 0 1-.268.309 1.038 1.038 0 0 1-.38.152 2.235 2.235 0 0 1-.427.042Zm3.79 2.934.383-1.278h1.67l.4 1.278h1.152L7.163.115H6.068L4.26 5.885h1.095ZM7.194 3.7h-1.2l.56-1.929h.072l.568 1.929Zm5.668 2.184v-.907h-.903V1.022h.76v.997h.879V.115H9.218V2.02h.879v-.997h.767v3.956h-.91v.907h2.91Zm3.91.115c.276 0 .547-.036.81-.107.265-.072.482-.17.652-.297V3.948h-.88v.997c-.164.033-.335.05-.51.05-.246 0-.464-.049-.656-.145a1.383 1.383 0 0 1-.488-.408 1.881 1.881 0 0 1-.304-.63A2.973 2.973 0 0 1 15.293 3c0-.34.038-.636.112-.886.075-.25.179-.457.312-.622.133-.165.29-.287.468-.367.178-.08.371-.12.58-.12.175 0 .346.014.511.042v.94h.88V.271a2.727 2.727 0 0 0-.548-.19A3.419 3.419 0 0 0 16.796 0c-.303 0-.613.05-.927.152-.314.102-.6.27-.855.503a2.611 2.611 0 0 0-.628.923c-.163.382-.244.856-.244 1.422 0 .544.072 1.007.216 1.389.144.382.336.692.576.931.24.24.518.412.835.52.317.106.652.16 1.003.16Zm3.325-.115V3.47h1.807v2.415H23V.115h-1.095v2.35h-1.807V.114h-1.095v5.77h1.095Z"></path></svg></div> /v4/webhooks/{webhook_guid}</h4><p class="MethodHeader_description__3_p_p">Update a webhook</p></div><div><h4 class="ParameterList_h4__nH9G8 ParameterList_dividing__wRGRx">Path Parameters</h4><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">webhook_guid</span><span class="Parameter_type__djM_s">string</span><span class="Parameter_required__pcK_H">Required</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">A GUID for a Bitly webhook</div></div></div><div><h4 class="ParameterList_h4__nH9G8 ParameterList_dividing__wRGRx">Request Body Schema</h4><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">guid</span><span class="Parameter_type__djM_s">string</span><span class="Parameter_required__pcK_H">Required</span></div></div><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">is_active</span><span class="Parameter_type__djM_s">boolean</span></div></div><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">organization_guid</span><span class="Parameter_type__djM_s">string</span></div></div><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">group_guid</span><span class="Parameter_type__djM_s">string</span></div></div><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">name</span><span class="Parameter_type__djM_s">string</span></div></div><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">event</span><span class="Parameter_type__djM_s">string</span></div></div><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">url</span><span class="Parameter_type__djM_s">string</span></div></div><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">oauth_url</span><span class="Parameter_type__djM_s">string</span></div></div><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">client_id</span><span class="Parameter_type__djM_s">string</span></div></div><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">client_secret</span><span class="Parameter_type__djM_s">string</span></div></div><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">fetch_tags</span><span class="Parameter_type__djM_s">boolean</span></div></div></div></div><div class="MethodDetail_examples__8nXeM"><div><label class="CodeSyntaxSelector_header__6P_Jc CodeSyntaxSelector_headerDark__hI3A0"><span>Request</span><div class="CodeSyntaxSelector_header__6P_Jc CodeSyntaxSelector_headerDark__hI3A0"><div class="Select_wrapper__58utF Select_dark__KPIws"><select class="Select_select__qXz_Z Select_dark__KPIws" aria-label="Select" autoComplete="off"><option value="cURL" selected="">cURL</option><option value="Node">Node</option><option value="Browser">Browser</option><option value="Go">Go</option><option value="Python">Python</option></select><svg viewBox="0 0 8 14" xmlns="http://www.w3.org/2000/svg"><path d="M6.463 7 .987 1.66a.61.61 0 0 1 0-.878.648.648 0 0 1 .9 0L7.813 6.56a.61.61 0 0 1 0 .878l-5.926 5.78a.648.648 0 0 1-.9 0 .61.61 0 0 1 0-.879L6.463 7Z"></path></svg></div></div></label><div class="CodeSyntaxSelector_body__hBJ7j CodeSyntaxSelector_bodyDark__cizVw"><div class="CodeBlock_codeBlock__KlURa"><pre tabindex="0" style="color:#ffffff;font-family:ProximaNova, monospace;line-height:1.2;font-size:1rem"><code class="language-bash" style="white-space:pre"><span class="token token" style="color:#ee6123">curl</span><span> </span><span class="token token punctuation">\</span><span> </span><span>-H </span><span class="token token" style="color:#acda95">'Authorization: Bearer {TOKEN}'</span><span> </span><span class="token token punctuation">\</span><span> </span><span>-H </span><span class="token token" style="color:#acda95">'Content-Type: application/json'</span><span> </span><span class="token token punctuation">\</span><span> </span><span>-X PATCH </span><span class="token token punctuation">\</span><span> </span><span>-d </span><span class="token token" style="color:#acda95">'{ </span><span class="token token" style="color:#acda95"> "guid": "Wa1bcDefG23", </span><span class="token token" style="color:#acda95"> "is_active": true, </span><span class="token token" style="color:#acda95"> "organization_guid": "Oa1bcd234eF", </span><span class="token token" style="color:#acda95"> "group_guid": "Ba1bc23dE4F", </span><span class="token token" style="color:#acda95"> "name": "My Webhook", </span><span class="token token" style="color:#acda95"> "event": "decodes", </span><span class="token token" style="color:#acda95"> "url": "https://bitly.com/webhooks", </span><span class="token token" style="color:#acda95"> "oauth_url": "https://fake.com/oauth", </span><span class="token token" style="color:#acda95"> "client_id": "fakeclientid123", </span><span class="token token" style="color:#acda95"> "client_secret": "itsasecreticanttellyou" </span><span class="token token" style="color:#acda95">}'</span><span> </span><span class="token token punctuation">\</span><span> </span>https://api-ssl.bitly.com/v4/webhooks/Wa1bcDefG23</code></pre></div></div></div><div><label class="CodeSyntaxSelector_header__6P_Jc"><span>Response</span><div class="CodeSyntaxSelector_header__6P_Jc"><div class="Select_wrapper__58utF"><select class="Select_select__qXz_Z" aria-label="Select" autoComplete="off"><option value="200" selected="">200 SUCCESS</option><option value="400">400 BAD_REQUEST</option><option value="402">402 UPGRADE_REQUIRED</option><option value="403">403 FORBIDDEN</option><option value="404">404 NOT_FOUND</option><option value="422">422 UNPROCESSABLE_ENTITY</option><option value="429">429 MONTHLY_LIMIT_EXCEEDED</option><option value="500">500 INTERNAL_ERROR</option><option value="503">503 TEMPORARILY_UNAVAILABLE</option></select><svg viewBox="0 0 8 14" xmlns="http://www.w3.org/2000/svg"><path d="M6.463 7 .987 1.66a.61.61 0 0 1 0-.878.648.648 0 0 1 .9 0L7.813 6.56a.61.61 0 0 1 0 .878l-5.926 5.78a.648.648 0 0 1-.9 0 .61.61 0 0 1 0-.879L6.463 7Z"></path></svg></div></div></label><div class="CodeSyntaxSelector_body__hBJ7j"><div class="CodeBlock_codeBlock__KlURa"><pre tabindex="0" style="color:#36383b;font-family:ProximaNova, monospace;line-height:1.2;font-size:1rem"><code class="language-json" style="white-space:pre"><span class="token token punctuation">{</span><span> </span><span> </span><span class="token token property">"references"</span><span class="token token operator">:</span><span> </span><span class="token token punctuation">{</span><span> </span><span class="token token" style="color:#51763e">"any"</span><span> </span><span class="token token punctuation">}</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"guid"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"created"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"modified"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"modified_by"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"alerted"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"deactivated"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"is_active"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"boolean"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"is_alert"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"boolean"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"organization_guid"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"group_guid"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"name"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"event"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"url"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"status"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"oauth_url"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"client_id"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"client_secret"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"fetch_tags"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"boolean"</span><span> </span><span></span><span class="token token punctuation">}</span></code></pre></div></div></div></div></div><div class="MethodDetail_methodContainer__3EF7h" id="deleteWebhook"><div class="MethodDetail_method__fyEiw"><div><h3 class="MethodHeader_h3__seOfC">Delete Webhook</h3><h4 class="MethodHeader_description__3_p_p"><div class="MethodHeader_iconStyle__x5Ow4"><svg viewBox="0 0 28 6" xmlns="http://www.w3.org/2000/svg" class="IconRest_restIcon__3pju8 delete"><title>Delete</title><path d="M1.439 6c.54 0 .984-.087 1.33-.262.345-.175.616-.405.811-.69.196-.287.331-.612.406-.979.075-.366.113-.74.113-1.123 0-.422-.038-.811-.113-1.17a2.419 2.419 0 0 0-.398-.931 1.918 1.918 0 0 0-.775-.62C2.486.075 2.073 0 1.575 0c-.128 0-.274.003-.438.008C.974.014.816.021.663.03A11.118 11.118 0 0 0 0 .083v5.834c.07.01.169.02.297.029L.7 5.97c.14.008.276.015.41.02.134.006.244.009.33.009Zm.128-1.015c-.027 0-.061-.002-.104-.004a35.064 35.064 0 0 0-.133-.009l-.067-.004-.066-.004a.56.56 0 0 1-.096-.013V1.05c.048-.006.12-.013.217-.021.096-.009.196-.013.297-.013.306 0 .547.061.724.183.176.122.31.278.398.466.088.189.144.397.168.624a6.241 6.241 0 0 1-.004 1.39 2.07 2.07 0 0 1-.177.658c-.09.194-.229.35-.413.47-.185.12-.433.179-.744.179Zm7.145.923V4.893H6.084V3.47H8.47V2.455H6.084V1.098h2.588V.083h-3.69v5.825h3.73Zm4.854 0V3.537h-.997v1.356H10.97V.083h-1.1v5.825h3.696Zm4.79 0V4.893h-2.628V3.47h2.387V2.455h-2.387V1.098h2.588V.083h-3.69v5.825h3.73Zm4.404 0v-.915h-.908V1h.763v1.007h.884V.083h-4.404v1.923h.884V.999h.772v3.994h-.916v.915h2.925Zm5.24 0V4.893h-2.628V3.47h2.387V2.455h-2.387V1.098h2.588V.083H24.27v5.825H28Z"></path></svg></div> /v4/webhooks/{webhook_guid}</h4><p class="MethodHeader_description__3_p_p">Deletes a webhook.</p></div><div><h4 class="ParameterList_h4__nH9G8 ParameterList_dividing__wRGRx">Path Parameters</h4><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">webhook_guid</span><span class="Parameter_type__djM_s">string</span><span class="Parameter_required__pcK_H">Required</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">A GUID for a Bitly webhook</div></div></div></div><div class="MethodDetail_examples__8nXeM"><div><label class="CodeSyntaxSelector_header__6P_Jc CodeSyntaxSelector_headerDark__hI3A0"><span>Request</span><div class="CodeSyntaxSelector_header__6P_Jc CodeSyntaxSelector_headerDark__hI3A0"><div class="Select_wrapper__58utF Select_dark__KPIws"><select class="Select_select__qXz_Z Select_dark__KPIws" aria-label="Select" autoComplete="off"><option value="cURL" selected="">cURL</option><option value="Node">Node</option><option value="Browser">Browser</option><option value="Go">Go</option><option value="Python">Python</option></select><svg viewBox="0 0 8 14" xmlns="http://www.w3.org/2000/svg"><path d="M6.463 7 .987 1.66a.61.61 0 0 1 0-.878.648.648 0 0 1 .9 0L7.813 6.56a.61.61 0 0 1 0 .878l-5.926 5.78a.648.648 0 0 1-.9 0 .61.61 0 0 1 0-.879L6.463 7Z"></path></svg></div></div></label><div class="CodeSyntaxSelector_body__hBJ7j CodeSyntaxSelector_bodyDark__cizVw"><div class="CodeBlock_codeBlock__KlURa"><pre tabindex="0" style="color:#ffffff;font-family:ProximaNova, monospace;line-height:1.2;font-size:1rem"><code class="language-bash" style="white-space:pre"><span class="token token" style="color:#ee6123">curl</span><span> </span><span class="token token punctuation">\</span><span> </span><span>-H </span><span class="token token" style="color:#acda95">'Authorization: Bearer {TOKEN}'</span><span> </span><span class="token token punctuation">\</span><span> </span><span>-X DELETE </span><span class="token token punctuation">\</span><span> </span>https://api-ssl.bitly.com/v4/webhooks/Wa1bcDefG23</code></pre></div></div></div><div><label class="CodeSyntaxSelector_header__6P_Jc"><span>Response</span><div class="CodeSyntaxSelector_header__6P_Jc"><div class="Select_wrapper__58utF"><select class="Select_select__qXz_Z" aria-label="Select" autoComplete="off"><option value="204" selected="">204 SUCCESS</option><option value="400">400 BAD_REQUEST</option><option value="402">402 UPGRADE_REQUIRED</option><option value="403">403 FORBIDDEN</option><option value="404">404 NOT_FOUND</option><option value="500">500 INTERNAL_ERROR</option><option value="503">503 TEMPORARILY_UNAVAILABLE</option></select><svg viewBox="0 0 8 14" xmlns="http://www.w3.org/2000/svg"><path d="M6.463 7 .987 1.66a.61.61 0 0 1 0-.878.648.648 0 0 1 .9 0L7.813 6.56a.61.61 0 0 1 0 .878l-5.926 5.78a.648.648 0 0 1-.9 0 .61.61 0 0 1 0-.879L6.463 7Z"></path></svg></div></div></label><div class="CodeSyntaxSelector_body__hBJ7j"></div></div></div></div><div class="MethodDetail_methodContainer__3EF7h" id="verifyWebhook"><div class="MethodDetail_method__fyEiw"><div><h3 class="MethodHeader_h3__seOfC">Verify Webhook</h3><h4 class="MethodHeader_description__3_p_p"><div class="MethodHeader_iconStyle__x5Ow4"><svg viewBox="0 0 18 6" xmlns="http://www.w3.org/2000/svg" class="IconRest_restIcon__3pju8 post"><title>Post</title><path d="M1.072 5.885V3.898c.026.006.069.011.129.017a3.88 3.88 0 0 0 .364.016h.125c.27 0 .533-.037.786-.11.253-.075.478-.193.677-.355.198-.162.357-.368.477-.618s.18-.551.18-.903c0-.401-.07-.727-.208-.977a1.592 1.592 0 0 0-.536-.585 1.971 1.971 0 0 0-.739-.28 4.854 4.854 0 0 0-.817-.07C1.249.033.987.045.724.07.46.095.219.13 0 .173v5.712h1.072Zm.461-2.934h-.098a2.344 2.344 0 0 1-.27-.017.818.818 0 0 1-.093-.016V1.047c.057-.011.133-.02.227-.03.093-.007.193-.012.297-.012.135 0 .268.014.399.042.13.027.246.077.348.148a.796.796 0 0 1 .246.284.954.954 0 0 1 .094.45c0 .214-.032.387-.098.519a.782.782 0 0 1-.262.309c-.11.074-.233.125-.371.152a2.141 2.141 0 0 1-.419.042ZM6.47 6c.694 0 1.212-.265 1.553-.795.342-.53.513-1.265.513-2.205 0-.44-.038-.843-.114-1.212a2.872 2.872 0 0 0-.36-.947 1.78 1.78 0 0 0-.637-.618C7.163.074 6.844 0 6.469 0c-.35 0-.653.069-.911.206a1.78 1.78 0 0 0-.645.59c-.172.255-.3.57-.384.943A5.804 5.804 0 0 0 4.404 3c0 .44.037.843.11 1.212.073.368.191.684.356.947.164.264.378.47.641.618.263.149.583.223.958.223Zm0-1.005c-.203 0-.366-.053-.489-.157a.989.989 0 0 1-.281-.425 2.57 2.57 0 0 1-.133-.63A8.129 8.129 0 0 1 5.53 3c0-.66.065-1.157.195-1.492.13-.335.378-.503.743-.503.209 0 .376.054.501.161a1 1 0 0 1 .286.433c.065.181.106.393.125.635.018.241.027.497.027.766 0 .34-.014.636-.043.886-.029.25-.08.457-.152.622a.826.826 0 0 1-.29.367.803.803 0 0 1-.454.12ZM10.991 6c.297 0 .574-.037.83-.111.255-.074.476-.187.664-.338.188-.151.334-.338.438-.56.104-.223.157-.483.157-.78 0-.307-.067-.563-.2-.766a1.814 1.814 0 0 0-.493-.507 3.3 3.3 0 0 0-.641-.342 11.165 11.165 0 0 1-.642-.28 2.185 2.185 0 0 1-.493-.313.562.562 0 0 1-.199-.445c0-.176.072-.316.215-.42.144-.105.34-.157.59-.157a2.757 2.757 0 0 1 .767.107.14.14 0 0 0 .047.008v.915h.86V.338a2.45 2.45 0 0 0-.735-.247C11.85.03 11.536 0 11.218 0c-.282 0-.537.041-.767.124-.23.082-.426.197-.59.346A1.557 1.557 0 0 0 9.476 1a1.66 1.66 0 0 0-.137.68c0 .324.067.588.2.792.133.203.297.372.493.506.195.135.409.246.641.334.232.088.446.176.642.264.195.088.36.19.492.305.133.115.2.266.2.453 0 .209-.081.375-.243.499-.161.123-.388.185-.68.185-.162 0-.314-.018-.458-.053a2.256 2.256 0 0 1-.395-.136l-.047-.017v-.816h-.86V5.53c.067.039.156.085.266.14.11.055.236.107.379.157.143.05.3.09.47.124.169.033.353.049.55.049Zm6.29-.115v-.907h-.885V1.022h.744v.997H18V.115h-4.287V2.02h.86v-.997h.752v3.956h-.892v.907h2.847Z"></path></svg></div> /v4/webhooks/{webhook_guid}/verify</h4><p class="MethodHeader_description__3_p_p">Sends ping event to test webhook configuration.</p></div><div><h4 class="ParameterList_h4__nH9G8 ParameterList_dividing__wRGRx">Path Parameters</h4><div class="Parameter_parameter__J0LgW"><div><span class="Parameter_name___UYgz">webhook_guid</span><span class="Parameter_type__djM_s">string</span><span class="Parameter_required__pcK_H">Required</span></div><div class="Parameter_description__tZj_3 Parameter_spacer__JKXbH">A GUID for a Bitly webhook</div></div></div></div><div class="MethodDetail_examples__8nXeM"><div><label class="CodeSyntaxSelector_header__6P_Jc CodeSyntaxSelector_headerDark__hI3A0"><span>Request</span><div class="CodeSyntaxSelector_header__6P_Jc CodeSyntaxSelector_headerDark__hI3A0"><div class="Select_wrapper__58utF Select_dark__KPIws"><select class="Select_select__qXz_Z Select_dark__KPIws" aria-label="Select" autoComplete="off"><option value="cURL" selected="">cURL</option><option value="Node">Node</option><option value="Browser">Browser</option><option value="Go">Go</option><option value="Python">Python</option></select><svg viewBox="0 0 8 14" xmlns="http://www.w3.org/2000/svg"><path d="M6.463 7 .987 1.66a.61.61 0 0 1 0-.878.648.648 0 0 1 .9 0L7.813 6.56a.61.61 0 0 1 0 .878l-5.926 5.78a.648.648 0 0 1-.9 0 .61.61 0 0 1 0-.879L6.463 7Z"></path></svg></div></div></label><div class="CodeSyntaxSelector_body__hBJ7j CodeSyntaxSelector_bodyDark__cizVw"><div class="CodeBlock_codeBlock__KlURa"><pre tabindex="0" style="color:#ffffff;font-family:ProximaNova, monospace;line-height:1.2;font-size:1rem"><code class="language-bash" style="white-space:pre"><span class="token token" style="color:#ee6123">curl</span><span> </span><span class="token token punctuation">\</span><span> </span><span>-H </span><span class="token token" style="color:#acda95">'Authorization: Bearer {TOKEN}'</span><span> </span><span class="token token punctuation">\</span><span> </span><span>-X POST </span><span class="token token punctuation">\</span><span> </span>https://api-ssl.bitly.com/v4/webhooks/Wa1bcDefG23/verify</code></pre></div></div></div><div><label class="CodeSyntaxSelector_header__6P_Jc"><span>Response</span><div class="CodeSyntaxSelector_header__6P_Jc"><div class="Select_wrapper__58utF"><select class="Select_select__qXz_Z" aria-label="Select" autoComplete="off"><option value="200" selected="">200 SUCCESS</option><option value="400">400 BAD_REQUEST</option><option value="402">402 UPGRADE_REQUIRED</option><option value="403">403 FORBIDDEN</option><option value="404">404 NOT_FOUND</option><option value="500">500 INTERNAL_ERROR</option><option value="503">503 TEMPORARILY_UNAVAILABLE</option></select><svg viewBox="0 0 8 14" xmlns="http://www.w3.org/2000/svg"><path d="M6.463 7 .987 1.66a.61.61 0 0 1 0-.878.648.648 0 0 1 .9 0L7.813 6.56a.61.61 0 0 1 0 .878l-5.926 5.78a.648.648 0 0 1-.9 0 .61.61 0 0 1 0-.879L6.463 7Z"></path></svg></div></div></label><div class="CodeSyntaxSelector_body__hBJ7j"><div class="CodeBlock_codeBlock__KlURa"><pre tabindex="0" style="color:#36383b;font-family:ProximaNova, monospace;line-height:1.2;font-size:1rem"><code class="language-json" style="white-space:pre"><span class="token token punctuation">{</span><span> </span><span> </span><span class="token token property">"references"</span><span class="token token operator">:</span><span> </span><span class="token token punctuation">{</span><span> </span><span class="token token" style="color:#51763e">"any"</span><span> </span><span class="token token punctuation">}</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"guid"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"created"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"modified"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"modified_by"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"alerted"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"deactivated"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"is_active"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"boolean"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"is_alert"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"boolean"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"organization_guid"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"group_guid"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"name"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"event"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"url"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"status"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"oauth_url"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"client_id"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"client_secret"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"string"</span><span class="token token punctuation">,</span><span> </span><span> </span><span class="token token property">"fetch_tags"</span><span class="token token operator">:</span><span> </span><span class="token token" style="color:#51763e">"boolean"</span><span> </span><span></span><span class="token token punctuation">}</span></code></pre></div></div></div></div></div></div><footer><div class="Footer_footer__7PvU2"><div class="Footer_row__1ruA0"><div class="Footer_title__Ct_v_">Resources</div><a target="_blank" rel="noopener noreferrer" href="https://bitly.com/blog/" class="Footer_link__V8hyW">Blog</a><a target="_blank" rel="noopener noreferrer" href="https://bitly.com/pages/resources/" class="Footer_link__V8hyW">Webinar and Ebooks</a></div><div class="Footer_row__1ruA0"><div class="Footer_title__Ct_v_">Legal</div><a target="_blank" rel="noopener noreferrer" href="https://bitly.com/pages/privacy/" class="Footer_link__V8hyW">Privacy Policy</a><a target="_blank" rel="noopener noreferrer" href="https://bitly.com/pages/terms-of-service/" class="Footer_link__V8hyW">Terms of Service</a></div><div class="Footer_row__1ruA0"><div class="Footer_title__Ct_v_">Company</div><a target="_blank" rel="noopener noreferrer" href="https://bitly.com/pages/careers/" class="Footer_link__V8hyW">Careers</a><a target="_blank" rel="noopener noreferrer" href="https://bitly.is/API-support" class="Footer_link__V8hyW">Contact</a></div><div class="Footer_row__1ruA0"><svg xmlns="http://www.w3.org/2000/svg" viewBox="-1376 546.6 90 45" xml:space="preserve"><title>Bitly</title><path d="M-1329.1 577c-4.5 0-7-2.7-7-6 0-1.3.1-11.4.1-11.4-1.5 0-2.2-.8-2.2-1.7 0-1 .8-1.9 2-1.9v-4.7c0-1.6 1.2-2.9 2.8-2.9 1.6 0 2.8 1.3 2.8 2.9 0 1.2-.1 2.8-.1 4.7h2.9c1.5 0 2.2.8 2.2 1.9 0 1.1-.8 1.8-1.9 1.8h-3.2c-.1 3.2-.2 7.1-.2 10.1 0 1.1.8 2.4 2.6 2.4 4.3 0 5.5-4.3 5.5-12.4 0-1.1.9-1.9 1.9-1.9 1.1 0 1.9.8 1.9 1.9.1 10.7-2.5 17.2-10.1 17.2"></path><path d="M-1310.9 560.5s1.8-1.2 2.9-1.2c1.1 0 .9.2.9 1.3 0 11.6-2.1 16.5-9.6 16.5-3.3 0-6.3-2.4-6.3-5.4 0-1.2.2-3.5.2-4.6 0-11.2-.2-13.5-.2-16.8 0-1.6 1.3-3 2.9-3 1.6 0 2.8 1.3 2.8 2.9 0 3.3-.4 8-.5 20.4 0 1 .5 1.8 1.8 1.8 4.3-.2 4.9-5.1 5.1-11.9"></path><path d="M-1297.3 575s-1.6 2.1-5.6 2c-5.3-.1-7.7-4.3-8-8.6-.2-3.3-.1-5.1-.1-7.3 0-1.6 1.1-2.9 2.6-2.9 1.6 0 2.5 1.3 2.5 2.9 0 2.1-.1 3.5-.2 5.9 0 2.8.9 5.3 3.2 5.2 2.2 0 4.7-.9 4.7-5.7v-5.4c0-1.6 1.1-2.9 2.7-2.9s2.7 1.3 2.7 2.9c0 2.1-.2 3.8-.2 7.1 0 0-.1 6.6.1 8.1.7-.2 1.8-1 2.9-2.7.7-1 2-1.3 2.7-.8 1.1.6 1.1 1.9.6 2.8-1.1 2.3-2.4 3.8-5.9 5 0 4-.3 9.8-7.6 10.9-6.3.9-9.1-2.7-9.1-5.8 0-4.9 4.9-6.3 11.9-8.1l.1-2.6zm.6 6.4c-3.6.8-8 1.9-8 4.1 0 2.1 2.2 2.4 4 2.1 3.7-.8 4.1-3 4-6.2zM-1347.6 571.6c0-1.3-.2-12.2-.2-12.2 0-1.6 1-2.9 2.6-2.9s2.6 1.4 2.6 2.9c-.2 5.1-.3 8.4-.3 10.2 0 1 .6 2.6 2.2 2.6 3.8 0 4.6-3.5 4.6-12.1 0-1.1 1.1-1.9 2.2-1.9s1.9.8 1.9 1.9c0 13-2.3 16.9-9.6 16.9-2.8 0-6-1.9-6-5.4"></path><path d="M-1345.8 557.5c-1.1 0-1.1.2-1.8 1.3 0 4.8-1.2 10.7-6.6 12.9 3.8-8-.1-15.3-6.4-15.3-3 0-4.9 1.1-6.1 2.1 0-2.3.1-6.4.1-6.4 0-2.9-1-5.1-4.5-5.2-2 0-3.5.9-4.5 3-.3.8-.2 1.6.5 2 .6.3 1.5.1 1.9-.5.3-.4.5-.5.7-.4.4 0 .4.7.5 1.2 0 .3.3 5.1.2 17.7 0 3.5 2.7 7.5 9.3 7.5 13 0 18.6-4.8 18.6-17.7-.3-1.2-.9-2.2-1.9-2.2zm-16.9 14.9c-2.5 0-4.2-.7-4.3-2.9v-2.2c.2-3.1 2.4-5.4 4.6-5.8 2.7-.5 4.5.7 4.5 4.2-.1 2.4-.8 6.6-4.8 6.7zM-1345.1 548.4c1.6 0 2.9 1.3 2.9 2.9s-1.3 2.9-2.9 2.9c-1.6 0-2.9-1.3-2.9-2.9s1.3-2.9 2.9-2.9"></path></svg><div class="Footer_description__eC8la">© 2025 Bitly</div><div class="Footer_description__eC8la">Handmade in NYC, San Francisco, Denver, and all over the world.</div><div class="Footer_socialIcons__dFxBT"><a href="https://x.com/bitly" target="_blank" rel="noopener noreferrer"><svg width="24" height="24" xmlns="http://www.w3.org/2000/svg"><title>X (Formerly Twitter)</title><path d="m.058.769 9.267 12.389L0 23.231h2.099l8.164-8.819 6.595 8.819H24l-9.788-13.086 8.68-9.376h-2.099l-7.518 8.122L7.2.769H.058Zm3.087 1.545h3.28l14.488 19.372h-3.28L3.145 2.314Z" fill="#121314"></path></svg></a><a href="https://www.instagram.com/bitly/" target="_blank" rel="noopener noreferrer"><svg width="24" height="24" xmlns="http://www.w3.org/2000/svg"><title>Instagram</title><path d="M12 0C8.74 0 8.333.015 7.053.072 5.775.132 4.905.333 4.14.63a5.876 5.876 0 0 0-2.126 1.384A5.855 5.855 0 0 0 .63 4.14C.333 4.905.131 5.775.072 7.053.012 8.333 0 8.74 0 12s.015 3.667.072 4.947c.06 1.277.261 2.148.558 2.913a5.885 5.885 0 0 0 1.384 2.126A5.868 5.868 0 0 0 4.14 23.37c.766.296 1.636.499 2.913.558C8.333 23.988 8.74 24 12 24s3.667-.015 4.947-.072c1.277-.06 2.148-.262 2.913-.558a5.898 5.898 0 0 0 2.126-1.384 5.86 5.86 0 0 0 1.384-2.126c.296-.765.499-1.636.558-2.913.06-1.28.072-1.687.072-4.947s-.015-3.667-.072-4.947c-.06-1.277-.262-2.149-.558-2.913a5.89 5.89 0 0 0-1.384-2.126A5.847 5.847 0 0 0 19.86.63c-.765-.297-1.636-.499-2.913-.558C15.667.012 15.26 0 12 0Zm0 2.16c3.203 0 3.585.016 4.85.071 1.17.055 1.805.249 2.227.415.562.217.96.477 1.382.896.419.42.679.819.896 1.381.164.422.36 1.057.413 2.227.057 1.266.07 1.646.07 4.85 0 3.204-.015 3.585-.074 4.85-.061 1.17-.256 1.805-.421 2.227a3.81 3.81 0 0 1-.899 1.382 3.744 3.744 0 0 1-1.38.896c-.42.164-1.065.36-2.235.413-1.274.057-1.649.07-4.859.07-3.211 0-3.586-.015-4.859-.074-1.171-.061-1.816-.256-2.236-.421a3.716 3.716 0 0 1-1.379-.899 3.644 3.644 0 0 1-.9-1.38c-.165-.42-.359-1.065-.42-2.235-.045-1.26-.061-1.649-.061-4.844 0-3.196.016-3.586.061-4.861.061-1.17.255-1.814.42-2.234.21-.57.479-.96.9-1.381.419-.419.81-.689 1.379-.898.42-.166 1.051-.361 2.221-.421 1.275-.045 1.65-.06 4.859-.06l.045.03Zm0 3.678a6.162 6.162 0 1 0 0 12.324 6.162 6.162 0 1 0 0-12.324ZM12 16c-2.21 0-4-1.79-4-4s1.79-4 4-4 4 1.79 4 4-1.79 4-4 4Zm7.846-10.405a1.441 1.441 0 0 1-2.88 0 1.44 1.44 0 0 1 2.88 0Z" fill="#121314"></path></svg></a><a href="https://www.linkedin.com/company/552285/admin/" target="_blank" rel="noopener noreferrer"><svg width="24" height="24" xmlns="http://www.w3.org/2000/svg"><title>LinkedIn</title><path d="M20.447 20.452h-3.554v-5.569c0-1.328-.027-3.037-1.852-3.037-1.853 0-2.136 1.445-2.136 2.939v5.667H9.351V9h3.414v1.561h.046c.477-.9 1.637-1.85 3.37-1.85 3.601 0 4.267 2.37 4.267 5.455v6.286h-.001ZM5.337 7.433a2.062 2.062 0 0 1-2.063-2.065 2.064 2.064 0 1 1 2.063 2.065Zm1.782 13.019H3.555V9h3.564v11.452ZM22.225 0H1.771C.792 0 0 .774 0 1.729v20.542C0 23.227.792 24 1.771 24h20.451C23.2 24 24 23.227 24 22.271V1.729C24 .774 23.2 0 22.222 0h.003Z" fill="#121314"></path></svg></a><a href="https://www.facebook.com/bitly" target="_blank" rel="noopener noreferrer"><svg width="24" height="24" xmlns="http://www.w3.org/2000/svg"><title>Facebook</title><path d="M22.676 0H1.324C.593 0 0 .593 0 1.324v21.352C0 23.408.593 24 1.324 24h11.494v-9.294H9.689v-3.621h3.129V8.41c0-3.099 1.894-4.785 4.659-4.785 1.325 0 2.464.097 2.796.141v3.24h-1.921c-1.5 0-1.792.721-1.792 1.771v2.311h3.584l-.465 3.63H16.56V24h6.115c.733 0 1.325-.592 1.325-1.324V1.324C24 .593 23.408 0 22.676 0" fill="#121314"></path></svg></a></div></div></div></footer></main></div></div></div><script id="__NEXT_DATA__" type="application/json">{"props":{"pageProps":{"methodsByTag":[{"name":"Bitlinks","description":"Bitlinks are shortened links. They could begin with the bit.ly domain or your own custom branded short domain (BSD).\n","methods":[{"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":{"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"}}}}},"responses":{"200":{"description":"SUCCESS","headers":{"X-Bsd-Error":{"schema":{"type":"string"},"description":"An explanation of the DNS error received"}},"content":{"application/json":{"schema":{"type":"object","allOf":[{"type":"object","properties":{"references":{"type":"object","additionalProperties":{"type":"string"}}}},{"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":{"type":"object","properties":{"guid":{"type":"string"},"bitlink":{"type":"string"},"app_uri_path":{"type":"string"},"install_url":{"type":"string"},"app_guid":{"type":"string"},"os":{"type":"string","enum":["ios","android"]},"install_type":{"type":"string","enum":["no_install","auto_install","promote_install"]},"created":{"type":"string","description":"ISO timestamp"},"modified":{"type":"string","description":"ISO timestamp"},"brand_guid":{"type":"string"}}}}}}]}}}},"201":{"description":"CREATED","headers":{"X-Bsd-Error":{"schema":{"type":"string"},"description":"An explanation of the DNS error received"}},"content":{"application/json":{"schema":{"type":"object","allOf":[{"type":"object","properties":{"references":{"type":"object","additionalProperties":{"type":"string"}}}},{"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":{"type":"object","properties":{"guid":{"type":"string"},"bitlink":{"type":"string"},"app_uri_path":{"type":"string"},"install_url":{"type":"string"},"app_guid":{"type":"string"},"os":{"type":"string","enum":["ios","android"]},"install_type":{"type":"string","enum":["no_install","auto_install","promote_install"]},"created":{"type":"string","description":"ISO timestamp"},"modified":{"type":"string","description":"ISO timestamp"},"brand_guid":{"type":"string"}}}}}}]}}}},"400":{"description":"BAD_REQUEST","content":{"application/json":{"schema":{"description":"BAD_REQUEST","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"403":{"description":"FORBIDDEN","headers":{"X-Ratelimit-Reason":{"schema":{"type":"string"},"description":"An explanation of the ratelimit received."}},"content":{"application/json":{"schema":{"description":"FORBIDDEN","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"417":{"description":"EXPECTATION_FAILED","content":{"application/json":{"schema":{"example":"DNS_CONFIGURATION_ERROR","description":"EXPECTATION_FAILED","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"422":{"description":"UNPROCESSABLE_ENTITY","content":{"application/json":{"schema":{"description":"UNPROCESSABLE_ENTITY","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"429":{"description":"MONTHLY_LIMIT_EXCEEDED","content":{"application/json":{"schema":{"example":"BRANDED_LINK_MONTHLY_LIMIT_EXCEEDED","description":"MONTHLY_LIMIT_EXCEEDED","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"}}}]}}}},"500":{"description":"INTERNAL_ERROR","content":{"application/json":{"schema":{"description":"INTERNAL_ERROR","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"503":{"description":"TEMPORARILY_UNAVAILABLE","content":{"application/json":{"schema":{"description":"TEMPORARILY_UNAVAILABLE","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}}},"method":"post","path":"/shorten","requestSamples":[{"name":"cURL","syntaxLanguage":"bash","sample":"curl \\\n-H 'Authorization: Bearer {TOKEN}' \\\n-H 'Content-Type: application/json' \\\n-X POST \\\n-d '{\n \"long_url\": \"https://dev.bitly.com\",\n \"domain\": \"bit.ly\",\n \"group_guid\": \"Ba1bc23dE4F\"\n}' \\\nhttps://api-ssl.bitly.com/v4/shorten","exampleName":"Default"},{"sample":"var fetch = require('node-fetch');\n\nfetch('https://api-ssl.bitly.com/v4/shorten', {\n method: 'POST',\n headers: {\n 'Authorization': 'Bearer {TOKEN}',\n 'Content-Type': 'application/json'\n },\n body: JSON.stringify({ \"long_url\": \"https://dev.bitly.com\", \"domain\": \"bit.ly\", \"group_guid\": \"Ba1bc23dE4F\" })\n});\n","name":"Node","syntaxLanguage":"javascript","exampleName":"Default"},{"sample":"fetch('https://api-ssl.bitly.com/v4/shorten', {\n method: 'POST',\n headers: {\n 'Authorization': 'Bearer {TOKEN}',\n 'Content-Type': 'application/json'\n },\n body: JSON.stringify({ \"long_url\": \"https://dev.bitly.com\", \"domain\": \"bit.ly\", \"group_guid\": \"Ba1bc23dE4F\" })\n});\n","name":"Browser","syntaxLanguage":"javascript","exampleName":"Default"},{"sample":"package main\n\nimport (\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n\t\"strings\"\n)\n\nfunc main() {\n\tclient := \u0026http.Client{}\n\tvar data = strings.NewReader(`{ \"long_url\": \"https://dev.bitly.com\", \"domain\": \"bit.ly\", \"group_guid\": \"Ba1bc23dE4F\" }`)\n\treq, err := http.NewRequest(\"POST\", \"https://api-ssl.bitly.com/v4/shorten\", data)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\treq.Header.Set(\"Authorization\", \"Bearer {TOKEN}\")\n\treq.Header.Set(\"Content-Type\", \"application/json\")\n\tresp, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tdefer resp.Body.Close()\n\tbodyText, err := ioutil.ReadAll(resp.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tfmt.Printf(\"%s\\n\", bodyText)\n}\n","name":"Go","syntaxLanguage":"go","exampleName":"Default"},{"sample":"import requests\n\nheaders = {\n 'Authorization': 'Bearer {TOKEN}',\n 'Content-Type': 'application/json',\n}\n\ndata = '{ \"long_url\": \"https://dev.bitly.com\", \"domain\": \"bit.ly\", \"group_guid\": \"Ba1bc23dE4F\" }'\n\nresponse = requests.post('https://api-ssl.bitly.com/v4/shorten', headers=headers, data=data)\n","name":"Python","syntaxLanguage":"python","exampleName":"Default"}],"responseSamples":[{"statusCode":"200","description":"SUCCESS","json":"{\n \"references\": { \"any\" },\n \"link\": \"string\",\n \"id\": \"string\",\n \"long_url\": \"string\",\n \"archived\": \"boolean\",\n \"created_at\": \"string\",\n \"custom_bitlinks\": [\n \"string\"\n ],\n \"tags\": [\n \"string\"\n ],\n \"deeplinks\": [\n {\n \"guid\": \"string\",\n \"bitlink\": \"string\",\n \"app_uri_path\": \"string\",\n \"install_url\": \"string\",\n \"app_guid\": \"string\",\n \"os\": \"string\",\n \"install_type\": \"string\",\n \"created\": \"string\",\n \"modified\": \"string\",\n \"brand_guid\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"201","description":"CREATED","json":"{\n \"references\": { \"any\" },\n \"link\": \"string\",\n \"id\": \"string\",\n \"long_url\": \"string\",\n \"archived\": \"boolean\",\n \"created_at\": \"string\",\n \"custom_bitlinks\": [\n \"string\"\n ],\n \"tags\": [\n \"string\"\n ],\n \"deeplinks\": [\n {\n \"guid\": \"string\",\n \"bitlink\": \"string\",\n \"app_uri_path\": \"string\",\n \"install_url\": \"string\",\n \"app_guid\": \"string\",\n \"os\": \"string\",\n \"install_type\": \"string\",\n \"created\": \"string\",\n \"modified\": \"string\",\n \"brand_guid\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"400","description":"BAD_REQUEST","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"403","description":"FORBIDDEN","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"417","description":"EXPECTATION_FAILED","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"422","description":"UNPROCESSABLE_ENTITY","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"429","description":"MONTHLY_LIMIT_EXCEEDED","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\"\n}","csv":null},{"statusCode":"500","description":"INTERNAL_ERROR","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"503","description":"TEMPORARILY_UNAVAILABLE","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null}],"requestBodyParams":[{"name":"long_url","description":null,"required":true,"schema":{"type":"string","default":null,"enum":null},"items":null,"properties":null},{"name":"domain","description":null,"required":false,"schema":{"type":"string","default":"bit.ly","enum":null},"items":null,"properties":null},{"name":"group_guid","description":null,"required":false,"schema":{"type":"string","default":null,"enum":null},"items":null,"properties":null}]},{"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":{"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":{"type":"object","properties":{"app_id":{"type":"string"},"app_uri_path":{"type":"string"},"install_url":{"type":"string"},"install_type":{"type":"string","enum":["no_install","auto_install","promote_install"]}}}}},"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\u0026hl=en_US","install_type":"promote_install"}]}}}}},"responses":{"200":{"description":"SUCCESS","content":{"application/json":{"schema":{"type":"object","allOf":[{"type":"object","properties":{"references":{"type":"object","additionalProperties":{"type":"string"}}}},{"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"}},"qr_code_ids":{"type":"array","items":{"type":"string"},"description":"a list of qr code ids that are associated with this bitlink"},"deeplinks":{"type":"array","items":{"type":"object","properties":{"guid":{"type":"string"},"bitlink":{"type":"string"},"app_uri_path":{"type":"string"},"install_url":{"type":"string"},"app_guid":{"type":"string"},"os":{"type":"string","enum":["ios","android"]},"install_type":{"type":"string","enum":["no_install","auto_install","promote_install"]},"created":{"type":"string","description":"ISO timestamp"},"modified":{"type":"string","description":"ISO timestamp"},"brand_guid":{"type":"string"}}}},"is_deleted":{"type":"boolean"},"campaign_ids":{"type":"array","items":{"type":"string"}}}}]}}}},"201":{"description":"CREATED","content":{"application/json":{"schema":{"type":"object","allOf":[{"type":"object","properties":{"references":{"type":"object","additionalProperties":{"type":"string"}}}},{"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"}},"qr_code_ids":{"type":"array","items":{"type":"string"},"description":"a list of qr code ids that are associated with this bitlink"},"deeplinks":{"type":"array","items":{"type":"object","properties":{"guid":{"type":"string"},"bitlink":{"type":"string"},"app_uri_path":{"type":"string"},"install_url":{"type":"string"},"app_guid":{"type":"string"},"os":{"type":"string","enum":["ios","android"]},"install_type":{"type":"string","enum":["no_install","auto_install","promote_install"]},"created":{"type":"string","description":"ISO timestamp"},"modified":{"type":"string","description":"ISO timestamp"},"brand_guid":{"type":"string"}}}},"is_deleted":{"type":"boolean"},"campaign_ids":{"type":"array","items":{"type":"string"}}}}]}}}},"400":{"description":"BAD_REQUEST","content":{"application/json":{"schema":{"description":"BAD_REQUEST","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"402":{"description":"UPGRADE_REQUIRED","content":{"application/json":{"schema":{"description":"UPGRADE_REQUIRED","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"403":{"description":"FORBIDDEN","content":{"application/json":{"schema":{"description":"FORBIDDEN","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"404":{"description":"NOT_FOUND","content":{"application/json":{"schema":{"description":"NOT_FOUND","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"417":{"description":"EXPECTATION_FAILED","content":{"application/json":{"schema":{"example":"DNS_CONFIGURATION_ERROR","description":"EXPECTATION_FAILED","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"422":{"description":"UNPROCESSABLE_ENTITY","content":{"application/json":{"schema":{"description":"UNPROCESSABLE_ENTITY","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"429":{"description":"MONTHLY_LIMIT_EXCEEDED","content":{"application/json":{"schema":{"example":"BRANDED_LINK_MONTHLY_LIMIT_EXCEEDED","description":"MONTHLY_LIMIT_EXCEEDED","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"}}}]}}}},"500":{"description":"INTERNAL_ERROR","content":{"application/json":{"schema":{"description":"INTERNAL_ERROR","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"503":{"description":"TEMPORARILY_UNAVAILABLE","content":{"application/json":{"schema":{"description":"TEMPORARILY_UNAVAILABLE","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}}},"method":"post","path":"/bitlinks","requestSamples":[{"name":"cURL","syntaxLanguage":"bash","sample":"curl \\\n-H 'Authorization: Bearer {TOKEN}' \\\n-H 'Content-Type: application/json' \\\n-X POST \\\n-d '{\n \"long_url\": \"https://dev.bitly.com\",\n \"domain\": \"bit.ly\",\n \"group_guid\": \"Ba1bc23dE4F\",\n \"title\": \"Bitly API Documentation\",\n \"tags\": [\n \"bitly\",\n \"api\"\n ],\n \"deeplinks\": [\n {\n \"app_id\": \"com.bitly.app\",\n \"app_uri_path\": \"/store?id=123456\",\n \"install_url\": \"https://play.google.com/store/apps/details?id=com.bitly.app\u0026hl=en_US\",\n \"install_type\": \"promote_install\"\n }\n ]\n}' \\\nhttps://api-ssl.bitly.com/v4/bitlinks","exampleName":"Default"},{"sample":"var fetch = require('node-fetch');\n\nfetch('https://api-ssl.bitly.com/v4/bitlinks', {\n method: 'POST',\n headers: {\n 'Authorization': 'Bearer {TOKEN}',\n 'Content-Type': 'application/json'\n },\n body: JSON.stringify({ \"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\u0026hl=en_US\", \"install_type\": \"promote_install\" } ] })\n});\n","name":"Node","syntaxLanguage":"javascript","exampleName":"Default"},{"sample":"fetch('https://api-ssl.bitly.com/v4/bitlinks', {\n method: 'POST',\n headers: {\n 'Authorization': 'Bearer {TOKEN}',\n 'Content-Type': 'application/json'\n },\n body: JSON.stringify({ \"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\u0026hl=en_US\", \"install_type\": \"promote_install\" } ] })\n});\n","name":"Browser","syntaxLanguage":"javascript","exampleName":"Default"},{"sample":"package main\n\nimport (\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n\t\"strings\"\n)\n\nfunc main() {\n\tclient := \u0026http.Client{}\n\tvar data = strings.NewReader(`{ \"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\u0026hl=en_US\", \"install_type\": \"promote_install\" } ] }`)\n\treq, err := http.NewRequest(\"POST\", \"https://api-ssl.bitly.com/v4/bitlinks\", data)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\treq.Header.Set(\"Authorization\", \"Bearer {TOKEN}\")\n\treq.Header.Set(\"Content-Type\", \"application/json\")\n\tresp, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tdefer resp.Body.Close()\n\tbodyText, err := ioutil.ReadAll(resp.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tfmt.Printf(\"%s\\n\", bodyText)\n}\n","name":"Go","syntaxLanguage":"go","exampleName":"Default"},{"sample":"import requests\n\nheaders = {\n 'Authorization': 'Bearer {TOKEN}',\n 'Content-Type': 'application/json',\n}\n\ndata = {\n '{ \"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',\n 'hl': 'en_US\", \"install_type\": \"promote_install\" } ] }'\n}\n\nresponse = requests.post('https://api-ssl.bitly.com/v4/bitlinks', headers=headers, data=data)\n","name":"Python","syntaxLanguage":"python","exampleName":"Default"}],"responseSamples":[{"statusCode":"200","description":"SUCCESS","json":"{\n \"references\": { \"any\" },\n \"link\": \"string\",\n \"id\": \"string\",\n \"long_url\": \"string\",\n \"title\": \"string\",\n \"archived\": \"boolean\",\n \"created_at\": \"string\",\n \"created_by\": \"string\",\n \"client_id\": \"string\",\n \"custom_bitlinks\": [\n \"string\"\n ],\n \"tags\": [\n \"string\"\n ],\n \"launchpad_ids\": [\n \"string\"\n ],\n \"qr_code_ids\": [\n \"string\"\n ],\n \"deeplinks\": [\n {\n \"guid\": \"string\",\n \"bitlink\": \"string\",\n \"app_uri_path\": \"string\",\n \"install_url\": \"string\",\n \"app_guid\": \"string\",\n \"os\": \"string\",\n \"install_type\": \"string\",\n \"created\": \"string\",\n \"modified\": \"string\",\n \"brand_guid\": \"string\"\n }\n ],\n \"campaign_ids\": [\n \"string\"\n ]\n}","csv":null},{"statusCode":"201","description":"CREATED","json":"{\n \"references\": { \"any\" },\n \"link\": \"string\",\n \"id\": \"string\",\n \"long_url\": \"string\",\n \"title\": \"string\",\n \"archived\": \"boolean\",\n \"created_at\": \"string\",\n \"created_by\": \"string\",\n \"client_id\": \"string\",\n \"custom_bitlinks\": [\n \"string\"\n ],\n \"tags\": [\n \"string\"\n ],\n \"launchpad_ids\": [\n \"string\"\n ],\n \"qr_code_ids\": [\n \"string\"\n ],\n \"deeplinks\": [\n {\n \"guid\": \"string\",\n \"bitlink\": \"string\",\n \"app_uri_path\": \"string\",\n \"install_url\": \"string\",\n \"app_guid\": \"string\",\n \"os\": \"string\",\n \"install_type\": \"string\",\n \"created\": \"string\",\n \"modified\": \"string\",\n \"brand_guid\": \"string\"\n }\n ],\n \"campaign_ids\": [\n \"string\"\n ]\n}","csv":null},{"statusCode":"400","description":"BAD_REQUEST","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"402","description":"UPGRADE_REQUIRED","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"403","description":"FORBIDDEN","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"404","description":"NOT_FOUND","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"417","description":"EXPECTATION_FAILED","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"422","description":"UNPROCESSABLE_ENTITY","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"429","description":"MONTHLY_LIMIT_EXCEEDED","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\"\n}","csv":null},{"statusCode":"500","description":"INTERNAL_ERROR","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"503","description":"TEMPORARILY_UNAVAILABLE","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null}],"requestBodyParams":[{"name":"long_url","description":null,"required":true,"schema":{"type":"string","default":null,"enum":null},"items":null,"properties":null},{"name":"domain","description":null,"required":false,"schema":{"type":"string","default":"bit.ly","enum":null},"items":null,"properties":null},{"name":"group_guid","description":"Always include a specific group and custom domain in your shorten calls.","required":false,"schema":{"type":"string","default":null,"enum":null},"items":null,"properties":null},{"name":"title","description":null,"required":false,"schema":{"type":"string","default":null,"enum":null},"items":null,"properties":null},{"name":"tags","description":null,"required":false,"schema":{"type":"array","default":null,"enum":null},"items":{"type":"string"},"properties":null},{"name":"deeplinks","description":null,"required":false,"schema":{"type":"array","default":null,"enum":null},"items":{"type":"object","properties":{"app_id":{"type":"string"},"app_uri_path":{"type":"string"},"install_url":{"type":"string"},"install_type":{"type":"string","enum":["no_install","auto_install","promote_install"]}}},"properties":null}]},{"summary":"Delete a Bitlink","description":"Delete an unedited hash Bitlink.","tags":["Bitlinks"],"parameters":[{"name":"bitlink","description":"A Bitlink made of the domain and hash","in":"path","required":true,"schema":{"type":"string"},"example":"bit.ly/12a4b6c"}],"operationId":"deleteBitlink","responses":{"200":{"description":"SUCCESS","content":{"application/json":{"schema":{"type":"object","properties":{"links_deleted":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"}}},"example":[{"id":"bit.ly/12a4b6c"},{"id":"chauncey.ly/documentation"}]}}}}}},"400":{"description":"BAD_REQUEST","content":{"application/json":{"schema":{"description":"BAD_REQUEST","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"403":{"description":"FORBIDDEN","content":{"application/json":{"schema":{"description":"FORBIDDEN","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"404":{"description":"NOT_FOUND","content":{"application/json":{"schema":{"description":"NOT_FOUND","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"429":{"description":"MONTHLY_LIMIT_EXCEEDED","content":{"application/json":{"schema":{"example":"API_USAGE_LIMIT_EXCEEDED","description":"MONTHLY_LIMIT_EXCEEDED","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"}}}]}}}},"500":{"description":"INTERNAL_ERROR","content":{"application/json":{"schema":{"description":"INTERNAL_ERROR","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"503":{"description":"TEMPORARILY_UNAVAILABLE","content":{"application/json":{"schema":{"description":"TEMPORARILY_UNAVAILABLE","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}}},"method":"delete","path":"/bitlinks/{bitlink}","requestSamples":[{"name":"cURL","syntaxLanguage":"bash","sample":"curl \\\n-H 'Authorization: Bearer {TOKEN}' \\\n-X DELETE \\\nhttps://api-ssl.bitly.com/v4/bitlinks/bit.ly/12a4b6c","exampleName":"Default"},{"sample":"var fetch = require('node-fetch');\n\nfetch('https://api-ssl.bitly.com/v4/bitlinks/bit.ly/12a4b6c', {\n method: 'DELETE',\n headers: {\n 'Authorization': 'Bearer {TOKEN}'\n }\n});\n","name":"Node","syntaxLanguage":"javascript","exampleName":"Default"},{"sample":"fetch('https://api-ssl.bitly.com/v4/bitlinks/bit.ly/12a4b6c', {\n method: 'DELETE',\n headers: {\n 'Authorization': 'Bearer {TOKEN}'\n }\n});\n","name":"Browser","syntaxLanguage":"javascript","exampleName":"Default"},{"sample":"package main\n\nimport (\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\tclient := \u0026http.Client{}\n\treq, err := http.NewRequest(\"DELETE\", \"https://api-ssl.bitly.com/v4/bitlinks/bit.ly/12a4b6c\", nil)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\treq.Header.Set(\"Authorization\", \"Bearer {TOKEN}\")\n\tresp, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tdefer resp.Body.Close()\n\tbodyText, err := ioutil.ReadAll(resp.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tfmt.Printf(\"%s\\n\", bodyText)\n}\n","name":"Go","syntaxLanguage":"go","exampleName":"Default"},{"sample":"import requests\n\nheaders = {\n 'Authorization': 'Bearer {TOKEN}',\n}\n\nresponse = requests.delete('https://api-ssl.bitly.com/v4/bitlinks/bit.ly/12a4b6c', headers=headers)\n","name":"Python","syntaxLanguage":"python","exampleName":"Default"}],"responseSamples":[{"statusCode":"200","description":"SUCCESS","json":"{\n \"links_deleted\": [\n {\n \"id\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"400","description":"BAD_REQUEST","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"403","description":"FORBIDDEN","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"404","description":"NOT_FOUND","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"429","description":"MONTHLY_LIMIT_EXCEEDED","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\"\n}","csv":null},{"statusCode":"500","description":"INTERNAL_ERROR","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"503","description":"TEMPORARILY_UNAVAILABLE","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null}],"requestBodyParams":null},{"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":[{"name":"bitlink","description":"A Bitlink made of the domain and hash","in":"path","required":true,"schema":{"type":"string"},"example":"bit.ly/12a4b6c"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"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\u0026hl=en_US","app_guid":"Ab1cdE2fG3h","os":"android","install_type":"promote_install","brand_guid":"Ba1bc23dE4F"}]},"type":"object","properties":{"title":{"type":"string"},"archived":{"type":"boolean"},"tags":{"type":"array","items":{"type":"string"}},"deeplinks":{"type":"array","items":{"type":"object","properties":{"guid":{"type":"string"},"bitlink":{"type":"string"},"app_uri_path":{"type":"string"},"install_url":{"type":"string"},"app_guid":{"type":"string"},"os":{"type":"string","enum":["ios","android"]},"install_type":{"type":"string","enum":["no_install","auto_install","promote_install"]},"created":{"type":"string","description":"ISO timestamp"},"modified":{"type":"string","description":"ISO timestamp"},"brand_guid":{"type":"string"}}}}}}}}},"responses":{"200":{"description":"SUCCESS","content":{"application/json":{"schema":{"type":"object","allOf":[{"type":"object","properties":{"references":{"type":"object","additionalProperties":{"type":"string"}}}},{"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"}},"qr_code_ids":{"type":"array","items":{"type":"string"},"description":"a list of qr code ids that are associated with this bitlink"},"deeplinks":{"type":"array","items":{"type":"object","properties":{"guid":{"type":"string"},"bitlink":{"type":"string"},"app_uri_path":{"type":"string"},"install_url":{"type":"string"},"app_guid":{"type":"string"},"os":{"type":"string","enum":["ios","android"]},"install_type":{"type":"string","enum":["no_install","auto_install","promote_install"]},"created":{"type":"string","description":"ISO timestamp"},"modified":{"type":"string","description":"ISO timestamp"},"brand_guid":{"type":"string"}}}},"is_deleted":{"type":"boolean"},"campaign_ids":{"type":"array","items":{"type":"string"}}}}]}}}},"400":{"description":"BAD_REQUEST","content":{"application/json":{"schema":{"description":"BAD_REQUEST","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"402":{"description":"UPGRADE_REQUIRED","content":{"application/json":{"schema":{"description":"UPGRADE_REQUIRED","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"403":{"description":"FORBIDDEN","content":{"application/json":{"schema":{"description":"FORBIDDEN","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"404":{"description":"NOT_FOUND","content":{"application/json":{"schema":{"description":"NOT_FOUND","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"410":{"description":"GONE","content":{"application/json":{"schema":{"description":"GONE","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"422":{"description":"UNPROCESSABLE_ENTITY","content":{"application/json":{"schema":{"description":"UNPROCESSABLE_ENTITY","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"429":{"description":"MONTHLY_LIMIT_EXCEEDED","content":{"application/json":{"schema":{"example":"API_USAGE_LIMIT_EXCEEDED","description":"MONTHLY_LIMIT_EXCEEDED","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"}}}]}}}},"500":{"description":"INTERNAL_ERROR","content":{"application/json":{"schema":{"description":"INTERNAL_ERROR","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"503":{"description":"TEMPORARILY_UNAVAILABLE","content":{"application/json":{"schema":{"description":"TEMPORARILY_UNAVAILABLE","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}}},"method":"patch","path":"/bitlinks/{bitlink}","requestSamples":[{"name":"cURL","syntaxLanguage":"bash","sample":"curl \\\n-H 'Authorization: Bearer {TOKEN}' \\\n-H 'Content-Type: application/json' \\\n-X PATCH \\\n-d '{\n \"title\": \"Bitly API Documentation\",\n \"archived\": false,\n \"tags\": [\n \"bitly\",\n \"api\"\n ],\n \"deeplinks\": [\n {\n \"guid\": \"Ra1bcD2eF3h\",\n \"bitlink\": \"bit.ly/documentation\",\n \"app_uri_path\": \"/store?id=123456\",\n \"install_url\": \"https://play.google.com/store/apps/details?id=com.bitly.app\u0026hl=en_US\",\n \"app_guid\": \"Ab1cdE2fG3h\",\n \"os\": \"android\",\n \"install_type\": \"promote_install\",\n \"brand_guid\": \"Ba1bc23dE4F\"\n }\n ]\n}' \\\nhttps://api-ssl.bitly.com/v4/bitlinks/bit.ly/12a4b6c","exampleName":"Default"},{"sample":"var fetch = require('node-fetch');\n\nfetch('https://api-ssl.bitly.com/v4/bitlinks/bit.ly/12a4b6c', {\n method: 'PATCH',\n headers: {\n 'Authorization': 'Bearer {TOKEN}',\n 'Content-Type': 'application/json'\n },\n body: JSON.stringify({ \"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\u0026hl=en_US\", \"app_guid\": \"Ab1cdE2fG3h\", \"os\": \"android\", \"install_type\": \"promote_install\", \"brand_guid\": \"Ba1bc23dE4F\" } ] })\n});\n","name":"Node","syntaxLanguage":"javascript","exampleName":"Default"},{"sample":"fetch('https://api-ssl.bitly.com/v4/bitlinks/bit.ly/12a4b6c', {\n method: 'PATCH',\n headers: {\n 'Authorization': 'Bearer {TOKEN}',\n 'Content-Type': 'application/json'\n },\n body: JSON.stringify({ \"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\u0026hl=en_US\", \"app_guid\": \"Ab1cdE2fG3h\", \"os\": \"android\", \"install_type\": \"promote_install\", \"brand_guid\": \"Ba1bc23dE4F\" } ] })\n});\n","name":"Browser","syntaxLanguage":"javascript","exampleName":"Default"},{"sample":"package main\n\nimport (\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n\t\"strings\"\n)\n\nfunc main() {\n\tclient := \u0026http.Client{}\n\tvar data = strings.NewReader(`{ \"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\u0026hl=en_US\", \"app_guid\": \"Ab1cdE2fG3h\", \"os\": \"android\", \"install_type\": \"promote_install\", \"brand_guid\": \"Ba1bc23dE4F\" } ] }`)\n\treq, err := http.NewRequest(\"PATCH\", \"https://api-ssl.bitly.com/v4/bitlinks/bit.ly/12a4b6c\", data)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\treq.Header.Set(\"Authorization\", \"Bearer {TOKEN}\")\n\treq.Header.Set(\"Content-Type\", \"application/json\")\n\tresp, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tdefer resp.Body.Close()\n\tbodyText, err := ioutil.ReadAll(resp.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tfmt.Printf(\"%s\\n\", bodyText)\n}\n","name":"Go","syntaxLanguage":"go","exampleName":"Default"},{"sample":"import requests\n\nheaders = {\n 'Authorization': 'Bearer {TOKEN}',\n 'Content-Type': 'application/json',\n}\n\ndata = {\n '{ \"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',\n 'hl': 'en_US\", \"app_guid\": \"Ab1cdE2fG3h\", \"os\": \"android\", \"install_type\": \"promote_install\", \"brand_guid\": \"Ba1bc23dE4F\" } ] }'\n}\n\nresponse = requests.patch('https://api-ssl.bitly.com/v4/bitlinks/bit.ly/12a4b6c', headers=headers, data=data)\n","name":"Python","syntaxLanguage":"python","exampleName":"Default"}],"responseSamples":[{"statusCode":"200","description":"SUCCESS","json":"{\n \"references\": { \"any\" },\n \"link\": \"string\",\n \"id\": \"string\",\n \"long_url\": \"string\",\n \"title\": \"string\",\n \"archived\": \"boolean\",\n \"created_at\": \"string\",\n \"created_by\": \"string\",\n \"client_id\": \"string\",\n \"custom_bitlinks\": [\n \"string\"\n ],\n \"tags\": [\n \"string\"\n ],\n \"launchpad_ids\": [\n \"string\"\n ],\n \"qr_code_ids\": [\n \"string\"\n ],\n \"deeplinks\": [\n {\n \"guid\": \"string\",\n \"bitlink\": \"string\",\n \"app_uri_path\": \"string\",\n \"install_url\": \"string\",\n \"app_guid\": \"string\",\n \"os\": \"string\",\n \"install_type\": \"string\",\n \"created\": \"string\",\n \"modified\": \"string\",\n \"brand_guid\": \"string\"\n }\n ],\n \"campaign_ids\": [\n \"string\"\n ]\n}","csv":null},{"statusCode":"400","description":"BAD_REQUEST","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"402","description":"UPGRADE_REQUIRED","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"403","description":"FORBIDDEN","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"404","description":"NOT_FOUND","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"410","description":"GONE","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"422","description":"UNPROCESSABLE_ENTITY","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"429","description":"MONTHLY_LIMIT_EXCEEDED","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\"\n}","csv":null},{"statusCode":"500","description":"INTERNAL_ERROR","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"503","description":"TEMPORARILY_UNAVAILABLE","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null}],"requestBodyParams":[{"name":"title","description":null,"required":null,"schema":{"type":"string","default":null,"enum":null},"items":null,"properties":null},{"name":"archived","description":null,"required":null,"schema":{"type":"boolean","default":null,"enum":null},"items":null,"properties":null},{"name":"tags","description":null,"required":null,"schema":{"type":"array","default":null,"enum":null},"items":{"type":"string"},"properties":null},{"name":"deeplinks","description":null,"required":null,"schema":{"type":"array","default":null,"enum":null},"items":{"type":"object","properties":{"guid":{"type":"string"},"bitlink":{"type":"string"},"app_uri_path":{"type":"string"},"install_url":{"type":"string"},"app_guid":{"type":"string"},"os":{"type":"string","enum":["ios","android"]},"install_type":{"type":"string","enum":["no_install","auto_install","promote_install"]},"created":{"type":"string","description":"ISO timestamp"},"modified":{"type":"string","description":"ISO timestamp"},"brand_guid":{"type":"string"}}},"properties":null}]},{"summary":"Retrieve a Bitlink","description":"Returns information for the specified link.","tags":["Bitlinks"],"parameters":[{"name":"bitlink","description":"A Bitlink made of the domain and hash","in":"path","required":true,"schema":{"type":"string"},"example":"bit.ly/12a4b6c"}],"operationId":"getBitlink","responses":{"200":{"description":"SUCCESS","content":{"application/json":{"schema":{"type":"object","allOf":[{"type":"object","properties":{"references":{"type":"object","additionalProperties":{"type":"string"}}}},{"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"}},"qr_code_ids":{"type":"array","items":{"type":"string"},"description":"a list of qr code ids that are associated with this bitlink"},"deeplinks":{"type":"array","items":{"type":"object","properties":{"guid":{"type":"string"},"bitlink":{"type":"string"},"app_uri_path":{"type":"string"},"install_url":{"type":"string"},"app_guid":{"type":"string"},"os":{"type":"string","enum":["ios","android"]},"install_type":{"type":"string","enum":["no_install","auto_install","promote_install"]},"created":{"type":"string","description":"ISO timestamp"},"modified":{"type":"string","description":"ISO timestamp"},"brand_guid":{"type":"string"}}}},"is_deleted":{"type":"boolean"},"campaign_ids":{"type":"array","items":{"type":"string"}}}}]}}}},"403":{"description":"FORBIDDEN","content":{"application/json":{"schema":{"description":"FORBIDDEN","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"404":{"description":"NOT_FOUND","content":{"application/json":{"schema":{"description":"NOT_FOUND","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"410":{"description":"GONE","content":{"application/json":{"schema":{"description":"GONE","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"429":{"description":"MONTHLY_LIMIT_EXCEEDED","content":{"application/json":{"schema":{"example":"API_USAGE_LIMIT_EXCEEDED","description":"MONTHLY_LIMIT_EXCEEDED","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"}}}]}}}},"500":{"description":"INTERNAL_ERROR","content":{"application/json":{"schema":{"description":"INTERNAL_ERROR","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"503":{"description":"TEMPORARILY_UNAVAILABLE","content":{"application/json":{"schema":{"description":"TEMPORARILY_UNAVAILABLE","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}}},"method":"get","path":"/bitlinks/{bitlink}","requestSamples":[{"name":"cURL","syntaxLanguage":"bash","sample":"curl \\\n-H 'Authorization: Bearer {TOKEN}' \\\n-X GET \\\nhttps://api-ssl.bitly.com/v4/bitlinks/bit.ly/12a4b6c","exampleName":"Default"},{"sample":"var fetch = require('node-fetch');\n\nfetch('https://api-ssl.bitly.com/v4/bitlinks/bit.ly/12a4b6c', {\n headers: {\n 'Authorization': 'Bearer {TOKEN}'\n }\n});\n","name":"Node","syntaxLanguage":"javascript","exampleName":"Default"},{"sample":"fetch('https://api-ssl.bitly.com/v4/bitlinks/bit.ly/12a4b6c', {\n headers: {\n 'Authorization': 'Bearer {TOKEN}'\n }\n});\n","name":"Browser","syntaxLanguage":"javascript","exampleName":"Default"},{"sample":"package main\n\nimport (\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\tclient := \u0026http.Client{}\n\treq, err := http.NewRequest(\"GET\", \"https://api-ssl.bitly.com/v4/bitlinks/bit.ly/12a4b6c\", nil)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\treq.Header.Set(\"Authorization\", \"Bearer {TOKEN}\")\n\tresp, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tdefer resp.Body.Close()\n\tbodyText, err := ioutil.ReadAll(resp.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tfmt.Printf(\"%s\\n\", bodyText)\n}\n","name":"Go","syntaxLanguage":"go","exampleName":"Default"},{"sample":"import requests\n\nheaders = {\n 'Authorization': 'Bearer {TOKEN}',\n}\n\nresponse = requests.get('https://api-ssl.bitly.com/v4/bitlinks/bit.ly/12a4b6c', headers=headers)\n","name":"Python","syntaxLanguage":"python","exampleName":"Default"}],"responseSamples":[{"statusCode":"200","description":"SUCCESS","json":"{\n \"references\": { \"any\" },\n \"link\": \"string\",\n \"id\": \"string\",\n \"long_url\": \"string\",\n \"title\": \"string\",\n \"archived\": \"boolean\",\n \"created_at\": \"string\",\n \"created_by\": \"string\",\n \"client_id\": \"string\",\n \"custom_bitlinks\": [\n \"string\"\n ],\n \"tags\": [\n \"string\"\n ],\n \"launchpad_ids\": [\n \"string\"\n ],\n \"qr_code_ids\": [\n \"string\"\n ],\n \"deeplinks\": [\n {\n \"guid\": \"string\",\n \"bitlink\": \"string\",\n \"app_uri_path\": \"string\",\n \"install_url\": \"string\",\n \"app_guid\": \"string\",\n \"os\": \"string\",\n \"install_type\": \"string\",\n \"created\": \"string\",\n \"modified\": \"string\",\n \"brand_guid\": \"string\"\n }\n ],\n \"campaign_ids\": [\n \"string\"\n ]\n}","csv":null},{"statusCode":"403","description":"FORBIDDEN","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"404","description":"NOT_FOUND","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"410","description":"GONE","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"429","description":"MONTHLY_LIMIT_EXCEEDED","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\"\n}","csv":null},{"statusCode":"500","description":"INTERNAL_ERROR","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"503","description":"TEMPORARILY_UNAVAILABLE","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null}],"requestBodyParams":null},{"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":{"type":"object","properties":{"bitlink_id":{"type":"string"}},"example":{"bitlink_id":"bit.ly/12a4b6c"}}}}},"operationId":"expandBitlink","responses":{"200":{"description":"SUCCESS","content":{"application/json":{"schema":{"type":"object","properties":{"link":{"type":"string"},"id":{"type":"string"},"long_url":{"type":"string"},"created_at":{"type":"string"}}}}}},"400":{"description":"BAD_REQUEST","content":{"application/json":{"schema":{"description":"BAD_REQUEST","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"404":{"description":"NOT_FOUND","content":{"application/json":{"schema":{"description":"NOT_FOUND","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"410":{"description":"GONE","content":{"application/json":{"schema":{"description":"GONE","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"422":{"description":"UNPROCESSABLE_ENTITY","content":{"application/json":{"schema":{"description":"UNPROCESSABLE_ENTITY","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"500":{"description":"INTERNAL_ERROR","content":{"application/json":{"schema":{"description":"INTERNAL_ERROR","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"503":{"description":"TEMPORARILY_UNAVAILABLE","content":{"application/json":{"schema":{"description":"TEMPORARILY_UNAVAILABLE","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}}},"method":"post","path":"/expand","requestSamples":[{"name":"cURL","syntaxLanguage":"bash","sample":"curl \\\n-H 'Authorization: Bearer {TOKEN}' \\\n-H 'Content-Type: application/json' \\\n-X POST \\\n-d '{\n \"bitlink_id\": \"bit.ly/12a4b6c\"\n}' \\\nhttps://api-ssl.bitly.com/v4/expand","exampleName":"Default"},{"sample":"var fetch = require('node-fetch');\n\nfetch('https://api-ssl.bitly.com/v4/expand', {\n method: 'POST',\n headers: {\n 'Authorization': 'Bearer {TOKEN}',\n 'Content-Type': 'application/json'\n },\n body: JSON.stringify({ \"bitlink_id\": \"bit.ly/12a4b6c\" })\n});\n","name":"Node","syntaxLanguage":"javascript","exampleName":"Default"},{"sample":"fetch('https://api-ssl.bitly.com/v4/expand', {\n method: 'POST',\n headers: {\n 'Authorization': 'Bearer {TOKEN}',\n 'Content-Type': 'application/json'\n },\n body: JSON.stringify({ \"bitlink_id\": \"bit.ly/12a4b6c\" })\n});\n","name":"Browser","syntaxLanguage":"javascript","exampleName":"Default"},{"sample":"package main\n\nimport (\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n\t\"strings\"\n)\n\nfunc main() {\n\tclient := \u0026http.Client{}\n\tvar data = strings.NewReader(`{ \"bitlink_id\": \"bit.ly/12a4b6c\" }`)\n\treq, err := http.NewRequest(\"POST\", \"https://api-ssl.bitly.com/v4/expand\", data)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\treq.Header.Set(\"Authorization\", \"Bearer {TOKEN}\")\n\treq.Header.Set(\"Content-Type\", \"application/json\")\n\tresp, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tdefer resp.Body.Close()\n\tbodyText, err := ioutil.ReadAll(resp.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tfmt.Printf(\"%s\\n\", bodyText)\n}\n","name":"Go","syntaxLanguage":"go","exampleName":"Default"},{"sample":"import requests\n\nheaders = {\n 'Authorization': 'Bearer {TOKEN}',\n 'Content-Type': 'application/json',\n}\n\ndata = '{ \"bitlink_id\": \"bit.ly/12a4b6c\" }'\n\nresponse = requests.post('https://api-ssl.bitly.com/v4/expand', headers=headers, data=data)\n","name":"Python","syntaxLanguage":"python","exampleName":"Default"}],"responseSamples":[{"statusCode":"200","description":"SUCCESS","json":"{\n \"link\": \"string\",\n \"id\": \"string\",\n \"long_url\": \"string\",\n \"created_at\": \"string\"\n}","csv":null},{"statusCode":"400","description":"BAD_REQUEST","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"404","description":"NOT_FOUND","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"410","description":"GONE","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"422","description":"UNPROCESSABLE_ENTITY","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"500","description":"INTERNAL_ERROR","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"503","description":"TEMPORARILY_UNAVAILABLE","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null}],"requestBodyParams":[{"name":"bitlink_id","description":null,"required":null,"schema":{"type":"string","default":null,"enum":null},"items":null,"properties":null}]},{"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":[{"name":"bitlink","description":"A Bitlink made of the domain and hash","in":"path","required":true,"schema":{"type":"string"},"example":"bit.ly/12a4b6c"},{"name":"unit","description":"A unit of time","schema":{"description":"the unit of time queried for (minute, hour, day, week, month)","type":"string","enum":["minute","hour","day","week","month"],"default":"day"},"required":true,"in":"query","example":"month"},{"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},{"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"}],"responses":{"200":{"description":"SUCCESS","content":{"application/json":{"schema":{"type":"object","properties":{"link_clicks":{"type":"array","items":{"type":"object","properties":{"clicks":{"type":"integer"},"date":{"type":"string"}}}},"units":{"type":"integer"},"unit":{"type":"string","enum":["minute","hour","day","week","month"]},"unit_reference":{"type":"string"}}}},"text/csv":{"schema":{"type":"object","properties":{"link_clicks":{"type":"array","items":{"type":"object","properties":{"clicks":{"type":"integer"},"date":{"type":"string"}}}},"units":{"type":"integer"},"unit":{"type":"string","enum":["minute","hour","day","week","month"]},"unit_reference":{"type":"string"}}},"example":"Date, Clicks\n2023-07-10T00:00:00+0000, 15\n"}}},"403":{"description":"FORBIDDEN","content":{"application/json":{"schema":{"description":"FORBIDDEN","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"404":{"description":"NOT_FOUND","content":{"application/json":{"schema":{"description":"NOT_FOUND","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"429":{"description":"MONTHLY_LIMIT_EXCEEDED","content":{"application/json":{"schema":{"example":"API_USAGE_LIMIT_EXCEEDED","description":"MONTHLY_LIMIT_EXCEEDED","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"}}}]}}}},"500":{"description":"INTERNAL_ERROR","content":{"application/json":{"schema":{"description":"INTERNAL_ERROR","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"503":{"description":"TEMPORARILY_UNAVAILABLE","content":{"application/json":{"schema":{"description":"TEMPORARILY_UNAVAILABLE","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}}},"method":"get","path":"/bitlinks/{bitlink}/clicks","requestSamples":[{"name":"cURL","syntaxLanguage":"bash","sample":"curl \\\n-H 'Authorization: Bearer {TOKEN}' \\\n-X GET \\\nhttps://api-ssl.bitly.com/v4/bitlinks/bit.ly/12a4b6c/clicks?unit=month\u0026units=1\u0026unit_reference=2006-01-02T15%3A04%3A05-0700","exampleName":"Default"},{"sample":"var fetch = require('node-fetch');\n\nfetch('https://api-ssl.bitly.com/v4/bitlinks/bit.ly/12a4b6c/clicks?unit=month\u0026units=1\u0026unit_reference=2006-01-02T15%3A04%3A05-0700', {\n headers: {\n 'Authorization': 'Bearer {TOKEN}'\n }\n});\n","name":"Node","syntaxLanguage":"javascript","exampleName":"Default"},{"sample":"fetch('https://api-ssl.bitly.com/v4/bitlinks/bit.ly/12a4b6c/clicks?unit=month\u0026units=1\u0026unit_reference=2006-01-02T15%3A04%3A05-0700', {\n headers: {\n 'Authorization': 'Bearer {TOKEN}'\n }\n});\n","name":"Browser","syntaxLanguage":"javascript","exampleName":"Default"},{"sample":"package main\n\nimport (\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\tclient := \u0026http.Client{}\n\treq, err := http.NewRequest(\"GET\", \"https://api-ssl.bitly.com/v4/bitlinks/bit.ly/12a4b6c/clicks?unit=month\u0026units=1\u0026unit_reference=2006-01-02T15%3A04%3A05-0700\", nil)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\treq.Header.Set(\"Authorization\", \"Bearer {TOKEN}\")\n\tresp, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tdefer resp.Body.Close()\n\tbodyText, err := ioutil.ReadAll(resp.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tfmt.Printf(\"%s\\n\", bodyText)\n}\n","name":"Go","syntaxLanguage":"go","exampleName":"Default"},{"sample":"import requests\n\nheaders = {\n 'Authorization': 'Bearer {TOKEN}',\n}\n\nparams = (\n ('unit', 'month'),\n ('units', '1'),\n ('unit_reference', '2006-01-02T15:04:05-0700'),\n)\n\nresponse = requests.get('https://api-ssl.bitly.com/v4/bitlinks/bit.ly/12a4b6c/clicks', headers=headers, params=params)\n\n#NB. Original query string below. It seems impossible to parse and\n#reproduce query strings 100% accurately so the one below is given\n#in case the reproduced version is not \"correct\".\n# response = requests.get('https://api-ssl.bitly.com/v4/bitlinks/bit.ly/12a4b6c/clicks?unit=month\u0026units=1\u0026unit_reference=2006-01-02T15%3A04%3A05-0700', headers=headers)\n","name":"Python","syntaxLanguage":"python","exampleName":"Default"}],"responseSamples":[{"statusCode":"200","description":"SUCCESS","json":"{\n \"link_clicks\": [\n {\n \"clicks\": \"integer\",\n \"date\": \"string\"\n }\n ],\n \"units\": \"integer\",\n \"unit\": \"string\",\n \"unit_reference\": \"string\"\n}","csv":"Date, Clicks\n2023-07-10T00:00:00+0000, 15\n"},{"statusCode":"403","description":"FORBIDDEN","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"404","description":"NOT_FOUND","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"429","description":"MONTHLY_LIMIT_EXCEEDED","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\"\n}","csv":null},{"statusCode":"500","description":"INTERNAL_ERROR","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"503","description":"TEMPORARILY_UNAVAILABLE","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null}],"requestBodyParams":null},{"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":[{"name":"bitlink","description":"A Bitlink made of the domain and hash","in":"path","required":true,"schema":{"type":"string"},"example":"bit.ly/12a4b6c"},{"name":"unit","description":"A unit of time","schema":{"description":"the unit of time queried for (minute, hour, day, week, month)","type":"string","enum":["minute","hour","day","week","month"],"default":"day"},"required":true,"in":"query","example":"month"},{"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},{"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"}],"responses":{"200":{"description":"SUCCESS","content":{"application/json":{"schema":{"type":"object","properties":{"total_clicks":{"type":"integer"},"units":{"type":"integer"},"unit":{"type":"string","enum":["minute","hour","day","week","month"]},"unit_reference":{"type":"string"}}}}}},"403":{"description":"FORBIDDEN","content":{"application/json":{"schema":{"description":"FORBIDDEN","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"404":{"description":"NOT_FOUND","content":{"application/json":{"schema":{"description":"NOT_FOUND","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"429":{"description":"MONTHLY_LIMIT_EXCEEDED","content":{"application/json":{"schema":{"example":"API_USAGE_LIMIT_EXCEEDED","description":"MONTHLY_LIMIT_EXCEEDED","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"}}}]}}}},"500":{"description":"INTERNAL_ERROR","content":{"application/json":{"schema":{"description":"INTERNAL_ERROR","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"503":{"description":"TEMPORARILY_UNAVAILABLE","content":{"application/json":{"schema":{"description":"TEMPORARILY_UNAVAILABLE","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}}},"method":"get","path":"/bitlinks/{bitlink}/clicks/summary","requestSamples":[{"name":"cURL","syntaxLanguage":"bash","sample":"curl \\\n-H 'Authorization: Bearer {TOKEN}' \\\n-X GET \\\nhttps://api-ssl.bitly.com/v4/bitlinks/bit.ly/12a4b6c/clicks/summary?unit=month\u0026units=1\u0026unit_reference=2006-01-02T15%3A04%3A05-0700","exampleName":"Default"},{"sample":"var fetch = require('node-fetch');\n\nfetch('https://api-ssl.bitly.com/v4/bitlinks/bit.ly/12a4b6c/clicks/summary?unit=month\u0026units=1\u0026unit_reference=2006-01-02T15%3A04%3A05-0700', {\n headers: {\n 'Authorization': 'Bearer {TOKEN}'\n }\n});\n","name":"Node","syntaxLanguage":"javascript","exampleName":"Default"},{"sample":"fetch('https://api-ssl.bitly.com/v4/bitlinks/bit.ly/12a4b6c/clicks/summary?unit=month\u0026units=1\u0026unit_reference=2006-01-02T15%3A04%3A05-0700', {\n headers: {\n 'Authorization': 'Bearer {TOKEN}'\n }\n});\n","name":"Browser","syntaxLanguage":"javascript","exampleName":"Default"},{"sample":"package main\n\nimport (\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\tclient := \u0026http.Client{}\n\treq, err := http.NewRequest(\"GET\", \"https://api-ssl.bitly.com/v4/bitlinks/bit.ly/12a4b6c/clicks/summary?unit=month\u0026units=1\u0026unit_reference=2006-01-02T15%3A04%3A05-0700\", nil)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\treq.Header.Set(\"Authorization\", \"Bearer {TOKEN}\")\n\tresp, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tdefer resp.Body.Close()\n\tbodyText, err := ioutil.ReadAll(resp.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tfmt.Printf(\"%s\\n\", bodyText)\n}\n","name":"Go","syntaxLanguage":"go","exampleName":"Default"},{"sample":"import requests\n\nheaders = {\n 'Authorization': 'Bearer {TOKEN}',\n}\n\nparams = (\n ('unit', 'month'),\n ('units', '1'),\n ('unit_reference', '2006-01-02T15:04:05-0700'),\n)\n\nresponse = requests.get('https://api-ssl.bitly.com/v4/bitlinks/bit.ly/12a4b6c/clicks/summary', headers=headers, params=params)\n\n#NB. Original query string below. It seems impossible to parse and\n#reproduce query strings 100% accurately so the one below is given\n#in case the reproduced version is not \"correct\".\n# response = requests.get('https://api-ssl.bitly.com/v4/bitlinks/bit.ly/12a4b6c/clicks/summary?unit=month\u0026units=1\u0026unit_reference=2006-01-02T15%3A04%3A05-0700', headers=headers)\n","name":"Python","syntaxLanguage":"python","exampleName":"Default"}],"responseSamples":[{"statusCode":"200","description":"SUCCESS","json":"{\n \"total_clicks\": \"integer\",\n \"units\": \"integer\",\n \"unit\": \"string\",\n \"unit_reference\": \"string\"\n}","csv":null},{"statusCode":"403","description":"FORBIDDEN","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"404","description":"NOT_FOUND","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"429","description":"MONTHLY_LIMIT_EXCEEDED","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\"\n}","csv":null},{"statusCode":"500","description":"INTERNAL_ERROR","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"503","description":"TEMPORARILY_UNAVAILABLE","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null}],"requestBodyParams":null},{"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":[{"name":"bitlink","description":"A Bitlink made of the domain and hash","in":"path","required":true,"schema":{"type":"string"},"example":"bit.ly/12a4b6c"},{"name":"unit","description":"A unit of time","schema":{"description":"the unit of time queried for (minute, hour, day, week, month)","type":"string","enum":["minute","hour","day","week","month"],"default":"day"},"required":true,"in":"query","example":"month"},{"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},{"name":"size","description":"The quantity of items to be be returned","in":"query","schema":{"type":"integer","default":50},"example":10},{"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"}],"responses":{"200":{"description":"SUCCESS","content":{"application/json":{"schema":{"type":"object","allOf":[{"type":"object","properties":{"unit":{"type":"string","x-faker":"internet.userName"},"units":{"type":"integer","x-faker":{"datatype.number":{"min":1,"max":100}}},"facet":{"type":"string","enum":["countries","cities","devices","referrers","referrers_by_domain","referring_domains","referring_networks","shorten_counts"]},"unit_reference":{"type":"string","x-faker":"date.past"}}},{"properties":{"metrics":{"type":"array","items":{"type":"object","properties":{"clicks":{"type":"integer","example":123,"x-faker":"random.number"},"value":{"type":"string","example":"bit.ly","x-faker":"internet.domainName"}}}}}}]}},"text/csv":{"schema":{"type":"object","allOf":[{"type":"object","properties":{"unit":{"type":"string","x-faker":"internet.userName"},"units":{"type":"integer","x-faker":{"datatype.number":{"min":1,"max":100}}},"facet":{"type":"string","enum":["countries","cities","devices","referrers","referrers_by_domain","referring_domains","referring_networks","shorten_counts"]},"unit_reference":{"type":"string","x-faker":"date.past"}}},{"properties":{"metrics":{"type":"array","items":{"type":"object","properties":{"clicks":{"type":"integer","example":123,"x-faker":"random.number"},"value":{"type":"string","example":"bit.ly","x-faker":"internet.domainName"}}}}}}]},"example":"Country, Clicks\nUS, 5\n"}}},"400":{"description":"BAD_REQUEST","content":{"application/json":{"schema":{"description":"BAD_REQUEST","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"403":{"description":"FORBIDDEN","content":{"application/json":{"schema":{"description":"FORBIDDEN","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"404":{"description":"NOT_FOUND","content":{"application/json":{"schema":{"description":"NOT_FOUND","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"410":{"description":"GONE","content":{"application/json":{"schema":{"description":"GONE","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"429":{"description":"MONTHLY_LIMIT_EXCEEDED","content":{"application/json":{"schema":{"example":"API_USAGE_LIMIT_EXCEEDED","description":"MONTHLY_LIMIT_EXCEEDED","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"}}}]}}}},"500":{"description":"INTERNAL_ERROR","content":{"application/json":{"schema":{"description":"INTERNAL_ERROR","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"503":{"description":"TEMPORARILY_UNAVAILABLE","content":{"application/json":{"schema":{"description":"TEMPORARILY_UNAVAILABLE","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}}},"method":"get","path":"/bitlinks/{bitlink}/countries","requestSamples":[{"name":"cURL","syntaxLanguage":"bash","sample":"curl \\\n-H 'Authorization: Bearer {TOKEN}' \\\n-X GET \\\nhttps://api-ssl.bitly.com/v4/bitlinks/bit.ly/12a4b6c/countries?unit=month\u0026units=1\u0026size=10\u0026unit_reference=2006-01-02T15%3A04%3A05-0700","exampleName":"Default"},{"sample":"var fetch = require('node-fetch');\n\nfetch('https://api-ssl.bitly.com/v4/bitlinks/bit.ly/12a4b6c/countries?unit=month\u0026units=1\u0026size=10\u0026unit_reference=2006-01-02T15%3A04%3A05-0700', {\n headers: {\n 'Authorization': 'Bearer {TOKEN}'\n }\n});\n","name":"Node","syntaxLanguage":"javascript","exampleName":"Default"},{"sample":"fetch('https://api-ssl.bitly.com/v4/bitlinks/bit.ly/12a4b6c/countries?unit=month\u0026units=1\u0026size=10\u0026unit_reference=2006-01-02T15%3A04%3A05-0700', {\n headers: {\n 'Authorization': 'Bearer {TOKEN}'\n }\n});\n","name":"Browser","syntaxLanguage":"javascript","exampleName":"Default"},{"sample":"package main\n\nimport (\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\tclient := \u0026http.Client{}\n\treq, err := http.NewRequest(\"GET\", \"https://api-ssl.bitly.com/v4/bitlinks/bit.ly/12a4b6c/countries?unit=month\u0026units=1\u0026size=10\u0026unit_reference=2006-01-02T15%3A04%3A05-0700\", nil)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\treq.Header.Set(\"Authorization\", \"Bearer {TOKEN}\")\n\tresp, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tdefer resp.Body.Close()\n\tbodyText, err := ioutil.ReadAll(resp.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tfmt.Printf(\"%s\\n\", bodyText)\n}\n","name":"Go","syntaxLanguage":"go","exampleName":"Default"},{"sample":"import requests\n\nheaders = {\n 'Authorization': 'Bearer {TOKEN}',\n}\n\nparams = (\n ('unit', 'month'),\n ('units', '1'),\n ('size', '10'),\n ('unit_reference', '2006-01-02T15:04:05-0700'),\n)\n\nresponse = requests.get('https://api-ssl.bitly.com/v4/bitlinks/bit.ly/12a4b6c/countries', headers=headers, params=params)\n\n#NB. Original query string below. It seems impossible to parse and\n#reproduce query strings 100% accurately so the one below is given\n#in case the reproduced version is not \"correct\".\n# response = requests.get('https://api-ssl.bitly.com/v4/bitlinks/bit.ly/12a4b6c/countries?unit=month\u0026units=1\u0026size=10\u0026unit_reference=2006-01-02T15%3A04%3A05-0700', headers=headers)\n","name":"Python","syntaxLanguage":"python","exampleName":"Default"}],"responseSamples":[{"statusCode":"200","description":"SUCCESS","json":"{\n \"unit\": \"string\",\n \"units\": \"integer\",\n \"facet\": \"string\",\n \"unit_reference\": \"string\",\n \"metrics\": [\n {\n \"clicks\": \"integer\",\n \"value\": \"string\"\n }\n ]\n}","csv":"Country, Clicks\nUS, 5\n"},{"statusCode":"400","description":"BAD_REQUEST","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"403","description":"FORBIDDEN","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"404","description":"NOT_FOUND","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"410","description":"GONE","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"429","description":"MONTHLY_LIMIT_EXCEEDED","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\"\n}","csv":null},{"statusCode":"500","description":"INTERNAL_ERROR","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"503","description":"TEMPORARILY_UNAVAILABLE","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null}],"requestBodyParams":null},{"summary":"Get Metrics for a Bitlink by City","description":"Returns the city origins of click traffic for the specified link.","tags":["Bitlinks"],"operationId":"getMetricsForBitlinkByCities","parameters":[{"name":"bitlink","description":"A Bitlink made of the domain and hash","in":"path","required":true,"schema":{"type":"string"},"example":"bit.ly/12a4b6c"},{"name":"unit","description":"A unit of time","schema":{"description":"the unit of time queried for (minute, hour, day, week, month)","type":"string","enum":["minute","hour","day","week","month"],"default":"day"},"required":true,"in":"query","example":"month"},{"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},{"name":"size","description":"The quantity of items to be be returned","in":"query","schema":{"type":"integer","default":50},"example":10},{"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"}],"responses":{"200":{"description":"SUCCESS","content":{"application/json":{"schema":{"type":"object","allOf":[{"type":"object","properties":{"unit":{"type":"string","x-faker":"internet.userName"},"units":{"type":"integer","x-faker":{"datatype.number":{"min":1,"max":100}}},"facet":{"type":"string","enum":["countries","cities","devices","referrers","referrers_by_domain","referring_domains","referring_networks","shorten_counts"]},"unit_reference":{"type":"string","x-faker":"date.past"}}},{"properties":{"metrics":{"type":"array","items":{"type":"object","properties":{"clicks":{"type":"integer","x-faker":"random.number"},"city":{"type":"string","x-faker":"address.city"},"subregion":{"type":"string","x-faker":"address.state"},"region":{"type":"string","x-faker":"address.state"},"country":{"type":"string","x-faker":"address.country"}}}},"other_metrics":{"type":"object","properties":{"other_city_clicks":{"type":"integer","x-faker":"random.number"},"no_city_clicks":{"type":"integer","x-faker":"random.number"}}}}}]}},"text/csv":{"schema":{"type":"object","allOf":[{"type":"object","properties":{"unit":{"type":"string","x-faker":"internet.userName"},"units":{"type":"integer","x-faker":{"datatype.number":{"min":1,"max":100}}},"facet":{"type":"string","enum":["countries","cities","devices","referrers","referrers_by_domain","referring_domains","referring_networks","shorten_counts"]},"unit_reference":{"type":"string","x-faker":"date.past"}}},{"properties":{"metrics":{"type":"array","items":{"type":"object","properties":{"clicks":{"type":"integer","x-faker":"random.number"},"city":{"type":"string","x-faker":"address.city"},"subregion":{"type":"string","x-faker":"address.state"},"region":{"type":"string","x-faker":"address.state"},"country":{"type":"string","x-faker":"address.country"}}}},"other_metrics":{"type":"object","properties":{"other_city_clicks":{"type":"integer","x-faker":"random.number"},"no_city_clicks":{"type":"integer","x-faker":"random.number"}}}}}]},"example":"City, Subregion, Region, Country, Clicks\nNew York, , NY, US, 5\n"}}},"400":{"description":"BAD_REQUEST","content":{"application/json":{"schema":{"description":"BAD_REQUEST","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"402":{"description":"UPGRADE_REQUIRED","content":{"application/json":{"schema":{"description":"UPGRADE_REQUIRED","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"403":{"description":"FORBIDDEN","content":{"application/json":{"schema":{"description":"FORBIDDEN","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"404":{"description":"NOT_FOUND","content":{"application/json":{"schema":{"description":"NOT_FOUND","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"410":{"description":"GONE","content":{"application/json":{"schema":{"description":"GONE","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"429":{"description":"MONTHLY_LIMIT_EXCEEDED","content":{"application/json":{"schema":{"example":"API_USAGE_LIMIT_EXCEEDED","description":"MONTHLY_LIMIT_EXCEEDED","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"}}}]}}}},"500":{"description":"INTERNAL_ERROR","content":{"application/json":{"schema":{"description":"INTERNAL_ERROR","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"503":{"description":"TEMPORARILY_UNAVAILABLE","content":{"application/json":{"schema":{"description":"TEMPORARILY_UNAVAILABLE","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}}},"method":"get","path":"/bitlinks/{bitlink}/cities","requestSamples":[{"name":"cURL","syntaxLanguage":"bash","sample":"curl \\\n-H 'Authorization: Bearer {TOKEN}' \\\n-X GET \\\nhttps://api-ssl.bitly.com/v4/bitlinks/bit.ly/12a4b6c/cities?unit=month\u0026units=1\u0026size=10\u0026unit_reference=2006-01-02T15%3A04%3A05-0700","exampleName":"Default"},{"sample":"var fetch = require('node-fetch');\n\nfetch('https://api-ssl.bitly.com/v4/bitlinks/bit.ly/12a4b6c/cities?unit=month\u0026units=1\u0026size=10\u0026unit_reference=2006-01-02T15%3A04%3A05-0700', {\n headers: {\n 'Authorization': 'Bearer {TOKEN}'\n }\n});\n","name":"Node","syntaxLanguage":"javascript","exampleName":"Default"},{"sample":"fetch('https://api-ssl.bitly.com/v4/bitlinks/bit.ly/12a4b6c/cities?unit=month\u0026units=1\u0026size=10\u0026unit_reference=2006-01-02T15%3A04%3A05-0700', {\n headers: {\n 'Authorization': 'Bearer {TOKEN}'\n }\n});\n","name":"Browser","syntaxLanguage":"javascript","exampleName":"Default"},{"sample":"package main\n\nimport (\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\tclient := \u0026http.Client{}\n\treq, err := http.NewRequest(\"GET\", \"https://api-ssl.bitly.com/v4/bitlinks/bit.ly/12a4b6c/cities?unit=month\u0026units=1\u0026size=10\u0026unit_reference=2006-01-02T15%3A04%3A05-0700\", nil)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\treq.Header.Set(\"Authorization\", \"Bearer {TOKEN}\")\n\tresp, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tdefer resp.Body.Close()\n\tbodyText, err := ioutil.ReadAll(resp.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tfmt.Printf(\"%s\\n\", bodyText)\n}\n","name":"Go","syntaxLanguage":"go","exampleName":"Default"},{"sample":"import requests\n\nheaders = {\n 'Authorization': 'Bearer {TOKEN}',\n}\n\nparams = (\n ('unit', 'month'),\n ('units', '1'),\n ('size', '10'),\n ('unit_reference', '2006-01-02T15:04:05-0700'),\n)\n\nresponse = requests.get('https://api-ssl.bitly.com/v4/bitlinks/bit.ly/12a4b6c/cities', headers=headers, params=params)\n\n#NB. Original query string below. It seems impossible to parse and\n#reproduce query strings 100% accurately so the one below is given\n#in case the reproduced version is not \"correct\".\n# response = requests.get('https://api-ssl.bitly.com/v4/bitlinks/bit.ly/12a4b6c/cities?unit=month\u0026units=1\u0026size=10\u0026unit_reference=2006-01-02T15%3A04%3A05-0700', headers=headers)\n","name":"Python","syntaxLanguage":"python","exampleName":"Default"}],"responseSamples":[{"statusCode":"200","description":"SUCCESS","json":"{\n \"unit\": \"string\",\n \"units\": \"integer\",\n \"facet\": \"string\",\n \"unit_reference\": \"string\",\n \"metrics\": [\n {\n \"clicks\": \"integer\",\n \"city\": \"string\",\n \"subregion\": \"string\",\n \"region\": \"string\",\n \"country\": \"string\"\n }\n ],\n \"other_metrics\": {\n \"other_city_clicks\": \"integer\",\n \"no_city_clicks\": \"integer\"\n }\n}","csv":"City, Subregion, Region, Country, Clicks\nNew York, , NY, US, 5\n"},{"statusCode":"400","description":"BAD_REQUEST","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"402","description":"UPGRADE_REQUIRED","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"403","description":"FORBIDDEN","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"404","description":"NOT_FOUND","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"410","description":"GONE","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"429","description":"MONTHLY_LIMIT_EXCEEDED","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\"\n}","csv":null},{"statusCode":"500","description":"INTERNAL_ERROR","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"503","description":"TEMPORARILY_UNAVAILABLE","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null}],"requestBodyParams":null},{"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","parameters":[{"name":"bitlink","description":"A Bitlink made of the domain and hash","in":"path","required":true,"schema":{"type":"string"},"example":"bit.ly/12a4b6c"},{"name":"unit","description":"A unit of time","schema":{"description":"the unit of time queried for (minute, hour, day, week, month)","type":"string","enum":["minute","hour","day","week","month"],"default":"day"},"required":true,"in":"query","example":"month"},{"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},{"name":"size","description":"The quantity of items to be be returned","in":"query","schema":{"type":"integer","default":50},"example":10},{"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"}],"responses":{"200":{"description":"SUCCESS","content":{"application/json":{"schema":{"type":"object","allOf":[{"type":"object","properties":{"unit":{"type":"string","x-faker":"internet.userName"},"units":{"type":"integer","x-faker":{"datatype.number":{"min":1,"max":100}}},"facet":{"type":"string","enum":["countries","cities","devices","referrers","referrers_by_domain","referring_domains","referring_networks","shorten_counts"]},"unit_reference":{"type":"string","x-faker":"date.past"}}},{"properties":{"metrics":{"type":"array","items":{"type":"object","properties":{"clicks":{"type":"integer"},"device_type":{"type":"string"}}}}}}]}},"text/csv":{"schema":{"type":"object","allOf":[{"type":"object","properties":{"unit":{"type":"string","x-faker":"internet.userName"},"units":{"type":"integer","x-faker":{"datatype.number":{"min":1,"max":100}}},"facet":{"type":"string","enum":["countries","cities","devices","referrers","referrers_by_domain","referring_domains","referring_networks","shorten_counts"]},"unit_reference":{"type":"string","x-faker":"date.past"}}},{"properties":{"metrics":{"type":"array","items":{"type":"object","properties":{"clicks":{"type":"integer"},"device_type":{"type":"string"}}}}}}]},"example":"Device Type, Clicks\nDesktop, 5\n"}}},"400":{"description":"BAD_REQUEST","content":{"application/json":{"schema":{"description":"BAD_REQUEST","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"402":{"description":"UPGRADE_REQUIRED","content":{"application/json":{"schema":{"description":"UPGRADE_REQUIRED","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"403":{"description":"FORBIDDEN","content":{"application/json":{"schema":{"description":"FORBIDDEN","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"404":{"description":"NOT_FOUND","content":{"application/json":{"schema":{"description":"NOT_FOUND","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"410":{"description":"GONE","content":{"application/json":{"schema":{"description":"GONE","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"429":{"description":"MONTHLY_LIMIT_EXCEEDED","content":{"application/json":{"schema":{"example":"API_USAGE_LIMIT_EXCEEDED","description":"MONTHLY_LIMIT_EXCEEDED","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"}}}]}}}},"500":{"description":"INTERNAL_ERROR","content":{"application/json":{"schema":{"description":"INTERNAL_ERROR","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"503":{"description":"TEMPORARILY_UNAVAILABLE","content":{"application/json":{"schema":{"description":"TEMPORARILY_UNAVAILABLE","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}}},"method":"get","path":"/bitlinks/{bitlink}/devices","requestSamples":[{"name":"cURL","syntaxLanguage":"bash","sample":"curl \\\n-H 'Authorization: Bearer {TOKEN}' \\\n-X GET \\\nhttps://api-ssl.bitly.com/v4/bitlinks/bit.ly/12a4b6c/devices?unit=month\u0026units=1\u0026size=10\u0026unit_reference=2006-01-02T15%3A04%3A05-0700","exampleName":"Default"},{"sample":"var fetch = require('node-fetch');\n\nfetch('https://api-ssl.bitly.com/v4/bitlinks/bit.ly/12a4b6c/devices?unit=month\u0026units=1\u0026size=10\u0026unit_reference=2006-01-02T15%3A04%3A05-0700', {\n headers: {\n 'Authorization': 'Bearer {TOKEN}'\n }\n});\n","name":"Node","syntaxLanguage":"javascript","exampleName":"Default"},{"sample":"fetch('https://api-ssl.bitly.com/v4/bitlinks/bit.ly/12a4b6c/devices?unit=month\u0026units=1\u0026size=10\u0026unit_reference=2006-01-02T15%3A04%3A05-0700', {\n headers: {\n 'Authorization': 'Bearer {TOKEN}'\n }\n});\n","name":"Browser","syntaxLanguage":"javascript","exampleName":"Default"},{"sample":"package main\n\nimport (\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\tclient := \u0026http.Client{}\n\treq, err := http.NewRequest(\"GET\", \"https://api-ssl.bitly.com/v4/bitlinks/bit.ly/12a4b6c/devices?unit=month\u0026units=1\u0026size=10\u0026unit_reference=2006-01-02T15%3A04%3A05-0700\", nil)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\treq.Header.Set(\"Authorization\", \"Bearer {TOKEN}\")\n\tresp, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tdefer resp.Body.Close()\n\tbodyText, err := ioutil.ReadAll(resp.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tfmt.Printf(\"%s\\n\", bodyText)\n}\n","name":"Go","syntaxLanguage":"go","exampleName":"Default"},{"sample":"import requests\n\nheaders = {\n 'Authorization': 'Bearer {TOKEN}',\n}\n\nparams = (\n ('unit', 'month'),\n ('units', '1'),\n ('size', '10'),\n ('unit_reference', '2006-01-02T15:04:05-0700'),\n)\n\nresponse = requests.get('https://api-ssl.bitly.com/v4/bitlinks/bit.ly/12a4b6c/devices', headers=headers, params=params)\n\n#NB. Original query string below. It seems impossible to parse and\n#reproduce query strings 100% accurately so the one below is given\n#in case the reproduced version is not \"correct\".\n# response = requests.get('https://api-ssl.bitly.com/v4/bitlinks/bit.ly/12a4b6c/devices?unit=month\u0026units=1\u0026size=10\u0026unit_reference=2006-01-02T15%3A04%3A05-0700', headers=headers)\n","name":"Python","syntaxLanguage":"python","exampleName":"Default"}],"responseSamples":[{"statusCode":"200","description":"SUCCESS","json":"{\n \"unit\": \"string\",\n \"units\": \"integer\",\n \"facet\": \"string\",\n \"unit_reference\": \"string\",\n \"metrics\": [\n {\n \"clicks\": \"integer\",\n \"device_type\": \"string\"\n }\n ]\n}","csv":"Device Type, Clicks\nDesktop, 5\n"},{"statusCode":"400","description":"BAD_REQUEST","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"402","description":"UPGRADE_REQUIRED","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"403","description":"FORBIDDEN","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"404","description":"NOT_FOUND","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"410","description":"GONE","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"429","description":"MONTHLY_LIMIT_EXCEEDED","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\"\n}","csv":null},{"statusCode":"500","description":"INTERNAL_ERROR","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"503","description":"TEMPORARILY_UNAVAILABLE","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null}],"requestBodyParams":null},{"summary":"Get Metrics for a Bitlink by Referrers","description":"Returns referrer click counts for the specified link.","tags":["Bitlinks"],"operationId":"getMetricsForBitlinkByReferrers","parameters":[{"name":"bitlink","description":"A Bitlink made of the domain and hash","in":"path","required":true,"schema":{"type":"string"},"example":"bit.ly/12a4b6c"},{"name":"unit","description":"A unit of time","schema":{"description":"the unit of time queried for (minute, hour, day, week, month)","type":"string","enum":["minute","hour","day","week","month"],"default":"day"},"required":true,"in":"query","example":"month"},{"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},{"name":"size","description":"The quantity of items to be be returned","in":"query","schema":{"type":"integer","default":50},"example":10},{"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"}],"responses":{"200":{"description":"SUCCESS","content":{"application/json":{"schema":{"type":"object","allOf":[{"type":"object","properties":{"unit":{"type":"string","x-faker":"internet.userName"},"units":{"type":"integer","x-faker":{"datatype.number":{"min":1,"max":100}}},"facet":{"type":"string","enum":["countries","cities","devices","referrers","referrers_by_domain","referring_domains","referring_networks","shorten_counts"]},"unit_reference":{"type":"string","x-faker":"date.past"}}},{"properties":{"metrics":{"type":"array","items":{"type":"object","properties":{"clicks":{"type":"integer","example":123,"x-faker":"random.number"},"value":{"type":"string","example":"bit.ly","x-faker":"internet.domainName"}}}}}}]}},"text/csv":{"schema":{"type":"object","allOf":[{"type":"object","properties":{"unit":{"type":"string","x-faker":"internet.userName"},"units":{"type":"integer","x-faker":{"datatype.number":{"min":1,"max":100}}},"facet":{"type":"string","enum":["countries","cities","devices","referrers","referrers_by_domain","referring_domains","referring_networks","shorten_counts"]},"unit_reference":{"type":"string","x-faker":"date.past"}}},{"properties":{"metrics":{"type":"array","items":{"type":"object","properties":{"clicks":{"type":"integer","example":123,"x-faker":"random.number"},"value":{"type":"string","example":"bit.ly","x-faker":"internet.domainName"}}}}}}]},"example":"Referrers, Domain/Sub-Domain, Clicks\nOther Sites, direct, 5\n"}}},"400":{"description":"BAD_REQUEST","content":{"application/json":{"schema":{"description":"BAD_REQUEST","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"403":{"description":"FORBIDDEN","content":{"application/json":{"schema":{"description":"FORBIDDEN","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"404":{"description":"NOT_FOUND","content":{"application/json":{"schema":{"description":"NOT_FOUND","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"410":{"description":"GONE","content":{"application/json":{"schema":{"description":"GONE","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"429":{"description":"MONTHLY_LIMIT_EXCEEDED","content":{"application/json":{"schema":{"example":"API_USAGE_LIMIT_EXCEEDED","description":"MONTHLY_LIMIT_EXCEEDED","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"}}}]}}}},"500":{"description":"INTERNAL_ERROR","content":{"application/json":{"schema":{"description":"INTERNAL_ERROR","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"503":{"description":"TEMPORARILY_UNAVAILABLE","content":{"application/json":{"schema":{"description":"TEMPORARILY_UNAVAILABLE","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}}},"method":"get","path":"/bitlinks/{bitlink}/referrers","requestSamples":[{"name":"cURL","syntaxLanguage":"bash","sample":"curl \\\n-H 'Authorization: Bearer {TOKEN}' \\\n-X GET \\\nhttps://api-ssl.bitly.com/v4/bitlinks/bit.ly/12a4b6c/referrers?unit=month\u0026units=1\u0026size=10\u0026unit_reference=2006-01-02T15%3A04%3A05-0700","exampleName":"Default"},{"sample":"var fetch = require('node-fetch');\n\nfetch('https://api-ssl.bitly.com/v4/bitlinks/bit.ly/12a4b6c/referrers?unit=month\u0026units=1\u0026size=10\u0026unit_reference=2006-01-02T15%3A04%3A05-0700', {\n headers: {\n 'Authorization': 'Bearer {TOKEN}'\n }\n});\n","name":"Node","syntaxLanguage":"javascript","exampleName":"Default"},{"sample":"fetch('https://api-ssl.bitly.com/v4/bitlinks/bit.ly/12a4b6c/referrers?unit=month\u0026units=1\u0026size=10\u0026unit_reference=2006-01-02T15%3A04%3A05-0700', {\n headers: {\n 'Authorization': 'Bearer {TOKEN}'\n }\n});\n","name":"Browser","syntaxLanguage":"javascript","exampleName":"Default"},{"sample":"package main\n\nimport (\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\tclient := \u0026http.Client{}\n\treq, err := http.NewRequest(\"GET\", \"https://api-ssl.bitly.com/v4/bitlinks/bit.ly/12a4b6c/referrers?unit=month\u0026units=1\u0026size=10\u0026unit_reference=2006-01-02T15%3A04%3A05-0700\", nil)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\treq.Header.Set(\"Authorization\", \"Bearer {TOKEN}\")\n\tresp, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tdefer resp.Body.Close()\n\tbodyText, err := ioutil.ReadAll(resp.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tfmt.Printf(\"%s\\n\", bodyText)\n}\n","name":"Go","syntaxLanguage":"go","exampleName":"Default"},{"sample":"import requests\n\nheaders = {\n 'Authorization': 'Bearer {TOKEN}',\n}\n\nparams = (\n ('unit', 'month'),\n ('units', '1'),\n ('size', '10'),\n ('unit_reference', '2006-01-02T15:04:05-0700'),\n)\n\nresponse = requests.get('https://api-ssl.bitly.com/v4/bitlinks/bit.ly/12a4b6c/referrers', headers=headers, params=params)\n\n#NB. Original query string below. It seems impossible to parse and\n#reproduce query strings 100% accurately so the one below is given\n#in case the reproduced version is not \"correct\".\n# response = requests.get('https://api-ssl.bitly.com/v4/bitlinks/bit.ly/12a4b6c/referrers?unit=month\u0026units=1\u0026size=10\u0026unit_reference=2006-01-02T15%3A04%3A05-0700', headers=headers)\n","name":"Python","syntaxLanguage":"python","exampleName":"Default"}],"responseSamples":[{"statusCode":"200","description":"SUCCESS","json":"{\n \"unit\": \"string\",\n \"units\": \"integer\",\n \"facet\": \"string\",\n \"unit_reference\": \"string\",\n \"metrics\": [\n {\n \"clicks\": \"integer\",\n \"value\": \"string\"\n }\n ]\n}","csv":"Referrers, Domain/Sub-Domain, Clicks\nOther Sites, direct, 5\n"},{"statusCode":"400","description":"BAD_REQUEST","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"403","description":"FORBIDDEN","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"404","description":"NOT_FOUND","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"410","description":"GONE","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"429","description":"MONTHLY_LIMIT_EXCEEDED","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\"\n}","csv":null},{"statusCode":"500","description":"INTERNAL_ERROR","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"503","description":"TEMPORARILY_UNAVAILABLE","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null}],"requestBodyParams":null},{"summary":"Get Metrics for a Bitlink by Referrer Name","description":"Returns referrer click counts for the specified link.","tags":["Bitlinks"],"operationId":"getMetricsForBitlinkByReferrerName","parameters":[{"name":"bitlink","description":"A Bitlink made of the domain and hash","in":"path","required":true,"schema":{"type":"string"},"example":"bit.ly/12a4b6c"},{"name":"unit","description":"A unit of time","schema":{"description":"the unit of time queried for (minute, hour, day, week, month)","type":"string","enum":["minute","hour","day","week","month"],"default":"day"},"required":true,"in":"query","example":"month"},{"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},{"name":"size","description":"The quantity of items to be be returned","in":"query","schema":{"type":"integer","default":50},"example":10},{"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"}],"responses":{"200":{"description":"SUCCESS","content":{"application/json":{"schema":{"type":"object","allOf":[{"type":"object","properties":{"unit":{"type":"string","x-faker":"internet.userName"},"units":{"type":"integer","x-faker":{"datatype.number":{"min":1,"max":100}}},"facet":{"type":"string","enum":["countries","cities","devices","referrers","referrers_by_domain","referring_domains","referring_networks","shorten_counts"]},"unit_reference":{"type":"string","x-faker":"date.past"}}},{"properties":{"metrics":{"type":"array","items":{"type":"object","properties":{"clicks":{"type":"integer","example":123,"x-faker":"random.number"},"value":{"type":"string","example":"bit.ly","x-faker":"internet.domainName"}}}}}}]}},"text/csv":{"schema":{"type":"object","allOf":[{"type":"object","properties":{"unit":{"type":"string","x-faker":"internet.userName"},"units":{"type":"integer","x-faker":{"datatype.number":{"min":1,"max":100}}},"facet":{"type":"string","enum":["countries","cities","devices","referrers","referrers_by_domain","referring_domains","referring_networks","shorten_counts"]},"unit_reference":{"type":"string","x-faker":"date.past"}}},{"properties":{"metrics":{"type":"array","items":{"type":"object","properties":{"clicks":{"type":"integer","example":123,"x-faker":"random.number"},"value":{"type":"string","example":"bit.ly","x-faker":"internet.domainName"}}}}}}]},"example":"Referrer-Name,Clicks\ndirect,4\n"}}},"400":{"description":"BAD_REQUEST","content":{"application/json":{"schema":{"description":"BAD_REQUEST","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"403":{"description":"FORBIDDEN","content":{"application/json":{"schema":{"description":"FORBIDDEN","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"404":{"description":"NOT_FOUND","content":{"application/json":{"schema":{"description":"NOT_FOUND","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"410":{"description":"GONE","content":{"application/json":{"schema":{"description":"GONE","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"500":{"description":"INTERNAL_ERROR","content":{"application/json":{"schema":{"description":"INTERNAL_ERROR","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"503":{"description":"TEMPORARILY_UNAVAILABLE","content":{"application/json":{"schema":{"description":"TEMPORARILY_UNAVAILABLE","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}}},"method":"get","path":"/bitlinks/{bitlink}/referrer_name","requestSamples":[{"name":"cURL","syntaxLanguage":"bash","sample":"curl \\\n-H 'Authorization: Bearer {TOKEN}' \\\n-X GET \\\nhttps://api-ssl.bitly.com/v4/bitlinks/bit.ly/12a4b6c/referrer_name?unit=month\u0026units=1\u0026size=10\u0026unit_reference=2006-01-02T15%3A04%3A05-0700","exampleName":"Default"},{"sample":"var fetch = require('node-fetch');\n\nfetch('https://api-ssl.bitly.com/v4/bitlinks/bit.ly/12a4b6c/referrer_name?unit=month\u0026units=1\u0026size=10\u0026unit_reference=2006-01-02T15%3A04%3A05-0700', {\n headers: {\n 'Authorization': 'Bearer {TOKEN}'\n }\n});\n","name":"Node","syntaxLanguage":"javascript","exampleName":"Default"},{"sample":"fetch('https://api-ssl.bitly.com/v4/bitlinks/bit.ly/12a4b6c/referrer_name?unit=month\u0026units=1\u0026size=10\u0026unit_reference=2006-01-02T15%3A04%3A05-0700', {\n headers: {\n 'Authorization': 'Bearer {TOKEN}'\n }\n});\n","name":"Browser","syntaxLanguage":"javascript","exampleName":"Default"},{"sample":"package main\n\nimport (\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\tclient := \u0026http.Client{}\n\treq, err := http.NewRequest(\"GET\", \"https://api-ssl.bitly.com/v4/bitlinks/bit.ly/12a4b6c/referrer_name?unit=month\u0026units=1\u0026size=10\u0026unit_reference=2006-01-02T15%3A04%3A05-0700\", nil)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\treq.Header.Set(\"Authorization\", \"Bearer {TOKEN}\")\n\tresp, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tdefer resp.Body.Close()\n\tbodyText, err := ioutil.ReadAll(resp.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tfmt.Printf(\"%s\\n\", bodyText)\n}\n","name":"Go","syntaxLanguage":"go","exampleName":"Default"},{"sample":"import requests\n\nheaders = {\n 'Authorization': 'Bearer {TOKEN}',\n}\n\nparams = (\n ('unit', 'month'),\n ('units', '1'),\n ('size', '10'),\n ('unit_reference', '2006-01-02T15:04:05-0700'),\n)\n\nresponse = requests.get('https://api-ssl.bitly.com/v4/bitlinks/bit.ly/12a4b6c/referrer_name', headers=headers, params=params)\n\n#NB. Original query string below. It seems impossible to parse and\n#reproduce query strings 100% accurately so the one below is given\n#in case the reproduced version is not \"correct\".\n# response = requests.get('https://api-ssl.bitly.com/v4/bitlinks/bit.ly/12a4b6c/referrer_name?unit=month\u0026units=1\u0026size=10\u0026unit_reference=2006-01-02T15%3A04%3A05-0700', headers=headers)\n","name":"Python","syntaxLanguage":"python","exampleName":"Default"}],"responseSamples":[{"statusCode":"200","description":"SUCCESS","json":"{\n \"unit\": \"string\",\n \"units\": \"integer\",\n \"facet\": \"string\",\n \"unit_reference\": \"string\",\n \"metrics\": [\n {\n \"clicks\": \"integer\",\n \"value\": \"string\"\n }\n ]\n}","csv":"Referrer-Name,Clicks\ndirect,4\n"},{"statusCode":"400","description":"BAD_REQUEST","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"403","description":"FORBIDDEN","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"404","description":"NOT_FOUND","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"410","description":"GONE","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"500","description":"INTERNAL_ERROR","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"503","description":"TEMPORARILY_UNAVAILABLE","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null}],"requestBodyParams":null},{"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":[{"name":"bitlink","description":"A Bitlink made of the domain and hash","in":"path","required":true,"schema":{"type":"string"},"example":"bit.ly/12a4b6c"},{"name":"unit","description":"A unit of time","schema":{"description":"the unit of time queried for (minute, hour, day, week, month)","type":"string","enum":["minute","hour","day","week","month"],"default":"day"},"required":true,"in":"query","example":"month"},{"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},{"name":"size","description":"The quantity of items to be be returned","in":"query","schema":{"type":"integer","default":50},"example":10},{"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"}],"responses":{"200":{"description":"SUCCESS","content":{"application/json":{"schema":{"type":"object","allOf":[{"type":"object","properties":{"unit":{"type":"string","x-faker":"internet.userName"},"units":{"type":"integer","x-faker":{"datatype.number":{"min":1,"max":100}}},"facet":{"type":"string","enum":["countries","cities","devices","referrers","referrers_by_domain","referring_domains","referring_networks","shorten_counts"]},"unit_reference":{"type":"string","x-faker":"date.past"}}},{"properties":{"metrics":{"type":"array","items":{"type":"object","properties":{"clicks":{"type":"integer","example":123,"x-faker":"random.number"},"value":{"type":"string","example":"bit.ly","x-faker":"internet.domainName"}}}}}}]}}}},"400":{"description":"BAD_REQUEST","content":{"application/json":{"schema":{"description":"BAD_REQUEST","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"403":{"description":"FORBIDDEN","content":{"application/json":{"schema":{"description":"FORBIDDEN","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"404":{"description":"NOT_FOUND","content":{"application/json":{"schema":{"description":"NOT_FOUND","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"410":{"description":"GONE","content":{"application/json":{"schema":{"description":"GONE","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"429":{"description":"MONTHLY_LIMIT_EXCEEDED","content":{"application/json":{"schema":{"example":"API_USAGE_LIMIT_EXCEEDED","description":"MONTHLY_LIMIT_EXCEEDED","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"}}}]}}}},"500":{"description":"INTERNAL_ERROR","content":{"application/json":{"schema":{"description":"INTERNAL_ERROR","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"503":{"description":"TEMPORARILY_UNAVAILABLE","content":{"application/json":{"schema":{"description":"TEMPORARILY_UNAVAILABLE","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}}},"method":"get","path":"/bitlinks/{bitlink}/referring_domains","requestSamples":[{"name":"cURL","syntaxLanguage":"bash","sample":"curl \\\n-H 'Authorization: Bearer {TOKEN}' \\\n-X GET \\\nhttps://api-ssl.bitly.com/v4/bitlinks/bit.ly/12a4b6c/referring_domains?unit=month\u0026units=1\u0026size=10\u0026unit_reference=2006-01-02T15%3A04%3A05-0700","exampleName":"Default"},{"sample":"var fetch = require('node-fetch');\n\nfetch('https://api-ssl.bitly.com/v4/bitlinks/bit.ly/12a4b6c/referring_domains?unit=month\u0026units=1\u0026size=10\u0026unit_reference=2006-01-02T15%3A04%3A05-0700', {\n headers: {\n 'Authorization': 'Bearer {TOKEN}'\n }\n});\n","name":"Node","syntaxLanguage":"javascript","exampleName":"Default"},{"sample":"fetch('https://api-ssl.bitly.com/v4/bitlinks/bit.ly/12a4b6c/referring_domains?unit=month\u0026units=1\u0026size=10\u0026unit_reference=2006-01-02T15%3A04%3A05-0700', {\n headers: {\n 'Authorization': 'Bearer {TOKEN}'\n }\n});\n","name":"Browser","syntaxLanguage":"javascript","exampleName":"Default"},{"sample":"package main\n\nimport (\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\tclient := \u0026http.Client{}\n\treq, err := http.NewRequest(\"GET\", \"https://api-ssl.bitly.com/v4/bitlinks/bit.ly/12a4b6c/referring_domains?unit=month\u0026units=1\u0026size=10\u0026unit_reference=2006-01-02T15%3A04%3A05-0700\", nil)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\treq.Header.Set(\"Authorization\", \"Bearer {TOKEN}\")\n\tresp, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tdefer resp.Body.Close()\n\tbodyText, err := ioutil.ReadAll(resp.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tfmt.Printf(\"%s\\n\", bodyText)\n}\n","name":"Go","syntaxLanguage":"go","exampleName":"Default"},{"sample":"import requests\n\nheaders = {\n 'Authorization': 'Bearer {TOKEN}',\n}\n\nparams = (\n ('unit', 'month'),\n ('units', '1'),\n ('size', '10'),\n ('unit_reference', '2006-01-02T15:04:05-0700'),\n)\n\nresponse = requests.get('https://api-ssl.bitly.com/v4/bitlinks/bit.ly/12a4b6c/referring_domains', headers=headers, params=params)\n\n#NB. Original query string below. It seems impossible to parse and\n#reproduce query strings 100% accurately so the one below is given\n#in case the reproduced version is not \"correct\".\n# response = requests.get('https://api-ssl.bitly.com/v4/bitlinks/bit.ly/12a4b6c/referring_domains?unit=month\u0026units=1\u0026size=10\u0026unit_reference=2006-01-02T15%3A04%3A05-0700', headers=headers)\n","name":"Python","syntaxLanguage":"python","exampleName":"Default"}],"responseSamples":[{"statusCode":"200","description":"SUCCESS","json":"{\n \"unit\": \"string\",\n \"units\": \"integer\",\n \"facet\": \"string\",\n \"unit_reference\": \"string\",\n \"metrics\": [\n {\n \"clicks\": \"integer\",\n \"value\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"400","description":"BAD_REQUEST","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"403","description":"FORBIDDEN","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"404","description":"NOT_FOUND","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"410","description":"GONE","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"429","description":"MONTHLY_LIMIT_EXCEEDED","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\"\n}","csv":null},{"statusCode":"500","description":"INTERNAL_ERROR","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"503","description":"TEMPORARILY_UNAVAILABLE","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null}],"requestBodyParams":null},{"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":[{"name":"bitlink","description":"A Bitlink made of the domain and hash","in":"path","required":true,"schema":{"type":"string"},"example":"bit.ly/12a4b6c"},{"name":"unit","description":"A unit of time","schema":{"description":"the unit of time queried for (minute, hour, day, week, month)","type":"string","enum":["minute","hour","day","week","month"],"default":"day"},"required":true,"in":"query","example":"month"},{"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},{"name":"size","description":"The quantity of items to be be returned","in":"query","schema":{"type":"integer","default":50},"example":10},{"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"}],"responses":{"200":{"description":"SUCCESS","content":{"application/json":{"schema":{"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":{"type":"object","properties":{"network":{"type":"string"},"referrers":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"integer"}}}}}}}}}}}},"400":{"description":"BAD_REQUEST","content":{"application/json":{"schema":{"description":"BAD_REQUEST","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"403":{"description":"FORBIDDEN","content":{"application/json":{"schema":{"description":"FORBIDDEN","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"404":{"description":"NOT_FOUND","content":{"application/json":{"schema":{"description":"NOT_FOUND","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"410":{"description":"GONE","content":{"application/json":{"schema":{"description":"GONE","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"429":{"description":"MONTHLY_LIMIT_EXCEEDED","content":{"application/json":{"schema":{"example":"API_USAGE_LIMIT_EXCEEDED","description":"MONTHLY_LIMIT_EXCEEDED","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"}}}]}}}},"500":{"description":"INTERNAL_ERROR","content":{"application/json":{"schema":{"description":"INTERNAL_ERROR","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"503":{"description":"TEMPORARILY_UNAVAILABLE","content":{"application/json":{"schema":{"description":"TEMPORARILY_UNAVAILABLE","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}}},"method":"get","path":"/bitlinks/{bitlink}/referrers_by_domains","requestSamples":[{"name":"cURL","syntaxLanguage":"bash","sample":"curl \\\n-H 'Authorization: Bearer {TOKEN}' \\\n-X GET \\\nhttps://api-ssl.bitly.com/v4/bitlinks/bit.ly/12a4b6c/referrers_by_domains?unit=month\u0026units=1\u0026size=10\u0026unit_reference=2006-01-02T15%3A04%3A05-0700","exampleName":"Default"},{"sample":"var fetch = require('node-fetch');\n\nfetch('https://api-ssl.bitly.com/v4/bitlinks/bit.ly/12a4b6c/referrers_by_domains?unit=month\u0026units=1\u0026size=10\u0026unit_reference=2006-01-02T15%3A04%3A05-0700', {\n headers: {\n 'Authorization': 'Bearer {TOKEN}'\n }\n});\n","name":"Node","syntaxLanguage":"javascript","exampleName":"Default"},{"sample":"fetch('https://api-ssl.bitly.com/v4/bitlinks/bit.ly/12a4b6c/referrers_by_domains?unit=month\u0026units=1\u0026size=10\u0026unit_reference=2006-01-02T15%3A04%3A05-0700', {\n headers: {\n 'Authorization': 'Bearer {TOKEN}'\n }\n});\n","name":"Browser","syntaxLanguage":"javascript","exampleName":"Default"},{"sample":"package main\n\nimport (\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\tclient := \u0026http.Client{}\n\treq, err := http.NewRequest(\"GET\", \"https://api-ssl.bitly.com/v4/bitlinks/bit.ly/12a4b6c/referrers_by_domains?unit=month\u0026units=1\u0026size=10\u0026unit_reference=2006-01-02T15%3A04%3A05-0700\", nil)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\treq.Header.Set(\"Authorization\", \"Bearer {TOKEN}\")\n\tresp, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tdefer resp.Body.Close()\n\tbodyText, err := ioutil.ReadAll(resp.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tfmt.Printf(\"%s\\n\", bodyText)\n}\n","name":"Go","syntaxLanguage":"go","exampleName":"Default"},{"sample":"import requests\n\nheaders = {\n 'Authorization': 'Bearer {TOKEN}',\n}\n\nparams = (\n ('unit', 'month'),\n ('units', '1'),\n ('size', '10'),\n ('unit_reference', '2006-01-02T15:04:05-0700'),\n)\n\nresponse = requests.get('https://api-ssl.bitly.com/v4/bitlinks/bit.ly/12a4b6c/referrers_by_domains', headers=headers, params=params)\n\n#NB. Original query string below. It seems impossible to parse and\n#reproduce query strings 100% accurately so the one below is given\n#in case the reproduced version is not \"correct\".\n# response = requests.get('https://api-ssl.bitly.com/v4/bitlinks/bit.ly/12a4b6c/referrers_by_domains?unit=month\u0026units=1\u0026size=10\u0026unit_reference=2006-01-02T15%3A04%3A05-0700', headers=headers)\n","name":"Python","syntaxLanguage":"python","exampleName":"Default"}],"responseSamples":[{"statusCode":"200","description":"SUCCESS","json":"{\n \"unit\": \"string\",\n \"units\": \"integer\",\n \"facet\": \"string\",\n \"unit_reference\": \"string\",\n \"referrers_by_domain\": [\n {\n \"network\": \"string\",\n \"referrers\": [\n {\n \"key\": \"string\",\n \"value\": \"integer\"\n }\n ]\n }\n ]\n}","csv":null},{"statusCode":"400","description":"BAD_REQUEST","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"403","description":"FORBIDDEN","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"404","description":"NOT_FOUND","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"410","description":"GONE","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"429","description":"MONTHLY_LIMIT_EXCEEDED","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\"\n}","csv":null},{"statusCode":"500","description":"INTERNAL_ERROR","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"503","description":"TEMPORARILY_UNAVAILABLE","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null}],"requestBodyParams":null},{"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":[{"name":"group_guid","description":"A GUID for a Bitly group","in":"path","required":true,"schema":{"type":"string"},"example":"Ba1bc23dE4F"},{"name":"size","description":"The quantity of items to be be returned","in":"query","schema":{"type":"integer","default":50},"example":10},{"name":"search_after","description":"Token used to search next batch, only use response from API as input value.","in":"query","schema":{"type":"string"}},{"name":"query","description":"The value that you would like to search","in":"query","schema":{"type":"string"},"example":"api"},{"name":"created_before","description":"Timestamp as an integer unix epoch (seconds only)","in":"query","schema":{"type":"integer"},"example":1694529902},{"name":"created_after","description":"Timestamp as an integer unix epoch (seconds only)","in":"query","schema":{"type":"integer"},"example":1694529902},{"name":"archived","description":"Whether or not to include archived resources","in":"query","schema":{"type":"string","default":"off","enum":["on","off","both"]},"example":"both"},{"name":"deeplinks","description":"Filter to only Bitlinks that contain deeplinks","in":"query","schema":{"type":"string","default":"both","enum":["on","off","both"]},"example":"both"},{"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"},{"name":"campaign_guid","description":"Filter to return only links for the given campaign GUID, can be provided","schema":{"type":"string"},"in":"query","example":"Ca1bcd2EFGh"},{"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"},{"name":"custom_bitlink","in":"query","schema":{"type":"string","default":"both","enum":["on","off","both"]},"example":"both"},{"name":"has_qr_codes","description":"a filter value if the resource has any QR codes","in":"query","schema":{"type":"string","default":"both","enum":["on","off","both"]},"example":"both"},{"name":"tags","description":"Filter by given tags","in":"query","style":"form","explode":true,"schema":{"type":"array","items":{"type":"string"}},"example":["bitly","api"]},{"name":"launchpad_ids","description":"Filter by launchpad id","in":"query","style":"form","explode":true,"schema":{"type":"array","items":{"type":"string"}},"example":["M1234567890"]},{"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"]}],"responses":{"200":{"description":"SUCCESS","content":{"application/json":{"schema":{"type":"object","properties":{"links":{"type":"array","items":{"type":"object","allOf":[{"type":"object","properties":{"references":{"type":"object","additionalProperties":{"type":"string"}}}},{"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"}},"qr_code_ids":{"type":"array","items":{"type":"string"},"description":"a list of qr code ids that are associated with this bitlink"},"deeplinks":{"type":"array","items":{"type":"object","properties":{"guid":{"type":"string"},"bitlink":{"type":"string"},"app_uri_path":{"type":"string"},"install_url":{"type":"string"},"app_guid":{"type":"string"},"os":{"type":"string","enum":["ios","android"]},"install_type":{"type":"string","enum":["no_install","auto_install","promote_install"]},"created":{"type":"string","description":"ISO timestamp"},"modified":{"type":"string","description":"ISO timestamp"},"brand_guid":{"type":"string"}}}},"is_deleted":{"type":"boolean"},"campaign_ids":{"type":"array","items":{"type":"string"}}}}]}},"pagination":{"type":"object","properties":{"next":{"type":"string"},"search_after":{"type":"string"},"size":{"type":"integer"}}}}}}}},"403":{"description":"FORBIDDEN","content":{"application/json":{"schema":{"description":"FORBIDDEN","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"404":{"description":"NOT_FOUND","content":{"application/json":{"schema":{"description":"NOT_FOUND","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"500":{"description":"INTERNAL_ERROR","content":{"application/json":{"schema":{"description":"INTERNAL_ERROR","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"503":{"description":"TEMPORARILY_UNAVAILABLE","content":{"application/json":{"schema":{"description":"TEMPORARILY_UNAVAILABLE","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}}},"method":"get","path":"/groups/{group_guid}/bitlinks","requestSamples":[{"name":"cURL","syntaxLanguage":"bash","sample":"curl \\\n-H 'Authorization: Bearer {TOKEN}' \\\n-X GET \\\nhttps://api-ssl.bitly.com/v4/groups/Ba1bc23dE4F/bitlinks?size=10\u0026search_after=\u0026query=api\u0026created_before=1694529902\u0026created_after=1694529902\u0026archived=both\u0026deeplinks=both\u0026domain_deeplinks=both\u0026campaign_guid=Ca1bcd2EFGh\u0026channel_guid=Ha1bc2DefGh\u0026custom_bitlink=both\u0026has_qr_codes=both\u0026tags=bitly\u0026tags=api\u0026launchpad_ids=M1234567890\u0026encoding_login=chauncey","exampleName":"Default"},{"sample":"var fetch = require('node-fetch');\n\nfetch('https://api-ssl.bitly.com/v4/groups/Ba1bc23dE4F/bitlinks?size=10\u0026search_after=\u0026query=api\u0026created_before=1694529902\u0026created_after=1694529902\u0026archived=both\u0026deeplinks=both\u0026domain_deeplinks=both\u0026campaign_guid=Ca1bcd2EFGh\u0026channel_guid=Ha1bc2DefGh\u0026custom_bitlink=both\u0026has_qr_codes=both\u0026tags=bitly\u0026tags=api\u0026launchpad_ids=M1234567890\u0026encoding_login=chauncey', {\n headers: {\n 'Authorization': 'Bearer {TOKEN}'\n }\n});\n","name":"Node","syntaxLanguage":"javascript","exampleName":"Default"},{"sample":"fetch('https://api-ssl.bitly.com/v4/groups/Ba1bc23dE4F/bitlinks?size=10\u0026search_after=\u0026query=api\u0026created_before=1694529902\u0026created_after=1694529902\u0026archived=both\u0026deeplinks=both\u0026domain_deeplinks=both\u0026campaign_guid=Ca1bcd2EFGh\u0026channel_guid=Ha1bc2DefGh\u0026custom_bitlink=both\u0026has_qr_codes=both\u0026tags=bitly\u0026tags=api\u0026launchpad_ids=M1234567890\u0026encoding_login=chauncey', {\n headers: {\n 'Authorization': 'Bearer {TOKEN}'\n }\n});\n","name":"Browser","syntaxLanguage":"javascript","exampleName":"Default"},{"sample":"package main\n\nimport (\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\tclient := \u0026http.Client{}\n\treq, err := http.NewRequest(\"GET\", \"https://api-ssl.bitly.com/v4/groups/Ba1bc23dE4F/bitlinks?size=10\u0026search_after=\u0026query=api\u0026created_before=1694529902\u0026created_after=1694529902\u0026archived=both\u0026deeplinks=both\u0026domain_deeplinks=both\u0026campaign_guid=Ca1bcd2EFGh\u0026channel_guid=Ha1bc2DefGh\u0026custom_bitlink=both\u0026has_qr_codes=both\u0026tags=bitly\u0026tags=api\u0026launchpad_ids=M1234567890\u0026encoding_login=chauncey\", nil)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\treq.Header.Set(\"Authorization\", \"Bearer {TOKEN}\")\n\tresp, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tdefer resp.Body.Close()\n\tbodyText, err := ioutil.ReadAll(resp.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tfmt.Printf(\"%s\\n\", bodyText)\n}\n","name":"Go","syntaxLanguage":"go","exampleName":"Default"},{"sample":"import requests\n\nheaders = {\n 'Authorization': 'Bearer {TOKEN}',\n}\n\nparams = (\n ('size', '10'),\n ('search_after', ''),\n ('query', 'api'),\n ('created_before', '1694529902'),\n ('created_after', '1694529902'),\n ('archived', 'both'),\n ('deeplinks', 'both'),\n ('domain_deeplinks', 'both'),\n ('campaign_guid', 'Ca1bcd2EFGh'),\n ('channel_guid', 'Ha1bc2DefGh'),\n ('custom_bitlink', 'both'),\n ('has_qr_codes', 'both'),\n ('tags', ['bitly', 'api']),\n ('launchpad_ids', 'M1234567890'),\n ('encoding_login', 'chauncey'),\n)\n\nresponse = requests.get('https://api-ssl.bitly.com/v4/groups/Ba1bc23dE4F/bitlinks', headers=headers, params=params)\n\n#NB. Original query string below. It seems impossible to parse and\n#reproduce query strings 100% accurately so the one below is given\n#in case the reproduced version is not \"correct\".\n# response = requests.get('https://api-ssl.bitly.com/v4/groups/Ba1bc23dE4F/bitlinks?size=10\u0026search_after=\u0026query=api\u0026created_before=1694529902\u0026created_after=1694529902\u0026archived=both\u0026deeplinks=both\u0026domain_deeplinks=both\u0026campaign_guid=Ca1bcd2EFGh\u0026channel_guid=Ha1bc2DefGh\u0026custom_bitlink=both\u0026has_qr_codes=both\u0026tags=bitly\u0026tags=api\u0026launchpad_ids=M1234567890\u0026encoding_login=chauncey', headers=headers)\n","name":"Python","syntaxLanguage":"python","exampleName":"Default"}],"responseSamples":[{"statusCode":"200","description":"SUCCESS","json":"{\n \"links\": [\n {\n \"references\": { \"any\" },\n \"link\": \"string\",\n \"id\": \"string\",\n \"long_url\": \"string\",\n \"title\": \"string\",\n \"archived\": \"boolean\",\n \"created_at\": \"string\",\n \"created_by\": \"string\",\n \"client_id\": \"string\",\n \"custom_bitlinks\": [\n \"string\"\n ],\n \"tags\": [\n \"string\"\n ],\n \"launchpad_ids\": [\n \"string\"\n ],\n \"qr_code_ids\": [\n \"string\"\n ],\n \"deeplinks\": [\n {\n \"guid\": \"string\",\n \"bitlink\": \"string\",\n \"app_uri_path\": \"string\",\n \"install_url\": \"string\",\n \"app_guid\": \"string\",\n \"os\": \"string\",\n \"install_type\": \"string\",\n \"created\": \"string\",\n \"modified\": \"string\",\n \"brand_guid\": \"string\"\n }\n ],\n \"campaign_ids\": [\n \"string\"\n ]\n }\n ],\n \"pagination\": {\n \"next\": \"string\",\n \"search_after\": \"string\",\n \"size\": \"integer\"\n }\n}","csv":null},{"statusCode":"403","description":"FORBIDDEN","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"404","description":"NOT_FOUND","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"500","description":"INTERNAL_ERROR","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"503","description":"TEMPORARILY_UNAVAILABLE","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null}],"requestBodyParams":null},{"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":[{"name":"group_guid","description":"A GUID for a Bitly group","in":"path","required":true,"schema":{"type":"string"},"example":"Ba1bc23dE4F"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"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"]}}}}},"responses":{"200":{"description":"SUCCESS","content":{"application/json":{"schema":{"type":"object","properties":{"links":{"type":"array","items":{"type":"string"}}}}}}},"400":{"description":"BAD_REQUEST","content":{"application/json":{"schema":{"description":"BAD_REQUEST","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"403":{"description":"FORBIDDEN","content":{"application/json":{"schema":{"description":"FORBIDDEN","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"404":{"description":"NOT_FOUND","content":{"application/json":{"schema":{"description":"NOT_FOUND","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"422":{"description":"UNPROCESSABLE_ENTITY","content":{"application/json":{"schema":{"description":"UNPROCESSABLE_ENTITY","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"500":{"description":"INTERNAL_ERROR","content":{"application/json":{"schema":{"description":"INTERNAL_ERROR","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"503":{"description":"TEMPORARILY_UNAVAILABLE","content":{"application/json":{"schema":{"description":"TEMPORARILY_UNAVAILABLE","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}}},"method":"patch","path":"/groups/{group_guid}/bitlinks","requestSamples":[{"name":"cURL","syntaxLanguage":"bash","sample":"curl \\\n-H 'Authorization: Bearer {TOKEN}' \\\n-H 'Content-Type: application/json' \\\n-X PATCH \\\n-d '{\n \"action\": \"edit_tags\",\n \"add_tags\": [\n \"tag1\",\n \"tag2\"\n ],\n \"links\": [\n \"bit.ly/1234abcd\",\n \"bit.ly/5678efgh\"\n ]\n}' \\\nhttps://api-ssl.bitly.com/v4/groups/Ba1bc23dE4F/bitlinks","exampleName":"Default"},{"sample":"var fetch = require('node-fetch');\n\nfetch('https://api-ssl.bitly.com/v4/groups/Ba1bc23dE4F/bitlinks', {\n method: 'PATCH',\n headers: {\n 'Authorization': 'Bearer {TOKEN}',\n 'Content-Type': 'application/json'\n },\n body: JSON.stringify({ \"action\": \"edit_tags\", \"add_tags\": [ \"tag1\", \"tag2\" ], \"links\": [ \"bit.ly/1234abcd\", \"bit.ly/5678efgh\" ] })\n});\n","name":"Node","syntaxLanguage":"javascript","exampleName":"Default"},{"sample":"fetch('https://api-ssl.bitly.com/v4/groups/Ba1bc23dE4F/bitlinks', {\n method: 'PATCH',\n headers: {\n 'Authorization': 'Bearer {TOKEN}',\n 'Content-Type': 'application/json'\n },\n body: JSON.stringify({ \"action\": \"edit_tags\", \"add_tags\": [ \"tag1\", \"tag2\" ], \"links\": [ \"bit.ly/1234abcd\", \"bit.ly/5678efgh\" ] })\n});\n","name":"Browser","syntaxLanguage":"javascript","exampleName":"Default"},{"sample":"package main\n\nimport (\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n\t\"strings\"\n)\n\nfunc main() {\n\tclient := \u0026http.Client{}\n\tvar data = strings.NewReader(`{ \"action\": \"edit_tags\", \"add_tags\": [ \"tag1\", \"tag2\" ], \"links\": [ \"bit.ly/1234abcd\", \"bit.ly/5678efgh\" ] }`)\n\treq, err := http.NewRequest(\"PATCH\", \"https://api-ssl.bitly.com/v4/groups/Ba1bc23dE4F/bitlinks\", data)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\treq.Header.Set(\"Authorization\", \"Bearer {TOKEN}\")\n\treq.Header.Set(\"Content-Type\", \"application/json\")\n\tresp, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tdefer resp.Body.Close()\n\tbodyText, err := ioutil.ReadAll(resp.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tfmt.Printf(\"%s\\n\", bodyText)\n}\n","name":"Go","syntaxLanguage":"go","exampleName":"Default"},{"sample":"import requests\n\nheaders = {\n 'Authorization': 'Bearer {TOKEN}',\n 'Content-Type': 'application/json',\n}\n\ndata = '{ \"action\": \"edit_tags\", \"add_tags\": [ \"tag1\", \"tag2\" ], \"links\": [ \"bit.ly/1234abcd\", \"bit.ly/5678efgh\" ] }'\n\nresponse = requests.patch('https://api-ssl.bitly.com/v4/groups/Ba1bc23dE4F/bitlinks', headers=headers, data=data)\n","name":"Python","syntaxLanguage":"python","exampleName":"Default"}],"responseSamples":[{"statusCode":"200","description":"SUCCESS","json":"{\n \"links\": [\n \"string\"\n ]\n}","csv":null},{"statusCode":"400","description":"BAD_REQUEST","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"403","description":"FORBIDDEN","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"404","description":"NOT_FOUND","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"422","description":"UNPROCESSABLE_ENTITY","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"500","description":"INTERNAL_ERROR","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"503","description":"TEMPORARILY_UNAVAILABLE","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null}],"requestBodyParams":[{"name":"action","description":"archive or edit_tags","required":true,"schema":{"type":"string","default":null,"enum":["archive","edit_tags"]},"items":null,"properties":null},{"name":"archive","description":null,"required":false,"schema":{"type":"boolean","default":null,"enum":null},"items":null,"properties":null},{"name":"add_tags","description":null,"required":false,"schema":{"type":"array","default":null,"enum":null},"items":{"type":"string"},"properties":null},{"name":"remove_tags","description":null,"required":false,"schema":{"type":"array","default":null,"enum":null},"items":{"type":"string"},"properties":null},{"name":"links","description":"this is limited to 100 bitlink ids","required":false,"schema":{"type":"array","default":null,"enum":null},"items":{"type":"string"},"properties":null}]},{"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":[{"name":"group_guid","description":"A GUID for a Bitly group","in":"path","required":true,"schema":{"type":"string"},"example":"Ba1bc23dE4F"},{"name":"sort","description":"The type of sorting that you would like to do","in":"path","required":true,"schema":{"type":"string","enum":["clicks"]},"example":"clicks"},{"name":"unit","description":"A unit of time","schema":{"description":"the unit of time queried for (minute, hour, day, week, month)","type":"string","enum":["minute","hour","day","week","month"],"default":"day"},"in":"query","example":"month"},{"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},{"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"},{"name":"size","description":"The quantity of items to be be returned","in":"query","schema":{"type":"integer","default":50,"maximum":100},"example":10}],"responses":{"200":{"description":"SUCCESS","content":{"application/json":{"schema":{"type":"object","properties":{"links":{"type":"array","items":{"type":"object","allOf":[{"type":"object","properties":{"references":{"type":"object","additionalProperties":{"type":"string"}}}},{"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"}},"qr_code_ids":{"type":"array","items":{"type":"string"},"description":"a list of qr code ids that are associated with this bitlink"},"deeplinks":{"type":"array","items":{"type":"object","properties":{"guid":{"type":"string"},"bitlink":{"type":"string"},"app_uri_path":{"type":"string"},"install_url":{"type":"string"},"app_guid":{"type":"string"},"os":{"type":"string","enum":["ios","android"]},"install_type":{"type":"string","enum":["no_install","auto_install","promote_install"]},"created":{"type":"string","description":"ISO timestamp"},"modified":{"type":"string","description":"ISO timestamp"},"brand_guid":{"type":"string"}}}},"is_deleted":{"type":"boolean"},"campaign_ids":{"type":"array","items":{"type":"string"}}}}]}},"sorted_links":{"type":"array","items":{"type":"object","properties":{"clicks":{"type":"integer"},"id":{"type":"string"}}}}}}}}},"403":{"description":"FORBIDDEN","content":{"application/json":{"schema":{"description":"FORBIDDEN","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"404":{"description":"NOT_FOUND","content":{"application/json":{"schema":{"description":"NOT_FOUND","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"429":{"description":"MONTHLY_LIMIT_EXCEEDED","content":{"application/json":{"schema":{"example":"API_USAGE_LIMIT_EXCEEDED","description":"MONTHLY_LIMIT_EXCEEDED","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"}}}]}}}},"500":{"description":"INTERNAL_ERROR","content":{"application/json":{"schema":{"description":"INTERNAL_ERROR","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"503":{"description":"TEMPORARILY_UNAVAILABLE","content":{"application/json":{"schema":{"description":"TEMPORARILY_UNAVAILABLE","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}}},"method":"get","path":"/groups/{group_guid}/bitlinks/{sort}","requestSamples":[{"name":"cURL","syntaxLanguage":"bash","sample":"curl \\\n-H 'Authorization: Bearer {TOKEN}' \\\n-X GET \\\nhttps://api-ssl.bitly.com/v4/groups/Ba1bc23dE4F/bitlinks/clicks?unit=month\u0026units=1\u0026unit_reference=2006-01-02T15%3A04%3A05-0700\u0026size=10","exampleName":"Default"},{"sample":"var fetch = require('node-fetch');\n\nfetch('https://api-ssl.bitly.com/v4/groups/Ba1bc23dE4F/bitlinks/clicks?unit=month\u0026units=1\u0026unit_reference=2006-01-02T15%3A04%3A05-0700\u0026size=10', {\n headers: {\n 'Authorization': 'Bearer {TOKEN}'\n }\n});\n","name":"Node","syntaxLanguage":"javascript","exampleName":"Default"},{"sample":"fetch('https://api-ssl.bitly.com/v4/groups/Ba1bc23dE4F/bitlinks/clicks?unit=month\u0026units=1\u0026unit_reference=2006-01-02T15%3A04%3A05-0700\u0026size=10', {\n headers: {\n 'Authorization': 'Bearer {TOKEN}'\n }\n});\n","name":"Browser","syntaxLanguage":"javascript","exampleName":"Default"},{"sample":"package main\n\nimport (\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\tclient := \u0026http.Client{}\n\treq, err := http.NewRequest(\"GET\", \"https://api-ssl.bitly.com/v4/groups/Ba1bc23dE4F/bitlinks/clicks?unit=month\u0026units=1\u0026unit_reference=2006-01-02T15%3A04%3A05-0700\u0026size=10\", nil)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\treq.Header.Set(\"Authorization\", \"Bearer {TOKEN}\")\n\tresp, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tdefer resp.Body.Close()\n\tbodyText, err := ioutil.ReadAll(resp.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tfmt.Printf(\"%s\\n\", bodyText)\n}\n","name":"Go","syntaxLanguage":"go","exampleName":"Default"},{"sample":"import requests\n\nheaders = {\n 'Authorization': 'Bearer {TOKEN}',\n}\n\nparams = (\n ('unit', 'month'),\n ('units', '1'),\n ('unit_reference', '2006-01-02T15:04:05-0700'),\n ('size', '10'),\n)\n\nresponse = requests.get('https://api-ssl.bitly.com/v4/groups/Ba1bc23dE4F/bitlinks/clicks', headers=headers, params=params)\n\n#NB. Original query string below. It seems impossible to parse and\n#reproduce query strings 100% accurately so the one below is given\n#in case the reproduced version is not \"correct\".\n# response = requests.get('https://api-ssl.bitly.com/v4/groups/Ba1bc23dE4F/bitlinks/clicks?unit=month\u0026units=1\u0026unit_reference=2006-01-02T15%3A04%3A05-0700\u0026size=10', headers=headers)\n","name":"Python","syntaxLanguage":"python","exampleName":"Default"}],"responseSamples":[{"statusCode":"200","description":"SUCCESS","json":"{\n \"links\": [\n {\n \"references\": { \"any\" },\n \"link\": \"string\",\n \"id\": \"string\",\n \"long_url\": \"string\",\n \"title\": \"string\",\n \"archived\": \"boolean\",\n \"created_at\": \"string\",\n \"created_by\": \"string\",\n \"client_id\": \"string\",\n \"custom_bitlinks\": [\n \"string\"\n ],\n \"tags\": [\n \"string\"\n ],\n \"launchpad_ids\": [\n \"string\"\n ],\n \"qr_code_ids\": [\n \"string\"\n ],\n \"deeplinks\": [\n {\n \"guid\": \"string\",\n \"bitlink\": \"string\",\n \"app_uri_path\": \"string\",\n \"install_url\": \"string\",\n \"app_guid\": \"string\",\n \"os\": \"string\",\n \"install_type\": \"string\",\n \"created\": \"string\",\n \"modified\": \"string\",\n \"brand_guid\": \"string\"\n }\n ],\n \"campaign_ids\": [\n \"string\"\n ]\n }\n ],\n \"sorted_links\": [\n {\n \"clicks\": \"integer\",\n \"id\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"403","description":"FORBIDDEN","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"404","description":"NOT_FOUND","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"429","description":"MONTHLY_LIMIT_EXCEEDED","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\"\n}","csv":null},{"statusCode":"500","description":"INTERNAL_ERROR","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"503","description":"TEMPORARILY_UNAVAILABLE","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null}],"requestBodyParams":null}]},{"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","methods":[{"summary":"Get BSDs","description":"Fetch all Branded Short Domains","operationId":"getBSDs","tags":["BSDs"],"responses":{"200":{"description":"SUCCESS","content":{"application/json":{"schema":{"type":"object","properties":{"bsds":{"type":"array","items":{"type":"string"}}}}}}},"400":{"description":"BAD_REQUEST","content":{"application/json":{"schema":{"description":"BAD_REQUEST","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"403":{"description":"FORBIDDEN","headers":{"X-Ratelimit-Reason":{"schema":{"type":"string"},"description":"An explanation of the ratelimit received."}},"content":{"application/json":{"schema":{"description":"FORBIDDEN","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"500":{"description":"INTERNAL_ERROR","content":{"application/json":{"schema":{"description":"INTERNAL_ERROR","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"503":{"description":"TEMPORARILY_UNAVAILABLE","content":{"application/json":{"schema":{"description":"TEMPORARILY_UNAVAILABLE","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}}},"method":"get","path":"/bsds","requestSamples":[{"name":"cURL","syntaxLanguage":"bash","sample":"curl \\\n-H 'Authorization: Bearer {TOKEN}' \\\n-X GET \\\nhttps://api-ssl.bitly.com/v4/bsds","exampleName":"Default"},{"sample":"var fetch = require('node-fetch');\n\nfetch('https://api-ssl.bitly.com/v4/bsds', {\n headers: {\n 'Authorization': 'Bearer {TOKEN}'\n }\n});\n","name":"Node","syntaxLanguage":"javascript","exampleName":"Default"},{"sample":"fetch('https://api-ssl.bitly.com/v4/bsds', {\n headers: {\n 'Authorization': 'Bearer {TOKEN}'\n }\n});\n","name":"Browser","syntaxLanguage":"javascript","exampleName":"Default"},{"sample":"package main\n\nimport (\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\tclient := \u0026http.Client{}\n\treq, err := http.NewRequest(\"GET\", \"https://api-ssl.bitly.com/v4/bsds\", nil)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\treq.Header.Set(\"Authorization\", \"Bearer {TOKEN}\")\n\tresp, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tdefer resp.Body.Close()\n\tbodyText, err := ioutil.ReadAll(resp.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tfmt.Printf(\"%s\\n\", bodyText)\n}\n","name":"Go","syntaxLanguage":"go","exampleName":"Default"},{"sample":"import requests\n\nheaders = {\n 'Authorization': 'Bearer {TOKEN}',\n}\n\nresponse = requests.get('https://api-ssl.bitly.com/v4/bsds', headers=headers)\n","name":"Python","syntaxLanguage":"python","exampleName":"Default"}],"responseSamples":[{"statusCode":"200","description":"SUCCESS","json":"{\n \"bsds\": [\n \"string\"\n ]\n}","csv":null},{"statusCode":"400","description":"BAD_REQUEST","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"403","description":"FORBIDDEN","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"500","description":"INTERNAL_ERROR","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"503","description":"TEMPORARILY_UNAVAILABLE","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null}],"requestBodyParams":null}]},{"name":"Campaigns","description":"Bitly Campaigns are used to build and organize links and metrics for marketing campaigns.\n","methods":[{"summary":"Retrieve Campaigns","description":"Returns the campaigns for the current authenticated user.","operationId":"getCampaigns","tags":["Campaigns"],"parameters":[{"name":"group_guid","description":"A GUID for a Bitly group","in":"query","schema":{"type":"string"},"example":"Ba1bc23dE4F"}],"responses":{"200":{"description":"SUCCESS","content":{"application/json":{"schema":{"type":"object","properties":{"campaigns":{"type":"array","items":{"type":"object","allOf":[{"type":"object","properties":{"references":{"type":"object","additionalProperties":{"type":"string"}}}},{"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"}}}]}}}}}}},"400":{"description":"BAD_REQUEST","content":{"application/json":{"schema":{"description":"BAD_REQUEST","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"402":{"description":"UPGRADE_REQUIRED","content":{"application/json":{"schema":{"description":"UPGRADE_REQUIRED","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"403":{"description":"FORBIDDEN","content":{"application/json":{"schema":{"description":"FORBIDDEN","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"404":{"description":"NOT_FOUND","content":{"application/json":{"schema":{"description":"NOT_FOUND","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"500":{"description":"INTERNAL_ERROR","content":{"application/json":{"schema":{"description":"INTERNAL_ERROR","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"502":{"description":"BAD_GATEWAY","content":{"application/json":{"schema":{"description":"BAD_GATEWAY","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"503":{"description":"TEMPORARILY_UNAVAILABLE","content":{"application/json":{"schema":{"description":"TEMPORARILY_UNAVAILABLE","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}}},"method":"get","path":"/campaigns","requestSamples":[{"name":"cURL","syntaxLanguage":"bash","sample":"curl \\\n-H 'Authorization: Bearer {TOKEN}' \\\n-X GET \\\nhttps://api-ssl.bitly.com/v4/campaigns?group_guid=Ba1bc23dE4F","exampleName":"Default"},{"sample":"var fetch = require('node-fetch');\n\nfetch('https://api-ssl.bitly.com/v4/campaigns?group_guid=Ba1bc23dE4F', {\n headers: {\n 'Authorization': 'Bearer {TOKEN}'\n }\n});\n","name":"Node","syntaxLanguage":"javascript","exampleName":"Default"},{"sample":"fetch('https://api-ssl.bitly.com/v4/campaigns?group_guid=Ba1bc23dE4F', {\n headers: {\n 'Authorization': 'Bearer {TOKEN}'\n }\n});\n","name":"Browser","syntaxLanguage":"javascript","exampleName":"Default"},{"sample":"package main\n\nimport (\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\tclient := \u0026http.Client{}\n\treq, err := http.NewRequest(\"GET\", \"https://api-ssl.bitly.com/v4/campaigns?group_guid=Ba1bc23dE4F\", nil)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\treq.Header.Set(\"Authorization\", \"Bearer {TOKEN}\")\n\tresp, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tdefer resp.Body.Close()\n\tbodyText, err := ioutil.ReadAll(resp.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tfmt.Printf(\"%s\\n\", bodyText)\n}\n","name":"Go","syntaxLanguage":"go","exampleName":"Default"},{"sample":"import requests\n\nheaders = {\n 'Authorization': 'Bearer {TOKEN}',\n}\n\nparams = (\n ('group_guid', 'Ba1bc23dE4F'),\n)\n\nresponse = requests.get('https://api-ssl.bitly.com/v4/campaigns', headers=headers, params=params)\n\n#NB. Original query string below. It seems impossible to parse and\n#reproduce query strings 100% accurately so the one below is given\n#in case the reproduced version is not \"correct\".\n# response = requests.get('https://api-ssl.bitly.com/v4/campaigns?group_guid=Ba1bc23dE4F', headers=headers)\n","name":"Python","syntaxLanguage":"python","exampleName":"Default"}],"responseSamples":[{"statusCode":"200","description":"SUCCESS","json":"{\n \"campaigns\": [\n {\n \"references\": { \"any\" },\n \"guid\": \"string\",\n \"group_guid\": \"string\",\n \"created_by\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"created\": \"string\",\n \"modified\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"400","description":"BAD_REQUEST","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"402","description":"UPGRADE_REQUIRED","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"403","description":"FORBIDDEN","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"404","description":"NOT_FOUND","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"500","description":"INTERNAL_ERROR","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"502","description":"BAD_GATEWAY","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"503","description":"TEMPORARILY_UNAVAILABLE","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null}],"requestBodyParams":null},{"summary":"Create Campaign","description":"Creates a new campaign.","operationId":"createCampaign","tags":["Campaigns"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"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"]}}}}},"responses":{"200":{"description":"SUCCESS","content":{"application/json":{"schema":{"type":"object","allOf":[{"type":"object","properties":{"references":{"type":"object","additionalProperties":{"type":"string"}}}},{"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"}}}]}}}},"400":{"description":"BAD_REQUEST","content":{"application/json":{"schema":{"description":"BAD_REQUEST","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"402":{"description":"UPGRADE_REQUIRED","content":{"application/json":{"schema":{"description":"UPGRADE_REQUIRED","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"403":{"description":"FORBIDDEN","content":{"application/json":{"schema":{"description":"FORBIDDEN","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"404":{"description":"NOT_FOUND","content":{"application/json":{"schema":{"description":"NOT_FOUND","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"422":{"description":"UNPROCESSABLE_ENTITY","content":{"application/json":{"schema":{"description":"UNPROCESSABLE_ENTITY","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"429":{"description":"MONTHLY_LIMIT_EXCEEDED","content":{"application/json":{"schema":{"example":"API_USAGE_LIMIT_EXCEEDED","description":"MONTHLY_LIMIT_EXCEEDED","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"}}}]}}}},"500":{"description":"INTERNAL_ERROR","content":{"application/json":{"schema":{"description":"INTERNAL_ERROR","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"503":{"description":"TEMPORARILY_UNAVAILABLE","content":{"application/json":{"schema":{"description":"TEMPORARILY_UNAVAILABLE","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}}},"method":"post","path":"/campaigns","requestSamples":[{"name":"cURL","syntaxLanguage":"bash","sample":"curl \\\n-H 'Authorization: Bearer {TOKEN}' \\\n-H 'Content-Type: application/json' \\\n-X POST \\\n-d '{\n \"group_guid\": \"Ba1bc23dE4F\",\n \"name\": \"My Campaign\",\n \"description\": \"my new campaign\",\n \"channel_guids\": [\n \"Ha1bc2DefGj\",\n \"Ha1bc2DefGk\"\n ]\n}' \\\nhttps://api-ssl.bitly.com/v4/campaigns","exampleName":"Default"},{"sample":"var fetch = require('node-fetch');\n\nfetch('https://api-ssl.bitly.com/v4/campaigns', {\n method: 'POST',\n headers: {\n 'Authorization': 'Bearer {TOKEN}',\n 'Content-Type': 'application/json'\n },\n body: JSON.stringify({ \"group_guid\": \"Ba1bc23dE4F\", \"name\": \"My Campaign\", \"description\": \"my new campaign\", \"channel_guids\": [ \"Ha1bc2DefGj\", \"Ha1bc2DefGk\" ] })\n});\n","name":"Node","syntaxLanguage":"javascript","exampleName":"Default"},{"sample":"fetch('https://api-ssl.bitly.com/v4/campaigns', {\n method: 'POST',\n headers: {\n 'Authorization': 'Bearer {TOKEN}',\n 'Content-Type': 'application/json'\n },\n body: JSON.stringify({ \"group_guid\": \"Ba1bc23dE4F\", \"name\": \"My Campaign\", \"description\": \"my new campaign\", \"channel_guids\": [ \"Ha1bc2DefGj\", \"Ha1bc2DefGk\" ] })\n});\n","name":"Browser","syntaxLanguage":"javascript","exampleName":"Default"},{"sample":"package main\n\nimport (\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n\t\"strings\"\n)\n\nfunc main() {\n\tclient := \u0026http.Client{}\n\tvar data = strings.NewReader(`{ \"group_guid\": \"Ba1bc23dE4F\", \"name\": \"My Campaign\", \"description\": \"my new campaign\", \"channel_guids\": [ \"Ha1bc2DefGj\", \"Ha1bc2DefGk\" ] }`)\n\treq, err := http.NewRequest(\"POST\", \"https://api-ssl.bitly.com/v4/campaigns\", data)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\treq.Header.Set(\"Authorization\", \"Bearer {TOKEN}\")\n\treq.Header.Set(\"Content-Type\", \"application/json\")\n\tresp, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tdefer resp.Body.Close()\n\tbodyText, err := ioutil.ReadAll(resp.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tfmt.Printf(\"%s\\n\", bodyText)\n}\n","name":"Go","syntaxLanguage":"go","exampleName":"Default"},{"sample":"import requests\n\nheaders = {\n 'Authorization': 'Bearer {TOKEN}',\n 'Content-Type': 'application/json',\n}\n\ndata = '{ \"group_guid\": \"Ba1bc23dE4F\", \"name\": \"My Campaign\", \"description\": \"my new campaign\", \"channel_guids\": [ \"Ha1bc2DefGj\", \"Ha1bc2DefGk\" ] }'\n\nresponse = requests.post('https://api-ssl.bitly.com/v4/campaigns', headers=headers, data=data)\n","name":"Python","syntaxLanguage":"python","exampleName":"Default"}],"responseSamples":[{"statusCode":"200","description":"SUCCESS","json":"{\n \"references\": { \"any\" },\n \"guid\": \"string\",\n \"group_guid\": \"string\",\n \"created_by\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"created\": \"string\",\n \"modified\": \"string\"\n}","csv":null},{"statusCode":"400","description":"BAD_REQUEST","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"402","description":"UPGRADE_REQUIRED","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"403","description":"FORBIDDEN","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"404","description":"NOT_FOUND","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"422","description":"UNPROCESSABLE_ENTITY","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"429","description":"MONTHLY_LIMIT_EXCEEDED","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\"\n}","csv":null},{"statusCode":"500","description":"INTERNAL_ERROR","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"503","description":"TEMPORARILY_UNAVAILABLE","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null}],"requestBodyParams":[{"name":"group_guid","description":null,"required":null,"schema":{"type":"string","default":null,"enum":null},"items":null,"properties":null},{"name":"name","description":null,"required":null,"schema":{"type":"string","default":null,"enum":null},"items":null,"properties":null},{"name":"description","description":null,"required":null,"schema":{"type":"string","default":null,"enum":null},"items":null,"properties":null},{"name":"channel_guids","description":null,"required":null,"schema":{"type":"array","default":null,"enum":null},"items":{"type":"string"},"properties":null}]},{"summary":"Retrieve a Campaign","description":"Returns details for a campaign.","operationId":"getCampaign","tags":["Campaigns"],"parameters":[{"name":"campaign_guid","description":"A GUID for a Bitly campaign","in":"path","required":true,"schema":{"type":"string"},"example":"Ca1bcd2EFGh"}],"responses":{"200":{"description":"SUCCESS","content":{"application/json":{"schema":{"type":"object","allOf":[{"type":"object","properties":{"references":{"type":"object","additionalProperties":{"type":"string"}}}},{"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"}}}]}}}},"402":{"description":"UPGRADE_REQUIRED","content":{"application/json":{"schema":{"description":"UPGRADE_REQUIRED","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"403":{"description":"FORBIDDEN","content":{"application/json":{"schema":{"description":"FORBIDDEN","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"404":{"description":"NOT_FOUND","content":{"application/json":{"schema":{"description":"NOT_FOUND","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"429":{"description":"MONTHLY_LIMIT_EXCEEDED","content":{"application/json":{"schema":{"example":"API_USAGE_LIMIT_EXCEEDED","description":"MONTHLY_LIMIT_EXCEEDED","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"}}}]}}}},"500":{"description":"INTERNAL_ERROR","content":{"application/json":{"schema":{"description":"INTERNAL_ERROR","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"503":{"description":"TEMPORARILY_UNAVAILABLE","content":{"application/json":{"schema":{"description":"TEMPORARILY_UNAVAILABLE","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}}},"method":"get","path":"/campaigns/{campaign_guid}","requestSamples":[{"name":"cURL","syntaxLanguage":"bash","sample":"curl \\\n-H 'Authorization: Bearer {TOKEN}' \\\n-X GET \\\nhttps://api-ssl.bitly.com/v4/campaigns/Ca1bcd2EFGh","exampleName":"Default"},{"sample":"var fetch = require('node-fetch');\n\nfetch('https://api-ssl.bitly.com/v4/campaigns/Ca1bcd2EFGh', {\n headers: {\n 'Authorization': 'Bearer {TOKEN}'\n }\n});\n","name":"Node","syntaxLanguage":"javascript","exampleName":"Default"},{"sample":"fetch('https://api-ssl.bitly.com/v4/campaigns/Ca1bcd2EFGh', {\n headers: {\n 'Authorization': 'Bearer {TOKEN}'\n }\n});\n","name":"Browser","syntaxLanguage":"javascript","exampleName":"Default"},{"sample":"package main\n\nimport (\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\tclient := \u0026http.Client{}\n\treq, err := http.NewRequest(\"GET\", \"https://api-ssl.bitly.com/v4/campaigns/Ca1bcd2EFGh\", nil)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\treq.Header.Set(\"Authorization\", \"Bearer {TOKEN}\")\n\tresp, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tdefer resp.Body.Close()\n\tbodyText, err := ioutil.ReadAll(resp.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tfmt.Printf(\"%s\\n\", bodyText)\n}\n","name":"Go","syntaxLanguage":"go","exampleName":"Default"},{"sample":"import requests\n\nheaders = {\n 'Authorization': 'Bearer {TOKEN}',\n}\n\nresponse = requests.get('https://api-ssl.bitly.com/v4/campaigns/Ca1bcd2EFGh', headers=headers)\n","name":"Python","syntaxLanguage":"python","exampleName":"Default"}],"responseSamples":[{"statusCode":"200","description":"SUCCESS","json":"{\n \"references\": { \"any\" },\n \"guid\": \"string\",\n \"group_guid\": \"string\",\n \"created_by\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"created\": \"string\",\n \"modified\": \"string\"\n}","csv":null},{"statusCode":"402","description":"UPGRADE_REQUIRED","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"403","description":"FORBIDDEN","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"404","description":"NOT_FOUND","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"429","description":"MONTHLY_LIMIT_EXCEEDED","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\"\n}","csv":null},{"statusCode":"500","description":"INTERNAL_ERROR","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"503","description":"TEMPORARILY_UNAVAILABLE","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null}],"requestBodyParams":null},{"summary":"Update Campaign","description":"Updates a campaign's details.","operationId":"updateCampaign","tags":["Campaigns"],"parameters":[{"name":"campaign_guid","description":"A GUID for a Bitly campaign","in":"path","required":true,"schema":{"type":"string"},"example":"Ca1bcd2EFGh"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"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"]}}}}},"responses":{"200":{"description":"SUCCESS","content":{"application/json":{"schema":{"type":"object","allOf":[{"type":"object","properties":{"references":{"type":"object","additionalProperties":{"type":"string"}}}},{"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"}}}]}}}},"400":{"description":"BAD_REQUEST","content":{"application/json":{"schema":{"description":"BAD_REQUEST","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"402":{"description":"UPGRADE_REQUIRED","content":{"application/json":{"schema":{"description":"UPGRADE_REQUIRED","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"403":{"description":"FORBIDDEN","content":{"application/json":{"schema":{"description":"FORBIDDEN","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"404":{"description":"NOT_FOUND","content":{"application/json":{"schema":{"description":"NOT_FOUND","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"422":{"description":"UNPROCESSABLE_ENTITY","content":{"application/json":{"schema":{"description":"UNPROCESSABLE_ENTITY","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"429":{"description":"MONTHLY_LIMIT_EXCEEDED","content":{"application/json":{"schema":{"example":"API_USAGE_LIMIT_EXCEEDED","description":"MONTHLY_LIMIT_EXCEEDED","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"}}}]}}}},"500":{"description":"INTERNAL_ERROR","content":{"application/json":{"schema":{"description":"INTERNAL_ERROR","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"503":{"description":"TEMPORARILY_UNAVAILABLE","content":{"application/json":{"schema":{"description":"TEMPORARILY_UNAVAILABLE","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}}},"method":"patch","path":"/campaigns/{campaign_guid}","requestSamples":[{"name":"cURL","syntaxLanguage":"bash","sample":"curl \\\n-H 'Authorization: Bearer {TOKEN}' \\\n-H 'Content-Type: application/json' \\\n-X PATCH \\\n-d '{\n \"group_guid\": \"Ba1bc23dE4F\",\n \"name\": \"My Campaign\",\n \"description\": \"my new campaign\",\n \"channel_guids\": [\n \"Ha1bc2DefGj\",\n \"Ha1bc2DefGk\"\n ]\n}' \\\nhttps://api-ssl.bitly.com/v4/campaigns/Ca1bcd2EFGh","exampleName":"Default"},{"sample":"var fetch = require('node-fetch');\n\nfetch('https://api-ssl.bitly.com/v4/campaigns/Ca1bcd2EFGh', {\n method: 'PATCH',\n headers: {\n 'Authorization': 'Bearer {TOKEN}',\n 'Content-Type': 'application/json'\n },\n body: JSON.stringify({ \"group_guid\": \"Ba1bc23dE4F\", \"name\": \"My Campaign\", \"description\": \"my new campaign\", \"channel_guids\": [ \"Ha1bc2DefGj\", \"Ha1bc2DefGk\" ] })\n});\n","name":"Node","syntaxLanguage":"javascript","exampleName":"Default"},{"sample":"fetch('https://api-ssl.bitly.com/v4/campaigns/Ca1bcd2EFGh', {\n method: 'PATCH',\n headers: {\n 'Authorization': 'Bearer {TOKEN}',\n 'Content-Type': 'application/json'\n },\n body: JSON.stringify({ \"group_guid\": \"Ba1bc23dE4F\", \"name\": \"My Campaign\", \"description\": \"my new campaign\", \"channel_guids\": [ \"Ha1bc2DefGj\", \"Ha1bc2DefGk\" ] })\n});\n","name":"Browser","syntaxLanguage":"javascript","exampleName":"Default"},{"sample":"package main\n\nimport (\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n\t\"strings\"\n)\n\nfunc main() {\n\tclient := \u0026http.Client{}\n\tvar data = strings.NewReader(`{ \"group_guid\": \"Ba1bc23dE4F\", \"name\": \"My Campaign\", \"description\": \"my new campaign\", \"channel_guids\": [ \"Ha1bc2DefGj\", \"Ha1bc2DefGk\" ] }`)\n\treq, err := http.NewRequest(\"PATCH\", \"https://api-ssl.bitly.com/v4/campaigns/Ca1bcd2EFGh\", data)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\treq.Header.Set(\"Authorization\", \"Bearer {TOKEN}\")\n\treq.Header.Set(\"Content-Type\", \"application/json\")\n\tresp, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tdefer resp.Body.Close()\n\tbodyText, err := ioutil.ReadAll(resp.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tfmt.Printf(\"%s\\n\", bodyText)\n}\n","name":"Go","syntaxLanguage":"go","exampleName":"Default"},{"sample":"import requests\n\nheaders = {\n 'Authorization': 'Bearer {TOKEN}',\n 'Content-Type': 'application/json',\n}\n\ndata = '{ \"group_guid\": \"Ba1bc23dE4F\", \"name\": \"My Campaign\", \"description\": \"my new campaign\", \"channel_guids\": [ \"Ha1bc2DefGj\", \"Ha1bc2DefGk\" ] }'\n\nresponse = requests.patch('https://api-ssl.bitly.com/v4/campaigns/Ca1bcd2EFGh', headers=headers, data=data)\n","name":"Python","syntaxLanguage":"python","exampleName":"Default"}],"responseSamples":[{"statusCode":"200","description":"SUCCESS","json":"{\n \"references\": { \"any\" },\n \"guid\": \"string\",\n \"group_guid\": \"string\",\n \"created_by\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"created\": \"string\",\n \"modified\": \"string\"\n}","csv":null},{"statusCode":"400","description":"BAD_REQUEST","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"402","description":"UPGRADE_REQUIRED","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"403","description":"FORBIDDEN","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"404","description":"NOT_FOUND","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"422","description":"UNPROCESSABLE_ENTITY","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"429","description":"MONTHLY_LIMIT_EXCEEDED","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\"\n}","csv":null},{"statusCode":"500","description":"INTERNAL_ERROR","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"503","description":"TEMPORARILY_UNAVAILABLE","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null}],"requestBodyParams":[{"name":"group_guid","description":null,"required":null,"schema":{"type":"string","default":null,"enum":null},"items":null,"properties":null},{"name":"name","description":null,"required":null,"schema":{"type":"string","default":null,"enum":null},"items":null,"properties":null},{"name":"description","description":null,"required":null,"schema":{"type":"string","default":null,"enum":null},"items":null,"properties":null},{"name":"channel_guids","description":null,"required":null,"schema":{"type":"array","default":null,"enum":null},"items":{"type":"string"},"properties":null}]},{"summary":"Retrieve Channels","description":"Returns the channels available to a user.","operationId":"getChannels","tags":["Campaigns"],"parameters":[{"name":"group_guid","description":"A GUID for a Bitly group","in":"query","schema":{"type":"string"},"example":"Ba1bc23dE4F"},{"name":"campaign_guid","description":"A GUID for a Bitly campaign","in":"query","schema":{"type":"string"},"example":"Ca1bcd2EFGh"}],"responses":{"200":{"description":"SUCCESS","content":{"application/json":{"schema":{"type":"object","properties":{"channels":{"type":"array","items":{"type":"object","allOf":[{"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"}}},{"type":"object","properties":{"references":{"type":"object","additionalProperties":{"type":"string"}}}}]}}}}}}},"402":{"description":"UPGRADE_REQUIRED","content":{"application/json":{"schema":{"description":"UPGRADE_REQUIRED","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"403":{"description":"FORBIDDEN","content":{"application/json":{"schema":{"description":"FORBIDDEN","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"404":{"description":"NOT_FOUND","content":{"application/json":{"schema":{"description":"NOT_FOUND","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"500":{"description":"INTERNAL_ERROR","content":{"application/json":{"schema":{"description":"INTERNAL_ERROR","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"503":{"description":"TEMPORARILY_UNAVAILABLE","content":{"application/json":{"schema":{"description":"TEMPORARILY_UNAVAILABLE","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}}},"method":"get","path":"/channels","requestSamples":[{"name":"cURL","syntaxLanguage":"bash","sample":"curl \\\n-H 'Authorization: Bearer {TOKEN}' \\\n-X GET \\\nhttps://api-ssl.bitly.com/v4/channels?group_guid=Ba1bc23dE4F\u0026campaign_guid=Ca1bcd2EFGh","exampleName":"Default"},{"sample":"var fetch = require('node-fetch');\n\nfetch('https://api-ssl.bitly.com/v4/channels?group_guid=Ba1bc23dE4F\u0026campaign_guid=Ca1bcd2EFGh', {\n headers: {\n 'Authorization': 'Bearer {TOKEN}'\n }\n});\n","name":"Node","syntaxLanguage":"javascript","exampleName":"Default"},{"sample":"fetch('https://api-ssl.bitly.com/v4/channels?group_guid=Ba1bc23dE4F\u0026campaign_guid=Ca1bcd2EFGh', {\n headers: {\n 'Authorization': 'Bearer {TOKEN}'\n }\n});\n","name":"Browser","syntaxLanguage":"javascript","exampleName":"Default"},{"sample":"package main\n\nimport (\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\tclient := \u0026http.Client{}\n\treq, err := http.NewRequest(\"GET\", \"https://api-ssl.bitly.com/v4/channels?group_guid=Ba1bc23dE4F\u0026campaign_guid=Ca1bcd2EFGh\", nil)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\treq.Header.Set(\"Authorization\", \"Bearer {TOKEN}\")\n\tresp, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tdefer resp.Body.Close()\n\tbodyText, err := ioutil.ReadAll(resp.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tfmt.Printf(\"%s\\n\", bodyText)\n}\n","name":"Go","syntaxLanguage":"go","exampleName":"Default"},{"sample":"import requests\n\nheaders = {\n 'Authorization': 'Bearer {TOKEN}',\n}\n\nparams = (\n ('group_guid', 'Ba1bc23dE4F'),\n ('campaign_guid', 'Ca1bcd2EFGh'),\n)\n\nresponse = requests.get('https://api-ssl.bitly.com/v4/channels', headers=headers, params=params)\n\n#NB. Original query string below. It seems impossible to parse and\n#reproduce query strings 100% accurately so the one below is given\n#in case the reproduced version is not \"correct\".\n# response = requests.get('https://api-ssl.bitly.com/v4/channels?group_guid=Ba1bc23dE4F\u0026campaign_guid=Ca1bcd2EFGh', headers=headers)\n","name":"Python","syntaxLanguage":"python","exampleName":"Default"}],"responseSamples":[{"statusCode":"200","description":"SUCCESS","json":"{\n \"channels\": [\n {\n \"name\": \"string\",\n \"guid\": \"string\",\n \"created\": \"string\",\n \"modified\": \"string\",\n \"group_guid\": \"string\",\n \"references\": { \"any\" }\n }\n ]\n}","csv":null},{"statusCode":"402","description":"UPGRADE_REQUIRED","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"403","description":"FORBIDDEN","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"404","description":"NOT_FOUND","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"500","description":"INTERNAL_ERROR","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"503","description":"TEMPORARILY_UNAVAILABLE","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null}],"requestBodyParams":null},{"summary":"Create Channel","description":"Creates a new channel.","operationId":"createChannel","tags":["Campaigns"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"example":{"name":"My Channel","guid":"Ha1bc2DefGh","group_guid":"Ba1bc23dE4F","bitlinks":[{"campaign_guid":"Ca1bcd2EFGh","bitlink_id":"bit.ly/1234abcd"}]},"type":"object","allOf":[{"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"}}},{"properties":{"bitlinks":{"type":"array","items":{"type":"object","properties":{"campaign_guid":{"type":"string"},"bitlink_id":{"type":"string"}}}}}}]}}}},"responses":{"200":{"description":"SUCCESS","content":{"application/json":{"schema":{"type":"object","allOf":[{"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"}}},{"type":"object","properties":{"references":{"type":"object","additionalProperties":{"type":"string"}}}}]}}}},"400":{"description":"BAD_REQUEST","content":{"application/json":{"schema":{"description":"BAD_REQUEST","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"402":{"description":"UPGRADE_REQUIRED","content":{"application/json":{"schema":{"description":"UPGRADE_REQUIRED","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"403":{"description":"FORBIDDEN","content":{"application/json":{"schema":{"description":"FORBIDDEN","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"404":{"description":"NOT_FOUND","content":{"application/json":{"schema":{"description":"NOT_FOUND","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"422":{"description":"UNPROCESSABLE_ENTITY","content":{"application/json":{"schema":{"description":"UNPROCESSABLE_ENTITY","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"429":{"description":"MONTHLY_LIMIT_EXCEEDED","content":{"application/json":{"schema":{"example":"API_USAGE_LIMIT_EXCEEDED","description":"MONTHLY_LIMIT_EXCEEDED","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"}}}]}}}},"500":{"description":"INTERNAL_ERROR","content":{"application/json":{"schema":{"description":"INTERNAL_ERROR","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"503":{"description":"TEMPORARILY_UNAVAILABLE","content":{"application/json":{"schema":{"description":"TEMPORARILY_UNAVAILABLE","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}}},"method":"post","path":"/channels","requestSamples":[{"name":"cURL","syntaxLanguage":"bash","sample":"curl \\\n-H 'Authorization: Bearer {TOKEN}' \\\n-H 'Content-Type: application/json' \\\n-X POST \\\n-d '{\n \"name\": \"My Channel\",\n \"guid\": \"Ha1bc2DefGh\",\n \"group_guid\": \"Ba1bc23dE4F\",\n \"bitlinks\": [\n {\n \"campaign_guid\": \"Ca1bcd2EFGh\",\n \"bitlink_id\": \"bit.ly/1234abcd\"\n }\n ]\n}' \\\nhttps://api-ssl.bitly.com/v4/channels","exampleName":"Default"},{"sample":"var fetch = require('node-fetch');\n\nfetch('https://api-ssl.bitly.com/v4/channels', {\n method: 'POST',\n headers: {\n 'Authorization': 'Bearer {TOKEN}',\n 'Content-Type': 'application/json'\n },\n body: JSON.stringify({ \"name\": \"My Channel\", \"guid\": \"Ha1bc2DefGh\", \"group_guid\": \"Ba1bc23dE4F\", \"bitlinks\": [ { \"campaign_guid\": \"Ca1bcd2EFGh\", \"bitlink_id\": \"bit.ly/1234abcd\" } ] })\n});\n","name":"Node","syntaxLanguage":"javascript","exampleName":"Default"},{"sample":"fetch('https://api-ssl.bitly.com/v4/channels', {\n method: 'POST',\n headers: {\n 'Authorization': 'Bearer {TOKEN}',\n 'Content-Type': 'application/json'\n },\n body: JSON.stringify({ \"name\": \"My Channel\", \"guid\": \"Ha1bc2DefGh\", \"group_guid\": \"Ba1bc23dE4F\", \"bitlinks\": [ { \"campaign_guid\": \"Ca1bcd2EFGh\", \"bitlink_id\": \"bit.ly/1234abcd\" } ] })\n});\n","name":"Browser","syntaxLanguage":"javascript","exampleName":"Default"},{"sample":"package main\n\nimport (\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n\t\"strings\"\n)\n\nfunc main() {\n\tclient := \u0026http.Client{}\n\tvar data = strings.NewReader(`{ \"name\": \"My Channel\", \"guid\": \"Ha1bc2DefGh\", \"group_guid\": \"Ba1bc23dE4F\", \"bitlinks\": [ { \"campaign_guid\": \"Ca1bcd2EFGh\", \"bitlink_id\": \"bit.ly/1234abcd\" } ] }`)\n\treq, err := http.NewRequest(\"POST\", \"https://api-ssl.bitly.com/v4/channels\", data)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\treq.Header.Set(\"Authorization\", \"Bearer {TOKEN}\")\n\treq.Header.Set(\"Content-Type\", \"application/json\")\n\tresp, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tdefer resp.Body.Close()\n\tbodyText, err := ioutil.ReadAll(resp.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tfmt.Printf(\"%s\\n\", bodyText)\n}\n","name":"Go","syntaxLanguage":"go","exampleName":"Default"},{"sample":"import requests\n\nheaders = {\n 'Authorization': 'Bearer {TOKEN}',\n 'Content-Type': 'application/json',\n}\n\ndata = '{ \"name\": \"My Channel\", \"guid\": \"Ha1bc2DefGh\", \"group_guid\": \"Ba1bc23dE4F\", \"bitlinks\": [ { \"campaign_guid\": \"Ca1bcd2EFGh\", \"bitlink_id\": \"bit.ly/1234abcd\" } ] }'\n\nresponse = requests.post('https://api-ssl.bitly.com/v4/channels', headers=headers, data=data)\n","name":"Python","syntaxLanguage":"python","exampleName":"Default"}],"responseSamples":[{"statusCode":"200","description":"SUCCESS","json":"{\n \"name\": \"string\",\n \"guid\": \"string\",\n \"created\": \"string\",\n \"modified\": \"string\",\n \"group_guid\": \"string\",\n \"references\": { \"any\" }\n}","csv":null},{"statusCode":"400","description":"BAD_REQUEST","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"402","description":"UPGRADE_REQUIRED","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"403","description":"FORBIDDEN","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"404","description":"NOT_FOUND","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"422","description":"UNPROCESSABLE_ENTITY","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"429","description":"MONTHLY_LIMIT_EXCEEDED","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\"\n}","csv":null},{"statusCode":"500","description":"INTERNAL_ERROR","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"503","description":"TEMPORARILY_UNAVAILABLE","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null}],"requestBodyParams":[{"name":"name","description":null,"required":null,"schema":{"type":"string","default":null,"enum":null},"items":null,"properties":null},{"name":"guid","description":null,"required":null,"schema":{"type":"string","default":null,"enum":null},"items":null,"properties":null},{"name":"created","description":"ISO TIMESTAMP","required":null,"schema":{"type":"string","default":null,"enum":null},"items":null,"properties":null},{"name":"modified","description":"ISO_TIMESTAMP","required":null,"schema":{"type":"string","default":null,"enum":null},"items":null,"properties":null},{"name":"group_guid","description":null,"required":null,"schema":{"type":"string","default":null,"enum":null},"items":null,"properties":null},{"name":"bitlinks","description":null,"required":null,"schema":{"type":"array","default":null,"enum":null},"items":{"type":"object","properties":{"campaign_guid":{"type":"string"},"bitlink_id":{"type":"string"}}},"properties":null}]},{"summary":"Get a Channel","description":"Returns a channel's details.","operationId":"getChannel","tags":["Campaigns"],"parameters":[{"name":"channel_guid","description":"A GUID for a Bitly Channel","in":"path","required":true,"schema":{"type":"string"},"example":"Ha1bc2DefGh"}],"responses":{"200":{"description":"SUCCESS","content":{"application/json":{"schema":{"type":"object","allOf":[{"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"}}},{"type":"object","properties":{"references":{"type":"object","additionalProperties":{"type":"string"}}}}]}}}},"402":{"description":"UPGRADE_REQUIRED","content":{"application/json":{"schema":{"description":"UPGRADE_REQUIRED","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"403":{"description":"FORBIDDEN","content":{"application/json":{"schema":{"description":"FORBIDDEN","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"404":{"description":"NOT_FOUND","content":{"application/json":{"schema":{"description":"NOT_FOUND","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"429":{"description":"MONTHLY_LIMIT_EXCEEDED","content":{"application/json":{"schema":{"example":"API_USAGE_LIMIT_EXCEEDED","description":"MONTHLY_LIMIT_EXCEEDED","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"}}}]}}}},"500":{"description":"INTERNAL_ERROR","content":{"application/json":{"schema":{"description":"INTERNAL_ERROR","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"503":{"description":"TEMPORARILY_UNAVAILABLE","content":{"application/json":{"schema":{"description":"TEMPORARILY_UNAVAILABLE","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}}},"method":"get","path":"/channels/{channel_guid}","requestSamples":[{"name":"cURL","syntaxLanguage":"bash","sample":"curl \\\n-H 'Authorization: Bearer {TOKEN}' \\\n-X GET \\\nhttps://api-ssl.bitly.com/v4/channels/Ha1bc2DefGh","exampleName":"Default"},{"sample":"var fetch = require('node-fetch');\n\nfetch('https://api-ssl.bitly.com/v4/channels/Ha1bc2DefGh', {\n headers: {\n 'Authorization': 'Bearer {TOKEN}'\n }\n});\n","name":"Node","syntaxLanguage":"javascript","exampleName":"Default"},{"sample":"fetch('https://api-ssl.bitly.com/v4/channels/Ha1bc2DefGh', {\n headers: {\n 'Authorization': 'Bearer {TOKEN}'\n }\n});\n","name":"Browser","syntaxLanguage":"javascript","exampleName":"Default"},{"sample":"package main\n\nimport (\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\tclient := \u0026http.Client{}\n\treq, err := http.NewRequest(\"GET\", \"https://api-ssl.bitly.com/v4/channels/Ha1bc2DefGh\", nil)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\treq.Header.Set(\"Authorization\", \"Bearer {TOKEN}\")\n\tresp, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tdefer resp.Body.Close()\n\tbodyText, err := ioutil.ReadAll(resp.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tfmt.Printf(\"%s\\n\", bodyText)\n}\n","name":"Go","syntaxLanguage":"go","exampleName":"Default"},{"sample":"import requests\n\nheaders = {\n 'Authorization': 'Bearer {TOKEN}',\n}\n\nresponse = requests.get('https://api-ssl.bitly.com/v4/channels/Ha1bc2DefGh', headers=headers)\n","name":"Python","syntaxLanguage":"python","exampleName":"Default"}],"responseSamples":[{"statusCode":"200","description":"SUCCESS","json":"{\n \"name\": \"string\",\n \"guid\": \"string\",\n \"created\": \"string\",\n \"modified\": \"string\",\n \"group_guid\": \"string\",\n \"references\": { \"any\" }\n}","csv":null},{"statusCode":"402","description":"UPGRADE_REQUIRED","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"403","description":"FORBIDDEN","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"404","description":"NOT_FOUND","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"429","description":"MONTHLY_LIMIT_EXCEEDED","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\"\n}","csv":null},{"statusCode":"500","description":"INTERNAL_ERROR","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"503","description":"TEMPORARILY_UNAVAILABLE","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null}],"requestBodyParams":null},{"summary":"Update a Channel","description":"Updates an existing channel.","operationId":"updateChannel","tags":["Campaigns"],"parameters":[{"name":"channel_guid","description":"A GUID for a Bitly Channel","in":"path","required":true,"schema":{"type":"string"},"example":"Ha1bc2DefGh"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"example":{"name":"My Channel","guid":"Ha1bc2DefGh","group_guid":"Ba1bc23dE4F","bitlinks":[{"campaign_guid":"Ca1bcd2EFGh","bitlink_id":"bit.ly/1234abcd"}]},"type":"object","allOf":[{"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"}}},{"properties":{"bitlinks":{"type":"array","items":{"type":"object","properties":{"campaign_guid":{"type":"string"},"bitlink_id":{"type":"string"}}}}}}]}}}},"responses":{"200":{"description":"SUCCESS","content":{"application/json":{"schema":{"type":"object","allOf":[{"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"}}},{"type":"object","properties":{"references":{"type":"object","additionalProperties":{"type":"string"}}}}]}}}},"400":{"description":"BAD_REQUEST","content":{"application/json":{"schema":{"description":"BAD_REQUEST","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"402":{"description":"UPGRADE_REQUIRED","content":{"application/json":{"schema":{"description":"UPGRADE_REQUIRED","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"403":{"description":"FORBIDDEN","content":{"application/json":{"schema":{"description":"FORBIDDEN","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"404":{"description":"NOT_FOUND","content":{"application/json":{"schema":{"description":"NOT_FOUND","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"422":{"description":"UNPROCESSABLE_ENTITY","content":{"application/json":{"schema":{"description":"UNPROCESSABLE_ENTITY","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"429":{"description":"MONTHLY_LIMIT_EXCEEDED","content":{"application/json":{"schema":{"example":"API_USAGE_LIMIT_EXCEEDED","description":"MONTHLY_LIMIT_EXCEEDED","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"}}}]}}}},"500":{"description":"INTERNAL_ERROR","content":{"application/json":{"schema":{"description":"INTERNAL_ERROR","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"503":{"description":"TEMPORARILY_UNAVAILABLE","content":{"application/json":{"schema":{"description":"TEMPORARILY_UNAVAILABLE","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}}},"method":"patch","path":"/channels/{channel_guid}","requestSamples":[{"name":"cURL","syntaxLanguage":"bash","sample":"curl \\\n-H 'Authorization: Bearer {TOKEN}' \\\n-H 'Content-Type: application/json' \\\n-X PATCH \\\n-d '{\n \"name\": \"My Channel\",\n \"guid\": \"Ha1bc2DefGh\",\n \"group_guid\": \"Ba1bc23dE4F\",\n \"bitlinks\": [\n {\n \"campaign_guid\": \"Ca1bcd2EFGh\",\n \"bitlink_id\": \"bit.ly/1234abcd\"\n }\n ]\n}' \\\nhttps://api-ssl.bitly.com/v4/channels/Ha1bc2DefGh","exampleName":"Default"},{"sample":"var fetch = require('node-fetch');\n\nfetch('https://api-ssl.bitly.com/v4/channels/Ha1bc2DefGh', {\n method: 'PATCH',\n headers: {\n 'Authorization': 'Bearer {TOKEN}',\n 'Content-Type': 'application/json'\n },\n body: JSON.stringify({ \"name\": \"My Channel\", \"guid\": \"Ha1bc2DefGh\", \"group_guid\": \"Ba1bc23dE4F\", \"bitlinks\": [ { \"campaign_guid\": \"Ca1bcd2EFGh\", \"bitlink_id\": \"bit.ly/1234abcd\" } ] })\n});\n","name":"Node","syntaxLanguage":"javascript","exampleName":"Default"},{"sample":"fetch('https://api-ssl.bitly.com/v4/channels/Ha1bc2DefGh', {\n method: 'PATCH',\n headers: {\n 'Authorization': 'Bearer {TOKEN}',\n 'Content-Type': 'application/json'\n },\n body: JSON.stringify({ \"name\": \"My Channel\", \"guid\": \"Ha1bc2DefGh\", \"group_guid\": \"Ba1bc23dE4F\", \"bitlinks\": [ { \"campaign_guid\": \"Ca1bcd2EFGh\", \"bitlink_id\": \"bit.ly/1234abcd\" } ] })\n});\n","name":"Browser","syntaxLanguage":"javascript","exampleName":"Default"},{"sample":"package main\n\nimport (\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n\t\"strings\"\n)\n\nfunc main() {\n\tclient := \u0026http.Client{}\n\tvar data = strings.NewReader(`{ \"name\": \"My Channel\", \"guid\": \"Ha1bc2DefGh\", \"group_guid\": \"Ba1bc23dE4F\", \"bitlinks\": [ { \"campaign_guid\": \"Ca1bcd2EFGh\", \"bitlink_id\": \"bit.ly/1234abcd\" } ] }`)\n\treq, err := http.NewRequest(\"PATCH\", \"https://api-ssl.bitly.com/v4/channels/Ha1bc2DefGh\", data)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\treq.Header.Set(\"Authorization\", \"Bearer {TOKEN}\")\n\treq.Header.Set(\"Content-Type\", \"application/json\")\n\tresp, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tdefer resp.Body.Close()\n\tbodyText, err := ioutil.ReadAll(resp.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tfmt.Printf(\"%s\\n\", bodyText)\n}\n","name":"Go","syntaxLanguage":"go","exampleName":"Default"},{"sample":"import requests\n\nheaders = {\n 'Authorization': 'Bearer {TOKEN}',\n 'Content-Type': 'application/json',\n}\n\ndata = '{ \"name\": \"My Channel\", \"guid\": \"Ha1bc2DefGh\", \"group_guid\": \"Ba1bc23dE4F\", \"bitlinks\": [ { \"campaign_guid\": \"Ca1bcd2EFGh\", \"bitlink_id\": \"bit.ly/1234abcd\" } ] }'\n\nresponse = requests.patch('https://api-ssl.bitly.com/v4/channels/Ha1bc2DefGh', headers=headers, data=data)\n","name":"Python","syntaxLanguage":"python","exampleName":"Default"}],"responseSamples":[{"statusCode":"200","description":"SUCCESS","json":"{\n \"name\": \"string\",\n \"guid\": \"string\",\n \"created\": \"string\",\n \"modified\": \"string\",\n \"group_guid\": \"string\",\n \"references\": { \"any\" }\n}","csv":null},{"statusCode":"400","description":"BAD_REQUEST","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"402","description":"UPGRADE_REQUIRED","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"403","description":"FORBIDDEN","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"404","description":"NOT_FOUND","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"422","description":"UNPROCESSABLE_ENTITY","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"429","description":"MONTHLY_LIMIT_EXCEEDED","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\"\n}","csv":null},{"statusCode":"500","description":"INTERNAL_ERROR","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"503","description":"TEMPORARILY_UNAVAILABLE","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null}],"requestBodyParams":[{"name":"name","description":null,"required":null,"schema":{"type":"string","default":null,"enum":null},"items":null,"properties":null},{"name":"guid","description":null,"required":null,"schema":{"type":"string","default":null,"enum":null},"items":null,"properties":null},{"name":"created","description":"ISO TIMESTAMP","required":null,"schema":{"type":"string","default":null,"enum":null},"items":null,"properties":null},{"name":"modified","description":"ISO_TIMESTAMP","required":null,"schema":{"type":"string","default":null,"enum":null},"items":null,"properties":null},{"name":"group_guid","description":null,"required":null,"schema":{"type":"string","default":null,"enum":null},"items":null,"properties":null},{"name":"bitlinks","description":null,"required":null,"schema":{"type":"array","default":null,"enum":null},"items":{"type":"object","properties":{"campaign_guid":{"type":"string"},"bitlink_id":{"type":"string"}}},"properties":null}]}]},{"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","methods":[{"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","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"custom_bitlink":{"type":"string"},"bitlink_id":{"type":"string"}},"example":{"custom_bitlink":"chauncey.ly/documentation","bitlink_id":"chauncey.ly/1234abcd"}}}}},"responses":{"200":{"description":"SUCCESS","content":{"application/json":{"schema":{"type":"object","properties":{"custom_bitlink":{"type":"string"},"bitlink":{"type":"object","allOf":[{"type":"object","properties":{"references":{"type":"object","additionalProperties":{"type":"string"}}}},{"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"}},"qr_code_ids":{"type":"array","items":{"type":"string"},"description":"a list of qr code ids that are associated with this bitlink"},"deeplinks":{"type":"array","items":{"type":"object","properties":{"guid":{"type":"string"},"bitlink":{"type":"string"},"app_uri_path":{"type":"string"},"install_url":{"type":"string"},"app_guid":{"type":"string"},"os":{"type":"string","enum":["ios","android"]},"install_type":{"type":"string","enum":["no_install","auto_install","promote_install"]},"created":{"type":"string","description":"ISO timestamp"},"modified":{"type":"string","description":"ISO timestamp"},"brand_guid":{"type":"string"}}}},"is_deleted":{"type":"boolean"},"campaign_ids":{"type":"array","items":{"type":"string"}}}}]},"bitlink_history":{"type":"array","items":{"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"}}}}}}}}},"400":{"description":"BAD_REQUEST","content":{"application/json":{"schema":{"description":"BAD_REQUEST","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"402":{"description":"UPGRADE_REQUIRED","content":{"application/json":{"schema":{"description":"UPGRADE_REQUIRED","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"403":{"description":"FORBIDDEN","content":{"application/json":{"schema":{"description":"FORBIDDEN","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"404":{"description":"NOT_FOUND","content":{"application/json":{"schema":{"description":"NOT_FOUND","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}}}},"422":{"description":"UNPROCESSABLE_ENTITY","content":{"application/json":{"schema":{"description":"UNPROCESSABLE_ENTITY","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"429":{"description":"MONTHLY_LIMIT_EXCEEDED","content":{"application/json":{"schema":{"example":"API_USAGE_LIMIT_EXCEEDED","description":"MONTHLY_LIMIT_EXCEEDED","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"}}}]}}}},"500":{"description":"INTERNAL_ERROR","content":{"application/json":{"schema":{"description":"INTERNAL_ERROR","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"503":{"description":"TEMPORARILY_UNAVAILABLE","content":{"application/json":{"schema":{"description":"TEMPORARILY_UNAVAILABLE","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}}},"method":"post","path":"/custom_bitlinks","requestSamples":[{"name":"cURL","syntaxLanguage":"bash","sample":"curl \\\n-H 'Authorization: Bearer {TOKEN}' \\\n-H 'Content-Type: application/json' \\\n-X POST \\\n-d '{\n \"custom_bitlink\": \"chauncey.ly/documentation\",\n \"bitlink_id\": \"chauncey.ly/1234abcd\"\n}' \\\nhttps://api-ssl.bitly.com/v4/custom_bitlinks","exampleName":"Default"},{"sample":"var fetch = require('node-fetch');\n\nfetch('https://api-ssl.bitly.com/v4/custom_bitlinks', {\n method: 'POST',\n headers: {\n 'Authorization': 'Bearer {TOKEN}',\n 'Content-Type': 'application/json'\n },\n body: JSON.stringify({ \"custom_bitlink\": \"chauncey.ly/documentation\", \"bitlink_id\": \"chauncey.ly/1234abcd\" })\n});\n","name":"Node","syntaxLanguage":"javascript","exampleName":"Default"},{"sample":"fetch('https://api-ssl.bitly.com/v4/custom_bitlinks', {\n method: 'POST',\n headers: {\n 'Authorization': 'Bearer {TOKEN}',\n 'Content-Type': 'application/json'\n },\n body: JSON.stringify({ \"custom_bitlink\": \"chauncey.ly/documentation\", \"bitlink_id\": \"chauncey.ly/1234abcd\" })\n});\n","name":"Browser","syntaxLanguage":"javascript","exampleName":"Default"},{"sample":"package main\n\nimport (\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n\t\"strings\"\n)\n\nfunc main() {\n\tclient := \u0026http.Client{}\n\tvar data = strings.NewReader(`{ \"custom_bitlink\": \"chauncey.ly/documentation\", \"bitlink_id\": \"chauncey.ly/1234abcd\" }`)\n\treq, err := http.NewRequest(\"POST\", \"https://api-ssl.bitly.com/v4/custom_bitlinks\", data)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\treq.Header.Set(\"Authorization\", \"Bearer {TOKEN}\")\n\treq.Header.Set(\"Content-Type\", \"application/json\")\n\tresp, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tdefer resp.Body.Close()\n\tbodyText, err := ioutil.ReadAll(resp.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tfmt.Printf(\"%s\\n\", bodyText)\n}\n","name":"Go","syntaxLanguage":"go","exampleName":"Default"},{"sample":"import requests\n\nheaders = {\n 'Authorization': 'Bearer {TOKEN}',\n 'Content-Type': 'application/json',\n}\n\ndata = '{ \"custom_bitlink\": \"chauncey.ly/documentation\", \"bitlink_id\": \"chauncey.ly/1234abcd\" }'\n\nresponse = requests.post('https://api-ssl.bitly.com/v4/custom_bitlinks', headers=headers, data=data)\n","name":"Python","syntaxLanguage":"python","exampleName":"Default"}],"responseSamples":[{"statusCode":"200","description":"SUCCESS","json":"{\n \"custom_bitlink\": \"string\",\n \"bitlink\": {\n \"references\": { \"any\" },\n \"link\": \"string\",\n \"id\": \"string\",\n \"long_url\": \"string\",\n \"title\": \"string\",\n \"archived\": \"boolean\",\n \"created_at\": \"string\",\n \"created_by\": \"string\",\n \"client_id\": \"string\",\n \"custom_bitlinks\": [\n \"string\"\n ],\n \"tags\": [\n \"string\"\n ],\n \"launchpad_ids\": [\n \"string\"\n ],\n \"qr_code_ids\": [\n \"string\"\n ],\n \"deeplinks\": [\n {\n \"guid\": \"string\",\n \"bitlink\": \"string\",\n \"app_uri_path\": \"string\",\n \"install_url\": \"string\",\n \"app_guid\": \"string\",\n \"os\": \"string\",\n \"install_type\": \"string\",\n \"created\": \"string\",\n \"modified\": \"string\",\n \"brand_guid\": \"string\"\n }\n ],\n \"campaign_ids\": [\n \"string\"\n ]\n },\n \"bitlink_history\": [\n {\n \"uuid\": \"string\",\n \"group_guid\": \"string\",\n \"keyword\": \"string\",\n \"bsd\": \"string\",\n \"hash\": \"string\",\n \"login\": \"string\",\n \"long_url\": \"string\",\n \"created\": \"string\",\n \"first_created\": \"string\",\n \"deactivated\": \"string\",\n \"is_active\": \"boolean\"\n }\n ]\n}","csv":null},{"statusCode":"400","description":"BAD_REQUEST","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"402","description":"UPGRADE_REQUIRED","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"403","description":"FORBIDDEN","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"404","description":"NOT_FOUND","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"409","description":"Conflict","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"422","description":"UNPROCESSABLE_ENTITY","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"429","description":"MONTHLY_LIMIT_EXCEEDED","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\"\n}","csv":null},{"statusCode":"500","description":"INTERNAL_ERROR","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"503","description":"TEMPORARILY_UNAVAILABLE","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null}],"requestBodyParams":[{"name":"custom_bitlink","description":null,"required":null,"schema":{"type":"string","default":null,"enum":null},"items":null,"properties":null},{"name":"bitlink_id","description":null,"required":null,"schema":{"type":"string","default":null,"enum":null},"items":null,"properties":null}]},{"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":[{"name":"custom_bitlink","description":"A Custom Bitlink made of the domain and keyword","in":"path","schema":{"type":"string"},"required":true,"example":"chauncey.ly/chauncey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"bitlink_id":{"type":"string"}},"example":{"bitlink_id":"chauncey.ly/1234abcd"}}}}},"responses":{"200":{"description":"SUCCESS","content":{"application/json":{"schema":{"type":"object","properties":{"custom_bitlink":{"type":"string"},"bitlink":{"type":"object","allOf":[{"type":"object","properties":{"references":{"type":"object","additionalProperties":{"type":"string"}}}},{"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"}},"qr_code_ids":{"type":"array","items":{"type":"string"},"description":"a list of qr code ids that are associated with this bitlink"},"deeplinks":{"type":"array","items":{"type":"object","properties":{"guid":{"type":"string"},"bitlink":{"type":"string"},"app_uri_path":{"type":"string"},"install_url":{"type":"string"},"app_guid":{"type":"string"},"os":{"type":"string","enum":["ios","android"]},"install_type":{"type":"string","enum":["no_install","auto_install","promote_install"]},"created":{"type":"string","description":"ISO timestamp"},"modified":{"type":"string","description":"ISO timestamp"},"brand_guid":{"type":"string"}}}},"is_deleted":{"type":"boolean"},"campaign_ids":{"type":"array","items":{"type":"string"}}}}]},"bitlink_history":{"type":"array","items":{"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"}}}}}}}}},"400":{"description":"BAD_REQUEST","content":{"application/json":{"schema":{"description":"BAD_REQUEST","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"402":{"description":"UPGRADE_REQUIRED","content":{"application/json":{"schema":{"description":"UPGRADE_REQUIRED","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"403":{"description":"FORBIDDEN","content":{"application/json":{"schema":{"description":"FORBIDDEN","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"404":{"description":"NOT_FOUND","content":{"application/json":{"schema":{"description":"NOT_FOUND","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"422":{"description":"UNPROCESSABLE_ENTITY","content":{"application/json":{"schema":{"description":"UNPROCESSABLE_ENTITY","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"429":{"description":"MONTHLY_LIMIT_EXCEEDED","content":{"application/json":{"schema":{"example":"API_USAGE_LIMIT_EXCEEDED","description":"MONTHLY_LIMIT_EXCEEDED","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"}}}]}}}},"500":{"description":"INTERNAL_ERROR","content":{"application/json":{"schema":{"description":"INTERNAL_ERROR","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"503":{"description":"TEMPORARILY_UNAVAILABLE","content":{"application/json":{"schema":{"description":"TEMPORARILY_UNAVAILABLE","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}}},"method":"patch","path":"/custom_bitlinks/{custom_bitlink}","requestSamples":[{"name":"cURL","syntaxLanguage":"bash","sample":"curl \\\n-H 'Authorization: Bearer {TOKEN}' \\\n-H 'Content-Type: application/json' \\\n-X PATCH \\\n-d '{\n \"bitlink_id\": \"chauncey.ly/1234abcd\"\n}' \\\nhttps://api-ssl.bitly.com/v4/custom_bitlinks/chauncey.ly/chauncey","exampleName":"Default"},{"sample":"var fetch = require('node-fetch');\n\nfetch('https://api-ssl.bitly.com/v4/custom_bitlinks/chauncey.ly/chauncey', {\n method: 'PATCH',\n headers: {\n 'Authorization': 'Bearer {TOKEN}',\n 'Content-Type': 'application/json'\n },\n body: JSON.stringify({ \"bitlink_id\": \"chauncey.ly/1234abcd\" })\n});\n","name":"Node","syntaxLanguage":"javascript","exampleName":"Default"},{"sample":"fetch('https://api-ssl.bitly.com/v4/custom_bitlinks/chauncey.ly/chauncey', {\n method: 'PATCH',\n headers: {\n 'Authorization': 'Bearer {TOKEN}',\n 'Content-Type': 'application/json'\n },\n body: JSON.stringify({ \"bitlink_id\": \"chauncey.ly/1234abcd\" })\n});\n","name":"Browser","syntaxLanguage":"javascript","exampleName":"Default"},{"sample":"package main\n\nimport (\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n\t\"strings\"\n)\n\nfunc main() {\n\tclient := \u0026http.Client{}\n\tvar data = strings.NewReader(`{ \"bitlink_id\": \"chauncey.ly/1234abcd\" }`)\n\treq, err := http.NewRequest(\"PATCH\", \"https://api-ssl.bitly.com/v4/custom_bitlinks/chauncey.ly/chauncey\", data)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\treq.Header.Set(\"Authorization\", \"Bearer {TOKEN}\")\n\treq.Header.Set(\"Content-Type\", \"application/json\")\n\tresp, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tdefer resp.Body.Close()\n\tbodyText, err := ioutil.ReadAll(resp.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tfmt.Printf(\"%s\\n\", bodyText)\n}\n","name":"Go","syntaxLanguage":"go","exampleName":"Default"},{"sample":"import requests\n\nheaders = {\n 'Authorization': 'Bearer {TOKEN}',\n 'Content-Type': 'application/json',\n}\n\ndata = '{ \"bitlink_id\": \"chauncey.ly/1234abcd\" }'\n\nresponse = requests.patch('https://api-ssl.bitly.com/v4/custom_bitlinks/chauncey.ly/chauncey', headers=headers, data=data)\n","name":"Python","syntaxLanguage":"python","exampleName":"Default"}],"responseSamples":[{"statusCode":"200","description":"SUCCESS","json":"{\n \"custom_bitlink\": \"string\",\n \"bitlink\": {\n \"references\": { \"any\" },\n \"link\": \"string\",\n \"id\": \"string\",\n \"long_url\": \"string\",\n \"title\": \"string\",\n \"archived\": \"boolean\",\n \"created_at\": \"string\",\n \"created_by\": \"string\",\n \"client_id\": \"string\",\n \"custom_bitlinks\": [\n \"string\"\n ],\n \"tags\": [\n \"string\"\n ],\n \"launchpad_ids\": [\n \"string\"\n ],\n \"qr_code_ids\": [\n \"string\"\n ],\n \"deeplinks\": [\n {\n \"guid\": \"string\",\n \"bitlink\": \"string\",\n \"app_uri_path\": \"string\",\n \"install_url\": \"string\",\n \"app_guid\": \"string\",\n \"os\": \"string\",\n \"install_type\": \"string\",\n \"created\": \"string\",\n \"modified\": \"string\",\n \"brand_guid\": \"string\"\n }\n ],\n \"campaign_ids\": [\n \"string\"\n ]\n },\n \"bitlink_history\": [\n {\n \"uuid\": \"string\",\n \"group_guid\": \"string\",\n \"keyword\": \"string\",\n \"bsd\": \"string\",\n \"hash\": \"string\",\n \"login\": \"string\",\n \"long_url\": \"string\",\n \"created\": \"string\",\n \"first_created\": \"string\",\n \"deactivated\": \"string\",\n \"is_active\": \"boolean\"\n }\n ]\n}","csv":null},{"statusCode":"400","description":"BAD_REQUEST","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"402","description":"UPGRADE_REQUIRED","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"403","description":"FORBIDDEN","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"404","description":"NOT_FOUND","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"422","description":"UNPROCESSABLE_ENTITY","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"429","description":"MONTHLY_LIMIT_EXCEEDED","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\"\n}","csv":null},{"statusCode":"500","description":"INTERNAL_ERROR","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"503","description":"TEMPORARILY_UNAVAILABLE","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null}],"requestBodyParams":[{"name":"bitlink_id","description":null,"required":null,"schema":{"type":"string","default":null,"enum":null},"items":null,"properties":null}]},{"summary":"Retrieve Custom Bitlink","description":"Returns the details and history of the specified link.","tags":["Custom Bitlinks"],"operationId":"getCustomBitlink","parameters":[{"name":"custom_bitlink","description":"A Custom Bitlink made of the domain and keyword","in":"path","schema":{"type":"string"},"required":true,"example":"chauncey.ly/chauncey"}],"responses":{"200":{"description":"SUCCESS","content":{"application/json":{"schema":{"type":"object","properties":{"custom_bitlink":{"type":"string"},"bitlink":{"type":"object","allOf":[{"type":"object","properties":{"references":{"type":"object","additionalProperties":{"type":"string"}}}},{"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"}},"qr_code_ids":{"type":"array","items":{"type":"string"},"description":"a list of qr code ids that are associated with this bitlink"},"deeplinks":{"type":"array","items":{"type":"object","properties":{"guid":{"type":"string"},"bitlink":{"type":"string"},"app_uri_path":{"type":"string"},"install_url":{"type":"string"},"app_guid":{"type":"string"},"os":{"type":"string","enum":["ios","android"]},"install_type":{"type":"string","enum":["no_install","auto_install","promote_install"]},"created":{"type":"string","description":"ISO timestamp"},"modified":{"type":"string","description":"ISO timestamp"},"brand_guid":{"type":"string"}}}},"is_deleted":{"type":"boolean"},"campaign_ids":{"type":"array","items":{"type":"string"}}}}]},"bitlink_history":{"type":"array","items":{"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"}}}}}}}}},"402":{"description":"UPGRADE_REQUIRED","content":{"application/json":{"schema":{"description":"UPGRADE_REQUIRED","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"403":{"description":"FORBIDDEN","content":{"application/json":{"schema":{"description":"FORBIDDEN","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"404":{"description":"NOT_FOUND","content":{"application/json":{"schema":{"description":"NOT_FOUND","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"410":{"description":"GONE","content":{"application/json":{"schema":{"description":"GONE","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"429":{"description":"MONTHLY_LIMIT_EXCEEDED","content":{"application/json":{"schema":{"example":"API_USAGE_LIMIT_EXCEEDED","description":"MONTHLY_LIMIT_EXCEEDED","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"}}}]}}}},"500":{"description":"INTERNAL_ERROR","content":{"application/json":{"schema":{"description":"INTERNAL_ERROR","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"503":{"description":"TEMPORARILY_UNAVAILABLE","content":{"application/json":{"schema":{"description":"TEMPORARILY_UNAVAILABLE","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}}},"method":"get","path":"/custom_bitlinks/{custom_bitlink}","requestSamples":[{"name":"cURL","syntaxLanguage":"bash","sample":"curl \\\n-H 'Authorization: Bearer {TOKEN}' \\\n-X GET \\\nhttps://api-ssl.bitly.com/v4/custom_bitlinks/chauncey.ly/chauncey","exampleName":"Default"},{"sample":"var fetch = require('node-fetch');\n\nfetch('https://api-ssl.bitly.com/v4/custom_bitlinks/chauncey.ly/chauncey', {\n headers: {\n 'Authorization': 'Bearer {TOKEN}'\n }\n});\n","name":"Node","syntaxLanguage":"javascript","exampleName":"Default"},{"sample":"fetch('https://api-ssl.bitly.com/v4/custom_bitlinks/chauncey.ly/chauncey', {\n headers: {\n 'Authorization': 'Bearer {TOKEN}'\n }\n});\n","name":"Browser","syntaxLanguage":"javascript","exampleName":"Default"},{"sample":"package main\n\nimport (\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\tclient := \u0026http.Client{}\n\treq, err := http.NewRequest(\"GET\", \"https://api-ssl.bitly.com/v4/custom_bitlinks/chauncey.ly/chauncey\", nil)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\treq.Header.Set(\"Authorization\", \"Bearer {TOKEN}\")\n\tresp, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tdefer resp.Body.Close()\n\tbodyText, err := ioutil.ReadAll(resp.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tfmt.Printf(\"%s\\n\", bodyText)\n}\n","name":"Go","syntaxLanguage":"go","exampleName":"Default"},{"sample":"import requests\n\nheaders = {\n 'Authorization': 'Bearer {TOKEN}',\n}\n\nresponse = requests.get('https://api-ssl.bitly.com/v4/custom_bitlinks/chauncey.ly/chauncey', headers=headers)\n","name":"Python","syntaxLanguage":"python","exampleName":"Default"}],"responseSamples":[{"statusCode":"200","description":"SUCCESS","json":"{\n \"custom_bitlink\": \"string\",\n \"bitlink\": {\n \"references\": { \"any\" },\n \"link\": \"string\",\n \"id\": \"string\",\n \"long_url\": \"string\",\n \"title\": \"string\",\n \"archived\": \"boolean\",\n \"created_at\": \"string\",\n \"created_by\": \"string\",\n \"client_id\": \"string\",\n \"custom_bitlinks\": [\n \"string\"\n ],\n \"tags\": [\n \"string\"\n ],\n \"launchpad_ids\": [\n \"string\"\n ],\n \"qr_code_ids\": [\n \"string\"\n ],\n \"deeplinks\": [\n {\n \"guid\": \"string\",\n \"bitlink\": \"string\",\n \"app_uri_path\": \"string\",\n \"install_url\": \"string\",\n \"app_guid\": \"string\",\n \"os\": \"string\",\n \"install_type\": \"string\",\n \"created\": \"string\",\n \"modified\": \"string\",\n \"brand_guid\": \"string\"\n }\n ],\n \"campaign_ids\": [\n \"string\"\n ]\n },\n \"bitlink_history\": [\n {\n \"uuid\": \"string\",\n \"group_guid\": \"string\",\n \"keyword\": \"string\",\n \"bsd\": \"string\",\n \"hash\": \"string\",\n \"login\": \"string\",\n \"long_url\": \"string\",\n \"created\": \"string\",\n \"first_created\": \"string\",\n \"deactivated\": \"string\",\n \"is_active\": \"boolean\"\n }\n ]\n}","csv":null},{"statusCode":"402","description":"UPGRADE_REQUIRED","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"403","description":"FORBIDDEN","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"404","description":"NOT_FOUND","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"410","description":"GONE","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"429","description":"MONTHLY_LIMIT_EXCEEDED","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\"\n}","csv":null},{"statusCode":"500","description":"INTERNAL_ERROR","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"503","description":"TEMPORARILY_UNAVAILABLE","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null}],"requestBodyParams":null},{"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":[{"name":"custom_bitlink","description":"A Custom Bitlink made of the domain and keyword","in":"path","schema":{"type":"string"},"required":true,"example":"chauncey.ly/chauncey"},{"name":"unit","description":"A unit of time","schema":{"description":"the unit of time queried for (minute, hour, day, week, month)","type":"string","enum":["minute","hour","day","week","month"],"default":"day"},"required":true,"in":"query","example":"month"},{"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},{"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"}],"responses":{"200":{"description":"SUCCESS","content":{"application/json":{"schema":{"type":"object","allOf":[{"type":"object","properties":{"unit":{"type":"string","x-faker":"internet.userName"},"units":{"type":"integer","x-faker":{"datatype.number":{"min":1,"max":100}}},"facet":{"type":"string","enum":["countries","cities","devices","referrers","referrers_by_domain","referring_domains","referring_networks","shorten_counts"]},"unit_reference":{"type":"string","x-faker":"date.past"}}},{"properties":{"metrics":{"type":"array","items":{"type":"object","properties":{"clicks":{"type":"integer","example":123,"x-faker":"random.number"},"value":{"type":"string","example":"bit.ly","x-faker":"internet.domainName"}}}}}}]}}}},"402":{"description":"UPGRADE_REQUIRED","content":{"application/json":{"schema":{"description":"UPGRADE_REQUIRED","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"403":{"description":"FORBIDDEN","content":{"application/json":{"schema":{"description":"FORBIDDEN","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"404":{"description":"NOT_FOUND","content":{"application/json":{"schema":{"description":"NOT_FOUND","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"410":{"description":"GONE","content":{"application/json":{"schema":{"description":"GONE","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"429":{"description":"MONTHLY_LIMIT_EXCEEDED","content":{"application/json":{"schema":{"example":"API_USAGE_LIMIT_EXCEEDED","description":"MONTHLY_LIMIT_EXCEEDED","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"}}}]}}}},"500":{"description":"INTERNAL_ERROR","content":{"application/json":{"schema":{"description":"INTERNAL_ERROR","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"503":{"description":"TEMPORARILY_UNAVAILABLE","content":{"application/json":{"schema":{"description":"TEMPORARILY_UNAVAILABLE","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}}},"method":"get","path":"/custom_bitlinks/{custom_bitlink}/clicks_by_destination","requestSamples":[{"name":"cURL","syntaxLanguage":"bash","sample":"curl \\\n-H 'Authorization: Bearer {TOKEN}' \\\n-X GET \\\nhttps://api-ssl.bitly.com/v4/custom_bitlinks/chauncey.ly/chauncey/clicks_by_destination?unit=month\u0026units=1\u0026unit_reference=2006-01-02T15%3A04%3A05-0700","exampleName":"Default"},{"sample":"var fetch = require('node-fetch');\n\nfetch('https://api-ssl.bitly.com/v4/custom_bitlinks/chauncey.ly/chauncey/clicks_by_destination?unit=month\u0026units=1\u0026unit_reference=2006-01-02T15%3A04%3A05-0700', {\n headers: {\n 'Authorization': 'Bearer {TOKEN}'\n }\n});\n","name":"Node","syntaxLanguage":"javascript","exampleName":"Default"},{"sample":"fetch('https://api-ssl.bitly.com/v4/custom_bitlinks/chauncey.ly/chauncey/clicks_by_destination?unit=month\u0026units=1\u0026unit_reference=2006-01-02T15%3A04%3A05-0700', {\n headers: {\n 'Authorization': 'Bearer {TOKEN}'\n }\n});\n","name":"Browser","syntaxLanguage":"javascript","exampleName":"Default"},{"sample":"package main\n\nimport (\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\tclient := \u0026http.Client{}\n\treq, err := http.NewRequest(\"GET\", \"https://api-ssl.bitly.com/v4/custom_bitlinks/chauncey.ly/chauncey/clicks_by_destination?unit=month\u0026units=1\u0026unit_reference=2006-01-02T15%3A04%3A05-0700\", nil)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\treq.Header.Set(\"Authorization\", \"Bearer {TOKEN}\")\n\tresp, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tdefer resp.Body.Close()\n\tbodyText, err := ioutil.ReadAll(resp.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tfmt.Printf(\"%s\\n\", bodyText)\n}\n","name":"Go","syntaxLanguage":"go","exampleName":"Default"},{"sample":"import requests\n\nheaders = {\n 'Authorization': 'Bearer {TOKEN}',\n}\n\nparams = (\n ('unit', 'month'),\n ('units', '1'),\n ('unit_reference', '2006-01-02T15:04:05-0700'),\n)\n\nresponse = requests.get('https://api-ssl.bitly.com/v4/custom_bitlinks/chauncey.ly/chauncey/clicks_by_destination', headers=headers, params=params)\n\n#NB. Original query string below. It seems impossible to parse and\n#reproduce query strings 100% accurately so the one below is given\n#in case the reproduced version is not \"correct\".\n# response = requests.get('https://api-ssl.bitly.com/v4/custom_bitlinks/chauncey.ly/chauncey/clicks_by_destination?unit=month\u0026units=1\u0026unit_reference=2006-01-02T15%3A04%3A05-0700', headers=headers)\n","name":"Python","syntaxLanguage":"python","exampleName":"Default"}],"responseSamples":[{"statusCode":"200","description":"SUCCESS","json":"{\n \"unit\": \"string\",\n \"units\": \"integer\",\n \"facet\": \"string\",\n \"unit_reference\": \"string\",\n \"metrics\": [\n {\n \"clicks\": \"integer\",\n \"value\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"402","description":"UPGRADE_REQUIRED","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"403","description":"FORBIDDEN","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"404","description":"NOT_FOUND","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"410","description":"GONE","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"429","description":"MONTHLY_LIMIT_EXCEEDED","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\"\n}","csv":null},{"statusCode":"500","description":"INTERNAL_ERROR","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"503","description":"TEMPORARILY_UNAVAILABLE","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null}],"requestBodyParams":null},{"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":[{"name":"custom_bitlink","description":"A Custom Bitlink made of the domain and keyword","in":"path","schema":{"type":"string"},"required":true,"example":"chauncey.ly/chauncey"},{"name":"unit","description":"A unit of time","schema":{"description":"the unit of time queried for (minute, hour, day, week, month)","type":"string","enum":["minute","hour","day","week","month"],"default":"day"},"required":true,"in":"query","example":"month"},{"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},{"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"}],"responses":{"200":{"description":"SUCCESS","content":{"application/json":{"schema":{"type":"object","properties":{"link_clicks":{"type":"array","items":{"type":"object","properties":{"clicks":{"type":"integer"},"date":{"type":"string"}}}},"units":{"type":"integer"},"unit":{"type":"string","enum":["minute","hour","day","week","month"]},"unit_reference":{"type":"string"}}}}}},"400":{"description":"BAD_REQUEST","content":{"application/json":{"schema":{"description":"BAD_REQUEST","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"402":{"description":"UPGRADE_REQUIRED","content":{"application/json":{"schema":{"description":"UPGRADE_REQUIRED","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"403":{"description":"FORBIDDEN","content":{"application/json":{"schema":{"description":"FORBIDDEN","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"404":{"description":"NOT_FOUND","content":{"application/json":{"schema":{"description":"NOT_FOUND","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"410":{"description":"GONE","content":{"application/json":{"schema":{"description":"GONE","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"429":{"description":"MONTHLY_LIMIT_EXCEEDED","content":{"application/json":{"schema":{"example":"API_USAGE_LIMIT_EXCEEDED","description":"MONTHLY_LIMIT_EXCEEDED","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"}}}]}}}},"500":{"description":"INTERNAL_ERROR","content":{"application/json":{"schema":{"description":"INTERNAL_ERROR","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"503":{"description":"TEMPORARILY_UNAVAILABLE","content":{"application/json":{"schema":{"description":"TEMPORARILY_UNAVAILABLE","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}}},"method":"get","path":"/custom_bitlinks/{custom_bitlink}/clicks","requestSamples":[{"name":"cURL","syntaxLanguage":"bash","sample":"curl \\\n-H 'Authorization: Bearer {TOKEN}' \\\n-X GET \\\nhttps://api-ssl.bitly.com/v4/custom_bitlinks/chauncey.ly/chauncey/clicks?unit=month\u0026units=1\u0026unit_reference=2006-01-02T15%3A04%3A05-0700","exampleName":"Default"},{"sample":"var fetch = require('node-fetch');\n\nfetch('https://api-ssl.bitly.com/v4/custom_bitlinks/chauncey.ly/chauncey/clicks?unit=month\u0026units=1\u0026unit_reference=2006-01-02T15%3A04%3A05-0700', {\n headers: {\n 'Authorization': 'Bearer {TOKEN}'\n }\n});\n","name":"Node","syntaxLanguage":"javascript","exampleName":"Default"},{"sample":"fetch('https://api-ssl.bitly.com/v4/custom_bitlinks/chauncey.ly/chauncey/clicks?unit=month\u0026units=1\u0026unit_reference=2006-01-02T15%3A04%3A05-0700', {\n headers: {\n 'Authorization': 'Bearer {TOKEN}'\n }\n});\n","name":"Browser","syntaxLanguage":"javascript","exampleName":"Default"},{"sample":"package main\n\nimport (\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\tclient := \u0026http.Client{}\n\treq, err := http.NewRequest(\"GET\", \"https://api-ssl.bitly.com/v4/custom_bitlinks/chauncey.ly/chauncey/clicks?unit=month\u0026units=1\u0026unit_reference=2006-01-02T15%3A04%3A05-0700\", nil)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\treq.Header.Set(\"Authorization\", \"Bearer {TOKEN}\")\n\tresp, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tdefer resp.Body.Close()\n\tbodyText, err := ioutil.ReadAll(resp.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tfmt.Printf(\"%s\\n\", bodyText)\n}\n","name":"Go","syntaxLanguage":"go","exampleName":"Default"},{"sample":"import requests\n\nheaders = {\n 'Authorization': 'Bearer {TOKEN}',\n}\n\nparams = (\n ('unit', 'month'),\n ('units', '1'),\n ('unit_reference', '2006-01-02T15:04:05-0700'),\n)\n\nresponse = requests.get('https://api-ssl.bitly.com/v4/custom_bitlinks/chauncey.ly/chauncey/clicks', headers=headers, params=params)\n\n#NB. Original query string below. It seems impossible to parse and\n#reproduce query strings 100% accurately so the one below is given\n#in case the reproduced version is not \"correct\".\n# response = requests.get('https://api-ssl.bitly.com/v4/custom_bitlinks/chauncey.ly/chauncey/clicks?unit=month\u0026units=1\u0026unit_reference=2006-01-02T15%3A04%3A05-0700', headers=headers)\n","name":"Python","syntaxLanguage":"python","exampleName":"Default"}],"responseSamples":[{"statusCode":"200","description":"SUCCESS","json":"{\n \"link_clicks\": [\n {\n \"clicks\": \"integer\",\n \"date\": \"string\"\n }\n ],\n \"units\": \"integer\",\n \"unit\": \"string\",\n \"unit_reference\": \"string\"\n}","csv":null},{"statusCode":"400","description":"BAD_REQUEST","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"402","description":"UPGRADE_REQUIRED","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"403","description":"FORBIDDEN","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"404","description":"NOT_FOUND","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"410","description":"GONE","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"429","description":"MONTHLY_LIMIT_EXCEEDED","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\"\n}","csv":null},{"statusCode":"500","description":"INTERNAL_ERROR","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"503","description":"TEMPORARILY_UNAVAILABLE","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null}],"requestBodyParams":null}]},{"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","methods":[{"summary":"Retrieve Groups","description":"Returns a list of groups in the organization.","tags":["Groups"],"operationId":"getGroups","parameters":[{"name":"organization_guid","description":"A GUID for a Bitly organization","in":"query","schema":{"type":"string"},"example":"Oa1bcd234eF"}],"responses":{"200":{"description":"SUCCESS","content":{"application/json":{"schema":{"type":"object","required":["groups"],"properties":{"groups":{"type":"array","items":{"type":"object","required":["guid","organization_guid","name","created","modified","is_active","role","bsds"],"allOf":[{"type":"object","properties":{"references":{"type":"object","additionalProperties":{"type":"string"}}}},{"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"}}}}]}}}}}}},"400":{"description":"BAD_REQUEST","content":{"application/json":{"schema":{"description":"BAD_REQUEST","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"403":{"description":"FORBIDDEN","content":{"application/json":{"schema":{"description":"FORBIDDEN","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"404":{"description":"NOT_FOUND","content":{"application/json":{"schema":{"description":"NOT_FOUND","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"422":{"description":"UNPROCESSABLE_ENTITY","content":{"application/json":{"schema":{"description":"UNPROCESSABLE_ENTITY","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"429":{"description":"MONTHLY_LIMIT_EXCEEDED","content":{"application/json":{"schema":{"example":"API_USAGE_LIMIT_EXCEEDED","description":"MONTHLY_LIMIT_EXCEEDED","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"}}}]}}}},"500":{"description":"INTERNAL_ERROR","content":{"application/json":{"schema":{"description":"INTERNAL_ERROR","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"503":{"description":"TEMPORARILY_UNAVAILABLE","content":{"application/json":{"schema":{"description":"TEMPORARILY_UNAVAILABLE","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}}},"method":"get","path":"/groups","requestSamples":[{"name":"cURL","syntaxLanguage":"bash","sample":"curl \\\n-H 'Authorization: Bearer {TOKEN}' \\\n-X GET \\\nhttps://api-ssl.bitly.com/v4/groups?organization_guid=Oa1bcd234eF","exampleName":"Default"},{"sample":"var fetch = require('node-fetch');\n\nfetch('https://api-ssl.bitly.com/v4/groups?organization_guid=Oa1bcd234eF', {\n headers: {\n 'Authorization': 'Bearer {TOKEN}'\n }\n});\n","name":"Node","syntaxLanguage":"javascript","exampleName":"Default"},{"sample":"fetch('https://api-ssl.bitly.com/v4/groups?organization_guid=Oa1bcd234eF', {\n headers: {\n 'Authorization': 'Bearer {TOKEN}'\n }\n});\n","name":"Browser","syntaxLanguage":"javascript","exampleName":"Default"},{"sample":"package main\n\nimport (\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\tclient := \u0026http.Client{}\n\treq, err := http.NewRequest(\"GET\", \"https://api-ssl.bitly.com/v4/groups?organization_guid=Oa1bcd234eF\", nil)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\treq.Header.Set(\"Authorization\", \"Bearer {TOKEN}\")\n\tresp, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tdefer resp.Body.Close()\n\tbodyText, err := ioutil.ReadAll(resp.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tfmt.Printf(\"%s\\n\", bodyText)\n}\n","name":"Go","syntaxLanguage":"go","exampleName":"Default"},{"sample":"import requests\n\nheaders = {\n 'Authorization': 'Bearer {TOKEN}',\n}\n\nparams = (\n ('organization_guid', 'Oa1bcd234eF'),\n)\n\nresponse = requests.get('https://api-ssl.bitly.com/v4/groups', headers=headers, params=params)\n\n#NB. Original query string below. It seems impossible to parse and\n#reproduce query strings 100% accurately so the one below is given\n#in case the reproduced version is not \"correct\".\n# response = requests.get('https://api-ssl.bitly.com/v4/groups?organization_guid=Oa1bcd234eF', headers=headers)\n","name":"Python","syntaxLanguage":"python","exampleName":"Default"}],"responseSamples":[{"statusCode":"200","description":"SUCCESS","json":"{\n \"groups\": [\n {\n \"references\": { \"any\" },\n \"name\": \"string\",\n \"guid\": \"string\",\n \"created\": \"string\",\n \"modified\": \"string\",\n \"is_active\": \"boolean\",\n \"role\": \"string\",\n \"organization_guid\": \"string\",\n \"bsds\": [\n \"string\"\n ]\n }\n ]\n}","csv":null},{"statusCode":"400","description":"BAD_REQUEST","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"403","description":"FORBIDDEN","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"404","description":"NOT_FOUND","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"422","description":"UNPROCESSABLE_ENTITY","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"429","description":"MONTHLY_LIMIT_EXCEEDED","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\"\n}","csv":null},{"statusCode":"500","description":"INTERNAL_ERROR","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"503","description":"TEMPORARILY_UNAVAILABLE","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null}],"requestBodyParams":null},{"summary":"Update a Group","description":"Updates the details of a group.","tags":["Groups"],"operationId":"updateGroup","parameters":[{"name":"group_guid","description":"A GUID for a Bitly group","in":"path","required":true,"schema":{"type":"string"},"example":"Ba1bc23dE4F"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"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"]}}}}},"responses":{"200":{"description":"SUCCESS","content":{"application/json":{"schema":{"type":"object","required":["guid","organization_guid","name","created","modified","is_active","role","bsds"],"allOf":[{"type":"object","properties":{"references":{"type":"object","additionalProperties":{"type":"string"}}}},{"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"}}}}]}}}},"400":{"description":"BAD_REQUEST","content":{"application/json":{"schema":{"description":"BAD_REQUEST","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"403":{"description":"FORBIDDEN","content":{"application/json":{"schema":{"description":"FORBIDDEN","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"404":{"description":"NOT_FOUND","content":{"application/json":{"schema":{"description":"NOT_FOUND","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"422":{"description":"UNPROCESSABLE_ENTITY","content":{"application/json":{"schema":{"description":"UNPROCESSABLE_ENTITY","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"500":{"description":"INTERNAL_ERROR","content":{"application/json":{"schema":{"description":"INTERNAL_ERROR","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"503":{"description":"TEMPORARILY_UNAVAILABLE","content":{"application/json":{"schema":{"description":"TEMPORARILY_UNAVAILABLE","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}}},"method":"patch","path":"/groups/{group_guid}","requestSamples":[{"name":"cURL","syntaxLanguage":"bash","sample":"curl \\\n-H 'Authorization: Bearer {TOKEN}' \\\n-H 'Content-Type: application/json' \\\n-X PATCH \\\n-d '{\n \"name\": \"My New Group\",\n \"organization_guid\": \"Oa1bcd234eF\",\n \"bsds\": [\n \"chauncey.ly\"\n ]\n}' \\\nhttps://api-ssl.bitly.com/v4/groups/Ba1bc23dE4F","exampleName":"Default"},{"sample":"var fetch = require('node-fetch');\n\nfetch('https://api-ssl.bitly.com/v4/groups/Ba1bc23dE4F', {\n method: 'PATCH',\n headers: {\n 'Authorization': 'Bearer {TOKEN}',\n 'Content-Type': 'application/json'\n },\n body: JSON.stringify({ \"name\": \"My New Group\", \"organization_guid\": \"Oa1bcd234eF\", \"bsds\": [ \"chauncey.ly\" ] })\n});\n","name":"Node","syntaxLanguage":"javascript","exampleName":"Default"},{"sample":"fetch('https://api-ssl.bitly.com/v4/groups/Ba1bc23dE4F', {\n method: 'PATCH',\n headers: {\n 'Authorization': 'Bearer {TOKEN}',\n 'Content-Type': 'application/json'\n },\n body: JSON.stringify({ \"name\": \"My New Group\", \"organization_guid\": \"Oa1bcd234eF\", \"bsds\": [ \"chauncey.ly\" ] })\n});\n","name":"Browser","syntaxLanguage":"javascript","exampleName":"Default"},{"sample":"package main\n\nimport (\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n\t\"strings\"\n)\n\nfunc main() {\n\tclient := \u0026http.Client{}\n\tvar data = strings.NewReader(`{ \"name\": \"My New Group\", \"organization_guid\": \"Oa1bcd234eF\", \"bsds\": [ \"chauncey.ly\" ] }`)\n\treq, err := http.NewRequest(\"PATCH\", \"https://api-ssl.bitly.com/v4/groups/Ba1bc23dE4F\", data)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\treq.Header.Set(\"Authorization\", \"Bearer {TOKEN}\")\n\treq.Header.Set(\"Content-Type\", \"application/json\")\n\tresp, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tdefer resp.Body.Close()\n\tbodyText, err := ioutil.ReadAll(resp.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tfmt.Printf(\"%s\\n\", bodyText)\n}\n","name":"Go","syntaxLanguage":"go","exampleName":"Default"},{"sample":"import requests\n\nheaders = {\n 'Authorization': 'Bearer {TOKEN}',\n 'Content-Type': 'application/json',\n}\n\ndata = '{ \"name\": \"My New Group\", \"organization_guid\": \"Oa1bcd234eF\", \"bsds\": [ \"chauncey.ly\" ] }'\n\nresponse = requests.patch('https://api-ssl.bitly.com/v4/groups/Ba1bc23dE4F', headers=headers, data=data)\n","name":"Python","syntaxLanguage":"python","exampleName":"Default"}],"responseSamples":[{"statusCode":"200","description":"SUCCESS","json":"{\n \"references\": { \"any\" },\n \"name\": \"string\",\n \"guid\": \"string\",\n \"created\": \"string\",\n \"modified\": \"string\",\n \"is_active\": \"boolean\",\n \"role\": \"string\",\n \"organization_guid\": \"string\",\n \"bsds\": [\n \"string\"\n ]\n}","csv":null},{"statusCode":"400","description":"BAD_REQUEST","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"403","description":"FORBIDDEN","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"404","description":"NOT_FOUND","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"422","description":"UNPROCESSABLE_ENTITY","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"500","description":"INTERNAL_ERROR","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"503","description":"TEMPORARILY_UNAVAILABLE","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null}],"requestBodyParams":[{"name":"name","description":null,"required":null,"schema":{"type":"string","default":null,"enum":null},"items":null,"properties":null},{"name":"organization_guid","description":null,"required":null,"schema":{"type":"string","default":null,"enum":null},"items":null,"properties":null},{"name":"bsds","description":null,"required":null,"schema":{"type":"array","default":null,"enum":null},"items":{"type":"string"},"properties":null}]},{"summary":"Retrieve a Group","description":"Returns details for a group.","tags":["Groups"],"operationId":"getGroup","parameters":[{"name":"group_guid","description":"A GUID for a Bitly group","in":"path","required":true,"schema":{"type":"string"},"example":"Ba1bc23dE4F"}],"responses":{"200":{"description":"SUCCESS","content":{"application/json":{"schema":{"type":"object","required":["guid","organization_guid","name","created","modified","is_active","role","bsds"],"allOf":[{"type":"object","properties":{"references":{"type":"object","additionalProperties":{"type":"string"}}}},{"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"}}}}]}}}},"403":{"description":"FORBIDDEN","content":{"application/json":{"schema":{"description":"FORBIDDEN","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"404":{"description":"NOT_FOUND","content":{"application/json":{"schema":{"description":"NOT_FOUND","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"429":{"description":"MONTHLY_LIMIT_EXCEEDED","content":{"application/json":{"schema":{"example":"API_USAGE_LIMIT_EXCEEDED","description":"MONTHLY_LIMIT_EXCEEDED","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"}}}]}}}},"500":{"description":"INTERNAL_ERROR","content":{"application/json":{"schema":{"description":"INTERNAL_ERROR","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"503":{"description":"TEMPORARILY_UNAVAILABLE","content":{"application/json":{"schema":{"description":"TEMPORARILY_UNAVAILABLE","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}}},"method":"get","path":"/groups/{group_guid}","requestSamples":[{"name":"cURL","syntaxLanguage":"bash","sample":"curl \\\n-H 'Authorization: Bearer {TOKEN}' \\\n-X GET \\\nhttps://api-ssl.bitly.com/v4/groups/Ba1bc23dE4F","exampleName":"Default"},{"sample":"var fetch = require('node-fetch');\n\nfetch('https://api-ssl.bitly.com/v4/groups/Ba1bc23dE4F', {\n headers: {\n 'Authorization': 'Bearer {TOKEN}'\n }\n});\n","name":"Node","syntaxLanguage":"javascript","exampleName":"Default"},{"sample":"fetch('https://api-ssl.bitly.com/v4/groups/Ba1bc23dE4F', {\n headers: {\n 'Authorization': 'Bearer {TOKEN}'\n }\n});\n","name":"Browser","syntaxLanguage":"javascript","exampleName":"Default"},{"sample":"package main\n\nimport (\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\tclient := \u0026http.Client{}\n\treq, err := http.NewRequest(\"GET\", \"https://api-ssl.bitly.com/v4/groups/Ba1bc23dE4F\", nil)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\treq.Header.Set(\"Authorization\", \"Bearer {TOKEN}\")\n\tresp, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tdefer resp.Body.Close()\n\tbodyText, err := ioutil.ReadAll(resp.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tfmt.Printf(\"%s\\n\", bodyText)\n}\n","name":"Go","syntaxLanguage":"go","exampleName":"Default"},{"sample":"import requests\n\nheaders = {\n 'Authorization': 'Bearer {TOKEN}',\n}\n\nresponse = requests.get('https://api-ssl.bitly.com/v4/groups/Ba1bc23dE4F', headers=headers)\n","name":"Python","syntaxLanguage":"python","exampleName":"Default"}],"responseSamples":[{"statusCode":"200","description":"SUCCESS","json":"{\n \"references\": { \"any\" },\n \"name\": \"string\",\n \"guid\": \"string\",\n \"created\": \"string\",\n \"modified\": \"string\",\n \"is_active\": \"boolean\",\n \"role\": \"string\",\n \"organization_guid\": \"string\",\n \"bsds\": [\n \"string\"\n ]\n}","csv":null},{"statusCode":"403","description":"FORBIDDEN","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"404","description":"NOT_FOUND","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"429","description":"MONTHLY_LIMIT_EXCEEDED","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\"\n}","csv":null},{"statusCode":"500","description":"INTERNAL_ERROR","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"503","description":"TEMPORARILY_UNAVAILABLE","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null}],"requestBodyParams":null},{"summary":"Retrieve Tags by Group","description":"Returns the tags currently used in the specified group. Maximum 1000.","tags":["Groups"],"operationId":"getGroupTags","parameters":[{"name":"group_guid","description":"A GUID for a Bitly group","in":"path","required":true,"schema":{"type":"string"},"example":"Ba1bc23dE4F"}],"responses":{"200":{"description":"SUCCESS","content":{"application/json":{"schema":{"type":"object","properties":{"tags":{"type":"array","items":{"type":"string"}}}}}}},"403":{"description":"FORBIDDEN","content":{"application/json":{"schema":{"description":"FORBIDDEN","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"404":{"description":"NOT_FOUND","content":{"application/json":{"schema":{"description":"NOT_FOUND","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"429":{"description":"MONTHLY_LIMIT_EXCEEDED","content":{"application/json":{"schema":{"example":"API_USAGE_LIMIT_EXCEEDED","description":"MONTHLY_LIMIT_EXCEEDED","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"}}}]}}}},"500":{"description":"INTERNAL_ERROR","content":{"application/json":{"schema":{"description":"INTERNAL_ERROR","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"503":{"description":"TEMPORARILY_UNAVAILABLE","content":{"application/json":{"schema":{"description":"TEMPORARILY_UNAVAILABLE","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}}},"method":"get","path":"/groups/{group_guid}/tags","requestSamples":[{"name":"cURL","syntaxLanguage":"bash","sample":"curl \\\n-H 'Authorization: Bearer {TOKEN}' \\\n-X GET \\\nhttps://api-ssl.bitly.com/v4/groups/Ba1bc23dE4F/tags","exampleName":"Default"},{"sample":"var fetch = require('node-fetch');\n\nfetch('https://api-ssl.bitly.com/v4/groups/Ba1bc23dE4F/tags', {\n headers: {\n 'Authorization': 'Bearer {TOKEN}'\n }\n});\n","name":"Node","syntaxLanguage":"javascript","exampleName":"Default"},{"sample":"fetch('https://api-ssl.bitly.com/v4/groups/Ba1bc23dE4F/tags', {\n headers: {\n 'Authorization': 'Bearer {TOKEN}'\n }\n});\n","name":"Browser","syntaxLanguage":"javascript","exampleName":"Default"},{"sample":"package main\n\nimport (\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\tclient := \u0026http.Client{}\n\treq, err := http.NewRequest(\"GET\", \"https://api-ssl.bitly.com/v4/groups/Ba1bc23dE4F/tags\", nil)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\treq.Header.Set(\"Authorization\", \"Bearer {TOKEN}\")\n\tresp, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tdefer resp.Body.Close()\n\tbodyText, err := ioutil.ReadAll(resp.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tfmt.Printf(\"%s\\n\", bodyText)\n}\n","name":"Go","syntaxLanguage":"go","exampleName":"Default"},{"sample":"import requests\n\nheaders = {\n 'Authorization': 'Bearer {TOKEN}',\n}\n\nresponse = requests.get('https://api-ssl.bitly.com/v4/groups/Ba1bc23dE4F/tags', headers=headers)\n","name":"Python","syntaxLanguage":"python","exampleName":"Default"}],"responseSamples":[{"statusCode":"200","description":"SUCCESS","json":"{\n \"tags\": [\n \"string\"\n ]\n}","csv":null},{"statusCode":"403","description":"FORBIDDEN","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"404","description":"NOT_FOUND","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"429","description":"MONTHLY_LIMIT_EXCEEDED","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\"\n}","csv":null},{"statusCode":"500","description":"INTERNAL_ERROR","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"503","description":"TEMPORARILY_UNAVAILABLE","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null}],"requestBodyParams":null},{"summary":"Retrieve Group Preferences","description":"Returns preferences for the specified group.","operationId":"getGroupPreferences","tags":["Groups"],"parameters":[{"name":"group_guid","description":"A GUID for a Bitly group","in":"path","required":true,"schema":{"type":"string"},"example":"Ba1bc23dE4F"}],"responses":{"200":{"description":"SUCCESS","content":{"application/json":{"schema":{"type":"object","properties":{"group_guid":{"type":"string"},"domain_preference":{"type":"string"}}}}}},"403":{"description":"FORBIDDEN","content":{"application/json":{"schema":{"description":"FORBIDDEN","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"404":{"description":"NOT_FOUND","content":{"application/json":{"schema":{"description":"NOT_FOUND","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"500":{"description":"INTERNAL_ERROR","content":{"application/json":{"schema":{"description":"INTERNAL_ERROR","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"503":{"description":"TEMPORARILY_UNAVAILABLE","content":{"application/json":{"schema":{"description":"TEMPORARILY_UNAVAILABLE","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}}},"method":"get","path":"/groups/{group_guid}/preferences","requestSamples":[{"name":"cURL","syntaxLanguage":"bash","sample":"curl \\\n-H 'Authorization: Bearer {TOKEN}' \\\n-X GET \\\nhttps://api-ssl.bitly.com/v4/groups/Ba1bc23dE4F/preferences","exampleName":"Default"},{"sample":"var fetch = require('node-fetch');\n\nfetch('https://api-ssl.bitly.com/v4/groups/Ba1bc23dE4F/preferences', {\n headers: {\n 'Authorization': 'Bearer {TOKEN}'\n }\n});\n","name":"Node","syntaxLanguage":"javascript","exampleName":"Default"},{"sample":"fetch('https://api-ssl.bitly.com/v4/groups/Ba1bc23dE4F/preferences', {\n headers: {\n 'Authorization': 'Bearer {TOKEN}'\n }\n});\n","name":"Browser","syntaxLanguage":"javascript","exampleName":"Default"},{"sample":"package main\n\nimport (\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\tclient := \u0026http.Client{}\n\treq, err := http.NewRequest(\"GET\", \"https://api-ssl.bitly.com/v4/groups/Ba1bc23dE4F/preferences\", nil)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\treq.Header.Set(\"Authorization\", \"Bearer {TOKEN}\")\n\tresp, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tdefer resp.Body.Close()\n\tbodyText, err := ioutil.ReadAll(resp.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tfmt.Printf(\"%s\\n\", bodyText)\n}\n","name":"Go","syntaxLanguage":"go","exampleName":"Default"},{"sample":"import requests\n\nheaders = {\n 'Authorization': 'Bearer {TOKEN}',\n}\n\nresponse = requests.get('https://api-ssl.bitly.com/v4/groups/Ba1bc23dE4F/preferences', headers=headers)\n","name":"Python","syntaxLanguage":"python","exampleName":"Default"}],"responseSamples":[{"statusCode":"200","description":"SUCCESS","json":"{\n \"group_guid\": \"string\",\n \"domain_preference\": \"string\"\n}","csv":null},{"statusCode":"403","description":"FORBIDDEN","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"404","description":"NOT_FOUND","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"500","description":"INTERNAL_ERROR","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"503","description":"TEMPORARILY_UNAVAILABLE","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null}],"requestBodyParams":null},{"summary":"Update Group Preferences","description":"Updates preferences for a group.","operationId":"updateGroupPreferences","tags":["Groups"],"parameters":[{"name":"group_guid","description":"A GUID for a Bitly group","in":"path","required":true,"schema":{"type":"string"},"example":"Ba1bc23dE4F"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"group_guid":{"type":"string"},"domain_preference":{"type":"string"}},"example":{"group_guid":"Ba1bc23dE4F","domain_preference":"chauncey.ly"}}}}},"responses":{"200":{"description":"SUCCESS","content":{"application/json":{"schema":{"type":"object","properties":{"group_guid":{"type":"string"},"domain_preference":{"type":"string"}}}}}},"400":{"description":"BAD_REQUEST","content":{"application/json":{"schema":{"description":"BAD_REQUEST","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"403":{"description":"FORBIDDEN","content":{"application/json":{"schema":{"description":"FORBIDDEN","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"404":{"description":"NOT_FOUND","content":{"application/json":{"schema":{"description":"NOT_FOUND","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"422":{"description":"UNPROCESSABLE_ENTITY","content":{"application/json":{"schema":{"description":"UNPROCESSABLE_ENTITY","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"429":{"description":"MONTHLY_LIMIT_EXCEEDED","content":{"application/json":{"schema":{"example":"API_USAGE_LIMIT_EXCEEDED","description":"MONTHLY_LIMIT_EXCEEDED","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"}}}]}}}},"500":{"description":"INTERNAL_ERROR","content":{"application/json":{"schema":{"description":"INTERNAL_ERROR","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"503":{"description":"TEMPORARILY_UNAVAILABLE","content":{"application/json":{"schema":{"description":"TEMPORARILY_UNAVAILABLE","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}}},"method":"patch","path":"/groups/{group_guid}/preferences","requestSamples":[{"name":"cURL","syntaxLanguage":"bash","sample":"curl \\\n-H 'Authorization: Bearer {TOKEN}' \\\n-H 'Content-Type: application/json' \\\n-X PATCH \\\n-d '{\n \"group_guid\": \"Ba1bc23dE4F\",\n \"domain_preference\": \"chauncey.ly\"\n}' \\\nhttps://api-ssl.bitly.com/v4/groups/Ba1bc23dE4F/preferences","exampleName":"Default"},{"sample":"var fetch = require('node-fetch');\n\nfetch('https://api-ssl.bitly.com/v4/groups/Ba1bc23dE4F/preferences', {\n method: 'PATCH',\n headers: {\n 'Authorization': 'Bearer {TOKEN}',\n 'Content-Type': 'application/json'\n },\n body: JSON.stringify({ \"group_guid\": \"Ba1bc23dE4F\", \"domain_preference\": \"chauncey.ly\" })\n});\n","name":"Node","syntaxLanguage":"javascript","exampleName":"Default"},{"sample":"fetch('https://api-ssl.bitly.com/v4/groups/Ba1bc23dE4F/preferences', {\n method: 'PATCH',\n headers: {\n 'Authorization': 'Bearer {TOKEN}',\n 'Content-Type': 'application/json'\n },\n body: JSON.stringify({ \"group_guid\": \"Ba1bc23dE4F\", \"domain_preference\": \"chauncey.ly\" })\n});\n","name":"Browser","syntaxLanguage":"javascript","exampleName":"Default"},{"sample":"package main\n\nimport (\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n\t\"strings\"\n)\n\nfunc main() {\n\tclient := \u0026http.Client{}\n\tvar data = strings.NewReader(`{ \"group_guid\": \"Ba1bc23dE4F\", \"domain_preference\": \"chauncey.ly\" }`)\n\treq, err := http.NewRequest(\"PATCH\", \"https://api-ssl.bitly.com/v4/groups/Ba1bc23dE4F/preferences\", data)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\treq.Header.Set(\"Authorization\", \"Bearer {TOKEN}\")\n\treq.Header.Set(\"Content-Type\", \"application/json\")\n\tresp, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tdefer resp.Body.Close()\n\tbodyText, err := ioutil.ReadAll(resp.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tfmt.Printf(\"%s\\n\", bodyText)\n}\n","name":"Go","syntaxLanguage":"go","exampleName":"Default"},{"sample":"import requests\n\nheaders = {\n 'Authorization': 'Bearer {TOKEN}',\n 'Content-Type': 'application/json',\n}\n\ndata = '{ \"group_guid\": \"Ba1bc23dE4F\", \"domain_preference\": \"chauncey.ly\" }'\n\nresponse = requests.patch('https://api-ssl.bitly.com/v4/groups/Ba1bc23dE4F/preferences', headers=headers, data=data)\n","name":"Python","syntaxLanguage":"python","exampleName":"Default"}],"responseSamples":[{"statusCode":"200","description":"SUCCESS","json":"{\n \"group_guid\": \"string\",\n \"domain_preference\": \"string\"\n}","csv":null},{"statusCode":"400","description":"BAD_REQUEST","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"403","description":"FORBIDDEN","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"404","description":"NOT_FOUND","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"422","description":"UNPROCESSABLE_ENTITY","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"429","description":"MONTHLY_LIMIT_EXCEEDED","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\"\n}","csv":null},{"statusCode":"500","description":"INTERNAL_ERROR","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"503","description":"TEMPORARILY_UNAVAILABLE","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null}],"requestBodyParams":[{"name":"group_guid","description":null,"required":null,"schema":{"type":"string","default":null,"enum":null},"items":null,"properties":null},{"name":"domain_preference","description":null,"required":null,"schema":{"type":"string","default":null,"enum":null},"items":null,"properties":null}]},{"summary":"Retrieve Group Shorten Counts","description":"Returns all the shorten counts for a group.","operationId":"getGroupShortenCounts","tags":["Groups"],"parameters":[{"name":"group_guid","description":"A GUID for a Bitly group","in":"path","required":true,"schema":{"type":"string"},"example":"Ba1bc23dE4F"},{"name":"unit","description":"A unit of time","schema":{"description":"the unit of time queried for (minute, hour, day, week, month)","type":"string","enum":["minute","hour","day","week","month"],"default":"day"},"required":true,"in":"query","example":"month"},{"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},{"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"}],"responses":{"200":{"description":"SUCCESS","content":{"application/json":{"schema":{"type":"object","allOf":[{"type":"object","properties":{"unit":{"type":"string","x-faker":"internet.userName"},"units":{"type":"integer","x-faker":{"datatype.number":{"min":1,"max":100}}},"facet":{"type":"string","enum":["countries","cities","devices","referrers","referrers_by_domain","referring_domains","referring_networks","shorten_counts"]},"unit_reference":{"type":"string","x-faker":"date.past"}}},{"properties":{"metrics":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"integer"}}}}}}]}}}},"403":{"description":"FORBIDDEN","content":{"application/json":{"schema":{"description":"FORBIDDEN","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"404":{"description":"NOT_FOUND","content":{"application/json":{"schema":{"description":"NOT_FOUND","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"429":{"description":"MONTHLY_LIMIT_EXCEEDED","content":{"application/json":{"schema":{"example":"API_USAGE_LIMIT_EXCEEDED","description":"MONTHLY_LIMIT_EXCEEDED","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"}}}]}}}},"500":{"description":"INTERNAL_ERROR","content":{"application/json":{"schema":{"description":"INTERNAL_ERROR","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"503":{"description":"TEMPORARILY_UNAVAILABLE","content":{"application/json":{"schema":{"description":"TEMPORARILY_UNAVAILABLE","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}}},"method":"get","path":"/groups/{group_guid}/shorten_counts","requestSamples":[{"name":"cURL","syntaxLanguage":"bash","sample":"curl \\\n-H 'Authorization: Bearer {TOKEN}' \\\n-X GET \\\nhttps://api-ssl.bitly.com/v4/groups/Ba1bc23dE4F/shorten_counts?unit=month\u0026units=1\u0026unit_reference=2006-01-02T15%3A04%3A05-0700","exampleName":"Default"},{"sample":"var fetch = require('node-fetch');\n\nfetch('https://api-ssl.bitly.com/v4/groups/Ba1bc23dE4F/shorten_counts?unit=month\u0026units=1\u0026unit_reference=2006-01-02T15%3A04%3A05-0700', {\n headers: {\n 'Authorization': 'Bearer {TOKEN}'\n }\n});\n","name":"Node","syntaxLanguage":"javascript","exampleName":"Default"},{"sample":"fetch('https://api-ssl.bitly.com/v4/groups/Ba1bc23dE4F/shorten_counts?unit=month\u0026units=1\u0026unit_reference=2006-01-02T15%3A04%3A05-0700', {\n headers: {\n 'Authorization': 'Bearer {TOKEN}'\n }\n});\n","name":"Browser","syntaxLanguage":"javascript","exampleName":"Default"},{"sample":"package main\n\nimport (\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\tclient := \u0026http.Client{}\n\treq, err := http.NewRequest(\"GET\", \"https://api-ssl.bitly.com/v4/groups/Ba1bc23dE4F/shorten_counts?unit=month\u0026units=1\u0026unit_reference=2006-01-02T15%3A04%3A05-0700\", nil)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\treq.Header.Set(\"Authorization\", \"Bearer {TOKEN}\")\n\tresp, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tdefer resp.Body.Close()\n\tbodyText, err := ioutil.ReadAll(resp.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tfmt.Printf(\"%s\\n\", bodyText)\n}\n","name":"Go","syntaxLanguage":"go","exampleName":"Default"},{"sample":"import requests\n\nheaders = {\n 'Authorization': 'Bearer {TOKEN}',\n}\n\nparams = (\n ('unit', 'month'),\n ('units', '1'),\n ('unit_reference', '2006-01-02T15:04:05-0700'),\n)\n\nresponse = requests.get('https://api-ssl.bitly.com/v4/groups/Ba1bc23dE4F/shorten_counts', headers=headers, params=params)\n\n#NB. Original query string below. It seems impossible to parse and\n#reproduce query strings 100% accurately so the one below is given\n#in case the reproduced version is not \"correct\".\n# response = requests.get('https://api-ssl.bitly.com/v4/groups/Ba1bc23dE4F/shorten_counts?unit=month\u0026units=1\u0026unit_reference=2006-01-02T15%3A04%3A05-0700', headers=headers)\n","name":"Python","syntaxLanguage":"python","exampleName":"Default"}],"responseSamples":[{"statusCode":"200","description":"SUCCESS","json":"{\n \"unit\": \"string\",\n \"units\": \"integer\",\n \"facet\": \"string\",\n \"unit_reference\": \"string\",\n \"metrics\": [\n {\n \"key\": \"string\",\n \"value\": \"integer\"\n }\n ]\n}","csv":null},{"statusCode":"403","description":"FORBIDDEN","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"404","description":"NOT_FOUND","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"429","description":"MONTHLY_LIMIT_EXCEEDED","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\"\n}","csv":null},{"statusCode":"500","description":"INTERNAL_ERROR","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"503","description":"TEMPORARILY_UNAVAILABLE","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null}],"requestBodyParams":null},{"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":[{"name":"group_guid","description":"A GUID for a Bitly group","in":"path","required":true,"schema":{"type":"string"},"example":"Ba1bc23dE4F"},{"name":"unit","description":"A unit of time","schema":{"description":"the unit of time queried for (minute, hour, day, week, month)","type":"string","enum":["minute","hour","day","week","month"],"default":"day"},"required":true,"in":"query","example":"month"},{"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},{"name":"size","description":"The quantity of items to be be returned","in":"query","schema":{"type":"integer","default":50},"example":10},{"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"}],"responses":{"200":{"description":"SUCCESS","content":{"application/json":{"schema":{"type":"object","allOf":[{"type":"object","properties":{"unit":{"type":"string","x-faker":"internet.userName"},"units":{"type":"integer","x-faker":{"datatype.number":{"min":1,"max":100}}},"facet":{"type":"string","enum":["countries","cities","devices","referrers","referrers_by_domain","referring_domains","referring_networks","shorten_counts"]},"unit_reference":{"type":"string","x-faker":"date.past"}}},{"properties":{"metrics":{"type":"array","items":{"type":"object","properties":{"clicks":{"type":"integer","example":123,"x-faker":"random.number"},"value":{"type":"string","example":"bit.ly","x-faker":"internet.domainName"}}}}}}]}},"text/csv":{"schema":{"type":"object","allOf":[{"type":"object","properties":{"unit":{"type":"string","x-faker":"internet.userName"},"units":{"type":"integer","x-faker":{"datatype.number":{"min":1,"max":100}}},"facet":{"type":"string","enum":["countries","cities","devices","referrers","referrers_by_domain","referring_domains","referring_networks","shorten_counts"]},"unit_reference":{"type":"string","x-faker":"date.past"}}},{"properties":{"metrics":{"type":"array","items":{"type":"object","properties":{"clicks":{"type":"integer","example":123,"x-faker":"random.number"},"value":{"type":"string","example":"bit.ly","x-faker":"internet.domainName"}}}}}}]},"example":"Country, Clicks\nUS, 5\n"}}},"403":{"description":"FORBIDDEN","content":{"application/json":{"schema":{"description":"FORBIDDEN","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"404":{"description":"NOT_FOUND","content":{"application/json":{"schema":{"description":"NOT_FOUND","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"429":{"description":"MONTHLY_LIMIT_EXCEEDED","content":{"application/json":{"schema":{"example":"API_USAGE_LIMIT_EXCEEDED","description":"MONTHLY_LIMIT_EXCEEDED","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"}}}]}}}},"500":{"description":"INTERNAL_ERROR","content":{"application/json":{"schema":{"description":"INTERNAL_ERROR","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"503":{"description":"TEMPORARILY_UNAVAILABLE","content":{"application/json":{"schema":{"description":"TEMPORARILY_UNAVAILABLE","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}}},"method":"get","path":"/groups/{group_guid}/countries","requestSamples":[{"name":"cURL","syntaxLanguage":"bash","sample":"curl \\\n-H 'Authorization: Bearer {TOKEN}' \\\n-X GET \\\nhttps://api-ssl.bitly.com/v4/groups/Ba1bc23dE4F/countries?unit=month\u0026units=1\u0026size=10\u0026unit_reference=2006-01-02T15%3A04%3A05-0700","exampleName":"Default"},{"sample":"var fetch = require('node-fetch');\n\nfetch('https://api-ssl.bitly.com/v4/groups/Ba1bc23dE4F/countries?unit=month\u0026units=1\u0026size=10\u0026unit_reference=2006-01-02T15%3A04%3A05-0700', {\n headers: {\n 'Authorization': 'Bearer {TOKEN}'\n }\n});\n","name":"Node","syntaxLanguage":"javascript","exampleName":"Default"},{"sample":"fetch('https://api-ssl.bitly.com/v4/groups/Ba1bc23dE4F/countries?unit=month\u0026units=1\u0026size=10\u0026unit_reference=2006-01-02T15%3A04%3A05-0700', {\n headers: {\n 'Authorization': 'Bearer {TOKEN}'\n }\n});\n","name":"Browser","syntaxLanguage":"javascript","exampleName":"Default"},{"sample":"package main\n\nimport (\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\tclient := \u0026http.Client{}\n\treq, err := http.NewRequest(\"GET\", \"https://api-ssl.bitly.com/v4/groups/Ba1bc23dE4F/countries?unit=month\u0026units=1\u0026size=10\u0026unit_reference=2006-01-02T15%3A04%3A05-0700\", nil)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\treq.Header.Set(\"Authorization\", \"Bearer {TOKEN}\")\n\tresp, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tdefer resp.Body.Close()\n\tbodyText, err := ioutil.ReadAll(resp.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tfmt.Printf(\"%s\\n\", bodyText)\n}\n","name":"Go","syntaxLanguage":"go","exampleName":"Default"},{"sample":"import requests\n\nheaders = {\n 'Authorization': 'Bearer {TOKEN}',\n}\n\nparams = (\n ('unit', 'month'),\n ('units', '1'),\n ('size', '10'),\n ('unit_reference', '2006-01-02T15:04:05-0700'),\n)\n\nresponse = requests.get('https://api-ssl.bitly.com/v4/groups/Ba1bc23dE4F/countries', headers=headers, params=params)\n\n#NB. Original query string below. It seems impossible to parse and\n#reproduce query strings 100% accurately so the one below is given\n#in case the reproduced version is not \"correct\".\n# response = requests.get('https://api-ssl.bitly.com/v4/groups/Ba1bc23dE4F/countries?unit=month\u0026units=1\u0026size=10\u0026unit_reference=2006-01-02T15%3A04%3A05-0700', headers=headers)\n","name":"Python","syntaxLanguage":"python","exampleName":"Default"}],"responseSamples":[{"statusCode":"200","description":"SUCCESS","json":"{\n \"unit\": \"string\",\n \"units\": \"integer\",\n \"facet\": \"string\",\n \"unit_reference\": \"string\",\n \"metrics\": [\n {\n \"clicks\": \"integer\",\n \"value\": \"string\"\n }\n ]\n}","csv":"Country, Clicks\nUS, 5\n"},{"statusCode":"403","description":"FORBIDDEN","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"404","description":"NOT_FOUND","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"429","description":"MONTHLY_LIMIT_EXCEEDED","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\"\n}","csv":null},{"statusCode":"500","description":"INTERNAL_ERROR","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"503","description":"TEMPORARILY_UNAVAILABLE","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null}],"requestBodyParams":null},{"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","tags":["Groups"],"parameters":[{"name":"group_guid","description":"A GUID for a Bitly group","in":"path","required":true,"schema":{"type":"string"},"example":"Ba1bc23dE4F"},{"name":"unit","description":"A unit of time","schema":{"description":"the unit of time queried for (minute, hour, day, week, month)","type":"string","enum":["minute","hour","day","week","month"],"default":"day"},"required":true,"in":"query","example":"month"},{"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},{"name":"size","description":"The quantity of items to be be returned","in":"query","schema":{"type":"integer","default":50},"example":10},{"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"}],"responses":{"200":{"description":"SUCCESS","content":{"application/json":{"schema":{"type":"object","allOf":[{"type":"object","properties":{"unit":{"type":"string","x-faker":"internet.userName"},"units":{"type":"integer","x-faker":{"datatype.number":{"min":1,"max":100}}},"facet":{"type":"string","enum":["countries","cities","devices","referrers","referrers_by_domain","referring_domains","referring_networks","shorten_counts"]},"unit_reference":{"type":"string","x-faker":"date.past"}}},{"properties":{"metrics":{"type":"array","items":{"type":"object","properties":{"clicks":{"type":"integer","x-faker":"random.number"},"city":{"type":"string","x-faker":"address.city"},"subregion":{"type":"string","x-faker":"address.state"},"region":{"type":"string","x-faker":"address.state"},"country":{"type":"string","x-faker":"address.country"}}}},"other_metrics":{"type":"object","properties":{"other_city_clicks":{"type":"integer","x-faker":"random.number"},"no_city_clicks":{"type":"integer","x-faker":"random.number"}}}}}]}},"text/csv":{"schema":{"type":"object","allOf":[{"type":"object","properties":{"unit":{"type":"string","x-faker":"internet.userName"},"units":{"type":"integer","x-faker":{"datatype.number":{"min":1,"max":100}}},"facet":{"type":"string","enum":["countries","cities","devices","referrers","referrers_by_domain","referring_domains","referring_networks","shorten_counts"]},"unit_reference":{"type":"string","x-faker":"date.past"}}},{"properties":{"metrics":{"type":"array","items":{"type":"object","properties":{"clicks":{"type":"integer","x-faker":"random.number"},"city":{"type":"string","x-faker":"address.city"},"subregion":{"type":"string","x-faker":"address.state"},"region":{"type":"string","x-faker":"address.state"},"country":{"type":"string","x-faker":"address.country"}}}},"other_metrics":{"type":"object","properties":{"other_city_clicks":{"type":"integer","x-faker":"random.number"},"no_city_clicks":{"type":"integer","x-faker":"random.number"}}}}}]},"example":"City, Subregion, Region, Country, Clicks\nNew York, , NY, US, 5\n"}}},"402":{"description":"UPGRADE_REQUIRED","content":{"application/json":{"schema":{"description":"UPGRADE_REQUIRED","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"403":{"description":"FORBIDDEN","content":{"application/json":{"schema":{"description":"FORBIDDEN","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"404":{"description":"NOT_FOUND","content":{"application/json":{"schema":{"description":"NOT_FOUND","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"429":{"description":"MONTHLY_LIMIT_EXCEEDED","content":{"application/json":{"schema":{"example":"API_USAGE_LIMIT_EXCEEDED","description":"MONTHLY_LIMIT_EXCEEDED","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"}}}]}}}},"500":{"description":"INTERNAL_ERROR","content":{"application/json":{"schema":{"description":"INTERNAL_ERROR","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"503":{"description":"TEMPORARILY_UNAVAILABLE","content":{"application/json":{"schema":{"description":"TEMPORARILY_UNAVAILABLE","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}}},"method":"get","path":"/groups/{group_guid}/cities","requestSamples":[{"name":"cURL","syntaxLanguage":"bash","sample":"curl \\\n-H 'Authorization: Bearer {TOKEN}' \\\n-X GET \\\nhttps://api-ssl.bitly.com/v4/groups/Ba1bc23dE4F/cities?unit=month\u0026units=1\u0026size=10\u0026unit_reference=2006-01-02T15%3A04%3A05-0700","exampleName":"Default"},{"sample":"var fetch = require('node-fetch');\n\nfetch('https://api-ssl.bitly.com/v4/groups/Ba1bc23dE4F/cities?unit=month\u0026units=1\u0026size=10\u0026unit_reference=2006-01-02T15%3A04%3A05-0700', {\n headers: {\n 'Authorization': 'Bearer {TOKEN}'\n }\n});\n","name":"Node","syntaxLanguage":"javascript","exampleName":"Default"},{"sample":"fetch('https://api-ssl.bitly.com/v4/groups/Ba1bc23dE4F/cities?unit=month\u0026units=1\u0026size=10\u0026unit_reference=2006-01-02T15%3A04%3A05-0700', {\n headers: {\n 'Authorization': 'Bearer {TOKEN}'\n }\n});\n","name":"Browser","syntaxLanguage":"javascript","exampleName":"Default"},{"sample":"package main\n\nimport (\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\tclient := \u0026http.Client{}\n\treq, err := http.NewRequest(\"GET\", \"https://api-ssl.bitly.com/v4/groups/Ba1bc23dE4F/cities?unit=month\u0026units=1\u0026size=10\u0026unit_reference=2006-01-02T15%3A04%3A05-0700\", nil)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\treq.Header.Set(\"Authorization\", \"Bearer {TOKEN}\")\n\tresp, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tdefer resp.Body.Close()\n\tbodyText, err := ioutil.ReadAll(resp.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tfmt.Printf(\"%s\\n\", bodyText)\n}\n","name":"Go","syntaxLanguage":"go","exampleName":"Default"},{"sample":"import requests\n\nheaders = {\n 'Authorization': 'Bearer {TOKEN}',\n}\n\nparams = (\n ('unit', 'month'),\n ('units', '1'),\n ('size', '10'),\n ('unit_reference', '2006-01-02T15:04:05-0700'),\n)\n\nresponse = requests.get('https://api-ssl.bitly.com/v4/groups/Ba1bc23dE4F/cities', headers=headers, params=params)\n\n#NB. Original query string below. It seems impossible to parse and\n#reproduce query strings 100% accurately so the one below is given\n#in case the reproduced version is not \"correct\".\n# response = requests.get('https://api-ssl.bitly.com/v4/groups/Ba1bc23dE4F/cities?unit=month\u0026units=1\u0026size=10\u0026unit_reference=2006-01-02T15%3A04%3A05-0700', headers=headers)\n","name":"Python","syntaxLanguage":"python","exampleName":"Default"}],"responseSamples":[{"statusCode":"200","description":"SUCCESS","json":"{\n \"unit\": \"string\",\n \"units\": \"integer\",\n \"facet\": \"string\",\n \"unit_reference\": \"string\",\n \"metrics\": [\n {\n \"clicks\": \"integer\",\n \"city\": \"string\",\n \"subregion\": \"string\",\n \"region\": \"string\",\n \"country\": \"string\"\n }\n ],\n \"other_metrics\": {\n \"other_city_clicks\": \"integer\",\n \"no_city_clicks\": \"integer\"\n }\n}","csv":"City, Subregion, Region, Country, Clicks\nNew York, , NY, US, 5\n"},{"statusCode":"402","description":"UPGRADE_REQUIRED","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"403","description":"FORBIDDEN","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"404","description":"NOT_FOUND","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"429","description":"MONTHLY_LIMIT_EXCEEDED","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\"\n}","csv":null},{"statusCode":"500","description":"INTERNAL_ERROR","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"503","description":"TEMPORARILY_UNAVAILABLE","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null}],"requestBodyParams":null},{"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","tags":["Groups"],"parameters":[{"name":"group_guid","description":"A GUID for a Bitly group","in":"path","required":true,"schema":{"type":"string"},"example":"Ba1bc23dE4F"},{"name":"unit","description":"A unit of time","schema":{"description":"the unit of time queried for (minute, hour, day, week, month)","type":"string","enum":["minute","hour","day","week","month"],"default":"day"},"required":true,"in":"query","example":"month"},{"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},{"name":"size","description":"The quantity of items to be be returned","in":"query","schema":{"type":"integer","default":50},"example":10},{"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"}],"responses":{"200":{"description":"SUCCESS","content":{"application/json":{"schema":{"type":"object","allOf":[{"type":"object","properties":{"unit":{"type":"string","x-faker":"internet.userName"},"units":{"type":"integer","x-faker":{"datatype.number":{"min":1,"max":100}}},"facet":{"type":"string","enum":["countries","cities","devices","referrers","referrers_by_domain","referring_domains","referring_networks","shorten_counts"]},"unit_reference":{"type":"string","x-faker":"date.past"}}},{"properties":{"metrics":{"type":"array","items":{"type":"object","properties":{"clicks":{"type":"integer"},"device_type":{"type":"string"}}}}}}]}},"text/csv":{"schema":{"type":"object","allOf":[{"type":"object","properties":{"unit":{"type":"string","x-faker":"internet.userName"},"units":{"type":"integer","x-faker":{"datatype.number":{"min":1,"max":100}}},"facet":{"type":"string","enum":["countries","cities","devices","referrers","referrers_by_domain","referring_domains","referring_networks","shorten_counts"]},"unit_reference":{"type":"string","x-faker":"date.past"}}},{"properties":{"metrics":{"type":"array","items":{"type":"object","properties":{"clicks":{"type":"integer"},"device_type":{"type":"string"}}}}}}]},"example":"Device Type, Clicks\nDesktop, 5\n"}}},"402":{"description":"UPGRADE_REQUIRED","content":{"application/json":{"schema":{"description":"UPGRADE_REQUIRED","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"403":{"description":"FORBIDDEN","content":{"application/json":{"schema":{"description":"FORBIDDEN","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"404":{"description":"NOT_FOUND","content":{"application/json":{"schema":{"description":"NOT_FOUND","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"429":{"description":"MONTHLY_LIMIT_EXCEEDED","content":{"application/json":{"schema":{"example":"API_USAGE_LIMIT_EXCEEDED","description":"MONTHLY_LIMIT_EXCEEDED","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"}}}]}}}},"500":{"description":"INTERNAL_ERROR","content":{"application/json":{"schema":{"description":"INTERNAL_ERROR","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"503":{"description":"TEMPORARILY_UNAVAILABLE","content":{"application/json":{"schema":{"description":"TEMPORARILY_UNAVAILABLE","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}}},"method":"get","path":"/groups/{group_guid}/devices","requestSamples":[{"name":"cURL","syntaxLanguage":"bash","sample":"curl \\\n-H 'Authorization: Bearer {TOKEN}' \\\n-X GET \\\nhttps://api-ssl.bitly.com/v4/groups/Ba1bc23dE4F/devices?unit=month\u0026units=1\u0026size=10\u0026unit_reference=2006-01-02T15%3A04%3A05-0700","exampleName":"Default"},{"sample":"var fetch = require('node-fetch');\n\nfetch('https://api-ssl.bitly.com/v4/groups/Ba1bc23dE4F/devices?unit=month\u0026units=1\u0026size=10\u0026unit_reference=2006-01-02T15%3A04%3A05-0700', {\n headers: {\n 'Authorization': 'Bearer {TOKEN}'\n }\n});\n","name":"Node","syntaxLanguage":"javascript","exampleName":"Default"},{"sample":"fetch('https://api-ssl.bitly.com/v4/groups/Ba1bc23dE4F/devices?unit=month\u0026units=1\u0026size=10\u0026unit_reference=2006-01-02T15%3A04%3A05-0700', {\n headers: {\n 'Authorization': 'Bearer {TOKEN}'\n }\n});\n","name":"Browser","syntaxLanguage":"javascript","exampleName":"Default"},{"sample":"package main\n\nimport (\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\tclient := \u0026http.Client{}\n\treq, err := http.NewRequest(\"GET\", \"https://api-ssl.bitly.com/v4/groups/Ba1bc23dE4F/devices?unit=month\u0026units=1\u0026size=10\u0026unit_reference=2006-01-02T15%3A04%3A05-0700\", nil)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\treq.Header.Set(\"Authorization\", \"Bearer {TOKEN}\")\n\tresp, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tdefer resp.Body.Close()\n\tbodyText, err := ioutil.ReadAll(resp.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tfmt.Printf(\"%s\\n\", bodyText)\n}\n","name":"Go","syntaxLanguage":"go","exampleName":"Default"},{"sample":"import requests\n\nheaders = {\n 'Authorization': 'Bearer {TOKEN}',\n}\n\nparams = (\n ('unit', 'month'),\n ('units', '1'),\n ('size', '10'),\n ('unit_reference', '2006-01-02T15:04:05-0700'),\n)\n\nresponse = requests.get('https://api-ssl.bitly.com/v4/groups/Ba1bc23dE4F/devices', headers=headers, params=params)\n\n#NB. Original query string below. It seems impossible to parse and\n#reproduce query strings 100% accurately so the one below is given\n#in case the reproduced version is not \"correct\".\n# response = requests.get('https://api-ssl.bitly.com/v4/groups/Ba1bc23dE4F/devices?unit=month\u0026units=1\u0026size=10\u0026unit_reference=2006-01-02T15%3A04%3A05-0700', headers=headers)\n","name":"Python","syntaxLanguage":"python","exampleName":"Default"}],"responseSamples":[{"statusCode":"200","description":"SUCCESS","json":"{\n \"unit\": \"string\",\n \"units\": \"integer\",\n \"facet\": \"string\",\n \"unit_reference\": \"string\",\n \"metrics\": [\n {\n \"clicks\": \"integer\",\n \"device_type\": \"string\"\n }\n ]\n}","csv":"Device Type, Clicks\nDesktop, 5\n"},{"statusCode":"402","description":"UPGRADE_REQUIRED","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"403","description":"FORBIDDEN","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"404","description":"NOT_FOUND","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"429","description":"MONTHLY_LIMIT_EXCEEDED","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\"\n}","csv":null},{"statusCode":"500","description":"INTERNAL_ERROR","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"503","description":"TEMPORARILY_UNAVAILABLE","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null}],"requestBodyParams":null},{"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":[{"name":"group_guid","description":"A GUID for a Bitly group","in":"path","required":true,"schema":{"type":"string"},"example":"Ba1bc23dE4F"},{"name":"unit","description":"A unit of time","schema":{"description":"the unit of time queried for (minute, hour, day, week, month)","type":"string","enum":["minute","hour","day","week","month"],"default":"day"},"required":true,"in":"query","example":"month"},{"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},{"name":"size","description":"The quantity of items to be be returned","in":"query","schema":{"type":"integer","default":50},"example":10},{"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"}],"responses":{"200":{"description":"SUCCESS","content":{"application/json":{"schema":{"type":"object","allOf":[{"type":"object","properties":{"unit":{"type":"string","x-faker":"internet.userName"},"units":{"type":"integer","x-faker":{"datatype.number":{"min":1,"max":100}}},"facet":{"type":"string","enum":["countries","cities","devices","referrers","referrers_by_domain","referring_domains","referring_networks","shorten_counts"]},"unit_reference":{"type":"string","x-faker":"date.past"}}},{"properties":{"metrics":{"type":"array","items":{"type":"object","properties":{"clicks":{"type":"integer","example":123,"x-faker":"random.number"},"value":{"type":"string","example":"bit.ly","x-faker":"internet.domainName"}}}}}}]}}}},"403":{"description":"FORBIDDEN","content":{"application/json":{"schema":{"description":"FORBIDDEN","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"404":{"description":"NOT_FOUND","content":{"application/json":{"schema":{"description":"NOT_FOUND","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"500":{"description":"INTERNAL_ERROR","content":{"application/json":{"schema":{"description":"INTERNAL_ERROR","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"503":{"description":"TEMPORARILY_UNAVAILABLE","content":{"application/json":{"schema":{"description":"TEMPORARILY_UNAVAILABLE","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}}},"method":"get","path":"/groups/{group_guid}/referring_networks","requestSamples":[{"name":"cURL","syntaxLanguage":"bash","sample":"curl \\\n-H 'Authorization: Bearer {TOKEN}' \\\n-X GET \\\nhttps://api-ssl.bitly.com/v4/groups/Ba1bc23dE4F/referring_networks?unit=month\u0026units=1\u0026size=10\u0026unit_reference=2006-01-02T15%3A04%3A05-0700","exampleName":"Default"},{"sample":"var fetch = require('node-fetch');\n\nfetch('https://api-ssl.bitly.com/v4/groups/Ba1bc23dE4F/referring_networks?unit=month\u0026units=1\u0026size=10\u0026unit_reference=2006-01-02T15%3A04%3A05-0700', {\n headers: {\n 'Authorization': 'Bearer {TOKEN}'\n }\n});\n","name":"Node","syntaxLanguage":"javascript","exampleName":"Default"},{"sample":"fetch('https://api-ssl.bitly.com/v4/groups/Ba1bc23dE4F/referring_networks?unit=month\u0026units=1\u0026size=10\u0026unit_reference=2006-01-02T15%3A04%3A05-0700', {\n headers: {\n 'Authorization': 'Bearer {TOKEN}'\n }\n});\n","name":"Browser","syntaxLanguage":"javascript","exampleName":"Default"},{"sample":"package main\n\nimport (\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\tclient := \u0026http.Client{}\n\treq, err := http.NewRequest(\"GET\", \"https://api-ssl.bitly.com/v4/groups/Ba1bc23dE4F/referring_networks?unit=month\u0026units=1\u0026size=10\u0026unit_reference=2006-01-02T15%3A04%3A05-0700\", nil)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\treq.Header.Set(\"Authorization\", \"Bearer {TOKEN}\")\n\tresp, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tdefer resp.Body.Close()\n\tbodyText, err := ioutil.ReadAll(resp.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tfmt.Printf(\"%s\\n\", bodyText)\n}\n","name":"Go","syntaxLanguage":"go","exampleName":"Default"},{"sample":"import requests\n\nheaders = {\n 'Authorization': 'Bearer {TOKEN}',\n}\n\nparams = (\n ('unit', 'month'),\n ('units', '1'),\n ('size', '10'),\n ('unit_reference', '2006-01-02T15:04:05-0700'),\n)\n\nresponse = requests.get('https://api-ssl.bitly.com/v4/groups/Ba1bc23dE4F/referring_networks', headers=headers, params=params)\n\n#NB. Original query string below. It seems impossible to parse and\n#reproduce query strings 100% accurately so the one below is given\n#in case the reproduced version is not \"correct\".\n# response = requests.get('https://api-ssl.bitly.com/v4/groups/Ba1bc23dE4F/referring_networks?unit=month\u0026units=1\u0026size=10\u0026unit_reference=2006-01-02T15%3A04%3A05-0700', headers=headers)\n","name":"Python","syntaxLanguage":"python","exampleName":"Default"}],"responseSamples":[{"statusCode":"200","description":"SUCCESS","json":"{\n \"unit\": \"string\",\n \"units\": \"integer\",\n \"facet\": \"string\",\n \"unit_reference\": \"string\",\n \"metrics\": [\n {\n \"clicks\": \"integer\",\n \"value\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"403","description":"FORBIDDEN","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"404","description":"NOT_FOUND","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"500","description":"INTERNAL_ERROR","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"503","description":"TEMPORARILY_UNAVAILABLE","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null}],"requestBodyParams":null},{"summary":"Get Click Metrics for a Group by Referrer","description":"Returns metrics by referrer for the specified group's links.","operationId":"GetGroupMetricsByReferrer","tags":["Groups"],"parameters":[{"name":"group_guid","description":"A GUID for a Bitly group","in":"path","required":true,"schema":{"type":"string"},"example":"Ba1bc23dE4F"},{"name":"unit","description":"A unit of time","schema":{"description":"the unit of time queried for (minute, hour, day, week, month)","type":"string","enum":["minute","hour","day","week","month"],"default":"day"},"required":true,"in":"query","example":"month"},{"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},{"name":"size","description":"The quantity of items to be be returned","in":"query","schema":{"type":"integer","default":50},"example":10},{"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"}],"responses":{"200":{"description":"SUCCESS","content":{"application/json":{"schema":{"type":"object","allOf":[{"type":"object","properties":{"unit":{"type":"string","x-faker":"internet.userName"},"units":{"type":"integer","x-faker":{"datatype.number":{"min":1,"max":100}}},"facet":{"type":"string","enum":["countries","cities","devices","referrers","referrers_by_domain","referring_domains","referring_networks","shorten_counts"]},"unit_reference":{"type":"string","x-faker":"date.past"}}},{"properties":{"metrics":{"type":"array","items":{"type":"object","properties":{"clicks":{"type":"integer","example":123,"x-faker":"random.number"},"value":{"type":"string","example":"bit.ly","x-faker":"internet.domainName"}}}}}}]}},"text/csv":{"schema":{"type":"object","allOf":[{"type":"object","properties":{"unit":{"type":"string","x-faker":"internet.userName"},"units":{"type":"integer","x-faker":{"datatype.number":{"min":1,"max":100}}},"facet":{"type":"string","enum":["countries","cities","devices","referrers","referrers_by_domain","referring_domains","referring_networks","shorten_counts"]},"unit_reference":{"type":"string","x-faker":"date.past"}}},{"properties":{"metrics":{"type":"array","items":{"type":"object","properties":{"clicks":{"type":"integer","example":123,"x-faker":"random.number"},"value":{"type":"string","example":"bit.ly","x-faker":"internet.domainName"}}}}}}]},"example":"Referrer,Clicks\ndirect,25\n"}}},"403":{"description":"FORBIDDEN","content":{"application/json":{"schema":{"description":"FORBIDDEN","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"404":{"description":"NOT_FOUND","content":{"application/json":{"schema":{"description":"NOT_FOUND","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"429":{"description":"MONTHLY_LIMIT_EXCEEDED","content":{"application/json":{"schema":{"example":"API_USAGE_LIMIT_EXCEEDED","description":"MONTHLY_LIMIT_EXCEEDED","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"}}}]}}}},"500":{"description":"INTERNAL_ERROR","content":{"application/json":{"schema":{"description":"INTERNAL_ERROR","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"503":{"description":"TEMPORARILY_UNAVAILABLE","content":{"application/json":{"schema":{"description":"TEMPORARILY_UNAVAILABLE","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}}},"method":"get","path":"/groups/{group_guid}/referrers","requestSamples":[{"name":"cURL","syntaxLanguage":"bash","sample":"curl \\\n-H 'Authorization: Bearer {TOKEN}' \\\n-X GET \\\nhttps://api-ssl.bitly.com/v4/groups/Ba1bc23dE4F/referrers?unit=month\u0026units=1\u0026size=10\u0026unit_reference=2006-01-02T15%3A04%3A05-0700","exampleName":"Default"},{"sample":"var fetch = require('node-fetch');\n\nfetch('https://api-ssl.bitly.com/v4/groups/Ba1bc23dE4F/referrers?unit=month\u0026units=1\u0026size=10\u0026unit_reference=2006-01-02T15%3A04%3A05-0700', {\n headers: {\n 'Authorization': 'Bearer {TOKEN}'\n }\n});\n","name":"Node","syntaxLanguage":"javascript","exampleName":"Default"},{"sample":"fetch('https://api-ssl.bitly.com/v4/groups/Ba1bc23dE4F/referrers?unit=month\u0026units=1\u0026size=10\u0026unit_reference=2006-01-02T15%3A04%3A05-0700', {\n headers: {\n 'Authorization': 'Bearer {TOKEN}'\n }\n});\n","name":"Browser","syntaxLanguage":"javascript","exampleName":"Default"},{"sample":"package main\n\nimport (\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\tclient := \u0026http.Client{}\n\treq, err := http.NewRequest(\"GET\", \"https://api-ssl.bitly.com/v4/groups/Ba1bc23dE4F/referrers?unit=month\u0026units=1\u0026size=10\u0026unit_reference=2006-01-02T15%3A04%3A05-0700\", nil)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\treq.Header.Set(\"Authorization\", \"Bearer {TOKEN}\")\n\tresp, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tdefer resp.Body.Close()\n\tbodyText, err := ioutil.ReadAll(resp.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tfmt.Printf(\"%s\\n\", bodyText)\n}\n","name":"Go","syntaxLanguage":"go","exampleName":"Default"},{"sample":"import requests\n\nheaders = {\n 'Authorization': 'Bearer {TOKEN}',\n}\n\nparams = (\n ('unit', 'month'),\n ('units', '1'),\n ('size', '10'),\n ('unit_reference', '2006-01-02T15:04:05-0700'),\n)\n\nresponse = requests.get('https://api-ssl.bitly.com/v4/groups/Ba1bc23dE4F/referrers', headers=headers, params=params)\n\n#NB. Original query string below. It seems impossible to parse and\n#reproduce query strings 100% accurately so the one below is given\n#in case the reproduced version is not \"correct\".\n# response = requests.get('https://api-ssl.bitly.com/v4/groups/Ba1bc23dE4F/referrers?unit=month\u0026units=1\u0026size=10\u0026unit_reference=2006-01-02T15%3A04%3A05-0700', headers=headers)\n","name":"Python","syntaxLanguage":"python","exampleName":"Default"}],"responseSamples":[{"statusCode":"200","description":"SUCCESS","json":"{\n \"unit\": \"string\",\n \"units\": \"integer\",\n \"facet\": \"string\",\n \"unit_reference\": \"string\",\n \"metrics\": [\n {\n \"clicks\": \"integer\",\n \"value\": \"string\"\n }\n ]\n}","csv":"Referrer,Clicks\ndirect,25\n"},{"statusCode":"403","description":"FORBIDDEN","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"404","description":"NOT_FOUND","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"429","description":"MONTHLY_LIMIT_EXCEEDED","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\"\n}","csv":null},{"statusCode":"500","description":"INTERNAL_ERROR","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"503","description":"TEMPORARILY_UNAVAILABLE","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null}],"requestBodyParams":null},{"operationId":"getGroupClicks","tags":["Groups"],"description":"get number of clicks on bitlinks in a group","summary":"Get clicks by group","parameters":[{"name":"group_guid","description":"A GUID for a Bitly group","in":"path","required":true,"schema":{"type":"string"},"example":"Ba1bc23dE4F"},{"name":"unit","description":"A unit of time","schema":{"description":"the unit of time queried for (minute, hour, day, week, month)","type":"string","enum":["minute","hour","day","week","month"],"default":"day"},"required":true,"in":"query","example":"month"},{"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},{"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"}],"responses":{"200":{"description":"SUCCESS","content":{"application/json":{"schema":{"type":"object","properties":{"unit":{"type":"string"},"units":{"type":"integer"},"unit_reference":{"type":"string"},"data":{"type":"array","items":{"type":"object","properties":{"ts":{"type":"string"},"count":{"type":"integer"}}}}}}}}},"400":{"description":"BAD_REQUEST","content":{"application/json":{"schema":{"description":"BAD_REQUEST","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"402":{"description":"UPGRADE_REQUIRED","content":{"application/json":{"schema":{"description":"UPGRADE_REQUIRED","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"403":{"description":"FORBIDDEN","content":{"application/json":{"schema":{"description":"FORBIDDEN","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"429":{"description":"MONTHLY_LIMIT_EXCEEDED","content":{"application/json":{"schema":{"example":"API_USAGE_LIMIT_EXCEEDED","description":"MONTHLY_LIMIT_EXCEEDED","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"}}}]}}}},"500":{"description":"INTERNAL_ERROR","content":{"application/json":{"schema":{"description":"INTERNAL_ERROR","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"503":{"description":"TEMPORARILY_UNAVAILABLE","content":{"application/json":{"schema":{"description":"TEMPORARILY_UNAVAILABLE","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}}},"method":"get","path":"/groups/{group_guid}/clicks","requestSamples":[{"name":"cURL","syntaxLanguage":"bash","sample":"curl \\\n-H 'Authorization: Bearer {TOKEN}' \\\n-X GET \\\nhttps://api-ssl.bitly.com/v4/groups/Ba1bc23dE4F/clicks?unit=month\u0026units=1\u0026unit_reference=2006-01-02T15%3A04%3A05-0700","exampleName":"Default"},{"sample":"var fetch = require('node-fetch');\n\nfetch('https://api-ssl.bitly.com/v4/groups/Ba1bc23dE4F/clicks?unit=month\u0026units=1\u0026unit_reference=2006-01-02T15%3A04%3A05-0700', {\n headers: {\n 'Authorization': 'Bearer {TOKEN}'\n }\n});\n","name":"Node","syntaxLanguage":"javascript","exampleName":"Default"},{"sample":"fetch('https://api-ssl.bitly.com/v4/groups/Ba1bc23dE4F/clicks?unit=month\u0026units=1\u0026unit_reference=2006-01-02T15%3A04%3A05-0700', {\n headers: {\n 'Authorization': 'Bearer {TOKEN}'\n }\n});\n","name":"Browser","syntaxLanguage":"javascript","exampleName":"Default"},{"sample":"package main\n\nimport (\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\tclient := \u0026http.Client{}\n\treq, err := http.NewRequest(\"GET\", \"https://api-ssl.bitly.com/v4/groups/Ba1bc23dE4F/clicks?unit=month\u0026units=1\u0026unit_reference=2006-01-02T15%3A04%3A05-0700\", nil)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\treq.Header.Set(\"Authorization\", \"Bearer {TOKEN}\")\n\tresp, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tdefer resp.Body.Close()\n\tbodyText, err := ioutil.ReadAll(resp.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tfmt.Printf(\"%s\\n\", bodyText)\n}\n","name":"Go","syntaxLanguage":"go","exampleName":"Default"},{"sample":"import requests\n\nheaders = {\n 'Authorization': 'Bearer {TOKEN}',\n}\n\nparams = (\n ('unit', 'month'),\n ('units', '1'),\n ('unit_reference', '2006-01-02T15:04:05-0700'),\n)\n\nresponse = requests.get('https://api-ssl.bitly.com/v4/groups/Ba1bc23dE4F/clicks', headers=headers, params=params)\n\n#NB. Original query string below. It seems impossible to parse and\n#reproduce query strings 100% accurately so the one below is given\n#in case the reproduced version is not \"correct\".\n# response = requests.get('https://api-ssl.bitly.com/v4/groups/Ba1bc23dE4F/clicks?unit=month\u0026units=1\u0026unit_reference=2006-01-02T15%3A04%3A05-0700', headers=headers)\n","name":"Python","syntaxLanguage":"python","exampleName":"Default"}],"responseSamples":[{"statusCode":"200","description":"SUCCESS","json":"{\n \"unit\": \"string\",\n \"units\": \"integer\",\n \"unit_reference\": \"string\",\n \"data\": [\n {\n \"ts\": \"string\",\n \"count\": \"integer\"\n }\n ]\n}","csv":null},{"statusCode":"400","description":"BAD_REQUEST","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"402","description":"UPGRADE_REQUIRED","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"403","description":"FORBIDDEN","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"429","description":"MONTHLY_LIMIT_EXCEEDED","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\"\n}","csv":null},{"statusCode":"500","description":"INTERNAL_ERROR","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"503","description":"TEMPORARILY_UNAVAILABLE","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null}],"requestBodyParams":null},{"summary":"Get limit usage for a group","description":"Get a group's current feature limit usage, optionally provide limit name(s) for usage on specific limit(s)","operationId":"getGroupFeatureUsage","parameters":[{"name":"group_guid","description":"A GUID for a Bitly group","in":"path","required":true,"schema":{"type":"string"},"example":"Ba1bc23dE4F"},{"name":"name","description":"The limit name you would like usage for","in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true,"example":["qr_codes"]}],"tags":["Groups"],"responses":{"200":{"description":"SUCCESS","content":{"application/json":{"schema":{"type":"object","required":["group_guid","limit_usage"],"properties":{"group_guid":{"type":"string","description":"the group's guid"},"limit_usage":{"type":"array","description":"an array of all of the group's consumable feature usage","items":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"count":{"type":"integer"}}}}}}}}},"400":{"description":"BAD_REQUEST","content":{"application/json":{"schema":{"description":"BAD_REQUEST","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"403":{"description":"FORBIDDEN","content":{"application/json":{"schema":{"description":"FORBIDDEN","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"429":{"description":"MONTHLY_LIMIT_EXCEEDED","content":{"application/json":{"schema":{"example":"API_USAGE_LIMIT_EXCEEDED","description":"MONTHLY_LIMIT_EXCEEDED","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"}}}]}}}},"500":{"description":"INTERNAL_ERROR","content":{"application/json":{"schema":{"description":"INTERNAL_ERROR","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}}},"method":"get","path":"/groups/{group_guid}/feature_usage","requestSamples":[{"name":"cURL","syntaxLanguage":"bash","sample":"curl \\\n-H 'Authorization: Bearer {TOKEN}' \\\n-X GET \\\nhttps://api-ssl.bitly.com/v4/groups/Ba1bc23dE4F/feature_usage?name=qr_codes","exampleName":"Default"},{"sample":"var fetch = require('node-fetch');\n\nfetch('https://api-ssl.bitly.com/v4/groups/Ba1bc23dE4F/feature_usage?name=qr_codes', {\n headers: {\n 'Authorization': 'Bearer {TOKEN}'\n }\n});\n","name":"Node","syntaxLanguage":"javascript","exampleName":"Default"},{"sample":"fetch('https://api-ssl.bitly.com/v4/groups/Ba1bc23dE4F/feature_usage?name=qr_codes', {\n headers: {\n 'Authorization': 'Bearer {TOKEN}'\n }\n});\n","name":"Browser","syntaxLanguage":"javascript","exampleName":"Default"},{"sample":"package main\n\nimport (\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\tclient := \u0026http.Client{}\n\treq, err := http.NewRequest(\"GET\", \"https://api-ssl.bitly.com/v4/groups/Ba1bc23dE4F/feature_usage?name=qr_codes\", nil)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\treq.Header.Set(\"Authorization\", \"Bearer {TOKEN}\")\n\tresp, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tdefer resp.Body.Close()\n\tbodyText, err := ioutil.ReadAll(resp.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tfmt.Printf(\"%s\\n\", bodyText)\n}\n","name":"Go","syntaxLanguage":"go","exampleName":"Default"},{"sample":"import requests\n\nheaders = {\n 'Authorization': 'Bearer {TOKEN}',\n}\n\nparams = (\n ('name', 'qr_codes'),\n)\n\nresponse = requests.get('https://api-ssl.bitly.com/v4/groups/Ba1bc23dE4F/feature_usage', headers=headers, params=params)\n\n#NB. Original query string below. It seems impossible to parse and\n#reproduce query strings 100% accurately so the one below is given\n#in case the reproduced version is not \"correct\".\n# response = requests.get('https://api-ssl.bitly.com/v4/groups/Ba1bc23dE4F/feature_usage?name=qr_codes', headers=headers)\n","name":"Python","syntaxLanguage":"python","exampleName":"Default"}],"responseSamples":[{"statusCode":"200","description":"SUCCESS","json":"{\n \"group_guid\": \"string\",\n \"limit_usage\": [\n {\n \"name\": \"string\",\n \"description\": \"string\",\n \"count\": \"integer\"\n }\n ]\n}","csv":null},{"statusCode":"400","description":"BAD_REQUEST","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"403","description":"FORBIDDEN","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"429","description":"MONTHLY_LIMIT_EXCEEDED","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\"\n}","csv":null},{"statusCode":"500","description":"INTERNAL_ERROR","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null}],"requestBodyParams":null},{"summary":"Get historical usage for a group","description":"Get a group's historical usage for specific limit(s) and date range. Refer to GET /v4/groups/{group_guid}/feature_usage endpoint response for available limit names.","operationId":"getGroupHistoricalUsage","parameters":[{"name":"group_guid","description":"A GUID for a Bitly group","in":"path","required":true,"schema":{"type":"string"},"example":"Ba1bc23dE4F"},{"name":"name","description":"The limit name you would like usage for","in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true,"example":["qr_codes"]},{"name":"start_date","description":"The start date for the date range","in":"query","schema":{"type":"string"},"example":"2022-02-02"},{"name":"end_date","description":"The end date for the date range","in":"query","schema":{"type":"string"},"example":"2023-10-04"},{"name":"unit","description":"A unit of time (day, week, or month)","schema":{"description":"the unit of time queried for (day, week, month)","type":"string","enum":["day","week","month"],"default":"month"},"in":"query","example":"month"}],"tags":["Groups"],"responses":{"200":{"description":"SUCCESS","content":{"application/json":{"schema":{"type":"object","required":["group_guid","unit","start_date","end_date","historical_limit_usage"],"properties":{"group_guid":{"type":"string","description":"the group's guid"},"unit":{"type":"string","description":"A unit of time (day, week, or month)"},"start_date":{"type":"string","description":"Start date (format \"2006-01-02\") of the historical usage"},"end_date":{"type":"string","description":"End date (format \"2006-01-02\") of the historical usage"},"historical_limit_usage":{"type":"array","description":"an array of all of the group's historical feature usage","items":{"type":"object","properties":{"name":{"type":"string","description":"feature name"},"usage":{"type":"array","items":{"type":"object","properties":{"count":{"type":"integer","description":"the usage count during the time period"},"unit_start":{"type":"string","description":"ISO_TIMESTAMP of the beginning of the time period"}}}}}}}}}}}},"400":{"description":"BAD_REQUEST","content":{"application/json":{"schema":{"description":"BAD_REQUEST","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"403":{"description":"FORBIDDEN","content":{"application/json":{"schema":{"description":"FORBIDDEN","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"429":{"description":"MONTHLY_LIMIT_EXCEEDED","content":{"application/json":{"schema":{"example":"API_USAGE_LIMIT_EXCEEDED","description":"MONTHLY_LIMIT_EXCEEDED","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"}}}]}}}},"500":{"description":"INTERNAL_ERROR","content":{"application/json":{"schema":{"description":"INTERNAL_ERROR","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}}},"method":"get","path":"/groups/{group_guid}/historical_usage","requestSamples":[{"name":"cURL","syntaxLanguage":"bash","sample":"curl \\\n-H 'Authorization: Bearer {TOKEN}' \\\n-X GET \\\nhttps://api-ssl.bitly.com/v4/groups/Ba1bc23dE4F/historical_usage?name=qr_codes\u0026start_date=2022-02-02\u0026end_date=2023-10-04\u0026unit=month","exampleName":"Default"},{"sample":"var fetch = require('node-fetch');\n\nfetch('https://api-ssl.bitly.com/v4/groups/Ba1bc23dE4F/historical_usage?name=qr_codes\u0026start_date=2022-02-02\u0026end_date=2023-10-04\u0026unit=month', {\n headers: {\n 'Authorization': 'Bearer {TOKEN}'\n }\n});\n","name":"Node","syntaxLanguage":"javascript","exampleName":"Default"},{"sample":"fetch('https://api-ssl.bitly.com/v4/groups/Ba1bc23dE4F/historical_usage?name=qr_codes\u0026start_date=2022-02-02\u0026end_date=2023-10-04\u0026unit=month', {\n headers: {\n 'Authorization': 'Bearer {TOKEN}'\n }\n});\n","name":"Browser","syntaxLanguage":"javascript","exampleName":"Default"},{"sample":"package main\n\nimport (\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\tclient := \u0026http.Client{}\n\treq, err := http.NewRequest(\"GET\", \"https://api-ssl.bitly.com/v4/groups/Ba1bc23dE4F/historical_usage?name=qr_codes\u0026start_date=2022-02-02\u0026end_date=2023-10-04\u0026unit=month\", nil)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\treq.Header.Set(\"Authorization\", \"Bearer {TOKEN}\")\n\tresp, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tdefer resp.Body.Close()\n\tbodyText, err := ioutil.ReadAll(resp.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tfmt.Printf(\"%s\\n\", bodyText)\n}\n","name":"Go","syntaxLanguage":"go","exampleName":"Default"},{"sample":"import requests\n\nheaders = {\n 'Authorization': 'Bearer {TOKEN}',\n}\n\nparams = (\n ('name', 'qr_codes'),\n ('start_date', '2022-02-02'),\n ('end_date', '2023-10-04'),\n ('unit', 'month'),\n)\n\nresponse = requests.get('https://api-ssl.bitly.com/v4/groups/Ba1bc23dE4F/historical_usage', headers=headers, params=params)\n\n#NB. Original query string below. It seems impossible to parse and\n#reproduce query strings 100% accurately so the one below is given\n#in case the reproduced version is not \"correct\".\n# response = requests.get('https://api-ssl.bitly.com/v4/groups/Ba1bc23dE4F/historical_usage?name=qr_codes\u0026start_date=2022-02-02\u0026end_date=2023-10-04\u0026unit=month', headers=headers)\n","name":"Python","syntaxLanguage":"python","exampleName":"Default"}],"responseSamples":[{"statusCode":"200","description":"SUCCESS","json":"{\n \"group_guid\": \"string\",\n \"unit\": \"string\",\n \"start_date\": \"string\",\n \"end_date\": \"string\",\n \"historical_limit_usage\": [\n {\n \"name\": \"string\",\n \"usage\": [\n {\n \"count\": \"integer\",\n \"unit_start\": \"string\"\n }\n ]\n }\n ]\n}","csv":null},{"statusCode":"400","description":"BAD_REQUEST","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"403","description":"FORBIDDEN","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"429","description":"MONTHLY_LIMIT_EXCEEDED","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\"\n}","csv":null},{"statusCode":"500","description":"INTERNAL_ERROR","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null}],"requestBodyParams":null}]},{"name":"Organizations","description":"Organizations are equivalent to a Bitly account. Every plan limit, group, and user is tied to an organization.\n","methods":[{"summary":"Retrieve Organizations","description":"Retrieve a list of organizations.","tags":["Organizations"],"operationId":"getOrganizations","responses":{"200":{"description":"SUCCESS","content":{"application/json":{"schema":{"type":"object","required":["organizations"],"properties":{"organizations":{"type":"array","items":{"type":"object","required":["guid","name","is_active","tier","tier_family","tier_display_name","role","created","modified","bsds"],"allOf":[{"type":"object","properties":{"references":{"type":"object","additionalProperties":{"type":"string"}}}},{"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"}}}}]}}}}}}},"403":{"description":"FORBIDDEN","content":{"application/json":{"schema":{"description":"FORBIDDEN","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"404":{"description":"NOT_FOUND","content":{"application/json":{"schema":{"description":"NOT_FOUND","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"500":{"description":"INTERNAL_ERROR","content":{"application/json":{"schema":{"description":"INTERNAL_ERROR","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"503":{"description":"TEMPORARILY_UNAVAILABLE","content":{"application/json":{"schema":{"description":"TEMPORARILY_UNAVAILABLE","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}}},"method":"get","path":"/organizations","requestSamples":[{"name":"cURL","syntaxLanguage":"bash","sample":"curl \\\n-H 'Authorization: Bearer {TOKEN}' \\\n-X GET \\\nhttps://api-ssl.bitly.com/v4/organizations","exampleName":"Default"},{"sample":"var fetch = require('node-fetch');\n\nfetch('https://api-ssl.bitly.com/v4/organizations', {\n headers: {\n 'Authorization': 'Bearer {TOKEN}'\n }\n});\n","name":"Node","syntaxLanguage":"javascript","exampleName":"Default"},{"sample":"fetch('https://api-ssl.bitly.com/v4/organizations', {\n headers: {\n 'Authorization': 'Bearer {TOKEN}'\n }\n});\n","name":"Browser","syntaxLanguage":"javascript","exampleName":"Default"},{"sample":"package main\n\nimport (\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\tclient := \u0026http.Client{}\n\treq, err := http.NewRequest(\"GET\", \"https://api-ssl.bitly.com/v4/organizations\", nil)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\treq.Header.Set(\"Authorization\", \"Bearer {TOKEN}\")\n\tresp, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tdefer resp.Body.Close()\n\tbodyText, err := ioutil.ReadAll(resp.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tfmt.Printf(\"%s\\n\", bodyText)\n}\n","name":"Go","syntaxLanguage":"go","exampleName":"Default"},{"sample":"import requests\n\nheaders = {\n 'Authorization': 'Bearer {TOKEN}',\n}\n\nresponse = requests.get('https://api-ssl.bitly.com/v4/organizations', headers=headers)\n","name":"Python","syntaxLanguage":"python","exampleName":"Default"}],"responseSamples":[{"statusCode":"200","description":"SUCCESS","json":"{\n \"organizations\": [\n {\n \"references\": { \"any\" },\n \"name\": \"string\",\n \"is_active\": \"boolean\",\n \"guid\": \"string\",\n \"tier\": \"string\",\n \"tier_family\": \"string\",\n \"tier_display_name\": \"string\",\n \"role\": \"string\",\n \"created\": \"string\",\n \"modified\": \"string\",\n \"bsds\": [\n \"string\"\n ]\n }\n ]\n}","csv":null},{"statusCode":"403","description":"FORBIDDEN","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"404","description":"NOT_FOUND","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"500","description":"INTERNAL_ERROR","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"503","description":"TEMPORARILY_UNAVAILABLE","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null}],"requestBodyParams":null},{"summary":"Retrieve an Organization","description":"Retrive details for the specified organization.","tags":["Organizations"],"operationId":"getOrganization","parameters":[{"name":"organization_guid","description":"A GUID for a Bitly organization","in":"path","required":true,"schema":{"type":"string"},"example":"Oa1bcd234eF"}],"responses":{"200":{"description":"SUCCESS","content":{"application/json":{"schema":{"type":"object","required":["guid","name","is_active","tier","tier_family","tier_display_name","role","created","modified","bsds"],"allOf":[{"type":"object","properties":{"references":{"type":"object","additionalProperties":{"type":"string"}}}},{"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"}}}}]}}}},"403":{"description":"FORBIDDEN","content":{"application/json":{"schema":{"description":"FORBIDDEN","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"404":{"description":"NOT_FOUND","content":{"application/json":{"schema":{"description":"NOT_FOUND","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"500":{"description":"INTERNAL_ERROR","content":{"application/json":{"schema":{"description":"INTERNAL_ERROR","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"503":{"description":"TEMPORARILY_UNAVAILABLE","content":{"application/json":{"schema":{"description":"TEMPORARILY_UNAVAILABLE","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}}},"method":"get","path":"/organizations/{organization_guid}","requestSamples":[{"name":"cURL","syntaxLanguage":"bash","sample":"curl \\\n-H 'Authorization: Bearer {TOKEN}' \\\n-X GET \\\nhttps://api-ssl.bitly.com/v4/organizations/Oa1bcd234eF","exampleName":"Default"},{"sample":"var fetch = require('node-fetch');\n\nfetch('https://api-ssl.bitly.com/v4/organizations/Oa1bcd234eF', {\n headers: {\n 'Authorization': 'Bearer {TOKEN}'\n }\n});\n","name":"Node","syntaxLanguage":"javascript","exampleName":"Default"},{"sample":"fetch('https://api-ssl.bitly.com/v4/organizations/Oa1bcd234eF', {\n headers: {\n 'Authorization': 'Bearer {TOKEN}'\n }\n});\n","name":"Browser","syntaxLanguage":"javascript","exampleName":"Default"},{"sample":"package main\n\nimport (\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\tclient := \u0026http.Client{}\n\treq, err := http.NewRequest(\"GET\", \"https://api-ssl.bitly.com/v4/organizations/Oa1bcd234eF\", nil)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\treq.Header.Set(\"Authorization\", \"Bearer {TOKEN}\")\n\tresp, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tdefer resp.Body.Close()\n\tbodyText, err := ioutil.ReadAll(resp.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tfmt.Printf(\"%s\\n\", bodyText)\n}\n","name":"Go","syntaxLanguage":"go","exampleName":"Default"},{"sample":"import requests\n\nheaders = {\n 'Authorization': 'Bearer {TOKEN}',\n}\n\nresponse = requests.get('https://api-ssl.bitly.com/v4/organizations/Oa1bcd234eF', headers=headers)\n","name":"Python","syntaxLanguage":"python","exampleName":"Default"}],"responseSamples":[{"statusCode":"200","description":"SUCCESS","json":"{\n \"references\": { \"any\" },\n \"name\": \"string\",\n \"is_active\": \"boolean\",\n \"guid\": \"string\",\n \"tier\": \"string\",\n \"tier_family\": \"string\",\n \"tier_display_name\": \"string\",\n \"role\": \"string\",\n \"created\": \"string\",\n \"modified\": \"string\",\n \"bsds\": [\n \"string\"\n ]\n}","csv":null},{"statusCode":"403","description":"FORBIDDEN","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"404","description":"NOT_FOUND","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"500","description":"INTERNAL_ERROR","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"503","description":"TEMPORARILY_UNAVAILABLE","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null}],"requestBodyParams":null},{"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":[{"name":"organization_guid","description":"A GUID for a Bitly organization","in":"path","required":true,"schema":{"type":"string"},"example":"Oa1bcd234eF"},{"name":"unit","description":"A unit of time","schema":{"description":"the unit of time queried for (minute, hour, day, week, month)","type":"string","enum":["minute","hour","day","week","month"],"default":"day"},"required":true,"in":"query","example":"month"},{"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},{"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"}],"responses":{"200":{"description":"SUCCESS","content":{"application/json":{"schema":{"type":"object","allOf":[{"type":"object","properties":{"unit":{"type":"string","x-faker":"internet.userName"},"units":{"type":"integer","x-faker":{"datatype.number":{"min":1,"max":100}}},"facet":{"type":"string","enum":["countries","cities","devices","referrers","referrers_by_domain","referring_domains","referring_networks","shorten_counts"]},"unit_reference":{"type":"string","x-faker":"date.past"}}},{"properties":{"metrics":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"integer"}}}}}}]}}}},"403":{"description":"FORBIDDEN","content":{"application/json":{"schema":{"description":"FORBIDDEN","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"404":{"description":"NOT_FOUND","content":{"application/json":{"schema":{"description":"NOT_FOUND","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"500":{"description":"INTERNAL_ERROR","content":{"application/json":{"schema":{"description":"INTERNAL_ERROR","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"503":{"description":"TEMPORARILY_UNAVAILABLE","content":{"application/json":{"schema":{"description":"TEMPORARILY_UNAVAILABLE","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}}},"method":"get","path":"/organizations/{organization_guid}/shorten_counts","requestSamples":[{"name":"cURL","syntaxLanguage":"bash","sample":"curl \\\n-H 'Authorization: Bearer {TOKEN}' \\\n-X GET \\\nhttps://api-ssl.bitly.com/v4/organizations/Oa1bcd234eF/shorten_counts?unit=month\u0026units=1\u0026unit_reference=2006-01-02T15%3A04%3A05-0700","exampleName":"Default"},{"sample":"var fetch = require('node-fetch');\n\nfetch('https://api-ssl.bitly.com/v4/organizations/Oa1bcd234eF/shorten_counts?unit=month\u0026units=1\u0026unit_reference=2006-01-02T15%3A04%3A05-0700', {\n headers: {\n 'Authorization': 'Bearer {TOKEN}'\n }\n});\n","name":"Node","syntaxLanguage":"javascript","exampleName":"Default"},{"sample":"fetch('https://api-ssl.bitly.com/v4/organizations/Oa1bcd234eF/shorten_counts?unit=month\u0026units=1\u0026unit_reference=2006-01-02T15%3A04%3A05-0700', {\n headers: {\n 'Authorization': 'Bearer {TOKEN}'\n }\n});\n","name":"Browser","syntaxLanguage":"javascript","exampleName":"Default"},{"sample":"package main\n\nimport (\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\tclient := \u0026http.Client{}\n\treq, err := http.NewRequest(\"GET\", \"https://api-ssl.bitly.com/v4/organizations/Oa1bcd234eF/shorten_counts?unit=month\u0026units=1\u0026unit_reference=2006-01-02T15%3A04%3A05-0700\", nil)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\treq.Header.Set(\"Authorization\", \"Bearer {TOKEN}\")\n\tresp, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tdefer resp.Body.Close()\n\tbodyText, err := ioutil.ReadAll(resp.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tfmt.Printf(\"%s\\n\", bodyText)\n}\n","name":"Go","syntaxLanguage":"go","exampleName":"Default"},{"sample":"import requests\n\nheaders = {\n 'Authorization': 'Bearer {TOKEN}',\n}\n\nparams = (\n ('unit', 'month'),\n ('units', '1'),\n ('unit_reference', '2006-01-02T15:04:05-0700'),\n)\n\nresponse = requests.get('https://api-ssl.bitly.com/v4/organizations/Oa1bcd234eF/shorten_counts', headers=headers, params=params)\n\n#NB. Original query string below. It seems impossible to parse and\n#reproduce query strings 100% accurately so the one below is given\n#in case the reproduced version is not \"correct\".\n# response = requests.get('https://api-ssl.bitly.com/v4/organizations/Oa1bcd234eF/shorten_counts?unit=month\u0026units=1\u0026unit_reference=2006-01-02T15%3A04%3A05-0700', headers=headers)\n","name":"Python","syntaxLanguage":"python","exampleName":"Default"}],"responseSamples":[{"statusCode":"200","description":"SUCCESS","json":"{\n \"unit\": \"string\",\n \"units\": \"integer\",\n \"facet\": \"string\",\n \"unit_reference\": \"string\",\n \"metrics\": [\n {\n \"key\": \"string\",\n \"value\": \"integer\"\n }\n ]\n}","csv":null},{"statusCode":"403","description":"FORBIDDEN","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"404","description":"NOT_FOUND","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"500","description":"INTERNAL_ERROR","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"503","description":"TEMPORARILY_UNAVAILABLE","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null}],"requestBodyParams":null},{"description":"Returns the shorten counts for a specific organization by group for the current month.","summary":"Get Shorten Counts for an Organization by Group","operationId":"getOrganizationShortenCountsByGroup","tags":["Organizations"],"parameters":[{"name":"organization_guid","description":"A GUID for a Bitly organization","in":"path","required":true,"schema":{"type":"string"},"example":"Oa1bcd234eF"}],"responses":{"200":{"description":"SUCCESS","content":{"application/json":{"schema":{"type":"object","allOf":[{"type":"object","properties":{"unit":{"type":"string","x-faker":"internet.userName"},"units":{"type":"integer","x-faker":{"datatype.number":{"min":1,"max":100}}},"facet":{"type":"string","enum":["countries","cities","devices","referrers","referrers_by_domain","referring_domains","referring_networks","shorten_counts"]},"unit_reference":{"type":"string","x-faker":"date.past"}}},{"properties":{"metrics":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"integer"}}}}}}]}}}},"403":{"description":"FORBIDDEN","content":{"application/json":{"schema":{"description":"FORBIDDEN","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"404":{"description":"NOT_FOUND","content":{"application/json":{"schema":{"description":"NOT_FOUND","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"500":{"description":"INTERNAL_ERROR","content":{"application/json":{"schema":{"description":"INTERNAL_ERROR","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"503":{"description":"TEMPORARILY_UNAVAILABLE","content":{"application/json":{"schema":{"description":"TEMPORARILY_UNAVAILABLE","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}}},"method":"get","path":"/organizations/{organization_guid}/shorten_counts_by_group","requestSamples":[{"name":"cURL","syntaxLanguage":"bash","sample":"curl \\\n-H 'Authorization: Bearer {TOKEN}' \\\n-X GET \\\nhttps://api-ssl.bitly.com/v4/organizations/Oa1bcd234eF/shorten_counts_by_group","exampleName":"Default"},{"sample":"var fetch = require('node-fetch');\n\nfetch('https://api-ssl.bitly.com/v4/organizations/Oa1bcd234eF/shorten_counts_by_group', {\n headers: {\n 'Authorization': 'Bearer {TOKEN}'\n }\n});\n","name":"Node","syntaxLanguage":"javascript","exampleName":"Default"},{"sample":"fetch('https://api-ssl.bitly.com/v4/organizations/Oa1bcd234eF/shorten_counts_by_group', {\n headers: {\n 'Authorization': 'Bearer {TOKEN}'\n }\n});\n","name":"Browser","syntaxLanguage":"javascript","exampleName":"Default"},{"sample":"package main\n\nimport (\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\tclient := \u0026http.Client{}\n\treq, err := http.NewRequest(\"GET\", \"https://api-ssl.bitly.com/v4/organizations/Oa1bcd234eF/shorten_counts_by_group\", nil)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\treq.Header.Set(\"Authorization\", \"Bearer {TOKEN}\")\n\tresp, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tdefer resp.Body.Close()\n\tbodyText, err := ioutil.ReadAll(resp.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tfmt.Printf(\"%s\\n\", bodyText)\n}\n","name":"Go","syntaxLanguage":"go","exampleName":"Default"},{"sample":"import requests\n\nheaders = {\n 'Authorization': 'Bearer {TOKEN}',\n}\n\nresponse = requests.get('https://api-ssl.bitly.com/v4/organizations/Oa1bcd234eF/shorten_counts_by_group', headers=headers)\n","name":"Python","syntaxLanguage":"python","exampleName":"Default"}],"responseSamples":[{"statusCode":"200","description":"SUCCESS","json":"{\n \"unit\": \"string\",\n \"units\": \"integer\",\n \"facet\": \"string\",\n \"unit_reference\": \"string\",\n \"metrics\": [\n {\n \"key\": \"string\",\n \"value\": \"integer\"\n }\n ]\n}","csv":null},{"statusCode":"403","description":"FORBIDDEN","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"404","description":"NOT_FOUND","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"500","description":"INTERNAL_ERROR","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"503","description":"TEMPORARILY_UNAVAILABLE","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null}],"requestBodyParams":null},{"summary":"Get Plan Limits","description":"Returns all plan limits and counts available for an organization.","operationId":"getPlanLimits","parameters":[{"name":"organization_guid","description":"A GUID for a Bitly organization","in":"path","required":true,"schema":{"type":"string"},"example":"Oa1bcd234eF"}],"tags":["Organizations"],"responses":{"200":{"description":"SUCCESS","content":{"application/json":{"schema":{"type":"object","allOf":[{"type":"object","properties":{"references":{"type":"object","additionalProperties":{"type":"string"}}}},{"properties":{"organization_guid":{"type":"string"},"plan_limits":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"limit":{"type":"integer"},"count":{"type":"integer"}}}}}}]}}}},"403":{"description":"FORBIDDEN","content":{"application/json":{"schema":{"description":"FORBIDDEN","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"500":{"description":"INTERNAL_ERROR","content":{"application/json":{"schema":{"description":"INTERNAL_ERROR","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"503":{"description":"TEMPORARILY_UNAVAILABLE","content":{"application/json":{"schema":{"description":"TEMPORARILY_UNAVAILABLE","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}}},"method":"get","path":"/organizations/{organization_guid}/plan_limits","requestSamples":[{"name":"cURL","syntaxLanguage":"bash","sample":"curl \\\n-H 'Authorization: Bearer {TOKEN}' \\\n-X GET \\\nhttps://api-ssl.bitly.com/v4/organizations/Oa1bcd234eF/plan_limits","exampleName":"Default"},{"sample":"var fetch = require('node-fetch');\n\nfetch('https://api-ssl.bitly.com/v4/organizations/Oa1bcd234eF/plan_limits', {\n headers: {\n 'Authorization': 'Bearer {TOKEN}'\n }\n});\n","name":"Node","syntaxLanguage":"javascript","exampleName":"Default"},{"sample":"fetch('https://api-ssl.bitly.com/v4/organizations/Oa1bcd234eF/plan_limits', {\n headers: {\n 'Authorization': 'Bearer {TOKEN}'\n }\n});\n","name":"Browser","syntaxLanguage":"javascript","exampleName":"Default"},{"sample":"package main\n\nimport (\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\tclient := \u0026http.Client{}\n\treq, err := http.NewRequest(\"GET\", \"https://api-ssl.bitly.com/v4/organizations/Oa1bcd234eF/plan_limits\", nil)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\treq.Header.Set(\"Authorization\", \"Bearer {TOKEN}\")\n\tresp, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tdefer resp.Body.Close()\n\tbodyText, err := ioutil.ReadAll(resp.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tfmt.Printf(\"%s\\n\", bodyText)\n}\n","name":"Go","syntaxLanguage":"go","exampleName":"Default"},{"sample":"import requests\n\nheaders = {\n 'Authorization': 'Bearer {TOKEN}',\n}\n\nresponse = requests.get('https://api-ssl.bitly.com/v4/organizations/Oa1bcd234eF/plan_limits', headers=headers)\n","name":"Python","syntaxLanguage":"python","exampleName":"Default"}],"responseSamples":[{"statusCode":"200","description":"SUCCESS","json":"{\n \"references\": { \"any\" },\n \"organization_guid\": \"string\",\n \"plan_limits\": [\n {\n \"name\": \"string\",\n \"description\": \"string\",\n \"limit\": \"integer\",\n \"count\": \"integer\"\n }\n ]\n}","csv":null},{"statusCode":"403","description":"FORBIDDEN","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"500","description":"INTERNAL_ERROR","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"503","description":"TEMPORARILY_UNAVAILABLE","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null}],"requestBodyParams":null}]},{"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","methods":[{"summary":"Create a QR Code","description":"Create a new QR Code and return its metadata","requestBody":{"required":true,"content":{"application/json":{"schema":{"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"}]}}},"description":"Customization and content values for a QR code created through the public API","type":"object","required":["group_guid","destination"],"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":{"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":{"type":"string","enum":["standard","circle","block","blob","rounded","vertical","horizontal","triangle","heart","star","diamond"],"default":"standard"},"corners":{"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":{"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"}}},"corner_2":{"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"}}},"corner_3":{"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"}}}}},"gradient":{"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":{"type":"object","properties":{"color":{"description":"A color in hexadecimal format to be used in one of the gradient's \u003cstop\u003e 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}}}},"exclude_corners":{"description":"Ignore gradient mask on corners","type":"boolean"}}},"background_gradient":{"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":{"type":"object","properties":{"color":{"description":"A color in hexadecimal format to be used in one of the gradient's \u003cstop\u003e 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}}}},"exclude_corners":{"description":"Ignore gradient mask on corners","type":"boolean"}}},"logo":{"type":"object","properties":{"image_guid":{"type":"string","description":"A GUID for an image uploaded to Bitly"}}},"frame":{"type":"object","required":["id"],"properties":{"id":{"description":"The unique id of the selected frame","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"},"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":{"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"}}},"secondary":{"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"}}}}}}},"text":{"description":"Contains the center, top, and bottom text to be used in the QR code","type":"object","properties":{"center":{"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"}}},"top":{"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"}}},"bottom":{"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"}}}},"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"}}},"branding":{"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"}}},"spec_settings":{"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"}}}}},"archived":{"description":"A boolean representing if the QR code should be archived (hidden from the UI) upon creation","type":"boolean"},"destination":{"type":"object","properties":{"bitlink_id":{"type":"string"},"long_url":{"type":"string"},"site_id":{"type":"string"}}},"gs1":{"description":"Contains GS1 related metadata","type":"object","properties":{"values":{"description":"A list of GS1 application identifiers and their values","type":"array","items":{"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."}}}}}}}}}}},"operationId":"createQRCodePublic","tags":["QR Codes"],"responses":{"201":{"description":"CREATED","content":{"application/json":{"schema":{"type":"object","properties":{"qrcode_id":{"type":"string"},"group_guid":{"type":"string"},"title":{"type":"string"},"is_customized":{"description":"Set to true if the QR code's customization values have been changed from their default setting","type":"boolean"},"serialized_content":{"description":"A serialized string of the QR code's content","type":"string"},"qr_code_type":{"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"]},"long_urls":{"description":"A list of destination URLs that the qr code leads to.","type":"array","items":{"type":"string"}},"bitlink_id":{"description":"The bitlink ID associated with the qr code. Not all qr codes are associated with one.","type":"string"},"is_gs1":{"description":"Set to true if QR code has GS1 values.","type":"boolean"},"created_by":{"description":"User that created the code.","type":"string"},"archived":{"type":"boolean"},"created":{"type":"string"},"modified":{"type":"string"}}}}}},"400":{"description":"BAD_REQUEST","content":{"application/json":{"schema":{"description":"BAD_REQUEST","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"402":{"description":"UPGRADE_REQUIRED","content":{"application/json":{"schema":{"description":"UPGRADE_REQUIRED","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"403":{"description":"FORBIDDEN","content":{"application/json":{"schema":{"description":"FORBIDDEN","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"404":{"description":"NOT_FOUND","content":{"application/json":{"schema":{"description":"NOT_FOUND","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"410":{"description":"GONE","content":{"application/json":{"schema":{"description":"GONE","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"429":{"description":"MONTHLY_LIMIT_EXCEEDED","content":{"application/json":{"schema":{"example":"BRANDED_LINK_MONTHLY_LIMIT_EXCEEDED","description":"MONTHLY_LIMIT_EXCEEDED","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"}}}]}}}},"500":{"description":"INTERNAL_ERROR","content":{"application/json":{"schema":{"description":"INTERNAL_ERROR","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}}},"method":"post","path":"/qr-codes","requestSamples":[{"name":"cURL","syntaxLanguage":"bash","sample":"curl \\\n-H 'Authorization: Bearer {TOKEN}' \\\n-H 'Content-Type: application/json' \\\n-X POST \\\n-d '{\n \"title\": \"Default QR Code\",\n \"group_guid\": \"Ba1bc23dE4F\",\n \"destination\": {\n \"bitlink_id\": \"bit.ly/abc123\"\n },\n \"archived\": false,\n \"render_customizations\": {\n \"background_color\": \"#ffffff\",\n \"dot_pattern_color\": \"#000000\",\n \"dot_pattern_type\": \"standard\",\n \"corners\": {\n \"corner_1\": {\n \"inner_color\": \"#000000\",\n \"outer_color\": \"#000000\",\n \"shape\": \"standard\"\n },\n \"corner_2\": {\n \"inner_color\": \"#000000\",\n \"outer_color\": \"#000000\",\n \"shape\": \"standard\"\n },\n \"corner_3\": {\n \"inner_color\": \"#000000\",\n \"outer_color\": \"#000000\",\n \"shape\": \"standard\"\n }\n },\n \"branding\": {\n \"bitly_brand\": true\n },\n \"spec_settings\": {\n \"error_correction\": 4\n }\n }\n}' \\\nhttps://api-ssl.bitly.com/v4/qr-codes","exampleName":"Default"},{"sample":"var fetch = require('node-fetch');\n\nfetch('https://api-ssl.bitly.com/v4/qr-codes', {\n method: 'POST',\n headers: {\n 'Authorization': 'Bearer {TOKEN}',\n 'Content-Type': 'application/json'\n },\n body: JSON.stringify({ \"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 } } })\n});\n","name":"Node","syntaxLanguage":"javascript","exampleName":"Default"},{"sample":"fetch('https://api-ssl.bitly.com/v4/qr-codes', {\n method: 'POST',\n headers: {\n 'Authorization': 'Bearer {TOKEN}',\n 'Content-Type': 'application/json'\n },\n body: JSON.stringify({ \"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 } } })\n});\n","name":"Browser","syntaxLanguage":"javascript","exampleName":"Default"},{"sample":"package main\n\nimport (\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n\t\"strings\"\n)\n\nfunc main() {\n\tclient := \u0026http.Client{}\n\tvar data = strings.NewReader(`{ \"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 } } }`)\n\treq, err := http.NewRequest(\"POST\", \"https://api-ssl.bitly.com/v4/qr-codes\", data)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\treq.Header.Set(\"Authorization\", \"Bearer {TOKEN}\")\n\treq.Header.Set(\"Content-Type\", \"application/json\")\n\tresp, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tdefer resp.Body.Close()\n\tbodyText, err := ioutil.ReadAll(resp.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tfmt.Printf(\"%s\\n\", bodyText)\n}\n","name":"Go","syntaxLanguage":"go","exampleName":"Default"},{"sample":"import requests\n\nheaders = {\n 'Authorization': 'Bearer {TOKEN}',\n 'Content-Type': 'application/json',\n}\n\ndata = '{ \"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 } } }'\n\nresponse = requests.post('https://api-ssl.bitly.com/v4/qr-codes', headers=headers, data=data)\n","name":"Python","syntaxLanguage":"python","exampleName":"Default"},{"name":"cURL","syntaxLanguage":"bash","sample":"curl \\\n-H 'Authorization: Bearer {TOKEN}' \\\n-H 'Content-Type: application/json' \\\n-X POST \\\n-d '{\n \"title\": \"Minimal QR Code\",\n \"group_guid\": \"Ba1bc23dE4F\",\n \"destination\": {\n \"bitlink_id\": \"bit.ly/abc123\"\n }\n}' \\\nhttps://api-ssl.bitly.com/v4/qr-codes","exampleName":"Minimal"},{"sample":"var fetch = require('node-fetch');\n\nfetch('https://api-ssl.bitly.com/v4/qr-codes', {\n method: 'POST',\n headers: {\n 'Authorization': 'Bearer {TOKEN}',\n 'Content-Type': 'application/json'\n },\n body: JSON.stringify({ \"title\": \"Minimal QR Code\", \"group_guid\": \"Ba1bc23dE4F\", \"destination\": { \"bitlink_id\": \"bit.ly/abc123\" } })\n});\n","name":"Node","syntaxLanguage":"javascript","exampleName":"Minimal"},{"sample":"fetch('https://api-ssl.bitly.com/v4/qr-codes', {\n method: 'POST',\n headers: {\n 'Authorization': 'Bearer {TOKEN}',\n 'Content-Type': 'application/json'\n },\n body: JSON.stringify({ \"title\": \"Minimal QR Code\", \"group_guid\": \"Ba1bc23dE4F\", \"destination\": { \"bitlink_id\": \"bit.ly/abc123\" } })\n});\n","name":"Browser","syntaxLanguage":"javascript","exampleName":"Minimal"},{"sample":"package main\n\nimport (\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n\t\"strings\"\n)\n\nfunc main() {\n\tclient := \u0026http.Client{}\n\tvar data = strings.NewReader(`{ \"title\": \"Minimal QR Code\", \"group_guid\": \"Ba1bc23dE4F\", \"destination\": { \"bitlink_id\": \"bit.ly/abc123\" } }`)\n\treq, err := http.NewRequest(\"POST\", \"https://api-ssl.bitly.com/v4/qr-codes\", data)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\treq.Header.Set(\"Authorization\", \"Bearer {TOKEN}\")\n\treq.Header.Set(\"Content-Type\", \"application/json\")\n\tresp, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tdefer resp.Body.Close()\n\tbodyText, err := ioutil.ReadAll(resp.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tfmt.Printf(\"%s\\n\", bodyText)\n}\n","name":"Go","syntaxLanguage":"go","exampleName":"Minimal"},{"sample":"import requests\n\nheaders = {\n 'Authorization': 'Bearer {TOKEN}',\n 'Content-Type': 'application/json',\n}\n\ndata = '{ \"title\": \"Minimal QR Code\", \"group_guid\": \"Ba1bc23dE4F\", \"destination\": { \"bitlink_id\": \"bit.ly/abc123\" } }'\n\nresponse = requests.post('https://api-ssl.bitly.com/v4/qr-codes', headers=headers, data=data)\n","name":"Python","syntaxLanguage":"python","exampleName":"Minimal"},{"name":"cURL","syntaxLanguage":"bash","sample":"curl \\\n-H 'Authorization: Bearer {TOKEN}' \\\n-H 'Content-Type: application/json' \\\n-X POST \\\n-d '{\n \"title\": \"Link-in-Bio QR Code\",\n \"group_guid\": \"Ba1bc23dE4F\",\n \"destination\": {\n \"site_id\": \"Mabc123\"\n }\n}' \\\nhttps://api-ssl.bitly.com/v4/qr-codes","exampleName":"Link in Bio"},{"sample":"var fetch = require('node-fetch');\n\nfetch('https://api-ssl.bitly.com/v4/qr-codes', {\n method: 'POST',\n headers: {\n 'Authorization': 'Bearer {TOKEN}',\n 'Content-Type': 'application/json'\n },\n body: JSON.stringify({ \"title\": \"Link-in-Bio QR Code\", \"group_guid\": \"Ba1bc23dE4F\", \"destination\": { \"site_id\": \"Mabc123\" } })\n});\n","name":"Node","syntaxLanguage":"javascript","exampleName":"Link in Bio"},{"sample":"fetch('https://api-ssl.bitly.com/v4/qr-codes', {\n method: 'POST',\n headers: {\n 'Authorization': 'Bearer {TOKEN}',\n 'Content-Type': 'application/json'\n },\n body: JSON.stringify({ \"title\": \"Link-in-Bio QR Code\", \"group_guid\": \"Ba1bc23dE4F\", \"destination\": { \"site_id\": \"Mabc123\" } })\n});\n","name":"Browser","syntaxLanguage":"javascript","exampleName":"Link in Bio"},{"sample":"package main\n\nimport (\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n\t\"strings\"\n)\n\nfunc main() {\n\tclient := \u0026http.Client{}\n\tvar data = strings.NewReader(`{ \"title\": \"Link-in-Bio QR Code\", \"group_guid\": \"Ba1bc23dE4F\", \"destination\": { \"site_id\": \"Mabc123\" } }`)\n\treq, err := http.NewRequest(\"POST\", \"https://api-ssl.bitly.com/v4/qr-codes\", data)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\treq.Header.Set(\"Authorization\", \"Bearer {TOKEN}\")\n\treq.Header.Set(\"Content-Type\", \"application/json\")\n\tresp, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tdefer resp.Body.Close()\n\tbodyText, err := ioutil.ReadAll(resp.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tfmt.Printf(\"%s\\n\", bodyText)\n}\n","name":"Go","syntaxLanguage":"go","exampleName":"Link in Bio"},{"sample":"import requests\n\nheaders = {\n 'Authorization': 'Bearer {TOKEN}',\n 'Content-Type': 'application/json',\n}\n\ndata = '{ \"title\": \"Link-in-Bio QR Code\", \"group_guid\": \"Ba1bc23dE4F\", \"destination\": { \"site_id\": \"Mabc123\" } }'\n\nresponse = requests.post('https://api-ssl.bitly.com/v4/qr-codes', headers=headers, data=data)\n","name":"Python","syntaxLanguage":"python","exampleName":"Link in Bio"},{"name":"cURL","syntaxLanguage":"bash","sample":"curl \\\n-H 'Authorization: Bearer {TOKEN}' \\\n-H 'Content-Type: application/json' \\\n-X POST \\\n-d '{\n \"title\": \"Complex QR Code\",\n \"group_guid\": \"Ba1bc23dE4F\",\n \"destination\": {\n \"bitlink_id\": \"bit.ly/abc123\"\n },\n \"archived\": false,\n \"render_customizations\": {\n \"background_color\": \"#ffffff\",\n \"dot_pattern_color\": \"#EF8000\",\n \"dot_pattern_type\": \"rounded\",\n \"corners\": {\n \"corner_1\": {\n \"inner_color\": \"#EF8000\",\n \"outer_color\": \"#EF8000\",\n \"shape\": \"concave\"\n },\n \"corner_2\": {\n \"inner_color\": \"#EF8000\",\n \"outer_color\": \"#EF8000\",\n \"shape\": \"leaf\"\n },\n \"corner_3\": {\n \"inner_color\": \"#EF8000\",\n \"outer_color\": \"#EF8000\",\n \"shape\": \"target\"\n }\n },\n \"logo\": {\n \"image_guid\": \"bitlylogo\"\n },\n \"frame\": {\n \"id\": \"text_top_and_bottom\",\n \"colors\": {\n \"primary\": \"#F55656\",\n \"background\": \"#FFFFFF\"\n },\n \"text\": {\n \"primary\": {\n \"content\": \"QR Frame\"\n },\n \"secondary\": {\n \"content\": \"Frame Text\"\n }\n }\n },\n \"branding\": {\n \"bitly_brand\": true\n }\n }\n}' \\\nhttps://api-ssl.bitly.com/v4/qr-codes","exampleName":"Complex"},{"sample":"var fetch = require('node-fetch');\n\nfetch('https://api-ssl.bitly.com/v4/qr-codes', {\n method: 'POST',\n headers: {\n 'Authorization': 'Bearer {TOKEN}',\n 'Content-Type': 'application/json'\n },\n body: JSON.stringify({ \"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 } } })\n});\n","name":"Node","syntaxLanguage":"javascript","exampleName":"Complex"},{"sample":"fetch('https://api-ssl.bitly.com/v4/qr-codes', {\n method: 'POST',\n headers: {\n 'Authorization': 'Bearer {TOKEN}',\n 'Content-Type': 'application/json'\n },\n body: JSON.stringify({ \"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 } } })\n});\n","name":"Browser","syntaxLanguage":"javascript","exampleName":"Complex"},{"sample":"package main\n\nimport (\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n\t\"strings\"\n)\n\nfunc main() {\n\tclient := \u0026http.Client{}\n\tvar data = strings.NewReader(`{ \"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 } } }`)\n\treq, err := http.NewRequest(\"POST\", \"https://api-ssl.bitly.com/v4/qr-codes\", data)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\treq.Header.Set(\"Authorization\", \"Bearer {TOKEN}\")\n\treq.Header.Set(\"Content-Type\", \"application/json\")\n\tresp, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tdefer resp.Body.Close()\n\tbodyText, err := ioutil.ReadAll(resp.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tfmt.Printf(\"%s\\n\", bodyText)\n}\n","name":"Go","syntaxLanguage":"go","exampleName":"Complex"},{"sample":"import requests\n\nheaders = {\n 'Authorization': 'Bearer {TOKEN}',\n 'Content-Type': 'application/json',\n}\n\ndata = '{ \"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 } } }'\n\nresponse = requests.post('https://api-ssl.bitly.com/v4/qr-codes', headers=headers, data=data)\n","name":"Python","syntaxLanguage":"python","exampleName":"Complex"},{"name":"cURL","syntaxLanguage":"bash","sample":"curl \\\n-H 'Authorization: Bearer {TOKEN}' \\\n-H 'Content-Type: application/json' \\\n-X POST \\\n-d '{\n \"title\": \"Gradient QR Code\",\n \"group_guid\": \"Ba1bc23dE4F\",\n \"destination\": {\n \"bitlink_id\": \"bit.ly/abc123\"\n },\n \"archived\": false,\n \"render_customizations\": {\n \"dot_pattern_type\": \"rounded\",\n \"corners\": {\n \"corner_1\": {\n \"shape\": \"leaf\"\n },\n \"corner_2\": {\n \"shape\": \"leaf\"\n },\n \"corner_3\": {\n \"shape\": \"leaf\"\n }\n },\n \"gradient\": {\n \"style\": \"linear\",\n \"angle\": 45,\n \"colors\": [\n {\n \"color\": \"#C80404\",\n \"offset\": 10\n },\n {\n \"color\": \"#042F86\",\n \"offset\": 90\n }\n ],\n \"exclude_corners\": false\n },\n \"background_gradient\": {\n \"style\": \"radial\",\n \"colors\": [\n {\n \"color\": \"#C696EE\",\n \"offset\": 25\n },\n {\n \"color\": \"#D4E1A8\",\n \"offset\": 50\n }\n ]\n }\n }\n}' \\\nhttps://api-ssl.bitly.com/v4/qr-codes","exampleName":"Gradients"},{"sample":"var fetch = require('node-fetch');\n\nfetch('https://api-ssl.bitly.com/v4/qr-codes', {\n method: 'POST',\n headers: {\n 'Authorization': 'Bearer {TOKEN}',\n 'Content-Type': 'application/json'\n },\n body: JSON.stringify({ \"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 } ] } } })\n});\n","name":"Node","syntaxLanguage":"javascript","exampleName":"Gradients"},{"sample":"fetch('https://api-ssl.bitly.com/v4/qr-codes', {\n method: 'POST',\n headers: {\n 'Authorization': 'Bearer {TOKEN}',\n 'Content-Type': 'application/json'\n },\n body: JSON.stringify({ \"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 } ] } } })\n});\n","name":"Browser","syntaxLanguage":"javascript","exampleName":"Gradients"},{"sample":"package main\n\nimport (\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n\t\"strings\"\n)\n\nfunc main() {\n\tclient := \u0026http.Client{}\n\tvar data = strings.NewReader(`{ \"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 } ] } } }`)\n\treq, err := http.NewRequest(\"POST\", \"https://api-ssl.bitly.com/v4/qr-codes\", data)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\treq.Header.Set(\"Authorization\", \"Bearer {TOKEN}\")\n\treq.Header.Set(\"Content-Type\", \"application/json\")\n\tresp, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tdefer resp.Body.Close()\n\tbodyText, err := ioutil.ReadAll(resp.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tfmt.Printf(\"%s\\n\", bodyText)\n}\n","name":"Go","syntaxLanguage":"go","exampleName":"Gradients"},{"sample":"import requests\n\nheaders = {\n 'Authorization': 'Bearer {TOKEN}',\n 'Content-Type': 'application/json',\n}\n\ndata = '{ \"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 } ] } } }'\n\nresponse = requests.post('https://api-ssl.bitly.com/v4/qr-codes', headers=headers, data=data)\n","name":"Python","syntaxLanguage":"python","exampleName":"Gradients"},{"name":"cURL","syntaxLanguage":"bash","sample":"curl \\\n-H 'Authorization: Bearer {TOKEN}' \\\n-H 'Content-Type: application/json' \\\n-X POST \\\n-d '{\n \"title\": \"Framed QR Code\",\n \"group_guid\": \"Ba1bc23dE4F\",\n \"destination\": {\n \"bitlink_id\": \"bit.ly/abc123\"\n },\n \"archived\": false,\n \"render_customizations\": {\n \"frame\": {\n \"id\": \"arrow\",\n \"colors\": {\n \"primary\": \"#F55656\",\n \"background\": \"#FFFFFF\"\n },\n \"text\": {\n \"primary\": {\n \"content\": \"Scan Here\"\n }\n }\n },\n \"background_color\": \"#ffffff\",\n \"dot_pattern_color\": \"#EF8000\",\n \"dot_pattern_type\": \"rounded\",\n \"corners\": {\n \"corner_1\": {\n \"inner_color\": \"#EF8000\",\n \"outer_color\": \"#EF8000\",\n \"shape\": \"concave\"\n },\n \"corner_2\": {\n \"inner_color\": \"#EF8000\",\n \"outer_color\": \"#EF8000\",\n \"shape\": \"leaf\"\n },\n \"corner_3\": {\n \"inner_color\": \"#EF8000\",\n \"outer_color\": \"#EF8000\",\n \"shape\": \"target\"\n }\n },\n \"logo\": {\n \"image_guid\": \"bitlylogo\"\n }\n }\n}' \\\nhttps://api-ssl.bitly.com/v4/qr-codes","exampleName":"Framed"},{"sample":"var fetch = require('node-fetch');\n\nfetch('https://api-ssl.bitly.com/v4/qr-codes', {\n method: 'POST',\n headers: {\n 'Authorization': 'Bearer {TOKEN}',\n 'Content-Type': 'application/json'\n },\n body: JSON.stringify({ \"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\" } } })\n});\n","name":"Node","syntaxLanguage":"javascript","exampleName":"Framed"},{"sample":"fetch('https://api-ssl.bitly.com/v4/qr-codes', {\n method: 'POST',\n headers: {\n 'Authorization': 'Bearer {TOKEN}',\n 'Content-Type': 'application/json'\n },\n body: JSON.stringify({ \"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\" } } })\n});\n","name":"Browser","syntaxLanguage":"javascript","exampleName":"Framed"},{"sample":"package main\n\nimport (\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n\t\"strings\"\n)\n\nfunc main() {\n\tclient := \u0026http.Client{}\n\tvar data = strings.NewReader(`{ \"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\" } } }`)\n\treq, err := http.NewRequest(\"POST\", \"https://api-ssl.bitly.com/v4/qr-codes\", data)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\treq.Header.Set(\"Authorization\", \"Bearer {TOKEN}\")\n\treq.Header.Set(\"Content-Type\", \"application/json\")\n\tresp, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tdefer resp.Body.Close()\n\tbodyText, err := ioutil.ReadAll(resp.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tfmt.Printf(\"%s\\n\", bodyText)\n}\n","name":"Go","syntaxLanguage":"go","exampleName":"Framed"},{"sample":"import requests\n\nheaders = {\n 'Authorization': 'Bearer {TOKEN}',\n 'Content-Type': 'application/json',\n}\n\ndata = '{ \"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\" } } }'\n\nresponse = requests.post('https://api-ssl.bitly.com/v4/qr-codes', headers=headers, data=data)\n","name":"Python","syntaxLanguage":"python","exampleName":"Framed"},{"name":"cURL","syntaxLanguage":"bash","sample":"curl \\\n-H 'Authorization: Bearer {TOKEN}' \\\n-H 'Content-Type: application/json' \\\n-X POST \\\n-d '{\n \"title\": \"Lowest Error Correction QR Code\",\n \"group_guid\": \"Ba1bc23dE4F\",\n \"destination\": {\n \"bitlink_id\": \"bit.ly/abc123\"\n },\n \"render_customizations\": {\n \"spec_settings\": {\n \"error_correction\": 1\n }\n }\n}' \\\nhttps://api-ssl.bitly.com/v4/qr-codes","exampleName":"Lowest Error Correction"},{"sample":"var fetch = require('node-fetch');\n\nfetch('https://api-ssl.bitly.com/v4/qr-codes', {\n method: 'POST',\n headers: {\n 'Authorization': 'Bearer {TOKEN}',\n 'Content-Type': 'application/json'\n },\n body: JSON.stringify({ \"title\": \"Lowest Error Correction QR Code\", \"group_guid\": \"Ba1bc23dE4F\", \"destination\": { \"bitlink_id\": \"bit.ly/abc123\" }, \"render_customizations\": { \"spec_settings\": { \"error_correction\": 1 } } })\n});\n","name":"Node","syntaxLanguage":"javascript","exampleName":"Lowest Error Correction"},{"sample":"fetch('https://api-ssl.bitly.com/v4/qr-codes', {\n method: 'POST',\n headers: {\n 'Authorization': 'Bearer {TOKEN}',\n 'Content-Type': 'application/json'\n },\n body: JSON.stringify({ \"title\": \"Lowest Error Correction QR Code\", \"group_guid\": \"Ba1bc23dE4F\", \"destination\": { \"bitlink_id\": \"bit.ly/abc123\" }, \"render_customizations\": { \"spec_settings\": { \"error_correction\": 1 } } })\n});\n","name":"Browser","syntaxLanguage":"javascript","exampleName":"Lowest Error Correction"},{"sample":"package main\n\nimport (\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n\t\"strings\"\n)\n\nfunc main() {\n\tclient := \u0026http.Client{}\n\tvar data = strings.NewReader(`{ \"title\": \"Lowest Error Correction QR Code\", \"group_guid\": \"Ba1bc23dE4F\", \"destination\": { \"bitlink_id\": \"bit.ly/abc123\" }, \"render_customizations\": { \"spec_settings\": { \"error_correction\": 1 } } }`)\n\treq, err := http.NewRequest(\"POST\", \"https://api-ssl.bitly.com/v4/qr-codes\", data)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\treq.Header.Set(\"Authorization\", \"Bearer {TOKEN}\")\n\treq.Header.Set(\"Content-Type\", \"application/json\")\n\tresp, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tdefer resp.Body.Close()\n\tbodyText, err := ioutil.ReadAll(resp.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tfmt.Printf(\"%s\\n\", bodyText)\n}\n","name":"Go","syntaxLanguage":"go","exampleName":"Lowest Error Correction"},{"sample":"import requests\n\nheaders = {\n 'Authorization': 'Bearer {TOKEN}',\n 'Content-Type': 'application/json',\n}\n\ndata = '{ \"title\": \"Lowest Error Correction QR Code\", \"group_guid\": \"Ba1bc23dE4F\", \"destination\": { \"bitlink_id\": \"bit.ly/abc123\" }, \"render_customizations\": { \"spec_settings\": { \"error_correction\": 1 } } }'\n\nresponse = requests.post('https://api-ssl.bitly.com/v4/qr-codes', headers=headers, data=data)\n","name":"Python","syntaxLanguage":"python","exampleName":"Lowest Error Correction"},{"name":"cURL","syntaxLanguage":"bash","sample":"curl \\\n-H 'Authorization: Bearer {TOKEN}' \\\n-H 'Content-Type: application/json' \\\n-X POST \\\n-d '{\n \"title\": \"GS1 QR Code\",\n \"group_guid\": \"Ba1bc23dE4F\",\n \"destination\": {\n \"bitlink_id\": \"bit.ly/abc123\"\n },\n \"gs1\": {\n \"values\": [\n {\n \"key\": \"01\",\n \"value\": \"12345670\"\n }\n ]\n }\n}' \\\nhttps://api-ssl.bitly.com/v4/qr-codes","exampleName":"GS1"},{"sample":"var fetch = require('node-fetch');\n\nfetch('https://api-ssl.bitly.com/v4/qr-codes', {\n method: 'POST',\n headers: {\n 'Authorization': 'Bearer {TOKEN}',\n 'Content-Type': 'application/json'\n },\n body: JSON.stringify({ \"title\": \"GS1 QR Code\", \"group_guid\": \"Ba1bc23dE4F\", \"destination\": { \"bitlink_id\": \"bit.ly/abc123\" }, \"gs1\": { \"values\": [ { \"key\": \"01\", \"value\": \"12345670\" } ] } })\n});\n","name":"Node","syntaxLanguage":"javascript","exampleName":"GS1"},{"sample":"fetch('https://api-ssl.bitly.com/v4/qr-codes', {\n method: 'POST',\n headers: {\n 'Authorization': 'Bearer {TOKEN}',\n 'Content-Type': 'application/json'\n },\n body: JSON.stringify({ \"title\": \"GS1 QR Code\", \"group_guid\": \"Ba1bc23dE4F\", \"destination\": { \"bitlink_id\": \"bit.ly/abc123\" }, \"gs1\": { \"values\": [ { \"key\": \"01\", \"value\": \"12345670\" } ] } })\n});\n","name":"Browser","syntaxLanguage":"javascript","exampleName":"GS1"},{"sample":"package main\n\nimport (\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n\t\"strings\"\n)\n\nfunc main() {\n\tclient := \u0026http.Client{}\n\tvar data = strings.NewReader(`{ \"title\": \"GS1 QR Code\", \"group_guid\": \"Ba1bc23dE4F\", \"destination\": { \"bitlink_id\": \"bit.ly/abc123\" }, \"gs1\": { \"values\": [ { \"key\": \"01\", \"value\": \"12345670\" } ] } }`)\n\treq, err := http.NewRequest(\"POST\", \"https://api-ssl.bitly.com/v4/qr-codes\", data)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\treq.Header.Set(\"Authorization\", \"Bearer {TOKEN}\")\n\treq.Header.Set(\"Content-Type\", \"application/json\")\n\tresp, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tdefer resp.Body.Close()\n\tbodyText, err := ioutil.ReadAll(resp.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tfmt.Printf(\"%s\\n\", bodyText)\n}\n","name":"Go","syntaxLanguage":"go","exampleName":"GS1"},{"sample":"import requests\n\nheaders = {\n 'Authorization': 'Bearer {TOKEN}',\n 'Content-Type': 'application/json',\n}\n\ndata = '{ \"title\": \"GS1 QR Code\", \"group_guid\": \"Ba1bc23dE4F\", \"destination\": { \"bitlink_id\": \"bit.ly/abc123\" }, \"gs1\": { \"values\": [ { \"key\": \"01\", \"value\": \"12345670\" } ] } }'\n\nresponse = requests.post('https://api-ssl.bitly.com/v4/qr-codes', headers=headers, data=data)\n","name":"Python","syntaxLanguage":"python","exampleName":"GS1"}],"responseSamples":[{"statusCode":"201","description":"CREATED","json":"{\n \"qrcode_id\": \"string\",\n \"group_guid\": \"string\",\n \"title\": \"string\",\n \"is_customized\": \"boolean\",\n \"serialized_content\": \"string\",\n \"qr_code_type\": \"string\",\n \"long_urls\": [\n \"string\"\n ],\n \"bitlink_id\": \"string\",\n \"is_gs1\": \"boolean\",\n \"created_by\": \"string\",\n \"archived\": \"boolean\",\n \"created\": \"string\",\n \"modified\": \"string\"\n}","csv":null},{"statusCode":"400","description":"BAD_REQUEST","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"402","description":"UPGRADE_REQUIRED","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"403","description":"FORBIDDEN","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"404","description":"NOT_FOUND","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"410","description":"GONE","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"429","description":"MONTHLY_LIMIT_EXCEEDED","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\"\n}","csv":null},{"statusCode":"500","description":"INTERNAL_ERROR","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null}],"requestBodyParams":[{"name":"title","description":"The title of the QR Code","required":false,"schema":{"type":"string","default":null,"enum":null},"items":null,"properties":null},{"name":"group_guid","description":"Identify which group to place the QR Code.","required":true,"schema":{"type":"string","default":null,"enum":null},"items":null,"properties":null},{"name":"render_customizations","description":"Options for customizing a QR Code's appearance","required":false,"schema":{"type":"object","default":null,"enum":null},"items":null,"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":{"type":"string","enum":["standard","circle","block","blob","rounded","vertical","horizontal","triangle","heart","star","diamond"],"default":"standard"},"corners":{"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":{"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"}}},"corner_2":{"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"}}},"corner_3":{"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"}}}}},"gradient":{"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":{"type":"object","properties":{"color":{"description":"A color in hexadecimal format to be used in one of the gradient's \u003cstop\u003e 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}}}},"exclude_corners":{"description":"Ignore gradient mask on corners","type":"boolean"}}},"background_gradient":{"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":{"type":"object","properties":{"color":{"description":"A color in hexadecimal format to be used in one of the gradient's \u003cstop\u003e 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}}}},"exclude_corners":{"description":"Ignore gradient mask on corners","type":"boolean"}}},"logo":{"type":"object","properties":{"image_guid":{"type":"string","description":"A GUID for an image uploaded to Bitly"}}},"frame":{"type":"object","required":["id"],"properties":{"id":{"description":"The unique id of the selected frame","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"},"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":{"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"}}},"secondary":{"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"}}}}}}},"text":{"description":"Contains the center, top, and bottom text to be used in the QR code","type":"object","properties":{"center":{"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"}}},"top":{"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"}}},"bottom":{"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"}}}},"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"}}},"branding":{"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"}}},"spec_settings":{"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"}}}}},{"name":"archived","description":"A boolean representing if the QR code should be archived (hidden from the UI) upon creation","required":false,"schema":{"type":"boolean","default":null,"enum":null},"items":null,"properties":null},{"name":"destination","description":null,"required":true,"schema":{"type":"object","default":null,"enum":null},"items":null,"properties":{"bitlink_id":{"type":"string"},"long_url":{"type":"string"},"site_id":{"type":"string"}}},{"name":"gs1","description":"Contains GS1 related metadata","required":false,"schema":{"type":"object","default":null,"enum":null},"items":null,"properties":{"values":{"description":"A list of GS1 application identifiers and their values","type":"array","items":{"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."}}}}}}]},{"summary":"Retrieve a QR Code image","description":"Get the image of a given QR Code. The Accept header controls how this is returned (options are \"application/json\", \"image/svg+xml\", and \"image/png\").\nIf the Accept header is \"application/json\" the format query parameter will determine the image format inside of the json (which will be base64 encoded and prefixed with its mime type as would be suitable for a HTML image src tag).\nTo Return the QR Code image itself, set the Accept header to \"image/svg+xml\" or \"image/png\", or remove the Accept header and set the format query parameter to “svg” or “png” (if no format is specified the default will be “svg”).\n","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, base64 encoded and prefixed with its mime type as would be suitable for a HTML image src tag.","schema":{"type":"string"},"required":false,"example":"image/svg+xml"},{"name":"qrcode_id","in":"path","description":"The QR Code ID","required":true,"schema":{"type":"string"},"example":"Qabcde12345"},{"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","png"],"default":"svg","example":"svg"},"required":false}],"responses":{"200":{"description":"SUCCESS","content":{"application/json":{"schema":{"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"}}}},"image/svg+xml":{"schema":{"type":"string"},"example":"\u003csvg\u003eQR code svg\u003c/svg\u003e"},"image/png":{"schema":{"type":"string"},"example":"...png bytes..."}}},"400":{"description":"BAD_REQUEST","content":{"application/json":{"schema":{"description":"BAD_REQUEST","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"403":{"description":"FORBIDDEN","content":{"application/json":{"schema":{"description":"FORBIDDEN","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"404":{"description":"NOT_FOUND","content":{"application/json":{"schema":{"description":"NOT_FOUND","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"410":{"description":"GONE","content":{"application/json":{"schema":{"description":"GONE","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"500":{"description":"INTERNAL_ERROR","content":{"application/json":{"schema":{"description":"INTERNAL_ERROR","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}}},"method":"get","path":"/qr-codes/{qrcode_id}/image","requestSamples":[{"name":"cURL","syntaxLanguage":"bash","sample":"curl \\\n-H 'Authorization: Bearer {TOKEN}' \\\n-X GET \\\nhttps://api-ssl.bitly.com/v4/qr-codes/Qabcde12345/image?format=","exampleName":"Default"},{"sample":"var fetch = require('node-fetch');\n\nfetch('https://api-ssl.bitly.com/v4/qr-codes/Qabcde12345/image?format=', {\n headers: {\n 'Authorization': 'Bearer {TOKEN}'\n }\n});\n","name":"Node","syntaxLanguage":"javascript","exampleName":"Default"},{"sample":"fetch('https://api-ssl.bitly.com/v4/qr-codes/Qabcde12345/image?format=', {\n headers: {\n 'Authorization': 'Bearer {TOKEN}'\n }\n});\n","name":"Browser","syntaxLanguage":"javascript","exampleName":"Default"},{"sample":"package main\n\nimport (\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\tclient := \u0026http.Client{}\n\treq, err := http.NewRequest(\"GET\", \"https://api-ssl.bitly.com/v4/qr-codes/Qabcde12345/image?format=\", nil)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\treq.Header.Set(\"Authorization\", \"Bearer {TOKEN}\")\n\tresp, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tdefer resp.Body.Close()\n\tbodyText, err := ioutil.ReadAll(resp.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tfmt.Printf(\"%s\\n\", bodyText)\n}\n","name":"Go","syntaxLanguage":"go","exampleName":"Default"},{"sample":"import requests\n\nheaders = {\n 'Authorization': 'Bearer {TOKEN}',\n}\n\nparams = (\n ('format', ''),\n)\n\nresponse = requests.get('https://api-ssl.bitly.com/v4/qr-codes/Qabcde12345/image', headers=headers, params=params)\n\n#NB. Original query string below. It seems impossible to parse and\n#reproduce query strings 100% accurately so the one below is given\n#in case the reproduced version is not \"correct\".\n# response = requests.get('https://api-ssl.bitly.com/v4/qr-codes/Qabcde12345/image?format=', headers=headers)\n","name":"Python","syntaxLanguage":"python","exampleName":"Default"}],"responseSamples":[{"statusCode":"200","description":"SUCCESS","json":"{\n \"qr_code_image\": \"string\"\n}","csv":null},{"statusCode":"400","description":"BAD_REQUEST","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"403","description":"FORBIDDEN","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"404","description":"NOT_FOUND","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"410","description":"GONE","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"500","description":"INTERNAL_ERROR","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null}],"requestBodyParams":null},{"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":{"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}}}},"description":"Customization and content values for a QR code created through the public API","type":"object","properties":{"title":{"type":"string"},"render_customizations":{"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":{"type":"string","enum":["standard","circle","block","blob","rounded","vertical","horizontal","triangle","heart","star","diamond"],"default":"standard"},"corners":{"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":{"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"}}},"corner_2":{"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"}}},"corner_3":{"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"}}}}},"gradient":{"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":{"type":"object","properties":{"color":{"description":"A color in hexadecimal format to be used in one of the gradient's \u003cstop\u003e 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}}}},"exclude_corners":{"description":"Ignore gradient mask on corners","type":"boolean"}}},"background_gradient":{"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":{"type":"object","properties":{"color":{"description":"A color in hexadecimal format to be used in one of the gradient's \u003cstop\u003e 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}}}},"exclude_corners":{"description":"Ignore gradient mask on corners","type":"boolean"}}},"logo":{"type":"object","properties":{"image_guid":{"type":"string","description":"A GUID for an image uploaded to Bitly"}}},"frame":{"type":"object","required":["id"],"properties":{"id":{"description":"The unique id of the selected frame","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"},"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":{"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"}}},"secondary":{"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"}}}}}}},"text":{"description":"Contains the center, top, and bottom text to be used in the QR code","type":"object","properties":{"center":{"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"}}},"top":{"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"}}},"bottom":{"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"}}}},"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"}}},"branding":{"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"}}},"spec_settings":{"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"}}}}},"archived":{"description":"A boolean representing if the QR code has been archived","type":"boolean"}}}}}},"responses":{"200":{"description":"SUCCESS","content":{"application/json":{"schema":{"type":"object","properties":{"qrcode_id":{"type":"string"},"group_guid":{"type":"string"},"title":{"type":"string"},"is_customized":{"description":"Set to true if the QR code's customization values have been changed from their default setting","type":"boolean"},"serialized_content":{"description":"A serialized string of the QR code's content","type":"string"},"qr_code_type":{"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"]},"long_urls":{"description":"A list of destination URLs that the qr code leads to.","type":"array","items":{"type":"string"}},"bitlink_id":{"description":"The bitlink ID associated with the qr code. Not all qr codes are associated with one.","type":"string"},"is_gs1":{"description":"Set to true if QR code has GS1 values.","type":"boolean"},"created_by":{"description":"User that created the code.","type":"string"},"archived":{"type":"boolean"},"created":{"type":"string"},"modified":{"type":"string"}}}}}},"400":{"description":"BAD_REQUEST","content":{"application/json":{"schema":{"description":"BAD_REQUEST","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"403":{"description":"FORBIDDEN","content":{"application/json":{"schema":{"description":"FORBIDDEN","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"404":{"description":"NOT_FOUND","content":{"application/json":{"schema":{"description":"NOT_FOUND","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"410":{"description":"GONE","content":{"application/json":{"schema":{"description":"GONE","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"500":{"description":"INTERNAL_ERROR","content":{"application/json":{"schema":{"description":"INTERNAL_ERROR","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}}},"method":"patch","path":"/qr-codes/{qrcode_id}","requestSamples":[{"name":"cURL","syntaxLanguage":"bash","sample":"curl \\\n-H 'Authorization: Bearer {TOKEN}' \\\n-H 'Content-Type: application/json' \\\n-X PATCH \\\n-d '{\n \"title\": \"Default QR Code Updated\",\n \"archived\": false,\n \"render_customizations\": {\n \"background_color\": \"#ffffff\",\n \"dot_pattern_color\": \"#000000\",\n \"dot_pattern_type\": \"standard\",\n \"corners\": {\n \"corner_1\": {\n \"inner_color\": \"#000000\",\n \"outer_color\": \"#000000\",\n \"shape\": \"standard\"\n },\n \"corner_2\": {\n \"inner_color\": \"#000000\",\n \"outer_color\": \"#000000\",\n \"shape\": \"standard\"\n },\n \"corner_3\": {\n \"inner_color\": \"#000000\",\n \"outer_color\": \"#000000\",\n \"shape\": \"standard\"\n }\n },\n \"branding\": {\n \"bitly_brand\": true\n },\n \"spec_settings\": {\n \"error_correction\": 4\n }\n }\n}' \\\nhttps://api-ssl.bitly.com/v4/qr-codes/Qabc123","exampleName":"Default"},{"sample":"var fetch = require('node-fetch');\n\nfetch('https://api-ssl.bitly.com/v4/qr-codes/Qabc123', {\n method: 'PATCH',\n headers: {\n 'Authorization': 'Bearer {TOKEN}',\n 'Content-Type': 'application/json'\n },\n body: JSON.stringify({ \"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 } } })\n});\n","name":"Node","syntaxLanguage":"javascript","exampleName":"Default"},{"sample":"fetch('https://api-ssl.bitly.com/v4/qr-codes/Qabc123', {\n method: 'PATCH',\n headers: {\n 'Authorization': 'Bearer {TOKEN}',\n 'Content-Type': 'application/json'\n },\n body: JSON.stringify({ \"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 } } })\n});\n","name":"Browser","syntaxLanguage":"javascript","exampleName":"Default"},{"sample":"package main\n\nimport (\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n\t\"strings\"\n)\n\nfunc main() {\n\tclient := \u0026http.Client{}\n\tvar data = strings.NewReader(`{ \"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 } } }`)\n\treq, err := http.NewRequest(\"PATCH\", \"https://api-ssl.bitly.com/v4/qr-codes/Qabc123\", data)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\treq.Header.Set(\"Authorization\", \"Bearer {TOKEN}\")\n\treq.Header.Set(\"Content-Type\", \"application/json\")\n\tresp, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tdefer resp.Body.Close()\n\tbodyText, err := ioutil.ReadAll(resp.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tfmt.Printf(\"%s\\n\", bodyText)\n}\n","name":"Go","syntaxLanguage":"go","exampleName":"Default"},{"sample":"import requests\n\nheaders = {\n 'Authorization': 'Bearer {TOKEN}',\n 'Content-Type': 'application/json',\n}\n\ndata = '{ \"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 } } }'\n\nresponse = requests.patch('https://api-ssl.bitly.com/v4/qr-codes/Qabc123', headers=headers, data=data)\n","name":"Python","syntaxLanguage":"python","exampleName":"Default"},{"name":"cURL","syntaxLanguage":"bash","sample":"curl \\\n-H 'Authorization: Bearer {TOKEN}' \\\n-H 'Content-Type: application/json' \\\n-X PATCH \\\n-d '{\n \"title\": \"Minimal QR Code Updated\"\n}' \\\nhttps://api-ssl.bitly.com/v4/qr-codes/Qabc123","exampleName":"Minimal"},{"sample":"var fetch = require('node-fetch');\n\nfetch('https://api-ssl.bitly.com/v4/qr-codes/Qabc123', {\n method: 'PATCH',\n headers: {\n 'Authorization': 'Bearer {TOKEN}',\n 'Content-Type': 'application/json'\n },\n body: JSON.stringify({ \"title\": \"Minimal QR Code Updated\" })\n});\n","name":"Node","syntaxLanguage":"javascript","exampleName":"Minimal"},{"sample":"fetch('https://api-ssl.bitly.com/v4/qr-codes/Qabc123', {\n method: 'PATCH',\n headers: {\n 'Authorization': 'Bearer {TOKEN}',\n 'Content-Type': 'application/json'\n },\n body: JSON.stringify({ \"title\": \"Minimal QR Code Updated\" })\n});\n","name":"Browser","syntaxLanguage":"javascript","exampleName":"Minimal"},{"sample":"package main\n\nimport (\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n\t\"strings\"\n)\n\nfunc main() {\n\tclient := \u0026http.Client{}\n\tvar data = strings.NewReader(`{ \"title\": \"Minimal QR Code Updated\" }`)\n\treq, err := http.NewRequest(\"PATCH\", \"https://api-ssl.bitly.com/v4/qr-codes/Qabc123\", data)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\treq.Header.Set(\"Authorization\", \"Bearer {TOKEN}\")\n\treq.Header.Set(\"Content-Type\", \"application/json\")\n\tresp, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tdefer resp.Body.Close()\n\tbodyText, err := ioutil.ReadAll(resp.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tfmt.Printf(\"%s\\n\", bodyText)\n}\n","name":"Go","syntaxLanguage":"go","exampleName":"Minimal"},{"sample":"import requests\n\nheaders = {\n 'Authorization': 'Bearer {TOKEN}',\n 'Content-Type': 'application/json',\n}\n\ndata = '{ \"title\": \"Minimal QR Code Updated\" }'\n\nresponse = requests.patch('https://api-ssl.bitly.com/v4/qr-codes/Qabc123', headers=headers, data=data)\n","name":"Python","syntaxLanguage":"python","exampleName":"Minimal"},{"name":"cURL","syntaxLanguage":"bash","sample":"curl \\\n-H 'Authorization: Bearer {TOKEN}' \\\n-H 'Content-Type: application/json' \\\n-X PATCH \\\n-d '{\n \"title\": \"Complex QR Code Updated\",\n \"archived\": false,\n \"render_customizations\": {\n \"background_color\": \"#ffffff\",\n \"dot_pattern_color\": \"#EF8000\",\n \"dot_pattern_type\": \"rounded\",\n \"corners\": {\n \"corner_1\": {\n \"inner_color\": \"#EF8000\",\n \"outer_color\": \"#EF8000\",\n \"shape\": \"concave\"\n },\n \"corner_2\": {\n \"inner_color\": \"#EF8000\",\n \"outer_color\": \"#EF8000\",\n \"shape\": \"leaf\"\n },\n \"corner_3\": {\n \"inner_color\": \"#EF8000\",\n \"outer_color\": \"#EF8000\",\n \"shape\": \"target\"\n }\n },\n \"logo\": {\n \"image_guid\": \"bitlylogo\"\n },\n \"frame\": {\n \"id\": \"text_top_and_bottom\",\n \"colors\": {\n \"primary\": \"#F55656\",\n \"background\": \"#FFFFFF\"\n },\n \"text\": {\n \"primary\": {\n \"content\": \"QR Frame\"\n },\n \"secondary\": {\n \"content\": \"Frame Text\"\n }\n }\n },\n \"branding\": {\n \"bitly_brand\": true\n }\n }\n}' \\\nhttps://api-ssl.bitly.com/v4/qr-codes/Qabc123","exampleName":"Complex"},{"sample":"var fetch = require('node-fetch');\n\nfetch('https://api-ssl.bitly.com/v4/qr-codes/Qabc123', {\n method: 'PATCH',\n headers: {\n 'Authorization': 'Bearer {TOKEN}',\n 'Content-Type': 'application/json'\n },\n body: JSON.stringify({ \"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 } } })\n});\n","name":"Node","syntaxLanguage":"javascript","exampleName":"Complex"},{"sample":"fetch('https://api-ssl.bitly.com/v4/qr-codes/Qabc123', {\n method: 'PATCH',\n headers: {\n 'Authorization': 'Bearer {TOKEN}',\n 'Content-Type': 'application/json'\n },\n body: JSON.stringify({ \"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 } } })\n});\n","name":"Browser","syntaxLanguage":"javascript","exampleName":"Complex"},{"sample":"package main\n\nimport (\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n\t\"strings\"\n)\n\nfunc main() {\n\tclient := \u0026http.Client{}\n\tvar data = strings.NewReader(`{ \"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 } } }`)\n\treq, err := http.NewRequest(\"PATCH\", \"https://api-ssl.bitly.com/v4/qr-codes/Qabc123\", data)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\treq.Header.Set(\"Authorization\", \"Bearer {TOKEN}\")\n\treq.Header.Set(\"Content-Type\", \"application/json\")\n\tresp, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tdefer resp.Body.Close()\n\tbodyText, err := ioutil.ReadAll(resp.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tfmt.Printf(\"%s\\n\", bodyText)\n}\n","name":"Go","syntaxLanguage":"go","exampleName":"Complex"},{"sample":"import requests\n\nheaders = {\n 'Authorization': 'Bearer {TOKEN}',\n 'Content-Type': 'application/json',\n}\n\ndata = '{ \"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 } } }'\n\nresponse = requests.patch('https://api-ssl.bitly.com/v4/qr-codes/Qabc123', headers=headers, data=data)\n","name":"Python","syntaxLanguage":"python","exampleName":"Complex"},{"name":"cURL","syntaxLanguage":"bash","sample":"curl \\\n-H 'Authorization: Bearer {TOKEN}' \\\n-H 'Content-Type: application/json' \\\n-X PATCH \\\n-d '{\n \"title\": \"Gradient QR Code Updated\",\n \"archived\": false,\n \"render_customizations\": {\n \"dot_pattern_type\": \"rounded\",\n \"corners\": {\n \"corner_1\": {\n \"shape\": \"leaf\"\n },\n \"corner_2\": {\n \"shape\": \"leaf\"\n },\n \"corner_3\": {\n \"shape\": \"leaf\"\n }\n },\n \"gradient\": {\n \"style\": \"linear\",\n \"angle\": 45,\n \"colors\": [\n {\n \"color\": \"#C80404\",\n \"offset\": 10\n },\n {\n \"color\": \"#042F86\",\n \"offset\": 90\n }\n ],\n \"exclude_corners\": false\n },\n \"background_gradient\": {\n \"style\": \"radial\",\n \"colors\": [\n {\n \"color\": \"#C696EE\",\n \"offset\": 25\n },\n {\n \"color\": \"#D4E1A8\",\n \"offset\": 50\n }\n ]\n }\n }\n}' \\\nhttps://api-ssl.bitly.com/v4/qr-codes/Qabc123","exampleName":"Gradients"},{"sample":"var fetch = require('node-fetch');\n\nfetch('https://api-ssl.bitly.com/v4/qr-codes/Qabc123', {\n method: 'PATCH',\n headers: {\n 'Authorization': 'Bearer {TOKEN}',\n 'Content-Type': 'application/json'\n },\n body: JSON.stringify({ \"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 } ] } } })\n});\n","name":"Node","syntaxLanguage":"javascript","exampleName":"Gradients"},{"sample":"fetch('https://api-ssl.bitly.com/v4/qr-codes/Qabc123', {\n method: 'PATCH',\n headers: {\n 'Authorization': 'Bearer {TOKEN}',\n 'Content-Type': 'application/json'\n },\n body: JSON.stringify({ \"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 } ] } } })\n});\n","name":"Browser","syntaxLanguage":"javascript","exampleName":"Gradients"},{"sample":"package main\n\nimport (\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n\t\"strings\"\n)\n\nfunc main() {\n\tclient := \u0026http.Client{}\n\tvar data = strings.NewReader(`{ \"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 } ] } } }`)\n\treq, err := http.NewRequest(\"PATCH\", \"https://api-ssl.bitly.com/v4/qr-codes/Qabc123\", data)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\treq.Header.Set(\"Authorization\", \"Bearer {TOKEN}\")\n\treq.Header.Set(\"Content-Type\", \"application/json\")\n\tresp, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tdefer resp.Body.Close()\n\tbodyText, err := ioutil.ReadAll(resp.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tfmt.Printf(\"%s\\n\", bodyText)\n}\n","name":"Go","syntaxLanguage":"go","exampleName":"Gradients"},{"sample":"import requests\n\nheaders = {\n 'Authorization': 'Bearer {TOKEN}',\n 'Content-Type': 'application/json',\n}\n\ndata = '{ \"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 } ] } } }'\n\nresponse = requests.patch('https://api-ssl.bitly.com/v4/qr-codes/Qabc123', headers=headers, data=data)\n","name":"Python","syntaxLanguage":"python","exampleName":"Gradients"},{"name":"cURL","syntaxLanguage":"bash","sample":"curl \\\n-H 'Authorization: Bearer {TOKEN}' \\\n-H 'Content-Type: application/json' \\\n-X PATCH \\\n-d '{\n \"title\": \"Framed QR Code Updated\",\n \"archived\": false,\n \"render_customizations\": {\n \"frame\": {\n \"id\": \"arrow\",\n \"colors\": {\n \"primary\": \"#F55656\",\n \"background\": \"#FFFFFF\"\n },\n \"text\": {\n \"primary\": {\n \"content\": \"Scan Here\"\n }\n }\n },\n \"background_color\": \"#ffffff\",\n \"dot_pattern_color\": \"#EF8000\",\n \"dot_pattern_type\": \"rounded\",\n \"corners\": {\n \"corner_1\": {\n \"inner_color\": \"#EF8000\",\n \"outer_color\": \"#EF8000\",\n \"shape\": \"concave\"\n },\n \"corner_2\": {\n \"inner_color\": \"#EF8000\",\n \"outer_color\": \"#EF8000\",\n \"shape\": \"leaf\"\n },\n \"corner_3\": {\n \"inner_color\": \"#EF8000\",\n \"outer_color\": \"#EF8000\",\n \"shape\": \"target\"\n }\n },\n \"logo\": {\n \"image_guid\": \"bitlylogo\"\n }\n }\n}' \\\nhttps://api-ssl.bitly.com/v4/qr-codes/Qabc123","exampleName":"Framed"},{"sample":"var fetch = require('node-fetch');\n\nfetch('https://api-ssl.bitly.com/v4/qr-codes/Qabc123', {\n method: 'PATCH',\n headers: {\n 'Authorization': 'Bearer {TOKEN}',\n 'Content-Type': 'application/json'\n },\n body: JSON.stringify({ \"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\" } } })\n});\n","name":"Node","syntaxLanguage":"javascript","exampleName":"Framed"},{"sample":"fetch('https://api-ssl.bitly.com/v4/qr-codes/Qabc123', {\n method: 'PATCH',\n headers: {\n 'Authorization': 'Bearer {TOKEN}',\n 'Content-Type': 'application/json'\n },\n body: JSON.stringify({ \"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\" } } })\n});\n","name":"Browser","syntaxLanguage":"javascript","exampleName":"Framed"},{"sample":"package main\n\nimport (\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n\t\"strings\"\n)\n\nfunc main() {\n\tclient := \u0026http.Client{}\n\tvar data = strings.NewReader(`{ \"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\" } } }`)\n\treq, err := http.NewRequest(\"PATCH\", \"https://api-ssl.bitly.com/v4/qr-codes/Qabc123\", data)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\treq.Header.Set(\"Authorization\", \"Bearer {TOKEN}\")\n\treq.Header.Set(\"Content-Type\", \"application/json\")\n\tresp, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tdefer resp.Body.Close()\n\tbodyText, err := ioutil.ReadAll(resp.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tfmt.Printf(\"%s\\n\", bodyText)\n}\n","name":"Go","syntaxLanguage":"go","exampleName":"Framed"},{"sample":"import requests\n\nheaders = {\n 'Authorization': 'Bearer {TOKEN}',\n 'Content-Type': 'application/json',\n}\n\ndata = '{ \"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\" } } }'\n\nresponse = requests.patch('https://api-ssl.bitly.com/v4/qr-codes/Qabc123', headers=headers, data=data)\n","name":"Python","syntaxLanguage":"python","exampleName":"Framed"},{"name":"cURL","syntaxLanguage":"bash","sample":"curl \\\n-H 'Authorization: Bearer {TOKEN}' \\\n-H 'Content-Type: application/json' \\\n-X PATCH \\\n-d '{\n \"title\": \"Lowest Error Correction QR Code Updated\",\n \"render_customizations\": {\n \"spec_settings\": {\n \"error_correction\": 1\n }\n }\n}' \\\nhttps://api-ssl.bitly.com/v4/qr-codes/Qabc123","exampleName":"Lowest Error Correction"},{"sample":"var fetch = require('node-fetch');\n\nfetch('https://api-ssl.bitly.com/v4/qr-codes/Qabc123', {\n method: 'PATCH',\n headers: {\n 'Authorization': 'Bearer {TOKEN}',\n 'Content-Type': 'application/json'\n },\n body: JSON.stringify({ \"title\": \"Lowest Error Correction QR Code Updated\", \"render_customizations\": { \"spec_settings\": { \"error_correction\": 1 } } })\n});\n","name":"Node","syntaxLanguage":"javascript","exampleName":"Lowest Error Correction"},{"sample":"fetch('https://api-ssl.bitly.com/v4/qr-codes/Qabc123', {\n method: 'PATCH',\n headers: {\n 'Authorization': 'Bearer {TOKEN}',\n 'Content-Type': 'application/json'\n },\n body: JSON.stringify({ \"title\": \"Lowest Error Correction QR Code Updated\", \"render_customizations\": { \"spec_settings\": { \"error_correction\": 1 } } })\n});\n","name":"Browser","syntaxLanguage":"javascript","exampleName":"Lowest Error Correction"},{"sample":"package main\n\nimport (\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n\t\"strings\"\n)\n\nfunc main() {\n\tclient := \u0026http.Client{}\n\tvar data = strings.NewReader(`{ \"title\": \"Lowest Error Correction QR Code Updated\", \"render_customizations\": { \"spec_settings\": { \"error_correction\": 1 } } }`)\n\treq, err := http.NewRequest(\"PATCH\", \"https://api-ssl.bitly.com/v4/qr-codes/Qabc123\", data)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\treq.Header.Set(\"Authorization\", \"Bearer {TOKEN}\")\n\treq.Header.Set(\"Content-Type\", \"application/json\")\n\tresp, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tdefer resp.Body.Close()\n\tbodyText, err := ioutil.ReadAll(resp.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tfmt.Printf(\"%s\\n\", bodyText)\n}\n","name":"Go","syntaxLanguage":"go","exampleName":"Lowest Error Correction"},{"sample":"import requests\n\nheaders = {\n 'Authorization': 'Bearer {TOKEN}',\n 'Content-Type': 'application/json',\n}\n\ndata = '{ \"title\": \"Lowest Error Correction QR Code Updated\", \"render_customizations\": { \"spec_settings\": { \"error_correction\": 1 } } }'\n\nresponse = requests.patch('https://api-ssl.bitly.com/v4/qr-codes/Qabc123', headers=headers, data=data)\n","name":"Python","syntaxLanguage":"python","exampleName":"Lowest Error Correction"}],"responseSamples":[{"statusCode":"200","description":"SUCCESS","json":"{\n \"qrcode_id\": \"string\",\n \"group_guid\": \"string\",\n \"title\": \"string\",\n \"is_customized\": \"boolean\",\n \"serialized_content\": \"string\",\n \"qr_code_type\": \"string\",\n \"long_urls\": [\n \"string\"\n ],\n \"bitlink_id\": \"string\",\n \"is_gs1\": \"boolean\",\n \"created_by\": \"string\",\n \"archived\": \"boolean\",\n \"created\": \"string\",\n \"modified\": \"string\"\n}","csv":null},{"statusCode":"400","description":"BAD_REQUEST","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"403","description":"FORBIDDEN","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"404","description":"NOT_FOUND","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"410","description":"GONE","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"500","description":"INTERNAL_ERROR","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null}],"requestBodyParams":[{"name":"title","description":null,"required":null,"schema":{"type":"string","default":null,"enum":null},"items":null,"properties":null},{"name":"render_customizations","description":"Options for customizing a QR Code's appearance","required":null,"schema":{"type":"object","default":null,"enum":null},"items":null,"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":{"type":"string","enum":["standard","circle","block","blob","rounded","vertical","horizontal","triangle","heart","star","diamond"],"default":"standard"},"corners":{"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":{"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"}}},"corner_2":{"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"}}},"corner_3":{"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"}}}}},"gradient":{"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":{"type":"object","properties":{"color":{"description":"A color in hexadecimal format to be used in one of the gradient's \u003cstop\u003e 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}}}},"exclude_corners":{"description":"Ignore gradient mask on corners","type":"boolean"}}},"background_gradient":{"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":{"type":"object","properties":{"color":{"description":"A color in hexadecimal format to be used in one of the gradient's \u003cstop\u003e 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}}}},"exclude_corners":{"description":"Ignore gradient mask on corners","type":"boolean"}}},"logo":{"type":"object","properties":{"image_guid":{"type":"string","description":"A GUID for an image uploaded to Bitly"}}},"frame":{"type":"object","required":["id"],"properties":{"id":{"description":"The unique id of the selected frame","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"},"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":{"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"}}},"secondary":{"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"}}}}}}},"text":{"description":"Contains the center, top, and bottom text to be used in the QR code","type":"object","properties":{"center":{"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"}}},"top":{"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"}}},"bottom":{"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"}}}},"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"}}},"branding":{"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"}}},"spec_settings":{"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"}}}}},{"name":"archived","description":"A boolean representing if the QR code has been archived","required":null,"schema":{"type":"boolean","default":null,"enum":null},"items":null,"properties":null}]},{"summary":"Retrieve a QR Code","description":"Gets the QR code with a matching id.","operationId":"getQRCodeByIdPublic","tags":["QR Codes"],"parameters":[{"name":"qrcode_id","in":"path","description":"The QR Code ID","required":true,"schema":{"type":"string"},"example":"Qabcde12345"}],"responses":{"200":{"description":"SUCCESS","content":{"application/json":{"schema":{"type":"object","properties":{"qrcode_id":{"type":"string"},"group_guid":{"type":"string"},"title":{"type":"string"},"gs1":{"description":"Contains GS1 related metadata","type":"object","properties":{"values":{"description":"A list of GS1 application identifiers and their values","type":"array","items":{"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."}}}}}},"render_customizations":{"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":{"type":"string","enum":["standard","circle","block","blob","rounded","vertical","horizontal","triangle","heart","star","diamond"],"default":"standard"},"corners":{"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":{"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"}}},"corner_2":{"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"}}},"corner_3":{"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"}}}}},"gradient":{"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":{"type":"object","properties":{"color":{"description":"A color in hexadecimal format to be used in one of the gradient's \u003cstop\u003e 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}}}},"exclude_corners":{"description":"Ignore gradient mask on corners","type":"boolean"}}},"background_gradient":{"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":{"type":"object","properties":{"color":{"description":"A color in hexadecimal format to be used in one of the gradient's \u003cstop\u003e 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}}}},"exclude_corners":{"description":"Ignore gradient mask on corners","type":"boolean"}}},"logo":{"type":"object","properties":{"image_guid":{"type":"string","description":"A GUID for an image uploaded to Bitly"}}},"frame":{"type":"object","required":["id"],"properties":{"id":{"description":"The unique id of the selected frame","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"},"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":{"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"}}},"secondary":{"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"}}}}}}},"text":{"description":"Contains the center, top, and bottom text to be used in the QR code","type":"object","properties":{"center":{"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"}}},"top":{"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"}}},"bottom":{"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"}}}},"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"}}},"branding":{"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"}}},"spec_settings":{"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"}}}}},"qr_code_type":{"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"]},"bitlink_id":{"description":"The bitlink associated with the qr code. Not all qr codes are associated with one.","type":"string"},"long_urls":{"description":"A list of destination URLs that the qr code leads to.","type":"array","items":{"type":"string"}},"serialized_content":{"description":"The serialized string of the QR code's content","type":"string"},"archived":{"type":"boolean"},"created":{"type":"string"},"modified":{"type":"string"}}}}}},"400":{"description":"BAD_REQUEST","content":{"application/json":{"schema":{"description":"BAD_REQUEST","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"403":{"description":"FORBIDDEN","content":{"application/json":{"schema":{"description":"FORBIDDEN","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"404":{"description":"NOT_FOUND","content":{"application/json":{"schema":{"description":"NOT_FOUND","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"410":{"description":"GONE","content":{"application/json":{"schema":{"description":"GONE","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"500":{"description":"INTERNAL_ERROR","content":{"application/json":{"schema":{"description":"INTERNAL_ERROR","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}}},"method":"get","path":"/qr-codes/{qrcode_id}","requestSamples":[{"name":"cURL","syntaxLanguage":"bash","sample":"curl \\\n-H 'Authorization: Bearer {TOKEN}' \\\n-X GET \\\nhttps://api-ssl.bitly.com/v4/qr-codes/Qabcde12345","exampleName":"Default"},{"sample":"var fetch = require('node-fetch');\n\nfetch('https://api-ssl.bitly.com/v4/qr-codes/Qabcde12345', {\n headers: {\n 'Authorization': 'Bearer {TOKEN}'\n }\n});\n","name":"Node","syntaxLanguage":"javascript","exampleName":"Default"},{"sample":"fetch('https://api-ssl.bitly.com/v4/qr-codes/Qabcde12345', {\n headers: {\n 'Authorization': 'Bearer {TOKEN}'\n }\n});\n","name":"Browser","syntaxLanguage":"javascript","exampleName":"Default"},{"sample":"package main\n\nimport (\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\tclient := \u0026http.Client{}\n\treq, err := http.NewRequest(\"GET\", \"https://api-ssl.bitly.com/v4/qr-codes/Qabcde12345\", nil)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\treq.Header.Set(\"Authorization\", \"Bearer {TOKEN}\")\n\tresp, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tdefer resp.Body.Close()\n\tbodyText, err := ioutil.ReadAll(resp.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tfmt.Printf(\"%s\\n\", bodyText)\n}\n","name":"Go","syntaxLanguage":"go","exampleName":"Default"},{"sample":"import requests\n\nheaders = {\n 'Authorization': 'Bearer {TOKEN}',\n}\n\nresponse = requests.get('https://api-ssl.bitly.com/v4/qr-codes/Qabcde12345', headers=headers)\n","name":"Python","syntaxLanguage":"python","exampleName":"Default"}],"responseSamples":[{"statusCode":"200","description":"SUCCESS","json":"{\n \"qrcode_id\": \"string\",\n \"group_guid\": \"string\",\n \"title\": \"string\",\n \"gs1\": {\n \"values\": [\n {\n \"key\": \"string\",\n \"value\": \"string\"\n }\n ]\n },\n \"render_customizations\": {\n \"background_color\": \"string\",\n \"dot_pattern_color\": \"string\",\n \"dot_pattern_type\": \"string\",\n \"corners\": {\n \"corner_1\": {\n \"inner_color\": \"string\",\n \"outer_color\": \"string\",\n \"shape\": \"string\"\n },\n \"corner_2\": {\n \"inner_color\": \"string\",\n \"outer_color\": \"string\",\n \"shape\": \"string\"\n },\n \"corner_3\": {\n \"inner_color\": \"string\",\n \"outer_color\": \"string\",\n \"shape\": \"string\"\n }\n },\n \"gradient\": {\n \"style\": \"string\",\n \"angle\": \"number\",\n \"colors\": [\n {\n \"color\": \"string\",\n \"offset\": \"integer\"\n }\n ],\n \"exclude_corners\": \"boolean\"\n },\n \"background_gradient\": {\n \"style\": \"string\",\n \"angle\": \"number\",\n \"colors\": [\n {\n \"color\": \"string\",\n \"offset\": \"integer\"\n }\n ],\n \"exclude_corners\": \"boolean\"\n },\n \"logo\": {\n \"image_guid\": \"string\"\n },\n \"frame\": {\n \"id\": \"string\",\n \"colors\": {\n \"primary\": \"string\",\n \"secondary\": \"string\",\n \"background\": \"string\"\n },\n \"text\": {\n \"primary\": {\n \"content\": \"string\",\n \"color\": \"string\"\n },\n \"secondary\": {\n \"content\": \"string\",\n \"color\": \"string\"\n }\n }\n },\n \"text\": {\n \"center\": {\n \"content\": \"string\",\n \"color\": \"string\"\n },\n \"top\": {\n \"content\": \"string\",\n \"color\": \"string\"\n },\n \"bottom\": {\n \"content\": \"string\",\n \"color\": \"string\"\n }\n },\n \"branding\": {\n \"bitly_brand\": \"boolean\"\n },\n \"spec_settings\": {\n \"error_correction\": \"integer\"\n }\n },\n \"qr_code_type\": \"string\",\n \"bitlink_id\": \"string\",\n \"long_urls\": [\n \"string\"\n ],\n \"serialized_content\": \"string\",\n \"archived\": \"boolean\",\n \"created\": \"string\",\n \"modified\": \"string\"\n}","csv":null},{"statusCode":"400","description":"BAD_REQUEST","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"403","description":"FORBIDDEN","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"404","description":"NOT_FOUND","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"410","description":"GONE","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"500","description":"INTERNAL_ERROR","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null}],"requestBodyParams":null},{"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":[{"name":"group_guid","description":"A GUID for a Bitly group","in":"path","required":true,"schema":{"type":"string"},"example":"Ba1bc23dE4F"},{"name":"has_render_customizations","description":"Whether or not QRCode has any render customizations (like color or shape changes)","in":"query","schema":{"type":"string","default":"both","enum":["on","off","both"]},"example":"both"},{"name":"size","description":"The quantity of items to be be returned","in":"query","schema":{"type":"integer","default":50},"example":10},{"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"}},{"name":"query","description":"The value that you would like to search","in":"query","schema":{"type":"string"},"example":"api"},{"name":"created_before","description":"Timestamp as an integer unix epoch (seconds only)","in":"query","schema":{"type":"integer"},"example":1694529902},{"name":"created_after","description":"Timestamp as an integer unix epoch (seconds only)","in":"query","schema":{"type":"integer"},"example":1694529902},{"name":"archived","description":"Whether or not to include archived resources","in":"query","schema":{"type":"string","default":"off","enum":["on","off","both"]},"example":"both"},{"name":"creating_login","description":"Filter by the login of the authenticated user that created the QR Code","in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true,"example":["chauncey"]},{"name":"qrc_type","in":"query","schema":{"type":"array","items":{"type":"string","enum":["bitlink","long_url"]},"example":["bitlink"],"default":["bitlink","long_url"]}},{"name":"is_gs1","description":"a filter value if the resource is a GS1 QR code","in":"query","schema":{"type":"string","default":"both","enum":["on","off","both"]},"example":"both"}],"responses":{"200":{"description":"SUCCESS","content":{"application/json":{"schema":{"description":"QR code paginated list Response","type":"object","properties":{"qr_codes":{"type":"array","items":{"type":"object","properties":{"qrcode_id":{"type":"string"},"group_guid":{"type":"string"},"title":{"type":"string"},"is_customized":{"description":"Set to true if the QR code's customization values have been changed from their default setting","type":"boolean"},"serialized_content":{"description":"A serialized string of the QR code's content","type":"string"},"qr_code_type":{"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"]},"long_urls":{"description":"A list of destination URLs that the qr code leads to.","type":"array","items":{"type":"string"}},"bitlink_id":{"description":"The bitlink ID associated with the qr code. Not all qr codes are associated with one.","type":"string"},"is_gs1":{"description":"Set to true if QR code has GS1 values.","type":"boolean"},"created_by":{"description":"User that created the code.","type":"string"},"archived":{"type":"boolean"},"created":{"type":"string"},"modified":{"type":"string"}}}},"pagination":{"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}}}}}}}},"403":{"description":"FORBIDDEN","content":{"application/json":{"schema":{"description":"FORBIDDEN","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"429":{"description":"MONTHLY_LIMIT_EXCEEDED","content":{"application/json":{"schema":{"example":"API_USAGE_LIMIT_EXCEEDED","description":"MONTHLY_LIMIT_EXCEEDED","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"}}}]}}}},"500":{"description":"INTERNAL_ERROR","content":{"application/json":{"schema":{"description":"INTERNAL_ERROR","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}}},"method":"get","path":"/groups/{group_guid}/qr-codes","requestSamples":[{"name":"cURL","syntaxLanguage":"bash","sample":"curl \\\n-H 'Authorization: Bearer {TOKEN}' \\\n-X GET \\\nhttps://api-ssl.bitly.com/v4/groups/Ba1bc23dE4F/qr-codes?has_render_customizations=both\u0026size=10\u0026search_after=\u0026query=api\u0026created_before=1694529902\u0026created_after=1694529902\u0026archived=both\u0026creating_login=chauncey\u0026qrc_type=\u0026is_gs1=both","exampleName":"Default"},{"sample":"var fetch = require('node-fetch');\n\nfetch('https://api-ssl.bitly.com/v4/groups/Ba1bc23dE4F/qr-codes?has_render_customizations=both\u0026size=10\u0026search_after=\u0026query=api\u0026created_before=1694529902\u0026created_after=1694529902\u0026archived=both\u0026creating_login=chauncey\u0026qrc_type=\u0026is_gs1=both', {\n headers: {\n 'Authorization': 'Bearer {TOKEN}'\n }\n});\n","name":"Node","syntaxLanguage":"javascript","exampleName":"Default"},{"sample":"fetch('https://api-ssl.bitly.com/v4/groups/Ba1bc23dE4F/qr-codes?has_render_customizations=both\u0026size=10\u0026search_after=\u0026query=api\u0026created_before=1694529902\u0026created_after=1694529902\u0026archived=both\u0026creating_login=chauncey\u0026qrc_type=\u0026is_gs1=both', {\n headers: {\n 'Authorization': 'Bearer {TOKEN}'\n }\n});\n","name":"Browser","syntaxLanguage":"javascript","exampleName":"Default"},{"sample":"package main\n\nimport (\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\tclient := \u0026http.Client{}\n\treq, err := http.NewRequest(\"GET\", \"https://api-ssl.bitly.com/v4/groups/Ba1bc23dE4F/qr-codes?has_render_customizations=both\u0026size=10\u0026search_after=\u0026query=api\u0026created_before=1694529902\u0026created_after=1694529902\u0026archived=both\u0026creating_login=chauncey\u0026qrc_type=\u0026is_gs1=both\", nil)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\treq.Header.Set(\"Authorization\", \"Bearer {TOKEN}\")\n\tresp, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tdefer resp.Body.Close()\n\tbodyText, err := ioutil.ReadAll(resp.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tfmt.Printf(\"%s\\n\", bodyText)\n}\n","name":"Go","syntaxLanguage":"go","exampleName":"Default"},{"sample":"import requests\n\nheaders = {\n 'Authorization': 'Bearer {TOKEN}',\n}\n\nparams = (\n ('has_render_customizations', 'both'),\n ('size', '10'),\n ('search_after', ''),\n ('query', 'api'),\n ('created_before', '1694529902'),\n ('created_after', '1694529902'),\n ('archived', 'both'),\n ('creating_login', 'chauncey'),\n ('qrc_type', ''),\n ('is_gs1', 'both'),\n)\n\nresponse = requests.get('https://api-ssl.bitly.com/v4/groups/Ba1bc23dE4F/qr-codes', headers=headers, params=params)\n\n#NB. Original query string below. It seems impossible to parse and\n#reproduce query strings 100% accurately so the one below is given\n#in case the reproduced version is not \"correct\".\n# response = requests.get('https://api-ssl.bitly.com/v4/groups/Ba1bc23dE4F/qr-codes?has_render_customizations=both\u0026size=10\u0026search_after=\u0026query=api\u0026created_before=1694529902\u0026created_after=1694529902\u0026archived=both\u0026creating_login=chauncey\u0026qrc_type=\u0026is_gs1=both', headers=headers)\n","name":"Python","syntaxLanguage":"python","exampleName":"Default"}],"responseSamples":[{"statusCode":"200","description":"SUCCESS","json":"{\n \"qr_codes\": [\n {\n \"qrcode_id\": \"string\",\n \"group_guid\": \"string\",\n \"title\": \"string\",\n \"is_customized\": \"boolean\",\n \"serialized_content\": \"string\",\n \"qr_code_type\": \"string\",\n \"long_urls\": [\n \"string\"\n ],\n \"bitlink_id\": \"string\",\n \"is_gs1\": \"boolean\",\n \"created_by\": \"string\",\n \"archived\": \"boolean\",\n \"created\": \"string\",\n \"modified\": \"string\"\n }\n ],\n \"pagination\": {\n \"next\": \"string\",\n \"search_after\": \"string\",\n \"size\": \"integer\"\n }\n}","csv":null},{"statusCode":"403","description":"FORBIDDEN","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"429","description":"MONTHLY_LIMIT_EXCEEDED","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\"\n}","csv":null},{"statusCode":"500","description":"INTERNAL_ERROR","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null}],"requestBodyParams":null},{"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":[{"name":"qrcode_id","in":"path","description":"The QR Code ID","required":true,"schema":{"type":"string"},"example":"Qabcde12345"},{"name":"unit","description":"A unit of time","schema":{"description":"the unit of time queried for (minute, hour, day, week, month)","type":"string","enum":["minute","hour","day","week","month"],"default":"day"},"required":true,"in":"query","example":"month"},{"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},{"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"}],"responses":{"200":{"description":"SUCCESS","content":{"application/json":{"schema":{"type":"object","properties":{"scans":{"type":"array","items":{"type":"object","properties":{"scans":{"type":"integer"},"date":{"type":"string"}}}},"units":{"type":"integer"},"unit":{"type":"string","enum":["minute","hour","day","week","month"]},"unit_reference":{"type":"string"}}}}}},"400":{"description":"BAD_REQUEST","content":{"application/json":{"schema":{"description":"BAD_REQUEST","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"403":{"description":"FORBIDDEN","content":{"application/json":{"schema":{"description":"FORBIDDEN","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"404":{"description":"NOT_FOUND","content":{"application/json":{"schema":{"description":"NOT_FOUND","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"410":{"description":"GONE","content":{"application/json":{"schema":{"description":"GONE","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"500":{"description":"INTERNAL_ERROR","content":{"application/json":{"schema":{"description":"INTERNAL_ERROR","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"503":{"description":"TEMPORARILY_UNAVAILABLE","content":{"application/json":{"schema":{"description":"TEMPORARILY_UNAVAILABLE","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}}},"method":"get","path":"/qr-codes/{qrcode_id}/scans","requestSamples":[{"name":"cURL","syntaxLanguage":"bash","sample":"curl \\\n-H 'Authorization: Bearer {TOKEN}' \\\n-X GET \\\nhttps://api-ssl.bitly.com/v4/qr-codes/Qabcde12345/scans?unit=month\u0026units=1\u0026unit_reference=2006-01-02T15%3A04%3A05-0700","exampleName":"Default"},{"sample":"var fetch = require('node-fetch');\n\nfetch('https://api-ssl.bitly.com/v4/qr-codes/Qabcde12345/scans?unit=month\u0026units=1\u0026unit_reference=2006-01-02T15%3A04%3A05-0700', {\n headers: {\n 'Authorization': 'Bearer {TOKEN}'\n }\n});\n","name":"Node","syntaxLanguage":"javascript","exampleName":"Default"},{"sample":"fetch('https://api-ssl.bitly.com/v4/qr-codes/Qabcde12345/scans?unit=month\u0026units=1\u0026unit_reference=2006-01-02T15%3A04%3A05-0700', {\n headers: {\n 'Authorization': 'Bearer {TOKEN}'\n }\n});\n","name":"Browser","syntaxLanguage":"javascript","exampleName":"Default"},{"sample":"package main\n\nimport (\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\tclient := \u0026http.Client{}\n\treq, err := http.NewRequest(\"GET\", \"https://api-ssl.bitly.com/v4/qr-codes/Qabcde12345/scans?unit=month\u0026units=1\u0026unit_reference=2006-01-02T15%3A04%3A05-0700\", nil)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\treq.Header.Set(\"Authorization\", \"Bearer {TOKEN}\")\n\tresp, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tdefer resp.Body.Close()\n\tbodyText, err := ioutil.ReadAll(resp.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tfmt.Printf(\"%s\\n\", bodyText)\n}\n","name":"Go","syntaxLanguage":"go","exampleName":"Default"},{"sample":"import requests\n\nheaders = {\n 'Authorization': 'Bearer {TOKEN}',\n}\n\nparams = (\n ('unit', 'month'),\n ('units', '1'),\n ('unit_reference', '2006-01-02T15:04:05-0700'),\n)\n\nresponse = requests.get('https://api-ssl.bitly.com/v4/qr-codes/Qabcde12345/scans', headers=headers, params=params)\n\n#NB. Original query string below. It seems impossible to parse and\n#reproduce query strings 100% accurately so the one below is given\n#in case the reproduced version is not \"correct\".\n# response = requests.get('https://api-ssl.bitly.com/v4/qr-codes/Qabcde12345/scans?unit=month\u0026units=1\u0026unit_reference=2006-01-02T15%3A04%3A05-0700', headers=headers)\n","name":"Python","syntaxLanguage":"python","exampleName":"Default"}],"responseSamples":[{"statusCode":"200","description":"SUCCESS","json":"{\n \"scans\": [\n {\n \"scans\": \"integer\",\n \"date\": \"string\"\n }\n ],\n \"units\": \"integer\",\n \"unit\": \"string\",\n \"unit_reference\": \"string\"\n}","csv":null},{"statusCode":"400","description":"BAD_REQUEST","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"403","description":"FORBIDDEN","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"404","description":"NOT_FOUND","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"410","description":"GONE","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"500","description":"INTERNAL_ERROR","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"503","description":"TEMPORARILY_UNAVAILABLE","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null}],"requestBodyParams":null},{"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":[{"name":"qrcode_id","in":"path","description":"The QR Code ID","required":true,"schema":{"type":"string"},"example":"Qabcde12345"},{"name":"unit","description":"A unit of time","schema":{"description":"the unit of time queried for (minute, hour, day, week, month)","type":"string","enum":["minute","hour","day","week","month"],"default":"day"},"required":true,"in":"query","example":"month"},{"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},{"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"}],"responses":{"200":{"description":"SUCCESS","content":{"application/json":{"schema":{"type":"object","properties":{"total_scans":{"type":"integer"},"units":{"type":"integer"},"unit":{"type":"string","enum":["minute","hour","day","week","month"]},"unit_reference":{"type":"string"}}}}}},"400":{"description":"BAD_REQUEST","content":{"application/json":{"schema":{"description":"BAD_REQUEST","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"403":{"description":"FORBIDDEN","content":{"application/json":{"schema":{"description":"FORBIDDEN","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"404":{"description":"NOT_FOUND","content":{"application/json":{"schema":{"description":"NOT_FOUND","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"410":{"description":"GONE","content":{"application/json":{"schema":{"description":"GONE","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"500":{"description":"INTERNAL_ERROR","content":{"application/json":{"schema":{"description":"INTERNAL_ERROR","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"503":{"description":"TEMPORARILY_UNAVAILABLE","content":{"application/json":{"schema":{"description":"TEMPORARILY_UNAVAILABLE","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}}},"method":"get","path":"/qr-codes/{qrcode_id}/scans/summary","requestSamples":[{"name":"cURL","syntaxLanguage":"bash","sample":"curl \\\n-H 'Authorization: Bearer {TOKEN}' \\\n-X GET \\\nhttps://api-ssl.bitly.com/v4/qr-codes/Qabcde12345/scans/summary?unit=month\u0026units=1\u0026unit_reference=2006-01-02T15%3A04%3A05-0700","exampleName":"Default"},{"sample":"var fetch = require('node-fetch');\n\nfetch('https://api-ssl.bitly.com/v4/qr-codes/Qabcde12345/scans/summary?unit=month\u0026units=1\u0026unit_reference=2006-01-02T15%3A04%3A05-0700', {\n headers: {\n 'Authorization': 'Bearer {TOKEN}'\n }\n});\n","name":"Node","syntaxLanguage":"javascript","exampleName":"Default"},{"sample":"fetch('https://api-ssl.bitly.com/v4/qr-codes/Qabcde12345/scans/summary?unit=month\u0026units=1\u0026unit_reference=2006-01-02T15%3A04%3A05-0700', {\n headers: {\n 'Authorization': 'Bearer {TOKEN}'\n }\n});\n","name":"Browser","syntaxLanguage":"javascript","exampleName":"Default"},{"sample":"package main\n\nimport (\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\tclient := \u0026http.Client{}\n\treq, err := http.NewRequest(\"GET\", \"https://api-ssl.bitly.com/v4/qr-codes/Qabcde12345/scans/summary?unit=month\u0026units=1\u0026unit_reference=2006-01-02T15%3A04%3A05-0700\", nil)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\treq.Header.Set(\"Authorization\", \"Bearer {TOKEN}\")\n\tresp, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tdefer resp.Body.Close()\n\tbodyText, err := ioutil.ReadAll(resp.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tfmt.Printf(\"%s\\n\", bodyText)\n}\n","name":"Go","syntaxLanguage":"go","exampleName":"Default"},{"sample":"import requests\n\nheaders = {\n 'Authorization': 'Bearer {TOKEN}',\n}\n\nparams = (\n ('unit', 'month'),\n ('units', '1'),\n ('unit_reference', '2006-01-02T15:04:05-0700'),\n)\n\nresponse = requests.get('https://api-ssl.bitly.com/v4/qr-codes/Qabcde12345/scans/summary', headers=headers, params=params)\n\n#NB. Original query string below. It seems impossible to parse and\n#reproduce query strings 100% accurately so the one below is given\n#in case the reproduced version is not \"correct\".\n# response = requests.get('https://api-ssl.bitly.com/v4/qr-codes/Qabcde12345/scans/summary?unit=month\u0026units=1\u0026unit_reference=2006-01-02T15%3A04%3A05-0700', headers=headers)\n","name":"Python","syntaxLanguage":"python","exampleName":"Default"}],"responseSamples":[{"statusCode":"200","description":"SUCCESS","json":"{\n \"total_scans\": \"integer\",\n \"units\": \"integer\",\n \"unit\": \"string\",\n \"unit_reference\": \"string\"\n}","csv":null},{"statusCode":"400","description":"BAD_REQUEST","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"403","description":"FORBIDDEN","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"404","description":"NOT_FOUND","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"410","description":"GONE","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"500","description":"INTERNAL_ERROR","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"503","description":"TEMPORARILY_UNAVAILABLE","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null}],"requestBodyParams":null},{"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":[{"name":"qrcode_id","in":"path","description":"The QR Code ID","required":true,"schema":{"type":"string"},"example":"Qabcde12345"},{"name":"unit","description":"A unit of time","schema":{"description":"the unit of time queried for (minute, hour, day, week, month)","type":"string","enum":["minute","hour","day","week","month"],"default":"day"},"required":true,"in":"query","example":"month"},{"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},{"name":"size","description":"The quantity of items to be be returned","in":"query","schema":{"type":"integer","default":50},"example":10},{"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"}],"responses":{"200":{"description":"SUCCESS","content":{"application/json":{"schema":{"type":"object","allOf":[{"type":"object","properties":{"unit":{"type":"string"},"units":{"type":"integer"},"facet":{"type":"string","enum":["countries","cities","device_os","browsers"]},"unit_reference":{"type":"string"}}},{"properties":{"metrics":{"type":"array","items":{"type":"object","properties":{"scans":{"type":"integer"},"value":{"type":"string"}}}}}}]}},"text/csv":{"schema":{"type":"object","allOf":[{"type":"object","properties":{"unit":{"type":"string"},"units":{"type":"integer"},"facet":{"type":"string","enum":["countries","cities","device_os","browsers"]},"unit_reference":{"type":"string"}}},{"properties":{"metrics":{"type":"array","items":{"type":"object","properties":{"scans":{"type":"integer"},"value":{"type":"string"}}}}}}]},"example":"Country, Scans\nUS, 5\n"}}},"400":{"description":"BAD_REQUEST","content":{"application/json":{"schema":{"description":"BAD_REQUEST","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"403":{"description":"FORBIDDEN","content":{"application/json":{"schema":{"description":"FORBIDDEN","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"404":{"description":"NOT_FOUND","content":{"application/json":{"schema":{"description":"NOT_FOUND","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"410":{"description":"GONE","content":{"application/json":{"schema":{"description":"GONE","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"500":{"description":"INTERNAL_ERROR","content":{"application/json":{"schema":{"description":"INTERNAL_ERROR","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"503":{"description":"TEMPORARILY_UNAVAILABLE","content":{"application/json":{"schema":{"description":"TEMPORARILY_UNAVAILABLE","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}}},"method":"get","path":"/qr-codes/{qrcode_id}/scans/countries","requestSamples":[{"name":"cURL","syntaxLanguage":"bash","sample":"curl \\\n-H 'Authorization: Bearer {TOKEN}' \\\n-X GET \\\nhttps://api-ssl.bitly.com/v4/qr-codes/Qabcde12345/scans/countries?unit=month\u0026units=1\u0026size=10\u0026unit_reference=2006-01-02T15%3A04%3A05-0700","exampleName":"Default"},{"sample":"var fetch = require('node-fetch');\n\nfetch('https://api-ssl.bitly.com/v4/qr-codes/Qabcde12345/scans/countries?unit=month\u0026units=1\u0026size=10\u0026unit_reference=2006-01-02T15%3A04%3A05-0700', {\n headers: {\n 'Authorization': 'Bearer {TOKEN}'\n }\n});\n","name":"Node","syntaxLanguage":"javascript","exampleName":"Default"},{"sample":"fetch('https://api-ssl.bitly.com/v4/qr-codes/Qabcde12345/scans/countries?unit=month\u0026units=1\u0026size=10\u0026unit_reference=2006-01-02T15%3A04%3A05-0700', {\n headers: {\n 'Authorization': 'Bearer {TOKEN}'\n }\n});\n","name":"Browser","syntaxLanguage":"javascript","exampleName":"Default"},{"sample":"package main\n\nimport (\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\tclient := \u0026http.Client{}\n\treq, err := http.NewRequest(\"GET\", \"https://api-ssl.bitly.com/v4/qr-codes/Qabcde12345/scans/countries?unit=month\u0026units=1\u0026size=10\u0026unit_reference=2006-01-02T15%3A04%3A05-0700\", nil)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\treq.Header.Set(\"Authorization\", \"Bearer {TOKEN}\")\n\tresp, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tdefer resp.Body.Close()\n\tbodyText, err := ioutil.ReadAll(resp.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tfmt.Printf(\"%s\\n\", bodyText)\n}\n","name":"Go","syntaxLanguage":"go","exampleName":"Default"},{"sample":"import requests\n\nheaders = {\n 'Authorization': 'Bearer {TOKEN}',\n}\n\nparams = (\n ('unit', 'month'),\n ('units', '1'),\n ('size', '10'),\n ('unit_reference', '2006-01-02T15:04:05-0700'),\n)\n\nresponse = requests.get('https://api-ssl.bitly.com/v4/qr-codes/Qabcde12345/scans/countries', headers=headers, params=params)\n\n#NB. Original query string below. It seems impossible to parse and\n#reproduce query strings 100% accurately so the one below is given\n#in case the reproduced version is not \"correct\".\n# response = requests.get('https://api-ssl.bitly.com/v4/qr-codes/Qabcde12345/scans/countries?unit=month\u0026units=1\u0026size=10\u0026unit_reference=2006-01-02T15%3A04%3A05-0700', headers=headers)\n","name":"Python","syntaxLanguage":"python","exampleName":"Default"}],"responseSamples":[{"statusCode":"200","description":"SUCCESS","json":"{\n \"unit\": \"string\",\n \"units\": \"integer\",\n \"facet\": \"string\",\n \"unit_reference\": \"string\",\n \"metrics\": [\n {\n \"scans\": \"integer\",\n \"value\": \"string\"\n }\n ]\n}","csv":"Country, Scans\nUS, 5\n"},{"statusCode":"400","description":"BAD_REQUEST","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"403","description":"FORBIDDEN","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"404","description":"NOT_FOUND","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"410","description":"GONE","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"500","description":"INTERNAL_ERROR","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"503","description":"TEMPORARILY_UNAVAILABLE","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null}],"requestBodyParams":null},{"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":[{"name":"qrcode_id","in":"path","description":"The QR Code ID","required":true,"schema":{"type":"string"},"example":"Qabcde12345"},{"name":"unit","description":"A unit of time","schema":{"description":"the unit of time queried for (minute, hour, day, week, month)","type":"string","enum":["minute","hour","day","week","month"],"default":"day"},"required":true,"in":"query","example":"month"},{"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},{"name":"size","description":"The quantity of items to be be returned","in":"query","schema":{"type":"integer","default":50},"example":10},{"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"}],"responses":{"200":{"description":"SUCCESS","content":{"application/json":{"schema":{"type":"object","allOf":[{"type":"object","properties":{"unit":{"type":"string"},"units":{"type":"integer"},"facet":{"type":"string","enum":["countries","cities","device_os","browsers"]},"unit_reference":{"type":"string"}}},{"properties":{"metrics":{"type":"array","items":{"type":"object","properties":{"scans":{"type":"integer"},"city":{"type":"string"},"subregion":{"type":"string"},"region":{"type":"string"},"country":{"type":"string"}}}},"other_metrics":{"type":"object","properties":{"other_city_scans":{"type":"integer"},"no_city_scans":{"type":"integer"}}}}}]}},"text/csv":{"schema":{"type":"object","allOf":[{"type":"object","properties":{"unit":{"type":"string"},"units":{"type":"integer"},"facet":{"type":"string","enum":["countries","cities","device_os","browsers"]},"unit_reference":{"type":"string"}}},{"properties":{"metrics":{"type":"array","items":{"type":"object","properties":{"scans":{"type":"integer"},"city":{"type":"string"},"subregion":{"type":"string"},"region":{"type":"string"},"country":{"type":"string"}}}},"other_metrics":{"type":"object","properties":{"other_city_scans":{"type":"integer"},"no_city_scans":{"type":"integer"}}}}}]},"example":"City, Subregion, Region, Country, Scans\nNew York, , NY, US, 5\n"}}},"400":{"description":"BAD_REQUEST","content":{"application/json":{"schema":{"description":"BAD_REQUEST","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"402":{"description":"UPGRADE_REQUIRED","content":{"application/json":{"schema":{"description":"UPGRADE_REQUIRED","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"403":{"description":"FORBIDDEN","content":{"application/json":{"schema":{"description":"FORBIDDEN","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"404":{"description":"NOT_FOUND","content":{"application/json":{"schema":{"description":"NOT_FOUND","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"410":{"description":"GONE","content":{"application/json":{"schema":{"description":"GONE","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"500":{"description":"INTERNAL_ERROR","content":{"application/json":{"schema":{"description":"INTERNAL_ERROR","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"503":{"description":"TEMPORARILY_UNAVAILABLE","content":{"application/json":{"schema":{"description":"TEMPORARILY_UNAVAILABLE","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}}},"method":"get","path":"/qr-codes/{qrcode_id}/scans/cities","requestSamples":[{"name":"cURL","syntaxLanguage":"bash","sample":"curl \\\n-H 'Authorization: Bearer {TOKEN}' \\\n-X GET \\\nhttps://api-ssl.bitly.com/v4/qr-codes/Qabcde12345/scans/cities?unit=month\u0026units=1\u0026size=10\u0026unit_reference=2006-01-02T15%3A04%3A05-0700","exampleName":"Default"},{"sample":"var fetch = require('node-fetch');\n\nfetch('https://api-ssl.bitly.com/v4/qr-codes/Qabcde12345/scans/cities?unit=month\u0026units=1\u0026size=10\u0026unit_reference=2006-01-02T15%3A04%3A05-0700', {\n headers: {\n 'Authorization': 'Bearer {TOKEN}'\n }\n});\n","name":"Node","syntaxLanguage":"javascript","exampleName":"Default"},{"sample":"fetch('https://api-ssl.bitly.com/v4/qr-codes/Qabcde12345/scans/cities?unit=month\u0026units=1\u0026size=10\u0026unit_reference=2006-01-02T15%3A04%3A05-0700', {\n headers: {\n 'Authorization': 'Bearer {TOKEN}'\n }\n});\n","name":"Browser","syntaxLanguage":"javascript","exampleName":"Default"},{"sample":"package main\n\nimport (\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\tclient := \u0026http.Client{}\n\treq, err := http.NewRequest(\"GET\", \"https://api-ssl.bitly.com/v4/qr-codes/Qabcde12345/scans/cities?unit=month\u0026units=1\u0026size=10\u0026unit_reference=2006-01-02T15%3A04%3A05-0700\", nil)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\treq.Header.Set(\"Authorization\", \"Bearer {TOKEN}\")\n\tresp, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tdefer resp.Body.Close()\n\tbodyText, err := ioutil.ReadAll(resp.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tfmt.Printf(\"%s\\n\", bodyText)\n}\n","name":"Go","syntaxLanguage":"go","exampleName":"Default"},{"sample":"import requests\n\nheaders = {\n 'Authorization': 'Bearer {TOKEN}',\n}\n\nparams = (\n ('unit', 'month'),\n ('units', '1'),\n ('size', '10'),\n ('unit_reference', '2006-01-02T15:04:05-0700'),\n)\n\nresponse = requests.get('https://api-ssl.bitly.com/v4/qr-codes/Qabcde12345/scans/cities', headers=headers, params=params)\n\n#NB. Original query string below. It seems impossible to parse and\n#reproduce query strings 100% accurately so the one below is given\n#in case the reproduced version is not \"correct\".\n# response = requests.get('https://api-ssl.bitly.com/v4/qr-codes/Qabcde12345/scans/cities?unit=month\u0026units=1\u0026size=10\u0026unit_reference=2006-01-02T15%3A04%3A05-0700', headers=headers)\n","name":"Python","syntaxLanguage":"python","exampleName":"Default"}],"responseSamples":[{"statusCode":"200","description":"SUCCESS","json":"{\n \"unit\": \"string\",\n \"units\": \"integer\",\n \"facet\": \"string\",\n \"unit_reference\": \"string\",\n \"metrics\": [\n {\n \"scans\": \"integer\",\n \"city\": \"string\",\n \"subregion\": \"string\",\n \"region\": \"string\",\n \"country\": \"string\"\n }\n ],\n \"other_metrics\": {\n \"other_city_scans\": \"integer\",\n \"no_city_scans\": \"integer\"\n }\n}","csv":"City, Subregion, Region, Country, Scans\nNew York, , NY, US, 5\n"},{"statusCode":"400","description":"BAD_REQUEST","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"402","description":"UPGRADE_REQUIRED","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"403","description":"FORBIDDEN","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"404","description":"NOT_FOUND","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"410","description":"GONE","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"500","description":"INTERNAL_ERROR","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"503","description":"TEMPORARILY_UNAVAILABLE","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null}],"requestBodyParams":null},{"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":[{"name":"qrcode_id","in":"path","description":"The QR Code ID","required":true,"schema":{"type":"string"},"example":"Qabcde12345"},{"name":"unit","description":"A unit of time","schema":{"description":"the unit of time queried for (minute, hour, day, week, month)","type":"string","enum":["minute","hour","day","week","month"],"default":"day"},"required":true,"in":"query","example":"month"},{"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},{"name":"size","description":"The quantity of items to be be returned","in":"query","schema":{"type":"integer","default":50},"example":10},{"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"}],"responses":{"200":{"description":"SUCCESS","content":{"application/json":{"schema":{"type":"object","allOf":[{"type":"object","properties":{"unit":{"type":"string"},"units":{"type":"integer"},"facet":{"type":"string","enum":["countries","cities","device_os","browsers"]},"unit_reference":{"type":"string"}}},{"properties":{"metrics":{"type":"array","items":{"type":"object","properties":{"scans":{"type":"integer"},"value":{"type":"string"}}}}}}]}},"text/csv":{"schema":{"type":"object","allOf":[{"type":"object","properties":{"unit":{"type":"string"},"units":{"type":"integer"},"facet":{"type":"string","enum":["countries","cities","device_os","browsers"]},"unit_reference":{"type":"string"}}},{"properties":{"metrics":{"type":"array","items":{"type":"object","properties":{"scans":{"type":"integer"},"value":{"type":"string"}}}}}}]},"example":"Device OS, Scans\nApple, 5\n"}}},"400":{"description":"BAD_REQUEST","content":{"application/json":{"schema":{"description":"BAD_REQUEST","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"402":{"description":"UPGRADE_REQUIRED","content":{"application/json":{"schema":{"description":"UPGRADE_REQUIRED","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"403":{"description":"FORBIDDEN","content":{"application/json":{"schema":{"description":"FORBIDDEN","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"404":{"description":"NOT_FOUND","content":{"application/json":{"schema":{"description":"NOT_FOUND","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"410":{"description":"GONE","content":{"application/json":{"schema":{"description":"GONE","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"500":{"description":"INTERNAL_ERROR","content":{"application/json":{"schema":{"description":"INTERNAL_ERROR","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"503":{"description":"TEMPORARILY_UNAVAILABLE","content":{"application/json":{"schema":{"description":"TEMPORARILY_UNAVAILABLE","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}}},"method":"get","path":"/qr-codes/{qrcode_id}/scans/device_os","requestSamples":[{"name":"cURL","syntaxLanguage":"bash","sample":"curl \\\n-H 'Authorization: Bearer {TOKEN}' \\\n-X GET \\\nhttps://api-ssl.bitly.com/v4/qr-codes/Qabcde12345/scans/device_os?unit=month\u0026units=1\u0026size=10\u0026unit_reference=2006-01-02T15%3A04%3A05-0700","exampleName":"Default"},{"sample":"var fetch = require('node-fetch');\n\nfetch('https://api-ssl.bitly.com/v4/qr-codes/Qabcde12345/scans/device_os?unit=month\u0026units=1\u0026size=10\u0026unit_reference=2006-01-02T15%3A04%3A05-0700', {\n headers: {\n 'Authorization': 'Bearer {TOKEN}'\n }\n});\n","name":"Node","syntaxLanguage":"javascript","exampleName":"Default"},{"sample":"fetch('https://api-ssl.bitly.com/v4/qr-codes/Qabcde12345/scans/device_os?unit=month\u0026units=1\u0026size=10\u0026unit_reference=2006-01-02T15%3A04%3A05-0700', {\n headers: {\n 'Authorization': 'Bearer {TOKEN}'\n }\n});\n","name":"Browser","syntaxLanguage":"javascript","exampleName":"Default"},{"sample":"package main\n\nimport (\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\tclient := \u0026http.Client{}\n\treq, err := http.NewRequest(\"GET\", \"https://api-ssl.bitly.com/v4/qr-codes/Qabcde12345/scans/device_os?unit=month\u0026units=1\u0026size=10\u0026unit_reference=2006-01-02T15%3A04%3A05-0700\", nil)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\treq.Header.Set(\"Authorization\", \"Bearer {TOKEN}\")\n\tresp, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tdefer resp.Body.Close()\n\tbodyText, err := ioutil.ReadAll(resp.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tfmt.Printf(\"%s\\n\", bodyText)\n}\n","name":"Go","syntaxLanguage":"go","exampleName":"Default"},{"sample":"import requests\n\nheaders = {\n 'Authorization': 'Bearer {TOKEN}',\n}\n\nparams = (\n ('unit', 'month'),\n ('units', '1'),\n ('size', '10'),\n ('unit_reference', '2006-01-02T15:04:05-0700'),\n)\n\nresponse = requests.get('https://api-ssl.bitly.com/v4/qr-codes/Qabcde12345/scans/device_os', headers=headers, params=params)\n\n#NB. Original query string below. It seems impossible to parse and\n#reproduce query strings 100% accurately so the one below is given\n#in case the reproduced version is not \"correct\".\n# response = requests.get('https://api-ssl.bitly.com/v4/qr-codes/Qabcde12345/scans/device_os?unit=month\u0026units=1\u0026size=10\u0026unit_reference=2006-01-02T15%3A04%3A05-0700', headers=headers)\n","name":"Python","syntaxLanguage":"python","exampleName":"Default"}],"responseSamples":[{"statusCode":"200","description":"SUCCESS","json":"{\n \"unit\": \"string\",\n \"units\": \"integer\",\n \"facet\": \"string\",\n \"unit_reference\": \"string\",\n \"metrics\": [\n {\n \"scans\": \"integer\",\n \"value\": \"string\"\n }\n ]\n}","csv":"Device OS, Scans\nApple, 5\n"},{"statusCode":"400","description":"BAD_REQUEST","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"402","description":"UPGRADE_REQUIRED","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"403","description":"FORBIDDEN","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"404","description":"NOT_FOUND","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"410","description":"GONE","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"500","description":"INTERNAL_ERROR","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"503","description":"TEMPORARILY_UNAVAILABLE","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null}],"requestBodyParams":null},{"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":[{"name":"qrcode_id","in":"path","description":"The QR Code ID","required":true,"schema":{"type":"string"},"example":"Qabcde12345"},{"name":"unit","description":"A unit of time","schema":{"description":"the unit of time queried for (minute, hour, day, week, month)","type":"string","enum":["minute","hour","day","week","month"],"default":"day"},"required":true,"in":"query","example":"month"},{"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},{"name":"size","description":"The quantity of items to be be returned","in":"query","schema":{"type":"integer","default":50},"example":10},{"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"}],"responses":{"200":{"description":"SUCCESS","content":{"application/json":{"schema":{"type":"object","allOf":[{"type":"object","properties":{"unit":{"type":"string"},"units":{"type":"integer"},"facet":{"type":"string","enum":["countries","cities","device_os","browsers"]},"unit_reference":{"type":"string"}}},{"properties":{"metrics":{"type":"array","items":{"type":"object","properties":{"scans":{"type":"integer"},"value":{"type":"string"}}}}}}]}},"text/csv":{"schema":{"type":"object","allOf":[{"type":"object","properties":{"unit":{"type":"string"},"units":{"type":"integer"},"facet":{"type":"string","enum":["countries","cities","device_os","browsers"]},"unit_reference":{"type":"string"}}},{"properties":{"metrics":{"type":"array","items":{"type":"object","properties":{"scans":{"type":"integer"},"value":{"type":"string"}}}}}}]},"example":"Browser, Scans\nGoogle Chrome, 5\n"}}},"400":{"description":"BAD_REQUEST","content":{"application/json":{"schema":{"description":"BAD_REQUEST","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"402":{"description":"UPGRADE_REQUIRED","content":{"application/json":{"schema":{"description":"UPGRADE_REQUIRED","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"403":{"description":"FORBIDDEN","content":{"application/json":{"schema":{"description":"FORBIDDEN","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"404":{"description":"NOT_FOUND","content":{"application/json":{"schema":{"description":"NOT_FOUND","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"410":{"description":"GONE","content":{"application/json":{"schema":{"description":"GONE","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"500":{"description":"INTERNAL_ERROR","content":{"application/json":{"schema":{"description":"INTERNAL_ERROR","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"503":{"description":"TEMPORARILY_UNAVAILABLE","content":{"application/json":{"schema":{"description":"TEMPORARILY_UNAVAILABLE","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}}},"method":"get","path":"/qr-codes/{qrcode_id}/scans/browsers","requestSamples":[{"name":"cURL","syntaxLanguage":"bash","sample":"curl \\\n-H 'Authorization: Bearer {TOKEN}' \\\n-X GET \\\nhttps://api-ssl.bitly.com/v4/qr-codes/Qabcde12345/scans/browsers?unit=month\u0026units=1\u0026size=10\u0026unit_reference=2006-01-02T15%3A04%3A05-0700","exampleName":"Default"},{"sample":"var fetch = require('node-fetch');\n\nfetch('https://api-ssl.bitly.com/v4/qr-codes/Qabcde12345/scans/browsers?unit=month\u0026units=1\u0026size=10\u0026unit_reference=2006-01-02T15%3A04%3A05-0700', {\n headers: {\n 'Authorization': 'Bearer {TOKEN}'\n }\n});\n","name":"Node","syntaxLanguage":"javascript","exampleName":"Default"},{"sample":"fetch('https://api-ssl.bitly.com/v4/qr-codes/Qabcde12345/scans/browsers?unit=month\u0026units=1\u0026size=10\u0026unit_reference=2006-01-02T15%3A04%3A05-0700', {\n headers: {\n 'Authorization': 'Bearer {TOKEN}'\n }\n});\n","name":"Browser","syntaxLanguage":"javascript","exampleName":"Default"},{"sample":"package main\n\nimport (\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\tclient := \u0026http.Client{}\n\treq, err := http.NewRequest(\"GET\", \"https://api-ssl.bitly.com/v4/qr-codes/Qabcde12345/scans/browsers?unit=month\u0026units=1\u0026size=10\u0026unit_reference=2006-01-02T15%3A04%3A05-0700\", nil)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\treq.Header.Set(\"Authorization\", \"Bearer {TOKEN}\")\n\tresp, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tdefer resp.Body.Close()\n\tbodyText, err := ioutil.ReadAll(resp.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tfmt.Printf(\"%s\\n\", bodyText)\n}\n","name":"Go","syntaxLanguage":"go","exampleName":"Default"},{"sample":"import requests\n\nheaders = {\n 'Authorization': 'Bearer {TOKEN}',\n}\n\nparams = (\n ('unit', 'month'),\n ('units', '1'),\n ('size', '10'),\n ('unit_reference', '2006-01-02T15:04:05-0700'),\n)\n\nresponse = requests.get('https://api-ssl.bitly.com/v4/qr-codes/Qabcde12345/scans/browsers', headers=headers, params=params)\n\n#NB. Original query string below. It seems impossible to parse and\n#reproduce query strings 100% accurately so the one below is given\n#in case the reproduced version is not \"correct\".\n# response = requests.get('https://api-ssl.bitly.com/v4/qr-codes/Qabcde12345/scans/browsers?unit=month\u0026units=1\u0026size=10\u0026unit_reference=2006-01-02T15%3A04%3A05-0700', headers=headers)\n","name":"Python","syntaxLanguage":"python","exampleName":"Default"}],"responseSamples":[{"statusCode":"200","description":"SUCCESS","json":"{\n \"unit\": \"string\",\n \"units\": \"integer\",\n \"facet\": \"string\",\n \"unit_reference\": \"string\",\n \"metrics\": [\n {\n \"scans\": \"integer\",\n \"value\": \"string\"\n }\n ]\n}","csv":"Browser, Scans\nGoogle Chrome, 5\n"},{"statusCode":"400","description":"BAD_REQUEST","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"402","description":"UPGRADE_REQUIRED","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"403","description":"FORBIDDEN","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"404","description":"NOT_FOUND","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"410","description":"GONE","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"500","description":"INTERNAL_ERROR","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"503","description":"TEMPORARILY_UNAVAILABLE","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null}],"requestBodyParams":null}]},{"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","methods":[{"summary":"Update a User","description":"Update fields in the user","tags":["User"],"operationId":"updateUser","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"default_group_guid":{"type":"string"}},"example":{"name":"Chauncey McPufferson","default_group_guid":"Ba1bc23dE4F"}}}}},"responses":{"200":{"description":"SUCCESS","content":{"application/json":{"schema":{"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":{"type":"object","properties":{"email":{"type":"string"},"is_primary":{"type":"boolean"},"is_verified":{"type":"boolean"}}}},"is_2fa_enabled":{"type":"boolean"},"default_group_guid":{"type":"string"}}}}}},"400":{"description":"BAD_REQUEST","content":{"application/json":{"schema":{"description":"BAD_REQUEST","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"403":{"description":"FORBIDDEN","content":{"application/json":{"schema":{"description":"FORBIDDEN","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"404":{"description":"NOT_FOUND","content":{"application/json":{"schema":{"description":"NOT_FOUND","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"422":{"description":"UNPROCESSABLE_ENTITY","content":{"application/json":{"schema":{"description":"UNPROCESSABLE_ENTITY","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"500":{"description":"INTERNAL_ERROR","content":{"application/json":{"schema":{"description":"INTERNAL_ERROR","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"503":{"description":"TEMPORARILY_UNAVAILABLE","content":{"application/json":{"schema":{"description":"TEMPORARILY_UNAVAILABLE","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}}},"method":"patch","path":"/user","requestSamples":[{"name":"cURL","syntaxLanguage":"bash","sample":"curl \\\n-H 'Authorization: Bearer {TOKEN}' \\\n-H 'Content-Type: application/json' \\\n-X PATCH \\\n-d '{\n \"name\": \"Chauncey McPufferson\",\n \"default_group_guid\": \"Ba1bc23dE4F\"\n}' \\\nhttps://api-ssl.bitly.com/v4/user","exampleName":"Default"},{"sample":"var fetch = require('node-fetch');\n\nfetch('https://api-ssl.bitly.com/v4/user', {\n method: 'PATCH',\n headers: {\n 'Authorization': 'Bearer {TOKEN}',\n 'Content-Type': 'application/json'\n },\n body: JSON.stringify({ \"name\": \"Chauncey McPufferson\", \"default_group_guid\": \"Ba1bc23dE4F\" })\n});\n","name":"Node","syntaxLanguage":"javascript","exampleName":"Default"},{"sample":"fetch('https://api-ssl.bitly.com/v4/user', {\n method: 'PATCH',\n headers: {\n 'Authorization': 'Bearer {TOKEN}',\n 'Content-Type': 'application/json'\n },\n body: JSON.stringify({ \"name\": \"Chauncey McPufferson\", \"default_group_guid\": \"Ba1bc23dE4F\" })\n});\n","name":"Browser","syntaxLanguage":"javascript","exampleName":"Default"},{"sample":"package main\n\nimport (\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n\t\"strings\"\n)\n\nfunc main() {\n\tclient := \u0026http.Client{}\n\tvar data = strings.NewReader(`{ \"name\": \"Chauncey McPufferson\", \"default_group_guid\": \"Ba1bc23dE4F\" }`)\n\treq, err := http.NewRequest(\"PATCH\", \"https://api-ssl.bitly.com/v4/user\", data)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\treq.Header.Set(\"Authorization\", \"Bearer {TOKEN}\")\n\treq.Header.Set(\"Content-Type\", \"application/json\")\n\tresp, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tdefer resp.Body.Close()\n\tbodyText, err := ioutil.ReadAll(resp.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tfmt.Printf(\"%s\\n\", bodyText)\n}\n","name":"Go","syntaxLanguage":"go","exampleName":"Default"},{"sample":"import requests\n\nheaders = {\n 'Authorization': 'Bearer {TOKEN}',\n 'Content-Type': 'application/json',\n}\n\ndata = '{ \"name\": \"Chauncey McPufferson\", \"default_group_guid\": \"Ba1bc23dE4F\" }'\n\nresponse = requests.patch('https://api-ssl.bitly.com/v4/user', headers=headers, data=data)\n","name":"Python","syntaxLanguage":"python","exampleName":"Default"}],"responseSamples":[{"statusCode":"200","description":"SUCCESS","json":"{\n \"login\": \"string\",\n \"name\": \"string\",\n \"is_active\": \"boolean\",\n \"created\": \"string\",\n \"modified\": \"string\",\n \"is_sso_user\": \"boolean\",\n \"emails\": [\n {\n \"email\": \"string\",\n \"is_primary\": \"boolean\",\n \"is_verified\": \"boolean\"\n }\n ],\n \"is_2fa_enabled\": \"boolean\",\n \"default_group_guid\": \"string\"\n}","csv":null},{"statusCode":"400","description":"BAD_REQUEST","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"403","description":"FORBIDDEN","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"404","description":"NOT_FOUND","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"422","description":"UNPROCESSABLE_ENTITY","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"500","description":"INTERNAL_ERROR","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"503","description":"TEMPORARILY_UNAVAILABLE","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null}],"requestBodyParams":[{"name":"name","description":null,"required":null,"schema":{"type":"string","default":null,"enum":null},"items":null,"properties":null},{"name":"default_group_guid","description":null,"required":null,"schema":{"type":"string","default":null,"enum":null},"items":null,"properties":null}]},{"summary":"Retrieve a User","description":"Returns information for the current authenticated user.","tags":["User"],"operationId":"getUser","responses":{"200":{"description":"SUCCESS","content":{"application/json":{"schema":{"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":{"type":"object","properties":{"email":{"type":"string"},"is_primary":{"type":"boolean"},"is_verified":{"type":"boolean"}}}},"is_2fa_enabled":{"type":"boolean"},"default_group_guid":{"type":"string"}}}}}},"403":{"description":"FORBIDDEN","content":{"application/json":{"schema":{"description":"FORBIDDEN","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"404":{"description":"NOT_FOUND","content":{"application/json":{"schema":{"description":"NOT_FOUND","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"500":{"description":"INTERNAL_ERROR","content":{"application/json":{"schema":{"description":"INTERNAL_ERROR","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"503":{"description":"TEMPORARILY_UNAVAILABLE","content":{"application/json":{"schema":{"description":"TEMPORARILY_UNAVAILABLE","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}}},"method":"get","path":"/user","requestSamples":[{"name":"cURL","syntaxLanguage":"bash","sample":"curl \\\n-H 'Authorization: Bearer {TOKEN}' \\\n-X GET \\\nhttps://api-ssl.bitly.com/v4/user","exampleName":"Default"},{"sample":"var fetch = require('node-fetch');\n\nfetch('https://api-ssl.bitly.com/v4/user', {\n headers: {\n 'Authorization': 'Bearer {TOKEN}'\n }\n});\n","name":"Node","syntaxLanguage":"javascript","exampleName":"Default"},{"sample":"fetch('https://api-ssl.bitly.com/v4/user', {\n headers: {\n 'Authorization': 'Bearer {TOKEN}'\n }\n});\n","name":"Browser","syntaxLanguage":"javascript","exampleName":"Default"},{"sample":"package main\n\nimport (\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\tclient := \u0026http.Client{}\n\treq, err := http.NewRequest(\"GET\", \"https://api-ssl.bitly.com/v4/user\", nil)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\treq.Header.Set(\"Authorization\", \"Bearer {TOKEN}\")\n\tresp, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tdefer resp.Body.Close()\n\tbodyText, err := ioutil.ReadAll(resp.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tfmt.Printf(\"%s\\n\", bodyText)\n}\n","name":"Go","syntaxLanguage":"go","exampleName":"Default"},{"sample":"import requests\n\nheaders = {\n 'Authorization': 'Bearer {TOKEN}',\n}\n\nresponse = requests.get('https://api-ssl.bitly.com/v4/user', headers=headers)\n","name":"Python","syntaxLanguage":"python","exampleName":"Default"}],"responseSamples":[{"statusCode":"200","description":"SUCCESS","json":"{\n \"login\": \"string\",\n \"name\": \"string\",\n \"is_active\": \"boolean\",\n \"created\": \"string\",\n \"modified\": \"string\",\n \"is_sso_user\": \"boolean\",\n \"emails\": [\n {\n \"email\": \"string\",\n \"is_primary\": \"boolean\",\n \"is_verified\": \"boolean\"\n }\n ],\n \"is_2fa_enabled\": \"boolean\",\n \"default_group_guid\": \"string\"\n}","csv":null},{"statusCode":"403","description":"FORBIDDEN","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"404","description":"NOT_FOUND","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"500","description":"INTERNAL_ERROR","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"503","description":"TEMPORARILY_UNAVAILABLE","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null}],"requestBodyParams":null},{"summary":"Get Platform Limits","description":"Fetch all platform limits and counts available for an organization","operationId":"getPlatformLimits","parameters":[{"name":"path","description":"The specific path for which information is requested","in":"query","schema":{"type":"string"},"example":"/organizations/{organization_guid}"}],"tags":["User"],"responses":{"200":{"description":"SUCCESS","content":{"application/json":{"schema":{"type":"object","properties":{"platform_limits":{"type":"array","items":{"type":"object","properties":{"endpoint":{"type":"string"},"methods":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"limit":{"type":"integer"},"count":{"type":"integer"}}}}}}}}}}}},"403":{"description":"FORBIDDEN","content":{"application/json":{"schema":{"description":"FORBIDDEN","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"404":{"description":"NOT_FOUND","content":{"application/json":{"schema":{"description":"NOT_FOUND","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"500":{"description":"INTERNAL_ERROR","content":{"application/json":{"schema":{"description":"INTERNAL_ERROR","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"503":{"description":"TEMPORARILY_UNAVAILABLE","content":{"application/json":{"schema":{"description":"TEMPORARILY_UNAVAILABLE","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}}},"method":"get","path":"/user/platform_limits","requestSamples":[{"name":"cURL","syntaxLanguage":"bash","sample":"curl \\\n-H 'Authorization: Bearer {TOKEN}' \\\n-X GET \\\nhttps://api-ssl.bitly.com/v4/user/platform_limits?path=%2Forganizations%2F%7Borganization_guid%7D","exampleName":"Default"},{"sample":"var fetch = require('node-fetch');\n\nfetch('https://api-ssl.bitly.com/v4/user/platform_limits?path=%2Forganizations%2F%7Borganization_guid%7D', {\n headers: {\n 'Authorization': 'Bearer {TOKEN}'\n }\n});\n","name":"Node","syntaxLanguage":"javascript","exampleName":"Default"},{"sample":"fetch('https://api-ssl.bitly.com/v4/user/platform_limits?path=%2Forganizations%2F%7Borganization_guid%7D', {\n headers: {\n 'Authorization': 'Bearer {TOKEN}'\n }\n});\n","name":"Browser","syntaxLanguage":"javascript","exampleName":"Default"},{"sample":"package main\n\nimport (\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\tclient := \u0026http.Client{}\n\treq, err := http.NewRequest(\"GET\", \"https://api-ssl.bitly.com/v4/user/platform_limits?path=%2Forganizations%2F%7Borganization_guid%7D\", nil)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\treq.Header.Set(\"Authorization\", \"Bearer {TOKEN}\")\n\tresp, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tdefer resp.Body.Close()\n\tbodyText, err := ioutil.ReadAll(resp.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tfmt.Printf(\"%s\\n\", bodyText)\n}\n","name":"Go","syntaxLanguage":"go","exampleName":"Default"},{"sample":"import requests\n\nheaders = {\n 'Authorization': 'Bearer {TOKEN}',\n}\n\nparams = (\n ('path', '/organizations/{organization_guid}'),\n)\n\nresponse = requests.get('https://api-ssl.bitly.com/v4/user/platform_limits', headers=headers, params=params)\n\n#NB. Original query string below. It seems impossible to parse and\n#reproduce query strings 100% accurately so the one below is given\n#in case the reproduced version is not \"correct\".\n# response = requests.get('https://api-ssl.bitly.com/v4/user/platform_limits?path=%2Forganizations%2F%7Borganization_guid%7D', headers=headers)\n","name":"Python","syntaxLanguage":"python","exampleName":"Default"}],"responseSamples":[{"statusCode":"200","description":"SUCCESS","json":"{\n \"platform_limits\": [\n {\n \"endpoint\": \"string\",\n \"methods\": [\n {\n \"name\": \"string\",\n \"limit\": \"integer\",\n \"count\": \"integer\"\n }\n ]\n }\n ]\n}","csv":null},{"statusCode":"403","description":"FORBIDDEN","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"404","description":"NOT_FOUND","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"500","description":"INTERNAL_ERROR","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"503","description":"TEMPORARILY_UNAVAILABLE","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null}],"requestBodyParams":null}]},{"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","methods":[{"summary":"Get Webhooks","description":"Fetch all webhooks available for an Organization","operationId":"getWebhooks","parameters":[{"name":"organization_guid","description":"A GUID for a Bitly organization","in":"path","required":true,"schema":{"type":"string"},"example":"Oa1bcd234eF"}],"tags":["Webhooks"],"responses":{"200":{"description":"SUCCESS","content":{"application/json":{"schema":{"type":"object","properties":{"webhooks":{"type":"array","items":{"type":"object","allOf":[{"type":"object","properties":{"references":{"type":"object","additionalProperties":{"type":"string"}}}},{"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"]}}}}}}},"402":{"description":"UPGRADE_REQUIRED","content":{"application/json":{"schema":{"description":"UPGRADE_REQUIRED","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"403":{"description":"FORBIDDEN","content":{"application/json":{"schema":{"description":"FORBIDDEN","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"404":{"description":"NOT_FOUND","content":{"application/json":{"schema":{"description":"NOT_FOUND","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"429":{"description":"MONTHLY_LIMIT_EXCEEDED","content":{"application/json":{"schema":{"example":"API_USAGE_LIMIT_EXCEEDED","description":"MONTHLY_LIMIT_EXCEEDED","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"}}}]}}}},"500":{"description":"INTERNAL_ERROR","content":{"application/json":{"schema":{"description":"INTERNAL_ERROR","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"503":{"description":"TEMPORARILY_UNAVAILABLE","content":{"application/json":{"schema":{"description":"TEMPORARILY_UNAVAILABLE","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}}},"method":"get","path":"/organizations/{organization_guid}/webhooks","requestSamples":[{"name":"cURL","syntaxLanguage":"bash","sample":"curl \\\n-H 'Authorization: Bearer {TOKEN}' \\\n-X GET \\\nhttps://api-ssl.bitly.com/v4/organizations/Oa1bcd234eF/webhooks","exampleName":"Default"},{"sample":"var fetch = require('node-fetch');\n\nfetch('https://api-ssl.bitly.com/v4/organizations/Oa1bcd234eF/webhooks', {\n headers: {\n 'Authorization': 'Bearer {TOKEN}'\n }\n});\n","name":"Node","syntaxLanguage":"javascript","exampleName":"Default"},{"sample":"fetch('https://api-ssl.bitly.com/v4/organizations/Oa1bcd234eF/webhooks', {\n headers: {\n 'Authorization': 'Bearer {TOKEN}'\n }\n});\n","name":"Browser","syntaxLanguage":"javascript","exampleName":"Default"},{"sample":"package main\n\nimport (\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\tclient := \u0026http.Client{}\n\treq, err := http.NewRequest(\"GET\", \"https://api-ssl.bitly.com/v4/organizations/Oa1bcd234eF/webhooks\", nil)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\treq.Header.Set(\"Authorization\", \"Bearer {TOKEN}\")\n\tresp, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tdefer resp.Body.Close()\n\tbodyText, err := ioutil.ReadAll(resp.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tfmt.Printf(\"%s\\n\", bodyText)\n}\n","name":"Go","syntaxLanguage":"go","exampleName":"Default"},{"sample":"import requests\n\nheaders = {\n 'Authorization': 'Bearer {TOKEN}',\n}\n\nresponse = requests.get('https://api-ssl.bitly.com/v4/organizations/Oa1bcd234eF/webhooks', headers=headers)\n","name":"Python","syntaxLanguage":"python","exampleName":"Default"}],"responseSamples":[{"statusCode":"200","description":"SUCCESS","json":"{\n \"webhooks\": [\n {\n \"references\": { \"any\" },\n \"guid\": \"string\",\n \"created\": \"string\",\n \"modified\": \"string\",\n \"modified_by\": \"string\",\n \"alerted\": \"string\",\n \"deactivated\": \"string\",\n \"is_active\": \"boolean\",\n \"is_alert\": \"boolean\",\n \"organization_guid\": \"string\",\n \"group_guid\": \"string\",\n \"name\": \"string\",\n \"event\": \"string\",\n \"url\": \"string\",\n \"status\": \"string\",\n \"oauth_url\": \"string\",\n \"client_id\": \"string\",\n \"client_secret\": \"string\",\n \"fetch_tags\": \"boolean\"\n }\n ]\n}","csv":null},{"statusCode":"402","description":"UPGRADE_REQUIRED","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"403","description":"FORBIDDEN","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"404","description":"NOT_FOUND","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"429","description":"MONTHLY_LIMIT_EXCEEDED","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\"\n}","csv":null},{"statusCode":"500","description":"INTERNAL_ERROR","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"503","description":"TEMPORARILY_UNAVAILABLE","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null}],"requestBodyParams":null},{"summary":"Create Webhook","description":"Creates a webhook.","operationId":"createWebhook","requestBody":{"required":true,"content":{"application/json":{"schema":{"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"}}}}},"tags":["Webhooks"],"responses":{"201":{"description":"CREATED","content":{"application/json":{"schema":{"type":"object","allOf":[{"type":"object","properties":{"references":{"type":"object","additionalProperties":{"type":"string"}}}},{"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"]}}}},"400":{"description":"BAD_REQUEST","content":{"application/json":{"schema":{"description":"BAD_REQUEST","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"402":{"description":"UPGRADE_REQUIRED","content":{"application/json":{"schema":{"description":"UPGRADE_REQUIRED","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"403":{"description":"FORBIDDEN","content":{"application/json":{"schema":{"description":"FORBIDDEN","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"404":{"description":"NOT_FOUND","content":{"application/json":{"schema":{"description":"NOT_FOUND","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"422":{"description":"UNPROCESSABLE_ENTITY","content":{"application/json":{"schema":{"description":"UNPROCESSABLE_ENTITY","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"429":{"description":"MONTHLY_LIMIT_EXCEEDED","content":{"application/json":{"schema":{"example":"API_USAGE_LIMIT_EXCEEDED","description":"MONTHLY_LIMIT_EXCEEDED","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"}}}]}}}},"500":{"description":"INTERNAL_ERROR","content":{"application/json":{"schema":{"description":"INTERNAL_ERROR","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"503":{"description":"TEMPORARILY_UNAVAILABLE","content":{"application/json":{"schema":{"description":"TEMPORARILY_UNAVAILABLE","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}}},"method":"post","path":"/webhooks","requestSamples":[{"name":"cURL","syntaxLanguage":"bash","sample":"curl \\\n-H 'Authorization: Bearer {TOKEN}' \\\n-H 'Content-Type: application/json' \\\n-X POST \\\n-d '{\n \"is_active\": true,\n \"organization_guid\": \"Oa1bcd234eF\",\n \"group_guid\": \"Ba1bc23dE4F\",\n \"name\": \"My Webhook\",\n \"event\": \"decodes\",\n \"url\": \"https://bitly.com/webhooks\",\n \"oauth_url\": \"https://fake.com/oauth\",\n \"client_id\": \"fakeclientid123\",\n \"client_secret\": \"itsasecreticanttellyou\"\n}' \\\nhttps://api-ssl.bitly.com/v4/webhooks","exampleName":"Default"},{"sample":"var fetch = require('node-fetch');\n\nfetch('https://api-ssl.bitly.com/v4/webhooks', {\n method: 'POST',\n headers: {\n 'Authorization': 'Bearer {TOKEN}',\n 'Content-Type': 'application/json'\n },\n body: JSON.stringify({ \"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\" })\n});\n","name":"Node","syntaxLanguage":"javascript","exampleName":"Default"},{"sample":"fetch('https://api-ssl.bitly.com/v4/webhooks', {\n method: 'POST',\n headers: {\n 'Authorization': 'Bearer {TOKEN}',\n 'Content-Type': 'application/json'\n },\n body: JSON.stringify({ \"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\" })\n});\n","name":"Browser","syntaxLanguage":"javascript","exampleName":"Default"},{"sample":"package main\n\nimport (\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n\t\"strings\"\n)\n\nfunc main() {\n\tclient := \u0026http.Client{}\n\tvar data = strings.NewReader(`{ \"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\" }`)\n\treq, err := http.NewRequest(\"POST\", \"https://api-ssl.bitly.com/v4/webhooks\", data)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\treq.Header.Set(\"Authorization\", \"Bearer {TOKEN}\")\n\treq.Header.Set(\"Content-Type\", \"application/json\")\n\tresp, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tdefer resp.Body.Close()\n\tbodyText, err := ioutil.ReadAll(resp.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tfmt.Printf(\"%s\\n\", bodyText)\n}\n","name":"Go","syntaxLanguage":"go","exampleName":"Default"},{"sample":"import requests\n\nheaders = {\n 'Authorization': 'Bearer {TOKEN}',\n 'Content-Type': 'application/json',\n}\n\ndata = '{ \"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\" }'\n\nresponse = requests.post('https://api-ssl.bitly.com/v4/webhooks', headers=headers, data=data)\n","name":"Python","syntaxLanguage":"python","exampleName":"Default"}],"responseSamples":[{"statusCode":"201","description":"CREATED","json":"{\n \"references\": { \"any\" },\n \"guid\": \"string\",\n \"created\": \"string\",\n \"modified\": \"string\",\n \"modified_by\": \"string\",\n \"alerted\": \"string\",\n \"deactivated\": \"string\",\n \"is_active\": \"boolean\",\n \"is_alert\": \"boolean\",\n \"organization_guid\": \"string\",\n \"group_guid\": \"string\",\n \"name\": \"string\",\n \"event\": \"string\",\n \"url\": \"string\",\n \"status\": \"string\",\n \"oauth_url\": \"string\",\n \"client_id\": \"string\",\n \"client_secret\": \"string\",\n \"fetch_tags\": \"boolean\"\n}","csv":null},{"statusCode":"400","description":"BAD_REQUEST","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"402","description":"UPGRADE_REQUIRED","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"403","description":"FORBIDDEN","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"404","description":"NOT_FOUND","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"422","description":"UNPROCESSABLE_ENTITY","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"429","description":"MONTHLY_LIMIT_EXCEEDED","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\"\n}","csv":null},{"statusCode":"500","description":"INTERNAL_ERROR","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"503","description":"TEMPORARILY_UNAVAILABLE","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null}],"requestBodyParams":[{"name":"is_active","description":null,"required":false,"schema":{"type":"boolean","default":null,"enum":null},"items":null,"properties":null},{"name":"organization_guid","description":null,"required":true,"schema":{"type":"string","default":null,"enum":null},"items":null,"properties":null},{"name":"group_guid","description":null,"required":false,"schema":{"type":"string","default":null,"enum":null},"items":null,"properties":null},{"name":"name","description":null,"required":true,"schema":{"type":"string","default":null,"enum":null},"items":null,"properties":null},{"name":"event","description":null,"required":true,"schema":{"type":"string","default":null,"enum":null},"items":null,"properties":null},{"name":"url","description":null,"required":true,"schema":{"type":"string","default":null,"enum":null},"items":null,"properties":null},{"name":"oauth_url","description":null,"required":false,"schema":{"type":"string","default":null,"enum":null},"items":null,"properties":null},{"name":"client_id","description":null,"required":false,"schema":{"type":"string","default":null,"enum":null},"items":null,"properties":null},{"name":"client_secret","description":null,"required":false,"schema":{"type":"string","default":null,"enum":null},"items":null,"properties":null},{"name":"fetch_tags","description":null,"required":false,"schema":{"type":"boolean","default":null,"enum":null},"items":null,"properties":null}]},{"summary":"Retrieve Webhook","description":"Returns a webhook.","operationId":"getWebhook","parameters":[{"name":"webhook_guid","description":"A GUID for a Bitly webhook","in":"path","required":true,"schema":{"type":"string"},"example":"Wa1bcDefG23"}],"tags":["Webhooks"],"responses":{"200":{"description":"SUCCESS","content":{"application/json":{"schema":{"type":"object","allOf":[{"type":"object","properties":{"references":{"type":"object","additionalProperties":{"type":"string"}}}},{"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"]}}}},"400":{"description":"BAD_REQUEST","content":{"application/json":{"schema":{"description":"BAD_REQUEST","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"402":{"description":"UPGRADE_REQUIRED","content":{"application/json":{"schema":{"description":"UPGRADE_REQUIRED","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"403":{"description":"FORBIDDEN","content":{"application/json":{"schema":{"description":"FORBIDDEN","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"404":{"description":"NOT_FOUND","content":{"application/json":{"schema":{"description":"NOT_FOUND","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"429":{"description":"MONTHLY_LIMIT_EXCEEDED","content":{"application/json":{"schema":{"example":"API_USAGE_LIMIT_EXCEEDED","description":"MONTHLY_LIMIT_EXCEEDED","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"}}}]}}}},"500":{"description":"INTERNAL_ERROR","content":{"application/json":{"schema":{"description":"INTERNAL_ERROR","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"503":{"description":"TEMPORARILY_UNAVAILABLE","content":{"application/json":{"schema":{"description":"TEMPORARILY_UNAVAILABLE","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}}},"method":"get","path":"/webhooks/{webhook_guid}","requestSamples":[{"name":"cURL","syntaxLanguage":"bash","sample":"curl \\\n-H 'Authorization: Bearer {TOKEN}' \\\n-X GET \\\nhttps://api-ssl.bitly.com/v4/webhooks/Wa1bcDefG23","exampleName":"Default"},{"sample":"var fetch = require('node-fetch');\n\nfetch('https://api-ssl.bitly.com/v4/webhooks/Wa1bcDefG23', {\n headers: {\n 'Authorization': 'Bearer {TOKEN}'\n }\n});\n","name":"Node","syntaxLanguage":"javascript","exampleName":"Default"},{"sample":"fetch('https://api-ssl.bitly.com/v4/webhooks/Wa1bcDefG23', {\n headers: {\n 'Authorization': 'Bearer {TOKEN}'\n }\n});\n","name":"Browser","syntaxLanguage":"javascript","exampleName":"Default"},{"sample":"package main\n\nimport (\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\tclient := \u0026http.Client{}\n\treq, err := http.NewRequest(\"GET\", \"https://api-ssl.bitly.com/v4/webhooks/Wa1bcDefG23\", nil)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\treq.Header.Set(\"Authorization\", \"Bearer {TOKEN}\")\n\tresp, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tdefer resp.Body.Close()\n\tbodyText, err := ioutil.ReadAll(resp.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tfmt.Printf(\"%s\\n\", bodyText)\n}\n","name":"Go","syntaxLanguage":"go","exampleName":"Default"},{"sample":"import requests\n\nheaders = {\n 'Authorization': 'Bearer {TOKEN}',\n}\n\nresponse = requests.get('https://api-ssl.bitly.com/v4/webhooks/Wa1bcDefG23', headers=headers)\n","name":"Python","syntaxLanguage":"python","exampleName":"Default"}],"responseSamples":[{"statusCode":"200","description":"SUCCESS","json":"{\n \"references\": { \"any\" },\n \"guid\": \"string\",\n \"created\": \"string\",\n \"modified\": \"string\",\n \"modified_by\": \"string\",\n \"alerted\": \"string\",\n \"deactivated\": \"string\",\n \"is_active\": \"boolean\",\n \"is_alert\": \"boolean\",\n \"organization_guid\": \"string\",\n \"group_guid\": \"string\",\n \"name\": \"string\",\n \"event\": \"string\",\n \"url\": \"string\",\n \"status\": \"string\",\n \"oauth_url\": \"string\",\n \"client_id\": \"string\",\n \"client_secret\": \"string\",\n \"fetch_tags\": \"boolean\"\n}","csv":null},{"statusCode":"400","description":"BAD_REQUEST","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"402","description":"UPGRADE_REQUIRED","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"403","description":"FORBIDDEN","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"404","description":"NOT_FOUND","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"429","description":"MONTHLY_LIMIT_EXCEEDED","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\"\n}","csv":null},{"statusCode":"500","description":"INTERNAL_ERROR","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"503","description":"TEMPORARILY_UNAVAILABLE","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null}],"requestBodyParams":null},{"summary":"Update Webhook","description":"Update a webhook","operationId":"updateWebhook","parameters":[{"name":"webhook_guid","description":"A GUID for a Bitly webhook","in":"path","required":true,"schema":{"type":"string"},"example":"Wa1bcDefG23"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"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"}}}}},"tags":["Webhooks"],"responses":{"200":{"description":"SUCCESS","content":{"application/json":{"schema":{"type":"object","allOf":[{"type":"object","properties":{"references":{"type":"object","additionalProperties":{"type":"string"}}}},{"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"]}}}},"400":{"description":"BAD_REQUEST","content":{"application/json":{"schema":{"description":"BAD_REQUEST","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"402":{"description":"UPGRADE_REQUIRED","content":{"application/json":{"schema":{"description":"UPGRADE_REQUIRED","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"403":{"description":"FORBIDDEN","content":{"application/json":{"schema":{"description":"FORBIDDEN","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"404":{"description":"NOT_FOUND","content":{"application/json":{"schema":{"description":"NOT_FOUND","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"422":{"description":"UNPROCESSABLE_ENTITY","content":{"application/json":{"schema":{"description":"UNPROCESSABLE_ENTITY","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"429":{"description":"MONTHLY_LIMIT_EXCEEDED","content":{"application/json":{"schema":{"example":"API_USAGE_LIMIT_EXCEEDED","description":"MONTHLY_LIMIT_EXCEEDED","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"}}}]}}}},"500":{"description":"INTERNAL_ERROR","content":{"application/json":{"schema":{"description":"INTERNAL_ERROR","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"503":{"description":"TEMPORARILY_UNAVAILABLE","content":{"application/json":{"schema":{"description":"TEMPORARILY_UNAVAILABLE","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}}},"method":"patch","path":"/webhooks/{webhook_guid}","requestSamples":[{"name":"cURL","syntaxLanguage":"bash","sample":"curl \\\n-H 'Authorization: Bearer {TOKEN}' \\\n-H 'Content-Type: application/json' \\\n-X PATCH \\\n-d '{\n \"guid\": \"Wa1bcDefG23\",\n \"is_active\": true,\n \"organization_guid\": \"Oa1bcd234eF\",\n \"group_guid\": \"Ba1bc23dE4F\",\n \"name\": \"My Webhook\",\n \"event\": \"decodes\",\n \"url\": \"https://bitly.com/webhooks\",\n \"oauth_url\": \"https://fake.com/oauth\",\n \"client_id\": \"fakeclientid123\",\n \"client_secret\": \"itsasecreticanttellyou\"\n}' \\\nhttps://api-ssl.bitly.com/v4/webhooks/Wa1bcDefG23","exampleName":"Default"},{"sample":"var fetch = require('node-fetch');\n\nfetch('https://api-ssl.bitly.com/v4/webhooks/Wa1bcDefG23', {\n method: 'PATCH',\n headers: {\n 'Authorization': 'Bearer {TOKEN}',\n 'Content-Type': 'application/json'\n },\n body: JSON.stringify({ \"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\" })\n});\n","name":"Node","syntaxLanguage":"javascript","exampleName":"Default"},{"sample":"fetch('https://api-ssl.bitly.com/v4/webhooks/Wa1bcDefG23', {\n method: 'PATCH',\n headers: {\n 'Authorization': 'Bearer {TOKEN}',\n 'Content-Type': 'application/json'\n },\n body: JSON.stringify({ \"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\" })\n});\n","name":"Browser","syntaxLanguage":"javascript","exampleName":"Default"},{"sample":"package main\n\nimport (\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n\t\"strings\"\n)\n\nfunc main() {\n\tclient := \u0026http.Client{}\n\tvar data = strings.NewReader(`{ \"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\" }`)\n\treq, err := http.NewRequest(\"PATCH\", \"https://api-ssl.bitly.com/v4/webhooks/Wa1bcDefG23\", data)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\treq.Header.Set(\"Authorization\", \"Bearer {TOKEN}\")\n\treq.Header.Set(\"Content-Type\", \"application/json\")\n\tresp, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tdefer resp.Body.Close()\n\tbodyText, err := ioutil.ReadAll(resp.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tfmt.Printf(\"%s\\n\", bodyText)\n}\n","name":"Go","syntaxLanguage":"go","exampleName":"Default"},{"sample":"import requests\n\nheaders = {\n 'Authorization': 'Bearer {TOKEN}',\n 'Content-Type': 'application/json',\n}\n\ndata = '{ \"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\" }'\n\nresponse = requests.patch('https://api-ssl.bitly.com/v4/webhooks/Wa1bcDefG23', headers=headers, data=data)\n","name":"Python","syntaxLanguage":"python","exampleName":"Default"}],"responseSamples":[{"statusCode":"200","description":"SUCCESS","json":"{\n \"references\": { \"any\" },\n \"guid\": \"string\",\n \"created\": \"string\",\n \"modified\": \"string\",\n \"modified_by\": \"string\",\n \"alerted\": \"string\",\n \"deactivated\": \"string\",\n \"is_active\": \"boolean\",\n \"is_alert\": \"boolean\",\n \"organization_guid\": \"string\",\n \"group_guid\": \"string\",\n \"name\": \"string\",\n \"event\": \"string\",\n \"url\": \"string\",\n \"status\": \"string\",\n \"oauth_url\": \"string\",\n \"client_id\": \"string\",\n \"client_secret\": \"string\",\n \"fetch_tags\": \"boolean\"\n}","csv":null},{"statusCode":"400","description":"BAD_REQUEST","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"402","description":"UPGRADE_REQUIRED","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"403","description":"FORBIDDEN","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"404","description":"NOT_FOUND","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"422","description":"UNPROCESSABLE_ENTITY","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"429","description":"MONTHLY_LIMIT_EXCEEDED","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\"\n}","csv":null},{"statusCode":"500","description":"INTERNAL_ERROR","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"503","description":"TEMPORARILY_UNAVAILABLE","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null}],"requestBodyParams":[{"name":"guid","description":null,"required":true,"schema":{"type":"string","default":null,"enum":null},"items":null,"properties":null},{"name":"is_active","description":null,"required":false,"schema":{"type":"boolean","default":null,"enum":null},"items":null,"properties":null},{"name":"organization_guid","description":null,"required":false,"schema":{"type":"string","default":null,"enum":null},"items":null,"properties":null},{"name":"group_guid","description":null,"required":false,"schema":{"type":"string","default":null,"enum":null},"items":null,"properties":null},{"name":"name","description":null,"required":false,"schema":{"type":"string","default":null,"enum":null},"items":null,"properties":null},{"name":"event","description":null,"required":false,"schema":{"type":"string","default":null,"enum":null},"items":null,"properties":null},{"name":"url","description":null,"required":false,"schema":{"type":"string","default":null,"enum":null},"items":null,"properties":null},{"name":"oauth_url","description":null,"required":false,"schema":{"type":"string","default":null,"enum":null},"items":null,"properties":null},{"name":"client_id","description":null,"required":false,"schema":{"type":"string","default":null,"enum":null},"items":null,"properties":null},{"name":"client_secret","description":null,"required":false,"schema":{"type":"string","default":null,"enum":null},"items":null,"properties":null},{"name":"fetch_tags","description":null,"required":false,"schema":{"type":"boolean","default":null,"enum":null},"items":null,"properties":null}]},{"summary":"Delete Webhook","description":"Deletes a webhook.","operationId":"deleteWebhook","parameters":[{"name":"webhook_guid","description":"A GUID for a Bitly webhook","in":"path","required":true,"schema":{"type":"string"},"example":"Wa1bcDefG23"}],"tags":["Webhooks"],"responses":{"204":{"description":"SUCCESS"},"400":{"description":"BAD_REQUEST","content":{"application/json":{"schema":{"description":"BAD_REQUEST","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"402":{"description":"UPGRADE_REQUIRED","content":{"application/json":{"schema":{"description":"UPGRADE_REQUIRED","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"403":{"description":"FORBIDDEN","content":{"application/json":{"schema":{"description":"FORBIDDEN","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"404":{"description":"NOT_FOUND","content":{"application/json":{"schema":{"description":"NOT_FOUND","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"500":{"description":"INTERNAL_ERROR","content":{"application/json":{"schema":{"description":"INTERNAL_ERROR","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"503":{"description":"TEMPORARILY_UNAVAILABLE","content":{"application/json":{"schema":{"description":"TEMPORARILY_UNAVAILABLE","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}}},"method":"delete","path":"/webhooks/{webhook_guid}","requestSamples":[{"name":"cURL","syntaxLanguage":"bash","sample":"curl \\\n-H 'Authorization: Bearer {TOKEN}' \\\n-X DELETE \\\nhttps://api-ssl.bitly.com/v4/webhooks/Wa1bcDefG23","exampleName":"Default"},{"sample":"var fetch = require('node-fetch');\n\nfetch('https://api-ssl.bitly.com/v4/webhooks/Wa1bcDefG23', {\n method: 'DELETE',\n headers: {\n 'Authorization': 'Bearer {TOKEN}'\n }\n});\n","name":"Node","syntaxLanguage":"javascript","exampleName":"Default"},{"sample":"fetch('https://api-ssl.bitly.com/v4/webhooks/Wa1bcDefG23', {\n method: 'DELETE',\n headers: {\n 'Authorization': 'Bearer {TOKEN}'\n }\n});\n","name":"Browser","syntaxLanguage":"javascript","exampleName":"Default"},{"sample":"package main\n\nimport (\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\tclient := \u0026http.Client{}\n\treq, err := http.NewRequest(\"DELETE\", \"https://api-ssl.bitly.com/v4/webhooks/Wa1bcDefG23\", nil)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\treq.Header.Set(\"Authorization\", \"Bearer {TOKEN}\")\n\tresp, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tdefer resp.Body.Close()\n\tbodyText, err := ioutil.ReadAll(resp.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tfmt.Printf(\"%s\\n\", bodyText)\n}\n","name":"Go","syntaxLanguage":"go","exampleName":"Default"},{"sample":"import requests\n\nheaders = {\n 'Authorization': 'Bearer {TOKEN}',\n}\n\nresponse = requests.delete('https://api-ssl.bitly.com/v4/webhooks/Wa1bcDefG23', headers=headers)\n","name":"Python","syntaxLanguage":"python","exampleName":"Default"}],"responseSamples":[{"statusCode":"204","description":"SUCCESS","json":null,"csv":null},{"statusCode":"400","description":"BAD_REQUEST","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"402","description":"UPGRADE_REQUIRED","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"403","description":"FORBIDDEN","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"404","description":"NOT_FOUND","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"500","description":"INTERNAL_ERROR","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"503","description":"TEMPORARILY_UNAVAILABLE","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null}],"requestBodyParams":null},{"summary":"Verify Webhook","description":"Sends ping event to test webhook configuration.","operationId":"verifyWebhook","parameters":[{"name":"webhook_guid","description":"A GUID for a Bitly webhook","in":"path","required":true,"schema":{"type":"string"},"example":"Wa1bcDefG23"}],"tags":["Webhooks"],"responses":{"200":{"description":"SUCCESS","content":{"application/json":{"schema":{"type":"object","allOf":[{"type":"object","properties":{"references":{"type":"object","additionalProperties":{"type":"string"}}}},{"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"]}}}},"400":{"description":"BAD_REQUEST","content":{"application/json":{"schema":{"description":"BAD_REQUEST","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"402":{"description":"UPGRADE_REQUIRED","content":{"application/json":{"schema":{"description":"UPGRADE_REQUIRED","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"403":{"description":"FORBIDDEN","content":{"application/json":{"schema":{"description":"FORBIDDEN","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"404":{"description":"NOT_FOUND","content":{"application/json":{"schema":{"description":"NOT_FOUND","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"500":{"description":"INTERNAL_ERROR","content":{"application/json":{"schema":{"description":"INTERNAL_ERROR","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}},"503":{"description":"TEMPORARILY_UNAVAILABLE","content":{"application/json":{"schema":{"description":"TEMPORARILY_UNAVAILABLE","allOf":[{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"resource":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"error_code":{"type":"string"},"message":{"type":"string"}}}}}}]}}}}},"method":"post","path":"/webhooks/{webhook_guid}/verify","requestSamples":[{"name":"cURL","syntaxLanguage":"bash","sample":"curl \\\n-H 'Authorization: Bearer {TOKEN}' \\\n-X POST \\\nhttps://api-ssl.bitly.com/v4/webhooks/Wa1bcDefG23/verify","exampleName":"Default"},{"sample":"var fetch = require('node-fetch');\n\nfetch('https://api-ssl.bitly.com/v4/webhooks/Wa1bcDefG23/verify', {\n method: 'POST',\n headers: {\n 'Authorization': 'Bearer {TOKEN}'\n }\n});\n","name":"Node","syntaxLanguage":"javascript","exampleName":"Default"},{"sample":"fetch('https://api-ssl.bitly.com/v4/webhooks/Wa1bcDefG23/verify', {\n method: 'POST',\n headers: {\n 'Authorization': 'Bearer {TOKEN}'\n }\n});\n","name":"Browser","syntaxLanguage":"javascript","exampleName":"Default"},{"sample":"package main\n\nimport (\n\t\"fmt\"\n\t\"io/ioutil\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\tclient := \u0026http.Client{}\n\treq, err := http.NewRequest(\"POST\", \"https://api-ssl.bitly.com/v4/webhooks/Wa1bcDefG23/verify\", nil)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\treq.Header.Set(\"Authorization\", \"Bearer {TOKEN}\")\n\tresp, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tdefer resp.Body.Close()\n\tbodyText, err := ioutil.ReadAll(resp.Body)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tfmt.Printf(\"%s\\n\", bodyText)\n}\n","name":"Go","syntaxLanguage":"go","exampleName":"Default"},{"sample":"import requests\n\nheaders = {\n 'Authorization': 'Bearer {TOKEN}',\n}\n\nresponse = requests.post('https://api-ssl.bitly.com/v4/webhooks/Wa1bcDefG23/verify', headers=headers)\n","name":"Python","syntaxLanguage":"python","exampleName":"Default"}],"responseSamples":[{"statusCode":"200","description":"SUCCESS","json":"{\n \"references\": { \"any\" },\n \"guid\": \"string\",\n \"created\": \"string\",\n \"modified\": \"string\",\n \"modified_by\": \"string\",\n \"alerted\": \"string\",\n \"deactivated\": \"string\",\n \"is_active\": \"boolean\",\n \"is_alert\": \"boolean\",\n \"organization_guid\": \"string\",\n \"group_guid\": \"string\",\n \"name\": \"string\",\n \"event\": \"string\",\n \"url\": \"string\",\n \"status\": \"string\",\n \"oauth_url\": \"string\",\n \"client_id\": \"string\",\n \"client_secret\": \"string\",\n \"fetch_tags\": \"boolean\"\n}","csv":null},{"statusCode":"400","description":"BAD_REQUEST","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"402","description":"UPGRADE_REQUIRED","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"403","description":"FORBIDDEN","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"404","description":"NOT_FOUND","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"500","description":"INTERNAL_ERROR","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null},{"statusCode":"503","description":"TEMPORARILY_UNAVAILABLE","json":"{\n \"message\": \"string\",\n \"description\": \"string\",\n \"resource\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"error_code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}","csv":null}],"requestBodyParams":null}]}]},"__N_SSG":true},"page":"/[apiReference]","query":{"apiReference":"api-reference"},"buildId":"b51c46fbb713db1dcf918361ef8e91da90fce810","isFallback":false,"gsp":true,"scriptLoader":[]}</script></body></html>