Jump from the product guides into the developer-focused API documentation.
ShortPen ships with a full REST API for creating short links, syncing resources, and exporting analytics. The developer experience lives under the API Reference tab in this documentation site.
Open the API Reference
Explore authentication, usage limits, and interactive playgrounds for every available endpoint.
Was this page helpful?
⌘I
{"docsConfig":{"theme":"maple","$schema":"https://mintlify.com/docs.json","name":"ShortPen Documentation","colors":{"primary":"#4D977B","light":"#07C983","dark":"#15803D"},"logo":"https://mintcdn.com/shortpem/QGnkBg-DxOBadyN8/logo/logo-docs.svg?fit=max\u0026auto=format\u0026n=QGnkBg-DxOBadyN8\u0026q=85\u0026s=9fd10d79212d4e9209a33464315525f3","favicon":"https://mintcdn.com/shortpem/QGnkBg-DxOBadyN8/favicon.svg?fit=max\u0026auto=format\u0026n=QGnkBg-DxOBadyN8\u0026q=85\u0026s=ec28f7328660380bff108d989dcc7bf5","seo":{"metatags":{"canonical":"https://shortpen.com/docs"}},"fonts":{"family":"Inter"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"shortpem","hasAudioNarration":false,"actualSubdomain":"shortpem","customDomains":["shortpen.com"],"gitSource":{"type":"github","owner":"shortpen","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"feedback":{"edits":false,"thumbs":true,"issues":false},"entitlements":{},"buildId":"6afc52600955db4b8f1bee5d","clientVersion":"0.0.4205","searchFilterCounts":[{"language":"default","tag":"Guides","count":100},{"language":"default","tag":"Link Management","count":34},{"language":"default","tag":"Key Concepts","count":13},{"language":"default","tag":"API Reference","count":11},{"language":"default","tag":"Analytics","count":9},{"language":"default","tag":"Links","count":9},{"language":"default","tag":"Link Settings","count":9},{"language":"default","tag":"Account, Billing \u0026 Security","count":8},{"language":"default","tag":"QR Codes","count":8},{"language":"default","tag":"Event Tracking","count":8}]},"assistantConfig":{},"basePath":"/docs","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","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":"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":"starter-pricing","enabled":true,"variant":{"name":"control","enabled":true,"payload":{"type":"string","value":"control"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"shortpen-overview/api-reference","slug":"/shortpen-overview/api-reference","pageMetadata":{"title":"API Reference","description":"Jump from the product guides into the developer-focused API documentation.","href":"/shortpen-overview/api-reference"},"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: \"Jump from the product guides into the developer-focused API documentation.\"\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={p:`p`,strong:`strong`,..._provideComponents(),...props.components},{Card,CardGroup}=_components;if(!Card)_missingMdxReference(`Card`,true);if(!CardGroup)_missingMdxReference(`CardGroup`,true);return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[`ShortPen ships with a full REST API for creating short links, syncing resources, and exporting analytics. The developer experience lives under the `,_jsx(_components.strong,{children:`API Reference`}),` tab in this documentation site.`]}),`\n`,_jsx(CardGroup,{cols:1,children:_jsx(Card,{title:`Open the API Reference`,icon:`code`,href:`/api-reference/introduction`,cta:`View endpoints`,children:_jsx(_components.p,{children:`Explore authentication, usage limits, and interactive playgrounds for every available endpoint.`})})})]})}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":"API Reference","description":"Jump from the product guides into the developer-focused API documentation.","href":"/shortpen-overview/api-reference"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"subdomain":"shortpem","siteName":"ShortPen Documentation","title":"API Reference - ShortPen Documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-09-22T16:20:52.125Z","originalFileLocation":"shortpen-overview/api-reference.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=\"Jump from the product guides into the developer-focused API documentation.\">\u003cmeta data-mint-head name=\"application-name\" content=\"ShortPen Documentation\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/shortpem/jGDdDhnnG3IycTHG/_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=\"/docs/mintlify-assets/_mintlify/favicons/shortpem/jGDdDhnnG3IycTHG/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/shortpem/jGDdDhnnG3IycTHG/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/shortpem/jGDdDhnnG3IycTHG/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/shortpem/jGDdDhnnG3IycTHG/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/shortpem/jGDdDhnnG3IycTHG/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/shortpem/jGDdDhnnG3IycTHG/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/shortpem/jGDdDhnnG3IycTHG/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/shortpem/jGDdDhnnG3IycTHG/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"API Reference - ShortPen Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Jump from the product guides into the developer-focused API documentation.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"ShortPen Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://shortpen.com/docs/shortpen-overview/api-reference\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://shortpem.mintlify.site/docs/_mintlify/api/og/v2?division=Welcome+and+Introduction\u0026amp;title=API+Reference\u0026amp;description=Jump+from+the+product+guides+into+the+developer-focused+API+documentation.\u0026amp;theme=eaadcc9a25c25f16b3b6956e\u0026amp;signature=cc3eeb64de98c0de2e8c57922f65e9ce31c6c33185aef425f61f8d1064aaf136\">\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=\"API Reference - ShortPen Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Jump from the product guides into the developer-focused API documentation.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://shortpem.mintlify.site/docs/_mintlify/api/og/v2?division=Welcome+and+Introduction\u0026amp;title=API+Reference\u0026amp;description=Jump+from+the+product+guides+into+the+developer-focused+API+documentation.\u0026amp;theme=eaadcc9a25c25f16b3b6956e\u0026amp;signature=cc3eeb64de98c0de2e8c57922f65e9ce31c6c33185aef425f61f8d1064aaf136\">\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=\"/docs/mintlify-assets/_mintlify/favicons/shortpem/jGDdDhnnG3IycTHG/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"ShortPen Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#4D977B\">\u003clink data-mint-head rel=\"canonical\" href=\"https://shortpen.com/docs/shortpen-overview/api-reference\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/docs/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/docs/shortpen-overview/api-reference.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://shortpen.com/#organization\",\"name\":\"ShortPen Documentation\",\"url\":\"https://shortpen.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/shortpem/QGnkBg-DxOBadyN8/logo/logo-docs.svg?fit=max\u0026auto=format\u0026n=QGnkBg-DxOBadyN8\u0026q=85\u0026s=9fd10d79212d4e9209a33464315525f3\"}},{\"@type\":\"WebSite\",\"@id\":\"https://shortpen.com/docs#website\",\"name\":\"ShortPen Documentation\",\"url\":\"https://shortpen.com/docs\",\"publisher\":{\"@id\":\"https://shortpen.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://shortpen.com/docs/shortpen-overview/api-reference#webpage\",\"url\":\"https://shortpen.com/docs/shortpen-overview/api-reference\",\"name\":\"API Reference\",\"description\":\"Jump from the product guides into the developer-focused API documentation.\",\"dateModified\":\"2026-09-22T16:20:52.125Z\",\"isPartOf\":{\"@id\":\"https://shortpen.com/docs#website\"},\"breadcrumb\":{\"@id\":\"https://shortpen.com/docs/shortpen-overview/api-reference#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://shortpen.com/docs/shortpen-overview/api-reference#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Welcome and Introduction\",\"item\":\"https://shortpen.com/docs/shortpen-overview/what-is-shortpen\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"API Reference\",\"item\":\"https://shortpen.com/docs/shortpen-overview/api-reference\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://shortpen.com/docs/shortpen-overview/api-reference#article\",\"headline\":\"API Reference\",\"name\":\"API Reference\",\"description\":\"Jump from the product guides into the developer-focused API documentation.\",\"url\":\"https://shortpen.com/docs/shortpen-overview/api-reference\",\"mainEntityOfPage\":{\"@id\":\"https://shortpen.com/docs/shortpen-overview/api-reference#webpage\"},\"dateModified\":\"2026-09-22T16:20:52.125Z\",\"publisher\":{\"@id\":\"https://shortpen.com/#organization\"},\"isPartOf\":{\"@id\":\"https://shortpen.com/docs#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"ShortPen Documentation\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"ShortPen Documentation\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/docs/shortpen-overview/api-reference.md","siteName":"ShortPen Documentation","nav":{"global":null,"tabs":[{"tab":"Guides","groups":[{"group":"Welcome and Introduction","icon":"book","pages":[{"title":"What is ShortPen and how can it help you?","sidebarTitle":"What is ShortPen","href":"/shortpen-overview/what-is-shortpen"},{"title":"Who ShortPen is for: Use Cases by Audience","sidebarTitle":"Who ShortPen is for","href":"/shortpen-overview/who-shortpen-is-for"},{"title":"All ShortPen features","sidebarTitle":"All features","href":"/shortpen-overview/features"},{"title":"What’s new in ShortPen: Release notes and changelog","description":"All ShortPen product updates in one place. Browse highlights and jump to docs for setup and best practices.","sidebarTitle":"Changelog","href":"/shortpen-overview/changelog-and-release-notes"},{"title":"API Reference","href":"/shortpen-overview/api-reference"}]},{"group":"Getting Started","icon":"rocket","pages":[{"title":"Quickstart Guide: Overview of Onboarding Steps","description":"Get started with ShortPen in minutes. Create your account, connect a custom domain, install the pixel, track events and links, and view analytics, all in one step-by-step guide.","sidebarTitle":"Quickstart Guide","href":"/getting-started/quickstart-guide"},{"title":"How to create your ShortPen Account and Organization","sidebarTitle":"Account \u0026 Organization Setup","href":"/getting-started/create-account-and-organization"},{"title":"How to set up your first workspace in ShortPen","sidebarTitle":"Workspace setup","href":"/getting-started/setup-first-workspace"},{"title":"How to connect a custom domain to ShortPen","sidebarTitle":"Domain connection","href":"/getting-started/connect-custom-domain"},{"title":"How to install the ShortPen Pixel","sidebarTitle":"Pixel installation","href":"/getting-started/install-shortpen-pixel"},{"title":"How to create your first event in ShortPen","sidebarTitle":"Event creation","href":"/getting-started/create-first-event"},{"title":"How to create your first link in ShortPen","sidebarTitle":"Link creation","href":"/getting-started/create-first-link"},{"title":"How to view analytics for your first ShortPen link","sidebarTitle":"Analytics overview","href":"/getting-started/view-first-analytics"}]},{"group":"Key Concepts","icon":"lightbulb","pages":[{"title":"How Organizations work in Shortpen","sidebarTitle":"Organization","href":"/key-concepts/organization-overview"},{"title":"Understanding roles and permissions in ShortPen","sidebarTitle":"Roles \u0026 Permissions","href":"/key-concepts/roles-and-permissions"},{"title":"How Workspaces work in ShortPen","sidebarTitle":"Workspaces","href":"/key-concepts/workspaces-overview"},{"title":"What is a link in ShortPen?","sidebarTitle":"Links","href":"/key-concepts/links-overview"},{"title":"What is a QR Code in ShortPen and how to use it?","sidebarTitle":"QR Codes","href":"/key-concepts/qr-codes-overview"},{"title":"How custom domains work in ShortPen","sidebarTitle":"Custom Domains","href":"/key-concepts/domains-overview"},{"title":"How folders work in ShortPen","sidebarTitle":"Folders","href":"/key-concepts/folders-overview"},{"title":"How tags work in ShortPen","sidebarTitle":"Tags","href":"/key-concepts/tags-overview"},{"title":"Overview of ShortPen Analytics","sidebarTitle":"Analytics","href":"/key-concepts/analytics-overview"},{"title":"Understanding events and conversions in ShortPen","sidebarTitle":"Events \u0026 Conversions","href":"/key-concepts/events-and-conversions-overview"},{"title":"What is the ShortPen Pixel","sidebarTitle":"Pixel","href":"/key-concepts/pixel-overview"},{"title":"Overview of Integrations in ShortPen","sidebarTitle":"Integrations","href":"/key-concepts/integrations-overview"},{"title":"What APIs are (and what they can do)","sidebarTitle":"APIs","href":"/key-concepts/api-overview"}]},{"group":"Link Management","icon":"paperclip","expanded":true,"pages":[{"group":"Links","pages":[{"title":"Components of a ShortPen Link","sidebarTitle":"Link Components","href":"/link-management/links/link-components"},{"title":"How to create a link in ShortPen","sidebarTitle":"Creation","href":"/link-management/links/link-creation"},{"title":"How to edit an existing link in ShortPen","sidebarTitle":"Editing","href":"/link-management/links/link-editing"},{"title":"How to duplicate a link in ShortPen","sidebarTitle":"Duplication","href":"/link-management/links/link-duplication"},{"title":"Best Practices and Troubleshooting for ShortPen links","sidebarTitle":"Best Practices \u0026 Troubleshooting","href":"/link-management/links/link-best-practices-and-troubleshooting"}]},{"group":"QR Codes","pages":[{"title":"How to create and customize QR Codes in ShortPen","sidebarTitle":"Creation","href":"/link-management/qr-code/qr-creation"},{"title":"QR code design options in ShortPen","sidebarTitle":"Design options","href":"/link-management/qr-code/qr-design"},{"title":"How to save and use QR design templates in ShortPen","sidebarTitle":"Design templates","href":"/link-management/qr-code/qr-design-templates"},{"title":"How to download and use QR Codes in ShortPen","sidebarTitle":"Download \u0026 Use","href":"/link-management/qr-code/qr-downloading"},{"title":"What happens to a QR Code after changing a link?","sidebarTitle":"Behavior After Changes","href":"/link-management/qr-code/qr-after-link-change"},{"title":"Best practices for QR Codes in offline campaigns","sidebarTitle":"Best Practices","href":"/link-management/qr-code/qr-best-practices"}]},{"group":"Management","pages":[{"title":"How to create and manage folders in ShortPen","sidebarTitle":"Folders","href":"/link-management/links-organization/folders"},{"title":"How to create and manage tags in ShortPen","sidebarTitle":"Tags","href":"/link-management/links-organization/tags"},{"title":"How to manage templates in ShortPen","sidebarTitle":"Templates","href":"/link-management/links-organization/templates"}]},{"group":"Link Settings","pages":[{"title":"UTMs in ShortPen: What they are and why they matter","sidebarTitle":"UTMs Overview","href":"/link-management/links-settings/utm-overview"},{"title":"How to add UTM Parameters in ShortPen","sidebarTitle":"Add UTM Parameters","href":"/link-management/links-settings/adding-utm-to-links"},{"title":"How to save and use UTM templates in ShortPen","sidebarTitle":"UTM templates","href":"/link-management/links-settings/utm-templates"},{"title":"How to enable Event Tracking on a ShortPen link","sidebarTitle":"Enable Event Tracking","href":"/link-management/links-settings/enabling-event-tracking"},{"title":"How to customize Social Share Previews in ShortPen","sidebarTitle":"Social Share Previews","href":"/link-management/links-settings/social-share-previews"},{"title":"How to password-protect a link in ShortPen","sidebarTitle":"Password Protection","href":"/link-management/links-settings/link-password-protection"},{"title":"Redirect types in ShortPen: What they are and when to use them","sidebarTitle":"Redirect Types","href":"/link-management/links-settings/redirect-types"},{"title":"How to enable Link Cloaking in ShortPen","sidebarTitle":"Link Cloaking","href":"/link-management/links-settings/link-cloaking"},{"title":"How to hide referrer information in ShortPen links","sidebarTitle":"Hide Referrer","href":"/link-management/links-settings/hide-referrer"}]},{"group":"Manage Links at Scale","pages":[{"title":"How to bulk update or delete links in ShortPen","sidebarTitle":"Bulk Actions","href":"/link-management/manage-links-at-scale/bulk-actions"},{"title":"How to import links from Bitly into ShortPen","sidebarTitle":"Import Links from Bitly","href":"/link-management/manage-links-at-scale/bitly-import"},{"title":"How to import links from Rebrandly into ShortPen","sidebarTitle":"Import Links from Rebrandly","href":"/link-management/manage-links-at-scale/rebrandly-import"},{"title":"How to import links from Dub.co into ShortPen","sidebarTitle":"Import Links from Dub.co","href":"/link-management/manage-links-at-scale/dub-import"},{"title":"How to import links from Short.io into ShortPen","sidebarTitle":"Import Links from Short.io","href":"/link-management/manage-links-at-scale/short-io-import"},{"title":"How to import links from a CSV into ShortPen","sidebarTitle":"Import Links from a CSV","href":"/link-management/manage-links-at-scale/csv-import"},{"title":"How to export links in ShortPen","sidebarTitle":"Export Links","href":"/link-management/manage-links-at-scale/export-links"}]},{"group":"Troubleshooting","pages":[{"title":"How to fix a ShortPen link that won't open","sidebarTitle":"Link not opening","href":"/link-management/troubleshooting/link-not-opening"},{"title":"How to resolve a slug conflict in ShortPen","sidebarTitle":"Slug Conflict","href":"/link-management/troubleshooting/slug-conflict"},{"title":"How to fix a ShortPen QR Code that doesn’t redirect","sidebarTitle":"QR not redirecting","href":"/link-management/troubleshooting/qr-no-redirect"},{"title":"Why events aren’t tracking on a ShortPen Link","sidebarTitle":"Events not tracking","href":"/link-management/troubleshooting/events-not-tracking"}]}]},{"group":"Event Tracking","icon":"stopwatch","expanded":true,"pages":[{"group":"ShortPen Pixel","pages":[{"title":"How to create the ShortPen Pixel","sidebarTitle":"Creation","href":"/event-tracking/shortpen-pixel/pixel-creation"},{"title":"How to manually install the ShortPen Pixel","sidebarTitle":"Manual Installation","href":"/event-tracking/shortpen-pixel/pixel-manual-installation"},{"title":"How to install the ShortPen Pixel with the Shopify app","sidebarTitle":"Shopify Installation","href":"/event-tracking/shortpen-pixel/pixel-shopify-installation"},{"title":"How to confirm your ShortPen Pixel is working","sidebarTitle":"Verification","href":"/event-tracking/shortpen-pixel/pixel-verification"}]},{"group":"Define and Manage Events","pages":[{"title":"How to create URL-Triggered events in ShortPen","sidebarTitle":"URL-Triggered Events","href":"/event-tracking/manage-events/url-triggered-events"},{"title":"How to create Code-Triggered events in ShortPen","sidebarTitle":"Code-Triggered Events","href":"/event-tracking/manage-events/code-triggered-events"},{"title":"How to edit or disable a ShortPen event","sidebarTitle":"Edit/Disable Events","href":"/event-tracking/manage-events/events-editing"},{"title":"How to test ShortPen events with the Event Testing Panel","sidebarTitle":"Event Testing","href":"/event-tracking/manage-events/events-testing"}]}]},{"group":"Analytics","icon":"chart-line","expanded":true,"pages":[{"group":"Link-Level Analytics","pages":[{"title":"What metrics are available for individual links in ShortPen?","sidebarTitle":"Link Analytics","href":"/analytics/link-level-analytics/link-level-metrics"},{"title":"How to use date range and segmentation filters in ShortPen","sidebarTitle":"Filters","href":"/analytics/link-level-analytics/analytics-filters-settings"},{"title":"How to view conversions for a single ShortPen Link ","sidebarTitle":"Link Conversion Analytics","href":"/analytics/link-level-analytics/link-conversion-analytics"},{"title":"How to view UTM campaign breakdowns in ShortPen Analytics","sidebarTitle":"Campaign (UTM) Analytics","href":"/analytics/link-level-analytics/utm-campaign-analytics"}]},{"group":"Workspace-Level Analytics","pages":[{"title":"How to view aggregate metrics for your ShortPen workspace","sidebarTitle":"Workspace Analytics","href":"/analytics/workspace-level-analytics/workspace-level-metrics"},{"title":"How to segment ShortPen data by folders and tags ","sidebarTitle":"Segmentation","href":"/analytics/workspace-level-analytics/workspace-segmentation"},{"title":"How to view all conversion analytics within the workspace","sidebarTitle":"Workspace Conversion Analytics","href":"/analytics/workspace-level-analytics/workspace-conversion-analytics"}]},{"title":"How to view real-time activity in ShortPen analytics","sidebarTitle":"Real-time Analytics","href":"/analytics/real-time-analyitcs"},{"group":"Reporting","pages":[{"title":"How to share ShortPen Analytics (public URL) ","sidebarTitle":"Sharing","href":"/analytics/reporting/analytics-sharing"}]}]},{"group":"Custom Domains","icon":"globe","expanded":true,"pages":[{"title":"Why use a custom domain with ShortPen? ","sidebarTitle":"Why should I use a custom domain?","href":"/domains/why-use-custom-domain"},{"title":"How to connect a custom domain to ShortPen ","sidebarTitle":"Connection","href":"/domains/domain-connection"},{"title":"How to verify your custom domain in ShortPen","sidebarTitle":"Verification","href":"/domains/domain-verification"},{"title":"How to set a root domain Redirect","sidebarTitle":"Root Domain Redirect","href":"/domains/root-domain-redirect"},{"title":"How to claim your free .link domain in ShortPen","sidebarTitle":"Free .link domain","href":"/domains/free-link-domain"},{"title":"How to set a custom 404 redirect in ShortPen","sidebarTitle":"404 Redirect","href":"/domains/custom-404-redirect"}]},{"group":"Organization Management","icon":"users-gear","expanded":true,"pages":[{"title":"How to manage your ShortPen organization settings and branding","sidebarTitle":"Organization Settings","href":"/organization-management/organization-settings"},{"title":"How to create, rename and delete workspaces in ShortPen","sidebarTitle":"Workspace Settings","href":"/organization-management/workspace-settings"},{"title":"How to assign and change user roles in ShortPen","sidebarTitle":"User Roles Settings","href":"/organization-management/user-roles-settings"},{"title":"How to invite and manage users in ShortPen","sidebarTitle":"User Management","href":"/organization-management/user-management"}]},{"group":"Integrations","icon":"plug","expanded":true,"pages":[{"title":"How does integration with Shopify work? ","sidebarTitle":"Shopify","href":"/integrations/native-integrations/shopify-integration"},{"title":"How does integration with Zapier work?","sidebarTitle":"Zapier","href":"/integrations/native-integrations/zapier-integration"},{"title":"How does integration with Make work?","sidebarTitle":"Make","href":"/integrations/native-integrations/make-integration"},{"title":"How does integration with viaSocket work?","sidebarTitle":"viaSocket","href":"/integrations/native-integrations/viasocket"}]},{"group":"Account, Billing \u0026 Security","icon":"shield-halved","expanded":true,"pages":[{"group":"Account Settings","pages":[{"title":"How to update your ShortPen profile, email and password","sidebarTitle":"Profile Settings","href":"/account-billing-security/account-settings/profile-settings"}]},{"group":"Plans and Limits","pages":[{"title":"Understanding ShortPen plans and limits","sidebarTitle":"Plans \u0026 Limits","href":"/account-billing-security/plans-and-limits/plans-and-limits"},{"title":"How to view your ShortPen plan and usage ","sidebarTitle":"Usage \u0026 Quota","href":"/account-billing-security/plans-and-limits/plan-usage"},{"title":"How to upgrade or downgrade your ShortPen plan","sidebarTitle":"Change Plan","href":"/account-billing-security/plans-and-limits/change-plan"},{"title":"How to cancel your ShortPen subscription and request a refund","sidebarTitle":"Cancel Your Plan","href":"/account-billing-security/plans-and-limits/plan-cancellation"},{"title":"What happens when you exceed your ShortPen plan limits","sidebarTitle":"Plans Limits \u0026 Overage","href":"/account-billing-security/plans-and-limits/plan-limits-exceeded"}]},{"group":"Security and Compliance","pages":[{"title":"How ShortPen protects your data (GDPR and Data Privacy) ","sidebarTitle":"GDPR \u0026 Data Privacy","href":"/account-billing-security/security-compliance/gdpr-data-privacy"},{"title":"Where ShortPen stores your data and how long it’s retained","sidebarTitle":"Data Storage \u0026 Retention","href":"/account-billing-security/security-compliance/data-storage-retention"}]}]},{"group":"Resources and Support","icon":"book","expanded":true,"pages":[{"title":"How to contact ShortPen support","sidebarTitle":"Contact Support","href":"/support"}]}]},{"tab":"API Reference","pages":[{"title":"API Reference","href":"/api-reference/introduction"}]}]},"basePath":"","title":"API Reference - ShortPen Documentation","deploymentId":"dpl_J2QdBVuN65x4CCtpqPb371YPt4xi","buildId":"dpl_J2QdBVuN65x4CCtpqPb371YPt4xi","dynamics":[],"chunks":[]}