Send a workspace API key with Links: Read (links.view). That permission is
enough to read the link configuration and its aggregate click, lead, sales, and
revenue values. You do not need a separate analytics permission.
Authentication is workspace-scoped; see Authentication. Errors use the standard envelope and request IDs described in Errors, and requests are subject to Rate limits.
{"docsConfig":{"theme":"aspen","$schema":"https://mintlify.com/docs.json","name":"Biqli","colors":{"primary":"#3B82F6","light":"#60A5FA","dark":"#1D4ED8"},"logo":{"light":"https://mintcdn.com/biqlillc-cc349ea4/vhOVG3nb6zjxQ8qQ/logo/light.png?fit=max\u0026auto=format\u0026n=vhOVG3nb6zjxQ8qQ\u0026q=85\u0026s=e047892083738e2bb348400f1a82f718","dark":"https://mintcdn.com/biqlillc-cc349ea4/vhOVG3nb6zjxQ8qQ/logo/dark.png?fit=max\u0026auto=format\u0026n=vhOVG3nb6zjxQ8qQ\u0026q=85\u0026s=76e3c2c1aa4073c126d611b40c7626cf","href":"/"},"favicon":"https://mintcdn.com/biqlillc-cc349ea4/vhOVG3nb6zjxQ8qQ/favicon.png?fit=max\u0026auto=format\u0026n=vhOVG3nb6zjxQ8qQ\u0026q=85\u0026s=9a00282d19492f9a39544861751e37f5","api":{},"navbar":{"links":[{"href":"https://biq.li/contact","label":"Contact Support"}],"primary":{"type":"button","label":"Dashboard","href":"https://biq.li/dashboard"}},"footer":{"socials":{"x":"https://x.com/mintlify","github":"https://github.com/mintlify","linkedin":"https://linkedin.com/company/mintlify"}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"biqlillc-cc349ea4","hasAudioNarration":false,"actualSubdomain":"biqlillc-cc349ea4","customDomains":["learn.biq.li"],"gitSource":{"type":"github","owner":"morphcode007","repo":"biqli-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6ad52d09126aad4f2ebbfbed","clientVersion":"0.0.4087","searchFilterCounts":[{"language":"default","tag":"Help Center","count":172},{"language":"default","tag":"MANAGING YOUR LINKS","count":91},{"language":"default","tag":"API Reference","count":72},{"language":"default","tag":"BIQLI LINKS API","count":50},{"language":"default","tag":"MANAGING YOUR WORKSPACE","count":46},{"language":"default","tag":"Biolinks","count":32},{"language":"default","tag":"Developer Docs","count":31},{"language":"default","tag":"Links","count":26},{"language":"default","tag":"BIQLI PARTNER PROGRAM","count":16},{"language":"default","tag":"GETTING STARTED","count":13}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"comment-mode","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":"#search-bar-entry{max-width:384px!important;border-radius:9999px!important;background-color:rgba(3, 7, 18, 0.03)!important;border:none!important;box-shadow:none!important;height:36px!important;color:#6b7280!important}#search-bar-entry:hover{background-color:rgba(3, 7, 18, 0.08)!important}.dark #search-bar-entry{background-color:rgba(255, 255, 255, 0.03)!important;color:rgba(255, 255, 255, 0.5)!important}.dark #search-bar-entry:hover{background-color:rgba(255, 255, 255, 0.08)!important}.navbar-link a{background-color:rgba(3, 7, 18, 0.03)!important;padding:8px 14px!important;border-radius:12px!important;font-weight:500!important;color:#1f2937!important;transition:background-color 0.2s ease, color 0.2s ease}.navbar-link a:hover{background-color:rgba(3, 7, 18, 0.08)!important;color:#111827!important;text-decoration:none!important}.dark .navbar-link a{background-color:rgba(255, 255, 255, 0.03)!important;color:#f3f4f6!important}.dark .navbar-link a:hover{background-color:rgba(255, 255, 255, 0.08)!important;color:#ffffff!important}#topbar-cta-button span{border-radius:12px!important;background-color:#155dfc!important}#topbar-cta-button:hover span{opacity:0.9!important}[data-testid=\"copy-code-button\"]{opacity:1!important;visibility:visible!important}.biqli-payout-country-filters{align-items:center}.biqli-payout-country-filter{appearance:none!important;display:inline-flex!important;flex:0 0 auto;align-items:center;justify-content:center;min-height:34px;padding:6px 16px;border:1px solid #e5e7eb!important;border-radius:9999px!important;background:#ffffff!important;color:#404040!important;font-size:14px;font-weight:400;line-height:20px;white-space:nowrap;cursor:pointer;transition:background-color 0.15s ease, border-color 0.15s ease,\n color 0.15s ease, box-shadow 0.15s ease}.biqli-payout-country-filter:hover{border-color:#d4d4d4!important;background:#fafafa!important;color:#171717!important}.biqli-payout-country-filter[data-active=\"true\"]{border-color:#171717!important;background:#171717!important;color:#ffffff!important;font-weight:500}.biqli-payout-country-filter[data-active=\"true\"]:hover{border-color:#262626!important;background:#262626!important;color:#ffffff!important}.biqli-payout-country-filter:focus-visible{outline:2px solid #2563eb;outline-offset:2px}.dark .biqli-payout-country-filter{border-color:#404040!important;background:#171717!important;color:#d4d4d4!important}.dark .biqli-payout-country-filter:hover{border-color:#525252!important;background:#262626!important;color:#ffffff!important}.dark .biqli-payout-country-filter[data-active=\"true\"]{border-color:#f5f5f5!important;background:#f5f5f5!important;color:#171717!important}.dark .biqli-payout-country-filter[data-active=\"true\"]:hover{border-color:#ffffff!important;background:#ffffff!important;color:#171717!important}"}],"page":{"pagePath":"docs/api-reference/links/get","slug":"/docs/api-reference/links/get","pageMetadata":{"title":"Retrieve a link","description":"Retrieve a link's complete safe configuration and aggregate performance data.","openapi":"GET /v1/link/{link}","href":"/docs/api-reference/links/get"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Retrieve a link’s complete safe configuration and aggregate performance data.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,p:`p`,pre:`pre`,span:`span`,strong:`strong`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,..._provideComponents(),...props.components},{CodeBlock,Heading,Table}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Table)_missingMdxReference(`Table`,true);return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[`Retrieve one short link from the workspace bound to your API key. Pass the\npublic `,_jsx(_components.code,{children:`biq_lnk_...`}),` ID returned when you created or listed the link.`]}),`\n`,_jsx(Heading,{level:`2`,id:`authentication-and-permission`,children:`Authentication and permission`}),`\n`,_jsxs(_components.p,{children:[`Send a workspace API key with `,_jsx(_components.strong,{children:`Links: Read`}),` (`,_jsx(_components.code,{children:`links.view`}),`). That permission is\nenough to read the link configuration and its aggregate click, lead, sales, and\nrevenue values. You do not need a separate analytics permission.`]}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`2`,language:`http`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`http`,children:_jsxs(_components.code,{language:`http`,numberOfLines:`2`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#569CD6`},children:`Authorization`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` Bearer biqli_your_workspace_api_key`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#569CD6`},children:`Accept`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` application/json`})]}),`\n`]})})}),`\n`,_jsx(_components.p,{children:`You do not send a workspace ID. The API key determines the workspace, and the\nendpoint never falls back to an internal numeric link ID.`}),`\n`,_jsx(Heading,{level:`2`,id:`request`,children:`Request`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`4`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`4`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`curl`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --request`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` GET`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --url`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` https://biq.li/api/v1/link/biq_lnk_01M14D2M8VFKYQCE7Z3A6HRXWP`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --header`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` 'Authorization: Bearer biqli_your_workspace_api_key'`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --header`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` 'Accept: application/json'`})]}),`\n`]})})}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Path parameter`}),_jsx(_components.th,{children:`Type`}),_jsx(_components.th,{children:`Description`})]})}),_jsx(_components.tbody,{children:_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`link`})}),_jsx(_components.td,{children:`string, required`}),_jsxs(_components.td,{children:[`Public link ID with the `,_jsx(_components.code,{children:`biq_lnk_`}),` prefix.`]})]})})]}),`\n`,_jsx(Heading,{level:`2`,id:`response`,children:`Response`}),`\n`,_jsx(_components.p,{children:`The endpoint returns the same complete link resource used by create and update,\nplus current aggregate performance values.`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`46`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`46`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"link\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"id\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"biq_lnk_01M14D2M8VFKYQCE7Z3A6HRXWP\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"external_id\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"campaign-link-1842\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"short_url\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"https://go.example.com/summer-product\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"long_url\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"https://example.com/product\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"name\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Summer campaign\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"domain_id\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"biq_dom_01M14C6KQ6SG2GKMCV7HQ9A1QT\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"alias\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"summer-product\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"active\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`true`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"has_password\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`true`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"activates_at\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`null`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"expires_at\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`null`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"exp_clicks_rule\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`null`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"utm\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"source=newsletter\u0026medium=email\u0026campaign=summer\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"geo_rules\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: [`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` {`}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"key\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"us\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"value\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"https://example.com/us/product\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` ],`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"device_rules\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: [],`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"platform_rules\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: [],`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"folder_ids\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: [`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"biq_fld_01M14C93RJD7W46PFJX9B1TVYH\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`],`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"pixel_ids\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: [`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"biq_pxl_01M14CBJNRXPW4Y22ZTA7F9W3J\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`],`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"tag_ids\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: [`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"biq_tag_01M14CC1TW7AQ6DWZG9TMRH0PQ\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`],`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"conversion_tracking_enabled\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`true`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"allow_search_engine_indexing\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`false`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"proxy\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`true`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"title\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Summer sale\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"description\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Explore the summer collection.\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"image\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"https://cdn.example.com/previews/summer.jpg\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"qr_code\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"url\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"https://biq.li/storage/workspaces/biq_ws_example/qr-codes/link.svg\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"format\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"svg\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"logo\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"app\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` },`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"clicks_count\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`2841`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"leads_count\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`93`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"sales_count\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`27`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"revenue\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`4148.5`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"revenue_currency\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"USD\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"clicked_at\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"2026-08-29T10:42:11+00:00\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"safety_status\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"clear\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"created_at\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"2026-08-28T16:42:19+00:00\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"updated_at\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"2026-08-29T09:20:03+00:00\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` },`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"status\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"success\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),`\n`,_jsx(Heading,{level:`3`,id:`configuration-fields`,children:`Configuration fields`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Field`}),_jsx(_components.th,{children:`Meaning`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsxs(_components.td,{children:[_jsx(_components.code,{children:`id`}),`, `,_jsx(_components.code,{children:`external_id`})]}),_jsx(_components.td,{children:`Biqli’s public link ID and your optional workspace-unique ID.`})]}),_jsxs(_components.tr,{children:[_jsxs(_components.td,{children:[_jsx(_components.code,{children:`short_url`}),`, `,_jsx(_components.code,{children:`long_url`})]}),_jsx(_components.td,{children:`Redirect URL and primary destination.`})]}),_jsxs(_components.tr,{children:[_jsxs(_components.td,{children:[_jsx(_components.code,{children:`domain_id`}),`, `,_jsx(_components.code,{children:`alias`})]}),_jsx(_components.td,{children:`Public custom-domain ID and short alias.`})]}),_jsxs(_components.tr,{children:[_jsxs(_components.td,{children:[_jsx(_components.code,{children:`active`}),`, `,_jsx(_components.code,{children:`safety_status`})]}),_jsx(_components.td,{children:`Requested active state and current safety state. Pending or quarantined links do not redirect.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`has_password`})}),_jsx(_components.td,{children:`Whether password protection is enabled. The password is never returned.`})]}),_jsxs(_components.tr,{children:[_jsxs(_components.td,{children:[_jsx(_components.code,{children:`activates_at`}),`, `,_jsx(_components.code,{children:`expires_at`}),`, `,_jsx(_components.code,{children:`exp_clicks_rule`})]}),_jsx(_components.td,{children:`Time- and click-based availability controls.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`utm`})}),_jsx(_components.td,{children:`Stored UTM query string.`})]}),_jsxs(_components.tr,{children:[_jsxs(_components.td,{children:[_jsx(_components.code,{children:`geo_rules`}),`, `,_jsx(_components.code,{children:`device_rules`}),`, `,_jsx(_components.code,{children:`platform_rules`})]}),_jsx(_components.td,{children:`Dynamic destination overrides.`})]}),_jsxs(_components.tr,{children:[_jsxs(_components.td,{children:[_jsx(_components.code,{children:`folder_ids`}),`, `,_jsx(_components.code,{children:`pixel_ids`}),`, `,_jsx(_components.code,{children:`tag_ids`})]}),_jsx(_components.td,{children:`Public IDs of attached workspace resources.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`conversion_tracking_enabled`})}),_jsx(_components.td,{children:`Whether Biqli appends a click ID for conversion attribution.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`allow_search_engine_indexing`})}),_jsx(_components.td,{children:`Whether search engines may index the short-link page.`})]}),_jsxs(_components.tr,{children:[_jsxs(_components.td,{children:[_jsx(_components.code,{children:`proxy`}),`, `,_jsx(_components.code,{children:`title`}),`, `,_jsx(_components.code,{children:`description`}),`, `,_jsx(_components.code,{children:`image`})]}),_jsx(_components.td,{children:`Custom social-preview configuration.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`qr_code`})}),_jsxs(_components.td,{children:[`Attached QR URL, format, and logo mode, or `,_jsx(_components.code,{children:`null`}),`.`]})]})]})]}),`\n`,_jsx(Heading,{level:`3`,id:`performance-fields`,children:`Performance fields`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Field`}),_jsx(_components.th,{children:`Meaning`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`clicks_count`})}),_jsx(_components.td,{children:`Total recorded link clicks.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`leads_count`})}),_jsx(_components.td,{children:`Total lead conversion events attributed to the link.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`sales_count`})}),_jsx(_components.td,{children:`Total sale conversion events attributed to the link.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`revenue`})}),_jsx(_components.td,{children:`Sum of attributed sales normalized to USD.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`revenue_currency`})}),_jsxs(_components.td,{children:[`Always `,_jsx(_components.code,{children:`USD`}),` for the normalized `,_jsx(_components.code,{children:`revenue`}),` value.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`clicked_at`})}),_jsxs(_components.td,{children:[`Most recent recorded click time, or `,_jsx(_components.code,{children:`null`}),` before the first click.`]})]})]})]}),`\n`,_jsxs(_components.p,{children:[`All date-time values use ISO 8601. Nullable settings are returned as `,_jsx(_components.code,{children:`null`}),`,\nand unattached resource lists are returned as empty arrays.`]}),`\n`,_jsx(Heading,{level:`2`,id:`errors`,children:`Errors`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`HTTP status`}),_jsx(_components.th,{children:`Error code`}),_jsx(_components.th,{children:`Meaning`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`401`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`invalid_token`})}),_jsx(_components.td,{children:`The API key is missing, invalid, malformed, or revoked.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`403`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`insufficient_scope`})}),_jsxs(_components.td,{children:[`The key lacks `,_jsx(_components.code,{children:`links.view`}),` or its user lost workspace access.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`404`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`resource_not_found`})}),_jsx(_components.td,{children:`The public link ID is invalid, deleted, or unavailable in this workspace.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`429`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`rate_limit_exceeded`})}),_jsx(_components.td,{children:`The workspace exceeded its API request limit.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`500`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`internal_server_error`})}),_jsx(_components.td,{children:`An unexpected server error occurred.`})]})]})]}),`\n`,_jsxs(_components.p,{children:[`Errors include an `,_jsx(_components.code,{children:`error`}),` object and a traceable `,_jsx(_components.code,{children:`request_id`}),`. The same request\nID is returned in the `,_jsx(_components.code,{children:`X-Biq-Request-Id`}),` response header.`]}),`\n`,_jsx(Heading,{level:`2`,id:`shared-api-behavior`,children:`Shared API behavior`}),`\n`,_jsxs(_components.p,{children:[`Authentication is workspace-scoped; see `,_jsx(_components.a,{href:`/docs/api-reference/authentication`,children:`Authentication`}),`. Errors use the standard envelope and request IDs described in `,_jsx(_components.a,{href:`/docs/api-reference/errors`,children:`Errors`}),`, and requests are subject to `,_jsx(_components.a,{href:`/docs/api-reference/rate-limits`,children:`Rate limits`}),`.`]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Retrieve a link","description":"Retrieve a link's complete safe configuration and aggregate performance data.","openapi":"GET /v1/link/{link}","href":"/docs/api-reference/links/get"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Authentication and permission","slug":"authentication-and-permission","depth":2,"children":[]},{"title":"Request","slug":"request","depth":2,"children":[]},{"title":"Response","slug":"response","depth":2,"children":[{"title":"Configuration fields","slug":"configuration-fields","depth":3,"children":[]},{"title":"Performance fields","slug":"performance-fields","depth":3,"children":[]}]},{"title":"Errors","slug":"errors","depth":2,"children":[]},{"title":"Shared API behavior","slug":"shared-api-behavior","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"link.show","summary":"Retrieve a link","description":"Retrieve a link's complete safe configuration and aggregate performance data.","tags":["Links"],"parameters":["79ddcc74-efa8-4fd0-8d20-8f6fb25e7f64"],"responses":{"200":"b2af3d2d-be97-4f3e-826a-10622717f173","401":"06318479-ae4d-4aae-8c3b-fe253c0dc106","403":"ae69be80-306d-4bdb-a73c-7d4e81077218","404":"d22a6e7e-63ce-476d-8b2f-1261e7c3cf04","429":"ddf5763f-1924-4709-ac4e-66da24afe856","500":"0269787a-4dee-4a4f-a0a6-4a8da54a52d7"},"method":"get","type":"path","servers":["2efa6d45-e74a-42aa-b55e-7e2ed6501676"],"security":["b0a2461c-5f0a-4771-907e-392809d004de","f2961585-0644-49fc-947d-36ebb0b61eeb"],"path":"/v1/link/{link}","baseUrlOptions":["https://biq.li/api"],"title":"Retrieve a link","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"79ddcc74-efa8-4fd0-8d20-8f6fb25e7f64":{"name":"link","in":"path","required":true,"description":"Public link ID.","schema":{"type":"string","pattern":"^biq_lnk_[0-9A-HJKMNP-TV-Z]{26}$","isRequired":true,"description":"Public link ID.","uniqueKey":"","typeLabel":"string"}}},"responses":{"b2af3d2d-be97-4f3e-826a-10622717f173":{"description":"Link returned successfully.","content":{"application/json":{"schema":{"type":"object","required":["link","status"],"properties":{"link":{"type":"object","required":["id","external_id","short_url","long_url","name","domain_id","alias","active","has_password","activates_at","expires_at","exp_clicks_rule","utm","folder_ids","pixel_ids","tag_ids","conversion_tracking_enabled","allow_search_engine_indexing","proxy","title","description","image","qr_code","geo_rules","device_rules","platform_rules","clicks_count","leads_count","sales_count","revenue","revenue_currency","clicked_at","safety_status","created_at","updated_at"],"properties":{"id":{"type":"string","description":"Public link ID. Internal numeric IDs are never returned.","pattern":"^biq_lnk_[0-9A-HJKMNP-TV-Z]{26}$","isRequired":true,"uniqueKey":"link.id","typeLabel":"string"},"external_id":{"oneOf":[{"type":"string","description":"Caller-controlled identifier, unique within the workspace.","isRequired":true,"uniqueKey":"link.external_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Caller-controlled identifier, unique within the workspace.","isRequired":true,"uniqueKey":"link.external_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"link.external_id","typeLabel":"string | null"},"short_url":{"type":"string","format":"uri","isRequired":true,"uniqueKey":"link.short_url","typeLabel":"string\u003curi>"},"long_url":{"type":"string","isRequired":true,"uniqueKey":"link.long_url","typeLabel":"string"},"name":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"link.name.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"link.name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"link.name","typeLabel":"string | null"},"domain_id":{"oneOf":[{"type":"string","pattern":"^biq_dom_[0-9A-HJKMNP-TV-Z]{26}$","isRequired":true,"uniqueKey":"link.domain_id.oneOf.0","typeLabel":"string"},{"type":"null","pattern":"^biq_dom_[0-9A-HJKMNP-TV-Z]{26}$","isRequired":true,"uniqueKey":"link.domain_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"link.domain_id","typeLabel":"string | null"},"alias":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"link.alias.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"link.alias.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"link.alias","typeLabel":"string | null"},"active":{"type":"boolean","isRequired":true,"uniqueKey":"link.active","typeLabel":"boolean"},"has_password":{"type":"boolean","isRequired":true,"uniqueKey":"link.has_password","typeLabel":"boolean"},"activates_at":{"oneOf":[{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"link.activates_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","isRequired":true,"uniqueKey":"link.activates_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"link.activates_at","typeLabel":"string\u003cdate-time> | null"},"expires_at":{"oneOf":[{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"link.expires_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","isRequired":true,"uniqueKey":"link.expires_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"link.expires_at","typeLabel":"string\u003cdate-time> | null"},"exp_clicks_rule":{"oneOf":[{"type":"object","required":["key"],"properties":{"key":{"type":"integer","minimum":1,"description":"Number of clicks after which the link expires.","isRequired":true,"uniqueKey":"link.exp_clicks_rule.oneOf.0.key","typeLabel":"integer"},"value":{"oneOf":[{"type":"string","description":"Optional URL to use after the click threshold is reached.","maxLength":1000,"uniqueKey":"link.exp_clicks_rule.oneOf.0.value.oneOf.0","typeLabel":"string"},{"type":"null","description":"Optional URL to use after the click threshold is reached.","maxLength":1000,"uniqueKey":"link.exp_clicks_rule.oneOf.0.value.oneOf.1","typeLabel":"null"}],"uniqueKey":"link.exp_clicks_rule.oneOf.0.value","typeLabel":"string | null"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"link.exp_clicks_rule.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"link.exp_clicks_rule.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"link.exp_clicks_rule","typeLabel":"object | null"},"utm":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"link.utm.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"link.utm.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"link.utm","typeLabel":"string | null"},"geo_rules":{"type":"array","items":{"type":"object","additionalProperties":false,"required":["key","value"],"properties":{"key":{"type":"string","description":"Match value, such as a country code, device, or platform.","maxLength":250,"isRequired":true,"uniqueKey":"link.geo_rules.items.[INDEX].key","typeLabel":"string"},"value":{"type":"string","description":"Destination URL used when the rule matches.","maxLength":1000,"isRequired":true,"uniqueKey":"link.geo_rules.items.[INDEX].value","typeLabel":"string"}},"uniqueKey":"link.geo_rules.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"link.geo_rules","typeLabel":"object[]"},"device_rules":{"type":"array","items":{"type":"object","additionalProperties":false,"required":["key","value"],"properties":{"key":{"type":"string","description":"Match value, such as a country code, device, or platform.","maxLength":250,"isRequired":true,"uniqueKey":"link.device_rules.items.[INDEX].key","typeLabel":"string"},"value":{"type":"string","description":"Destination URL used when the rule matches.","maxLength":1000,"isRequired":true,"uniqueKey":"link.device_rules.items.[INDEX].value","typeLabel":"string"}},"uniqueKey":"link.device_rules.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"link.device_rules","typeLabel":"object[]"},"platform_rules":{"type":"array","items":{"type":"object","additionalProperties":false,"required":["key","value"],"properties":{"key":{"type":"string","description":"Match value, such as a country code, device, or platform.","maxLength":250,"isRequired":true,"uniqueKey":"link.platform_rules.items.[INDEX].key","typeLabel":"string"},"value":{"type":"string","description":"Destination URL used when the rule matches.","maxLength":1000,"isRequired":true,"uniqueKey":"link.platform_rules.items.[INDEX].value","typeLabel":"string"}},"uniqueKey":"link.platform_rules.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"link.platform_rules","typeLabel":"object[]"},"folder_ids":{"type":"array","items":{"type":"string","uniqueKey":"link.folder_ids.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"link.folder_ids","typeLabel":"string[]"},"pixel_ids":{"type":"array","items":{"type":"string","uniqueKey":"link.pixel_ids.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"link.pixel_ids","typeLabel":"string[]"},"tag_ids":{"type":"array","items":{"type":"string","uniqueKey":"link.tag_ids.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"link.tag_ids","typeLabel":"string[]"},"conversion_tracking_enabled":{"type":"boolean","isRequired":true,"uniqueKey":"link.conversion_tracking_enabled","typeLabel":"boolean"},"allow_search_engine_indexing":{"type":"boolean","isRequired":true,"uniqueKey":"link.allow_search_engine_indexing","typeLabel":"boolean"},"proxy":{"type":"boolean","isRequired":true,"uniqueKey":"link.proxy","typeLabel":"boolean"},"title":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"link.title.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"link.title.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"link.title","typeLabel":"string | null"},"description":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"link.description.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"link.description.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"link.description","typeLabel":"string | null"},"image":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"link.image.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"link.image.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"link.image","typeLabel":"string | null"},"qr_code":{"oneOf":[{"type":"object","required":["url","format","logo"],"properties":{"url":{"type":"string","format":"uri","isRequired":true,"uniqueKey":"link.qr_code.oneOf.0.url","typeLabel":"string\u003curi>"},"format":{"type":"string","const":"svg","isRequired":true,"uniqueKey":"link.qr_code.oneOf.0.format","typeLabel":"string"},"logo":{"type":"string","enum":["app","none"],"isRequired":true,"uniqueKey":"link.qr_code.oneOf.0.logo","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"link.qr_code.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"link.qr_code.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"link.qr_code","typeLabel":"object | null"},"clicks_count":{"type":"integer","minimum":0,"description":"Total recorded clicks.","isRequired":true,"uniqueKey":"link.clicks_count","typeLabel":"integer"},"leads_count":{"type":"integer","minimum":0,"description":"Total attributed lead events.","isRequired":true,"uniqueKey":"link.leads_count","typeLabel":"integer"},"sales_count":{"type":"integer","minimum":0,"description":"Total attributed sale events.","isRequired":true,"uniqueKey":"link.sales_count","typeLabel":"integer"},"revenue":{"type":"number","minimum":0,"description":"Attributed sales amount normalized to USD.","isRequired":true,"uniqueKey":"link.revenue","typeLabel":"number"},"revenue_currency":{"type":"string","const":"USD","isRequired":true,"uniqueKey":"link.revenue_currency","typeLabel":"string"},"clicked_at":{"oneOf":[{"type":"string","format":"date-time","description":"Time of the most recent recorded click.","isRequired":true,"uniqueKey":"link.clicked_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Time of the most recent recorded click.","isRequired":true,"uniqueKey":"link.clicked_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"link.clicked_at","typeLabel":"string\u003cdate-time> | null"},"safety_status":{"type":"string","enum":["clear","pending","quarantined"],"isRequired":true,"uniqueKey":"link.safety_status","typeLabel":"enum\u003cstring>"},"created_at":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"link.created_at","typeLabel":"string\u003cdate-time>"},"updated_at":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"link.updated_at","typeLabel":"string\u003cdate-time>"}},"isRequired":true,"uniqueKey":"link","typeLabel":"object"},"status":{"type":"string","const":"success","isRequired":true,"uniqueKey":"status","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"link":{"id":"\u003cstring>","external_id":"\u003cstring>","short_url":"\u003cstring>","long_url":"\u003cstring>","name":"\u003cstring>","domain_id":"\u003cstring>","alias":"\u003cstring>","active":true,"has_password":true,"activates_at":"2023-11-07T05:31:56Z","expires_at":"2023-11-07T05:31:56Z","exp_clicks_rule":{"key":2,"value":"\u003cstring>"},"utm":"\u003cstring>","geo_rules":[{"key":"\u003cstring>","value":"\u003cstring>"}],"device_rules":[{"key":"\u003cstring>","value":"\u003cstring>"}],"platform_rules":[{"key":"\u003cstring>","value":"\u003cstring>"}],"folder_ids":["\u003cstring>"],"pixel_ids":["\u003cstring>"],"tag_ids":["\u003cstring>"],"conversion_tracking_enabled":true,"allow_search_engine_indexing":true,"proxy":true,"title":"\u003cstring>","description":"\u003cstring>","image":"\u003cstring>","qr_code":{"url":"\u003cstring>","format":"svg","logo":"app"},"clicks_count":1,"leads_count":1,"sales_count":1,"revenue":1,"revenue_currency":"USD","clicked_at":"2023-11-07T05:31:56Z","safety_status":"clear","created_at":"2023-11-07T05:31:56Z","updated_at":"2023-11-07T05:31:56Z"},"status":"success"}}},"exampleType":"generated"}},"exampleType":"generated"},"06318479-ae4d-4aae-8c3b-fe253c0dc106":{"description":"The bearer credential is missing, invalid, expired, or revoked.","headers":{"X-Biq-Request-Id":{"description":"Request identifier for support and tracing.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["error","request_id"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["invalid_token","insufficient_scope","upgrade_required","quota_exceeded","resource_not_found","tracking_disabled","attribution_required","currency_unavailable","idempotency_conflict","idempotency_key_required","invalid_preflight","origin_required","hostname_not_configured","origin_not_allowed","client_click_tracking_disabled","invalid_click_id","stripe_account_not_connected","stripe_environment_required","stripe_attribution_conflict","stripe_mode_mismatch","domain_taken","alias_taken","external_id_taken","folder_name_taken","tag_name_taken","pixel_name_taken","biolink_name_taken","method_not_allowed","url_blocked","dns_verification_failed","validation_error","rate_limit_exceeded","internal_server_error"],"isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"type":"object","additionalProperties":true,"uniqueKey":"error.details","typeLabel":"object"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"},"request_id":{"type":"string","description":"Request identifier to include when contacting support.","isRequired":true,"uniqueKey":"request_id","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"invalid_token","message":"\u003cstring>","details":{}},"request_id":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"ae69be80-306d-4bdb-a73c-7d4e81077218":{"description":"The credential lacks a required permission, the workspace must upgrade, or its quota is exhausted.","headers":{"X-Biq-Request-Id":{"description":"Request identifier for support and tracing.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["error","request_id"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["invalid_token","insufficient_scope","upgrade_required","quota_exceeded","resource_not_found","tracking_disabled","attribution_required","currency_unavailable","idempotency_conflict","idempotency_key_required","invalid_preflight","origin_required","hostname_not_configured","origin_not_allowed","client_click_tracking_disabled","invalid_click_id","stripe_account_not_connected","stripe_environment_required","stripe_attribution_conflict","stripe_mode_mismatch","domain_taken","alias_taken","external_id_taken","folder_name_taken","tag_name_taken","pixel_name_taken","biolink_name_taken","method_not_allowed","url_blocked","dns_verification_failed","validation_error","rate_limit_exceeded","internal_server_error"],"isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"type":"object","additionalProperties":true,"uniqueKey":"error.details","typeLabel":"object"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"},"request_id":{"type":"string","description":"Request identifier to include when contacting support.","isRequired":true,"uniqueKey":"request_id","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"invalid_token","message":"\u003cstring>","details":{}},"request_id":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"d22a6e7e-63ce-476d-8b2f-1261e7c3cf04":{"description":"The requested resource or referenced public ID is unavailable in the authenticated workspace.","headers":{"X-Biq-Request-Id":{"description":"Request identifier for support and tracing.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["error","request_id"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["invalid_token","insufficient_scope","upgrade_required","quota_exceeded","resource_not_found","tracking_disabled","attribution_required","currency_unavailable","idempotency_conflict","idempotency_key_required","invalid_preflight","origin_required","hostname_not_configured","origin_not_allowed","client_click_tracking_disabled","invalid_click_id","stripe_account_not_connected","stripe_environment_required","stripe_attribution_conflict","stripe_mode_mismatch","domain_taken","alias_taken","external_id_taken","folder_name_taken","tag_name_taken","pixel_name_taken","biolink_name_taken","method_not_allowed","url_blocked","dns_verification_failed","validation_error","rate_limit_exceeded","internal_server_error"],"isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"type":"object","additionalProperties":true,"uniqueKey":"error.details","typeLabel":"object"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"},"request_id":{"type":"string","description":"Request identifier to include when contacting support.","isRequired":true,"uniqueKey":"request_id","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"invalid_token","message":"\u003cstring>","details":{}},"request_id":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"ddf5763f-1924-4709-ac4e-66da24afe856":{"description":"The workspace exceeded its plan's API rate limit.","headers":{"RateLimit-Policy":{"description":"Current IETF HTTPAPI quota policy as a structured field.","schema":{"type":"string","example":"\"workspace-api\";q=1000;w=60"}},"RateLimit":{"description":"Current IETF HTTPAPI service limit as a structured field.","schema":{"type":"string","example":"\"workspace-api\";r=0;t=17"}},"Retry-After":{"description":"Seconds to wait before retrying the request.","schema":{"type":"integer","minimum":0,"example":17}},"X-RateLimit-Limit":{"description":"Legacy maximum request count for the current window.","schema":{"type":"integer","minimum":1,"example":1000}},"X-RateLimit-Remaining":{"description":"Legacy remaining request count.","schema":{"type":"integer","minimum":0,"example":0}},"X-RateLimit-Reset":{"description":"Legacy reset time as a UTC Unix timestamp.","schema":{"type":"integer","format":"int64","example":1788126519}},"X-Biq-Request-Id":{"description":"Request identifier for support and tracing.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["error","request_id"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["invalid_token","insufficient_scope","upgrade_required","quota_exceeded","resource_not_found","tracking_disabled","attribution_required","currency_unavailable","idempotency_conflict","idempotency_key_required","invalid_preflight","origin_required","hostname_not_configured","origin_not_allowed","client_click_tracking_disabled","invalid_click_id","stripe_account_not_connected","stripe_environment_required","stripe_attribution_conflict","stripe_mode_mismatch","domain_taken","alias_taken","external_id_taken","folder_name_taken","tag_name_taken","pixel_name_taken","biolink_name_taken","method_not_allowed","url_blocked","dns_verification_failed","validation_error","rate_limit_exceeded","internal_server_error"],"isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"type":"object","additionalProperties":true,"uniqueKey":"error.details","typeLabel":"object"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"},"request_id":{"type":"string","description":"Request identifier to include when contacting support.","isRequired":true,"uniqueKey":"request_id","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"invalid_token","message":"\u003cstring>","details":{}},"request_id":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"0269787a-4dee-4a4f-a0a6-4a8da54a52d7":{"description":"The request failed unexpectedly.","headers":{"X-Biq-Request-Id":{"description":"Request identifier for support and tracing.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["error","request_id"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["invalid_token","insufficient_scope","upgrade_required","quota_exceeded","resource_not_found","tracking_disabled","attribution_required","currency_unavailable","idempotency_conflict","idempotency_key_required","invalid_preflight","origin_required","hostname_not_configured","origin_not_allowed","client_click_tracking_disabled","invalid_click_id","stripe_account_not_connected","stripe_environment_required","stripe_attribution_conflict","stripe_mode_mismatch","domain_taken","alias_taken","external_id_taken","folder_name_taken","tag_name_taken","pixel_name_taken","biolink_name_taken","method_not_allowed","url_blocked","dns_verification_failed","validation_error","rate_limit_exceeded","internal_server_error"],"isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"type":"object","additionalProperties":true,"uniqueKey":"error.details","typeLabel":"object"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"},"request_id":{"type":"string","description":"Request identifier to include when contacting support.","isRequired":true,"uniqueKey":"request_id","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"invalid_token","message":"\u003cstring>","details":{}},"request_id":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"b0a2461c-5f0a-4771-907e-392809d004de":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"Workspace API key","description":"A workspace API key beginning with biqli_.","scopes":[]}},"f2961585-0644-49fc-947d-36ebb0b61eeb":{"integrationOAuth":{"type":"oauth2","description":"OAuth 2.0 authorization code flow for self-service and Biqli-managed integrations. A user selects one workspace and approves the requested permissions. Confidential clients authenticate with a secret; public clients use S256 PKCE.","flows":{"authorizationCode":{"authorizationUrl":"https://biq.li/oauth/authorize","tokenUrl":"https://biq.li/api/v1/oauth/token","refreshUrl":"https://biq.li/api/v1/oauth/token","scopes":{"workspace.read":"Read the connected user and workspace identity.","links.view":"View links in the connected workspace.","links.create":"Create links in the connected workspace.","links.update":"Update links in the connected workspace.","links.delete":"Delete links in the connected workspace.","qr_codes.view":"View QR codes in the connected workspace.","qr_codes.create":"Create QR codes in the connected workspace.","qr_codes.update":"Update QR codes in the connected workspace.","qr_codes.delete":"Delete QR codes in the connected workspace.","biolinks.view":"View Biolinks in the connected workspace.","biolinks.create":"Create Biolinks in the connected workspace.","biolinks.update":"Update Biolinks in the connected workspace.","biolinks.delete":"Delete Biolinks in the connected workspace.","link_groups.view":"View folders in the connected workspace.","link_groups.create":"Create folders in the connected workspace.","link_groups.update":"Update folders in the connected workspace.","link_groups.delete":"Delete folders in the connected workspace.","tracking_pixels.view":"View tracking pixels in the connected workspace.","tracking_pixels.create":"Create tracking pixels in the connected workspace.","tracking_pixels.update":"Update tracking pixels in the connected workspace.","tracking_pixels.delete":"Delete tracking pixels in the connected workspace.","custom_domains.view":"View custom domains in the connected workspace.","custom_domains.create":"Create custom domains in the connected workspace.","custom_domains.update":"Update custom domains in the connected workspace.","custom_domains.delete":"Delete custom domains in the connected workspace.","tags.view":"View tags in the connected workspace.","tags.create":"Create tags in the connected workspace.","tags.update":"Update tags in the connected workspace.","tags.delete":"Delete tags in the connected workspace.","webhooks.view":"View webhook endpoints and delivery history in the connected workspace.","webhooks.create":"Create webhook endpoints in the connected workspace.","webhooks.update":"Update and test webhook endpoints in the connected workspace.","webhooks.delete":"Delete webhook endpoints in the connected workspace.","conversions.create":"Record attributed lead and sale events in the connected workspace.","links.read":"Compatibility scope for viewing links in a Biqli-managed integration.","links.write":"Compatibility scope for managing links and viewing their referenced resources.","webhooks.read":"Compatibility scope for reading representative webhook payloads.","webhooks.write":"Compatibility scope for managing Biqli-owned automation subscriptions.","conversions.write":"Compatibility scope for recording attributed lead and sale events."}}},"scopes":[]}}},"servers":{"2efa6d45-e74a-42aa-b55e-7e2ed6501676":{"url":"https://biq.li/api"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"Workspace API key","description":"A workspace API key beginning with biqli_.","scopes":[]},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"A workspace API key beginning with biqli_.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"},{"schemes":[{"scheme":{"type":"oauth2","description":"OAuth 2.0 authorization code flow for self-service and Biqli-managed integrations. A user selects one workspace and approves the requested permissions. Confidential clients authenticate with a secret; public clients use S256 PKCE.","flows":{"authorizationCode":{"authorizationUrl":"https://biq.li/oauth/authorize","tokenUrl":"https://biq.li/api/v1/oauth/token","refreshUrl":"https://biq.li/api/v1/oauth/token","scopes":{"workspace.read":"Read the connected user and workspace identity.","links.view":"View links in the connected workspace.","links.create":"Create links in the connected workspace.","links.update":"Update links in the connected workspace.","links.delete":"Delete links in the connected workspace.","qr_codes.view":"View QR codes in the connected workspace.","qr_codes.create":"Create QR codes in the connected workspace.","qr_codes.update":"Update QR codes in the connected workspace.","qr_codes.delete":"Delete QR codes in the connected workspace.","biolinks.view":"View Biolinks in the connected workspace.","biolinks.create":"Create Biolinks in the connected workspace.","biolinks.update":"Update Biolinks in the connected workspace.","biolinks.delete":"Delete Biolinks in the connected workspace.","link_groups.view":"View folders in the connected workspace.","link_groups.create":"Create folders in the connected workspace.","link_groups.update":"Update folders in the connected workspace.","link_groups.delete":"Delete folders in the connected workspace.","tracking_pixels.view":"View tracking pixels in the connected workspace.","tracking_pixels.create":"Create tracking pixels in the connected workspace.","tracking_pixels.update":"Update tracking pixels in the connected workspace.","tracking_pixels.delete":"Delete tracking pixels in the connected workspace.","custom_domains.view":"View custom domains in the connected workspace.","custom_domains.create":"Create custom domains in the connected workspace.","custom_domains.update":"Update custom domains in the connected workspace.","custom_domains.delete":"Delete custom domains in the connected workspace.","tags.view":"View tags in the connected workspace.","tags.create":"Create tags in the connected workspace.","tags.update":"Update tags in the connected workspace.","tags.delete":"Delete tags in the connected workspace.","webhooks.view":"View webhook endpoints and delivery history in the connected workspace.","webhooks.create":"Create webhook endpoints in the connected workspace.","webhooks.update":"Update and test webhook endpoints in the connected workspace.","webhooks.delete":"Delete webhook endpoints in the connected workspace.","conversions.create":"Record attributed lead and sale events in the connected workspace.","links.read":"Compatibility scope for viewing links in a Biqli-managed integration.","links.write":"Compatibility scope for managing links and viewing their referenced resources.","webhooks.read":"Compatibility scope for reading representative webhook payloads.","webhooks.write":"Compatibility scope for managing Biqli-owned automation subscriptions.","conversions.write":"Compatibility scope for recording attributed lead and sale events."}}},"scopes":[]},"schema":{"title":"OAuth2 Auth","type":"string","isRequired":true,"description":"OAuth 2.0 authorization code flow for self-service and Biqli-managed integrations. A user selects one workspace and approves the requested permissions. Confidential clients authenticate with a secret; public clients use S256 PKCE.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"integrationOAuth","name":"Authorization"}],"title":"integrationOAuth"}]},"originalFileLocation":"openapi.json"},"subdomain":"biqlillc-cc349ea4","siteName":"Biqli","title":"Retrieve a link - Biqli","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-08-31T17:25:18.118Z","originalFileLocation":"docs/api-reference/links/get.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Retrieve a link\u0026#x27;s complete safe configuration and aggregate performance data.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Biqli\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/biqlillc-cc349ea4/T5qpvXSLmYQj7Z5y/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/biqlillc-cc349ea4/T5qpvXSLmYQj7Z5y/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/biqlillc-cc349ea4/T5qpvXSLmYQj7Z5y/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/biqlillc-cc349ea4/T5qpvXSLmYQj7Z5y/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/biqlillc-cc349ea4/T5qpvXSLmYQj7Z5y/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/biqlillc-cc349ea4/T5qpvXSLmYQj7Z5y/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/biqlillc-cc349ea4/T5qpvXSLmYQj7Z5y/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/biqlillc-cc349ea4/T5qpvXSLmYQj7Z5y/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/biqlillc-cc349ea4/T5qpvXSLmYQj7Z5y/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Retrieve a link - Biqli\">\u003cmeta data-mint-head property=\"og:description\" content=\"Retrieve a link\u0026#x27;s complete safe configuration and aggregate performance data.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Biqli\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://learn.biq.li/docs/api-reference/links/get\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://biqlillc-cc349ea4.mintlify.site/_mintlify/api/og/v2?division=Links\u0026amp;title=Retrieve+a+link\u0026amp;description=Retrieve+a+link%27s+complete+safe+configuration+and+aggregate+performance+data.\u0026amp;theme=7fdbf1577f29ece888d7a2b3\u0026amp;signature=e50010ff94b007035f37314d783c5871c6483b15d47d50e163221117cb896278\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Retrieve a link - Biqli\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Retrieve a link\u0026#x27;s complete safe configuration and aggregate performance data.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://biqlillc-cc349ea4.mintlify.site/_mintlify/api/og/v2?division=Links\u0026amp;title=Retrieve+a+link\u0026amp;description=Retrieve+a+link%27s+complete+safe+configuration+and+aggregate+performance+data.\u0026amp;theme=7fdbf1577f29ece888d7a2b3\u0026amp;signature=e50010ff94b007035f37314d783c5871c6483b15d47d50e163221117cb896278\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/biqlillc-cc349ea4/T5qpvXSLmYQj7Z5y/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Biqli\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#3B82F6\">\u003clink data-mint-head rel=\"canonical\" href=\"https://learn.biq.li/docs/api-reference/links/get\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/docs/api-reference/links/get.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://learn.biq.li/#organization\",\"name\":\"Biqli\",\"url\":\"https://learn.biq.li\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/biqlillc-cc349ea4/vhOVG3nb6zjxQ8qQ/logo/light.png?fit=max\u0026auto=format\u0026n=vhOVG3nb6zjxQ8qQ\u0026q=85\u0026s=e047892083738e2bb348400f1a82f718\"}},{\"@type\":\"WebSite\",\"@id\":\"https://learn.biq.li#website\",\"name\":\"Biqli\",\"url\":\"https://learn.biq.li\",\"publisher\":{\"@id\":\"https://learn.biq.li/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://learn.biq.li/docs/api-reference/links/get#webpage\",\"url\":\"https://learn.biq.li/docs/api-reference/links/get\",\"name\":\"Retrieve a link\",\"description\":\"Retrieve a link's complete safe configuration and aggregate performance data.\",\"dateModified\":\"2026-08-31T17:25:18.118Z\",\"isPartOf\":{\"@id\":\"https://learn.biq.li#website\"},\"breadcrumb\":{\"@id\":\"https://learn.biq.li/docs/api-reference/links/get#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://learn.biq.li/docs/api-reference/links/get#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"BIQLI LINKS API\",\"item\":\"https://learn.biq.li/docs/api-reference/links/create\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Links\",\"item\":\"https://learn.biq.li/docs/api-reference/links/create\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Retrieve a link\",\"item\":\"https://learn.biq.li/docs/api-reference/links/get\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://learn.biq.li/docs/api-reference/links/get#apireference\",\"headline\":\"Retrieve a link\",\"name\":\"Retrieve a link\",\"description\":\"Retrieve a link's complete safe configuration and aggregate performance data.\",\"url\":\"https://learn.biq.li/docs/api-reference/links/get\",\"mainEntityOfPage\":{\"@id\":\"https://learn.biq.li/docs/api-reference/links/get#webpage\"},\"dateModified\":\"2026-08-31T17:25:18.118Z\",\"publisher\":{\"@id\":\"https://learn.biq.li/#organization\"},\"isPartOf\":{\"@id\":\"https://learn.biq.li#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Biqli\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Biqli","nav":{"global":null,"tabs":[{"tab":"Developer Docs","icon":"code","pages":[{"title":"Developer Docs","href":"/developers/introduction"}]},{"tab":"Help Center","icon":"life-ring","pages":[{"title":"Help Center","href":"/help"}]},{"tab":"API Reference","icon":"rectangle-terminal","groups":[{"group":"GETTING STARTED","pages":[{"title":"Introduction","href":"/docs/api-reference/introduction"},{"title":"Authentication","href":"/docs/api-reference/authentication"},{"title":"Rate limits","href":"/docs/api-reference/rate-limits"},{"title":"Errors","href":"/docs/api-reference/errors"},{"title":"Pagination","href":"/docs/api-reference/pagination"}]},{"group":"OAUTH 2.0","pages":[{"title":"OAuth 2.0 overview","href":"/docs/api-reference/oauth/overview"},{"title":"Authorize a workspace","href":"/docs/api-reference/oauth/authorize"},{"title":"Exchange or refresh a token","href":"/docs/api-reference/oauth/token"},{"title":"Retrieve the connected workspace","href":"/docs/api-reference/oauth/connection"},{"title":"Revoke a connection","href":"/docs/api-reference/oauth/revoke"},{"title":"OAuth scopes","href":"/docs/api-reference/oauth/scopes"},{"title":"OAuth errors","href":"/docs/api-reference/oauth/errors"}]},{"group":"OFFICIAL AUTOMATION APIS","pages":[{"title":"Official Zapier integration API","href":"/docs/api-reference/integrations/zapier"},{"title":"Official Make integration API","href":"/docs/api-reference/integrations/make"}]},{"group":"SDKs","pages":[{"title":"SDK overview","href":"/docs/api-reference/sdks/overview"},{"title":"Browser SDK","href":"/docs/api-reference/sdks/browser"},{"title":"TypeScript SDK","href":"/docs/api-reference/sdks/typescript"},{"title":"PHP SDK","href":"/docs/api-reference/sdks/php"},{"title":"Android SDK","href":"/docs/api-reference/sdks/android"},{"title":"iOS SDK","href":"/docs/api-reference/sdks/ios"}]},{"group":"MOBILE ATTRIBUTION","pages":[{"title":"Resolve a mobile open","openapi":"POST /v1/track/open","href":"/docs/api-reference/mobile/track-open"},{"title":"Verify attribution receipts","href":"/docs/api-reference/mobile/attribution-receipts"}]},{"group":"BIQLI LINKS API","pages":[{"group":"Links","pages":[{"title":"Create a link","description":"Create a short link, configure its behavior, and optionally attach workspace resources or an SVG QR code.","openapi":"POST /v1/link","href":"/docs/api-reference/links/create"},{"title":"Retrieve a link","openapi":"GET /v1/link/{link}","href":"/docs/api-reference/links/get"},{"title":"Update a link","description":"Partially update specific fields on an existing short link.","openapi":"PATCH /v1/link/{link}","href":"/docs/api-reference/links/update"},{"title":"Delete a link","openapi":"DELETE /v1/link/{link}","href":"/docs/api-reference/links/delete"},{"title":"List links","openapi":"GET /v1/link","href":"/docs/api-reference/links/list"},{"title":"Count links","openapi":"GET /v1/link/count","href":"/docs/api-reference/links/count"},{"title":"Bulk create links","openapi":"POST /v1/link/bulk","href":"/docs/api-reference/links/bulk-create"},{"title":"Bulk update links","openapi":"PATCH /v1/link/bulk","href":"/docs/api-reference/links/bulk-update"},{"title":"Bulk delete links","openapi":"DELETE /v1/link/bulk","href":"/docs/api-reference/links/bulk-delete"}]},{"group":"Webhook endpoints","pages":[{"title":"Manage webhook endpoints","href":"/docs/api-reference/webhooks/manage"}]},{"group":"Conversions","pages":[{"title":"Track a lead","openapi":"POST /v1/track/lead","href":"/docs/api-reference/conversions/track-lead"},{"title":"Track a sale","openapi":"POST /v1/track/sale","href":"/docs/api-reference/conversions/track-sale"},{"title":"Store a Stripe Checkout Session","sidebarTitle":"Store Stripe session","href":"/docs/api-reference/conversions/store-stripe-session"}]},{"group":"Domains","pages":[{"title":"Create a domain","openapi":"POST /v1/domain","href":"/docs/api-reference/domains/create"},{"title":"Retrieve a domain","openapi":"GET /v1/domain/{domain}","href":"/docs/api-reference/domains/get"},{"title":"Update a domain","openapi":"PATCH /v1/domain/{domain}","href":"/docs/api-reference/domains/update"},{"title":"Delete a domain","openapi":"DELETE /v1/domain/{domain}","href":"/docs/api-reference/domains/delete"},{"title":"List domains","openapi":"GET /v1/domain","href":"/docs/api-reference/domains/list"},{"title":"Check domain availability","openapi":"GET /v1/domain/availability","href":"/docs/api-reference/domains/availability"},{"title":"Retrieve DNS configuration","openapi":"GET /v1/domain/{domain}/dns-config","href":"/docs/api-reference/domains/dns-config"},{"title":"Verify a domain","openapi":"POST /v1/domain/{domain}/verify","href":"/docs/api-reference/domains/verify"}]},{"group":"Folders","pages":[{"title":"Create a folder","openapi":"POST /v1/folder","href":"/docs/api-reference/folders/create"},{"title":"Retrieve a folder","openapi":"GET /v1/folder/{folder}","href":"/docs/api-reference/folders/get"},{"title":"Update a folder","openapi":"PATCH /v1/folder/{folder}","href":"/docs/api-reference/folders/update"},{"title":"Delete a folder","openapi":"DELETE /v1/folder/{folder}","href":"/docs/api-reference/folders/delete"},{"title":"List folders","openapi":"GET /v1/folder","href":"/docs/api-reference/folders/list"},{"title":"Manage folder links","openapi":"PUT /v1/folder/{folder}/links/{link}","href":"/docs/api-reference/folders/links"}]},{"group":"Tags","pages":[{"title":"Create a tag","openapi":"POST /v1/tag","href":"/docs/api-reference/tags/create"},{"title":"Retrieve a tag","openapi":"GET /v1/tag/{tag}","href":"/docs/api-reference/tags/get"},{"title":"Update a tag","openapi":"PATCH /v1/tag/{tag}","href":"/docs/api-reference/tags/update"},{"title":"Delete a tag","openapi":"DELETE /v1/tag/{tag}","href":"/docs/api-reference/tags/delete"},{"title":"List tags","openapi":"GET /v1/tag","href":"/docs/api-reference/tags/list"},{"title":"Manage tagged links","openapi":"PUT /v1/tag/{tag}/links/{link}","href":"/docs/api-reference/tags/links"}]},{"group":"Tracking pixels","pages":[{"title":"Create a tracking pixel","openapi":"POST /v1/tracking-pixel","href":"/docs/api-reference/tracking-pixels/create"},{"title":"Retrieve a tracking pixel","openapi":"GET /v1/tracking-pixel/{pixel}","href":"/docs/api-reference/tracking-pixels/get"},{"title":"Update a tracking pixel","openapi":"PATCH /v1/tracking-pixel/{pixel}","href":"/docs/api-reference/tracking-pixels/update"},{"title":"Delete a tracking pixel","openapi":"DELETE /v1/tracking-pixel/{pixel}","href":"/docs/api-reference/tracking-pixels/delete"},{"title":"List tracking pixels","openapi":"GET /v1/tracking-pixel","href":"/docs/api-reference/tracking-pixels/list"},{"title":"Manage pixel links","openapi":"PUT /v1/tracking-pixel/{pixel}/links/{link}","href":"/docs/api-reference/tracking-pixels/links"}]},{"group":"QR codes","pages":[{"title":"Create a QR code","openapi":"POST /v1/qr","href":"/docs/api-reference/qr-codes/create"},{"title":"Style a QR code","href":"/docs/api-reference/qr-codes/styling"},{"title":"Retrieve a QR code","openapi":"GET /v1/qr/{qr}","href":"/docs/api-reference/qr-codes/get"},{"title":"Update a QR code","openapi":"PATCH /v1/qr/{qr}","href":"/docs/api-reference/qr-codes/update"},{"title":"Delete a QR code","openapi":"DELETE /v1/qr/{qr}","href":"/docs/api-reference/qr-codes/delete"},{"title":"List QR codes","openapi":"GET /v1/qr","href":"/docs/api-reference/qr-codes/list"}]},{"group":"Biolinks","pages":[{"title":"Create a biolink","openapi":"POST /v1/bio","href":"/docs/api-reference/biolinks/create"},{"title":"Retrieve a biolink","openapi":"GET /v1/bio/{bio}","href":"/docs/api-reference/biolinks/get"},{"title":"Update a biolink","openapi":"PATCH /v1/bio/{bio}","href":"/docs/api-reference/biolinks/update"},{"title":"Delete a biolink","openapi":"DELETE /v1/bio/{bio}","href":"/docs/api-reference/biolinks/delete"},{"title":"List biolinks","openapi":"GET /v1/bio","href":"/docs/api-reference/biolinks/list"}]}]}]},{"tab":"Webhooks","icon":"webhook","pages":[{"title":"Webhooks","href":"/webhooks/introduction"}]}]},"basePath":"","title":"Retrieve a link - Biqli","buildId":"dpl_FWZhTb2vab28gFGFH4ojka6qEznQ","deploymentId":"dpl_FWZhTb2vab28gFGFH4ojka6qEznQ","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CBsVopKK.js","utils-DZAk68jJ.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-D32AYZrP.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-D_A5_cny.js","snippetPresets-xNRfS9th.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-BIB25-tq.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-CydJ4w4j.js","shallow-CYPBeQSG.js","getApiPlaygroundDisplay-A5xJVBOu.js","CodeSnippet-BVRTgi3m.js","CodeSnippets-DjD6BSlt.js","Page-Dr40SSJq.js","getPastedJson-D4V4JyrR.js","icon-uhcnG22T.js","MethodPill-CM-ZQdGH.js","DuplicateIcon-B_WnOiNf.js","createIcon-CJsb8utt.js","DynamicMarkdown-D-2HDKEp.js","SectionHeading-KP5xmMgQ.js","axios-vUo_bRtp.js","Markdown-D_k0dg6k.js","clsx-DK3K4Z1S.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-DE3EVdvd.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-fN9H9n9g.js"]}