# ShortPen Documentation

## Docs

- [How to update your ShortPen profile, email and password](https://shortpen.com/docs/account-billing-security/account-settings/profile-settings.md): Update your ShortPen profile, email, and password. Manage account details, timezone, and security settings easily.
- [How to upgrade or downgrade your ShortPen plan](https://shortpen.com/docs/account-billing-security/plans-and-limits/change-plan.md): Upgrade or downgrade your ShortPen plan anytime. Change limits, features, and billing with instant or scheduled updates.
- [How to cancel your ShortPen subscription and request a refund](https://shortpen.com/docs/account-billing-security/plans-and-limits/plan-cancellation.md): Cancel your ShortPen subscription anytime. Downgrade to the Free plan or contact support for exceptional refund cases.
- [What happens when you exceed your ShortPen plan limits](https://shortpen.com/docs/account-billing-security/plans-and-limits/plan-limits-exceeded.md): Learn what happens when you exceed your ShortPen plan limits. Links keep working, but extra events stop tracking.
- [How to view your ShortPen plan and usage ](https://shortpen.com/docs/account-billing-security/plans-and-limits/plan-usage.md): View your ShortPen plan and usage. Check limits for users, workspaces, and events, and manage upgrades easily.
- [Understanding ShortPen plans and limits](https://shortpen.com/docs/account-billing-security/plans-and-limits/plans-and-limits.md): Compare ShortPen plans and limits. See workspaces, users, events, and domain caps to choose the right plan for you.
- [Where ShortPen stores your data and how long it’s retained](https://shortpen.com/docs/account-billing-security/security-compliance/data-storage-retention.md): Learn where ShortPen stores your data, how long it’s retained, and the safeguards ensuring GDPR-compliant deletion.
- [How ShortPen protects your data (GDPR and Data Privacy) ](https://shortpen.com/docs/account-billing-security/security-compliance/gdpr-data-privacy.md): Learn how ShortPen ensures GDPR compliance, EU data hosting, and privacy-first analytics for your tracked links.
- [How to use date range and segmentation filters in ShortPen](https://shortpen.com/docs/analytics/link-level-analytics/analytics-filters-settings.md): Use date range and segmentation filters in ShortPen to analyze clicks, conversions, and traffic sources with precision.
- [How to view conversions for a single ShortPen Link ](https://shortpen.com/docs/analytics/link-level-analytics/link-conversion-analytics.md): View conversions for any ShortPen link. Track events, sources, and real-time performance to measure campaign results.
- [What metrics are available for individual links in ShortPen?](https://shortpen.com/docs/analytics/link-level-analytics/link-level-metrics.md): View detailed link analytics in ShortPen, including clicks, scans, conversions, and audience breakdowns by source and device.
- [How to share ShortPen Analytics (public URL) ](https://shortpen.com/docs/analytics/reporting/analytics-sharing.md): Share ShortPen analytics via a public URL. Give clients read-only access to link or workspace performance data.
- [How to view all conversion analytics within the workspace](https://shortpen.com/docs/analytics/workspace-level-analytics/workspace-conversion-analytics.md): View all conversion analytics in your ShortPen workspace. Track events, sources, and performance across every link.
- [How to view aggregate metrics for your ShortPen workspace](https://shortpen.com/docs/analytics/workspace-level-analytics/workspace-level-metrics.md): View total clicks, scans, and conversions across your ShortPen workspace to analyze performance and top sources.
- [How to segment ShortPen data by folders and tags ](https://shortpen.com/docs/analytics/workspace-level-analytics/workspace-segmentation.md): Segment ShortPen analytics by folders and tags to compare campaigns, clients, or channels with precise filters.
- [Retrieve Click Analytics](https://shortpen.com/docs/api-reference/endpoint/analytics.md): Returns raw click analytics for the specified date range. Results are scoped to the organization and optionally filtered by workspace or link.
- [Edit Link](https://shortpen.com/docs/api-reference/endpoint/edit-link.md): Updates an existing link identified by `url_id`. Only `url_id` is required — include at least one additional field to specify what to change. Omitted fields retain their current values. The API enforces the same plan limits and feature checks as creation.
- [Create Link](https://shortpen.com/docs/api-reference/endpoint/generate.md): Creates a new link in the current workspace. The API enforces plan limits and feature availability for the authenticated organization.
- [Fetch Resources](https://shortpen.com/docs/api-reference/endpoint/get-resources.md): Fetch supporting resources scoped to the authenticated organization. The response shape depends on the `resource` parameter.
- [List Links](https://shortpen.com/docs/api-reference/endpoint/list-links.md): Returns a paginated list of links for the workspace associated with the API token. Supports optional workspace override and pagination controls.
- [Get Authenticated User](https://shortpen.com/docs/api-reference/endpoint/me.md): Returns profile information, enabled features, and usage limits for the organization associated with the supplied API token.
- [Ping](https://shortpen.com/docs/api-reference/endpoint/ping.md): Check connectivity to the ShortPen API. Limited to 30 requests per minute per IP address.
- [Introduction](https://shortpen.com/docs/api-reference/introduction.md): Programmatically manage links, resources, and analytics with the ShortPen API.
- [How to connect a custom domain to ShortPen ](https://shortpen.com/docs/domains/domain-connection.md): Connect your custom domain to ShortPen. Add DNS records, verify ownership, and create branded links easily.
- [How to verify your custom domain in ShortPen](https://shortpen.com/docs/domains/domain-verification.md): Verify your custom domain in ShortPen by checking DNS records and activating your domain for branded links.
- [How to set a root domain Redirect](https://shortpen.com/docs/domains/root-domain-redirect.md): Set a root domain redirect in ShortPen to send visitors from your base domain to any landing or homepage URL.
- [Why use a custom domain with ShortPen? ](https://shortpen.com/docs/domains/why-use-custom-domain.md): Use a custom domain in ShortPen to boost trust, improve CTR, and keep your brand consistent across every link.
- [How to create Code-Triggered events in ShortPen](https://shortpen.com/docs/event-tracking/manage-events/code-triggered-events.md): Create code-triggered events in ShortPen to track actions like signups or purchases directly from your site or app.
- [How to edit or disable a ShortPen event](https://shortpen.com/docs/event-tracking/manage-events/events-editing.md): Edit or pause ShortPen events anytime. Update triggers, rename events, or disable tracking without losing data.
- [How to test ShortPen events with the Event Testing Panel](https://shortpen.com/docs/event-tracking/manage-events/events-testing.md): Test ShortPen events in real time with the Event Testing Panel to verify pixel setup and event tracking accuracy.
- [How to create URL-Triggered events in ShortPen](https://shortpen.com/docs/event-tracking/manage-events/url-triggered-events.md): Create URL-triggered events in ShortPen to track page visits, signups, and conversions automatically with your pixel.
- [How to create the ShortPen Pixel](https://shortpen.com/docs/event-tracking/shortpen-pixel/pixel-creation.md): Create a ShortPen Pixel to track conversions, connect domains, and link workspaces for accurate event analytics.
- [How to manually install the ShortPen Pixel](https://shortpen.com/docs/event-tracking/shortpen-pixel/pixel-manual-installation.md): Install the ShortPen pixel manually and start tracking user events and conversions in real time.
- [How to install the ShortPen Pixel with the Shopify app](https://shortpen.com/docs/event-tracking/shortpen-pixel/pixel-shopify-installation.md): Install the ShortPen pixel on Shopify automatically. Connect your store, track purchases, and monitor events with no code.
- [How to confirm your ShortPen Pixel is working](https://shortpen.com/docs/event-tracking/shortpen-pixel/pixel-verification.md): Verify your ShortPen pixel installation. Check if it’s active, detect issues, and confirm real-time event tracking.
- [How to connect a custom domain to ShortPen](https://shortpen.com/docs/getting-started/connect-custom-domain.md): Replace default short links with your own brand domain. Follow this guide to add DNS records, verify your domain, and make every ShortPen link look professional and trustworthy.
- [How to create your ShortPen Account and Organization](https://shortpen.com/docs/getting-started/create-account-and-organization.md): Create your ShortPen account and organization in minutes. Learn how to set up your workspace, invite teammates, and start managing branded links, QR codes, and analytics right away.
- [How to create your first event in ShortPen](https://shortpen.com/docs/getting-started/create-first-event.md): Learn how to create your first event in ShortPen. Set up triggers, verify your Pixel, and start tracking real conversions from your links and campaigns in minutes.
- [How to create your first link in ShortPen](https://shortpen.com/docs/getting-started/create-first-link.md): Learn how to create your first link in ShortPen: from setting a destination and choosing a custom domain to adding UTMs, QR codes, and event tracking for accurate conversion analytics.
- [How to install the ShortPen Pixel](https://shortpen.com/docs/getting-started/install-shortpen-pixel.md): Learn how to install the ShortPen Pixel. Step-by-step guide to add your tracking script, verify Pixel activity, and track conversions and custom events in ShortPen.
- [Quickstart Guide: Overview of Onboarding Steps](https://shortpen.com/docs/getting-started/quickstart-guide.md): 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.
- [How to set up your first workspace in ShortPen](https://shortpen.com/docs/getting-started/setup-first-workspace.md): Set up your first workspace in ShortPen. Learn how to create or rename workspaces, invite teammates, assign roles, and organize projects with folders, tags, and analytics.
- [How to view analytics for your first ShortPen link](https://shortpen.com/docs/getting-started/view-first-analytics.md): Learn how to view detailed analytics for your ShortPen links. Track clicks, QR scans, sources, devices, and conversions to understand your campaign performance and audience behavior.
- [How does integration with Make work?](https://shortpen.com/docs/integrations/native-integrations/make-integration.md): Connect ShortPen with Make to automate link creation, API calls, and workflows across your favorite apps.
- [How does integration with Shopify work? ](https://shortpen.com/docs/integrations/native-integrations/shopify-integration.md): Connect Shopify with ShortPen to track purchases, checkouts, and add-to-cart events automatically.
- [How does integration with viaSocket work?](https://shortpen.com/docs/integrations/native-integrations/viasocket.md): Connect viaSocket to ShortPen in minutes. Learn how to authorize with an API key, set up a workflow, map URL fields, and test your automation.
- [How does integration with Zapier work?](https://shortpen.com/docs/integrations/native-integrations/zapier-integration.md): Connect ShortPen with Zapier to automate link creation, updates, and QR generation from any app or workflow.
- [Overview of ShortPen Analytics](https://shortpen.com/docs/key-concepts/analytics-overview.md): Explore ShortPen analytics: track link clicks, QR scans, and conversions, compare campaigns across workspaces, and turn your traffic data into actionable insights.
- [What APIs are (and what they can do)](https://shortpen.com/docs/key-concepts/api-overview.md): Learn how to use the ShortPen API to automate link creation, track analytics, and integrate ShortPen with other tools for faster, scalable workflows.
- [How custom domains work in ShortPen](https://shortpen.com/docs/key-concepts/domains-overview.md): Learn how domains work in ShortPen: connect custom domains, improve link trust and branding, and manage all your organization’s link domains in one place.
- [Understanding events and conversions in ShortPen](https://shortpen.com/docs/key-concepts/events-and-conversions-overview.md): Learn how ShortPen tracks clicks, events, and conversions to measure campaign performance accurately.
- [How folders work in ShortPen](https://shortpen.com/docs/key-concepts/folders-overview.md): Learn how folders in ShortPen help you organize links, campaigns, and clients efficiently. Keep your workspace structured and reporting consistent.
- [Overview of Integrations in ShortPen](https://shortpen.com/docs/key-concepts/integrations-overview.md): Integrations help ShortPen talk to the tools you already use, so links, events, and analytics flow automatically, without manual copy-paste.
- [What is a link in ShortPen?](https://shortpen.com/docs/key-concepts/links-overview.md): Learn what a ShortPen link is and how it works. Create branded links, organize them by folders or tags, add UTMs and QR codes, and track clicks and conversions in one place.
- [How Organizations work in Shortpen](https://shortpen.com/docs/key-concepts/organization-overview.md): Learn how organizations work in ShortPen. Manage domains, pixels, users, and workspaces under one structure to keep your data, branding, and permissions consistent across teams.
- [What is the ShortPen Pixel](https://shortpen.com/docs/key-concepts/pixel-overview.md): Discover how the ShortPen Pixel works: track post-click events, measure real conversions, and connect your links and QR scans to complete analytics for smarter marketing decisions.
- [What is a QR Code in ShortPen and how to use it?](https://shortpen.com/docs/key-concepts/qr-codes-overview.md): Learn how ShortPen QR Codes work. Create, customize, and track dynamic QR Codes that stay functional even after editing your links, with full analytics and brand options.
- [Understanding roles and permissions in ShortPen](https://shortpen.com/docs/key-concepts/roles-and-permissions.md): Learn how roles and permissions work in ShortPen. Understand what Owners, Admins, and Users can do across organizations and workspaces to manage access, security, and collaboration.
- [How tags work in ShortPen](https://shortpen.com/docs/key-concepts/tags-overview.md): Discover how tags in ShortPen help you organize, filter, and analyze links by campaigns, channels, and audiences for smarter reporting and teamwork.
- [How Workspaces work in ShortPen](https://shortpen.com/docs/key-concepts/workspaces-overview.md): Understand how workspaces in ShortPen organize your links, analytics, and team collaboration. Learn what they are, why they matter, and how to manage multiple ones by plan.
- [How to create and manage folders in ShortPen](https://shortpen.com/docs/link-management/links-organization/folders.md): Organize your ShortPen links by folders. Create, rename, or delete folders to manage campaigns and analyze performance easily.
- [How to create and manage tags in ShortPen](https://shortpen.com/docs/link-management/links-organization/tags.md): Create, edit, and organize tags in ShortPen to group links, filter analytics, and manage campaigns more efficiently.
- [How to add UTM Parameters in ShortPen](https://shortpen.com/docs/link-management/links-settings/adding-utm-to-links.md): Add UTM parameters in ShortPen to track campaigns, sources, and partners with precise analytics.
- [How to enable Event Tracking on a ShortPen link](https://shortpen.com/docs/link-management/links-settings/enabling-event-tracking.md): Enable event tracking on ShortPen links to measure conversions, connect pixels, and analyze campaign performance.
- [How to hide referrer information in ShortPen links](https://shortpen.com/docs/link-management/links-settings/hide-referrer.md): Hide referrer data in ShortPen links to protect user privacy and keep destination sites from seeing the source URL.
- [How to enable Link Cloaking in ShortPen](https://shortpen.com/docs/link-management/links-settings/link-cloaking.md): Enable link cloaking in ShortPen to hide destination URLs, protect affiliate links, and keep your branded domain visible.
- [How to password-protect a link in ShortPen](https://shortpen.com/docs/link-management/links-settings/link-password-protection.md): Protect ShortPen links with passwords. Add a lock screen to control access and keep shared URLs secure.
- [Redirect types in ShortPen: What they are and when to use them](https://shortpen.com/docs/link-management/links-settings/redirect-types.md): Learn when to use 301, 302, 307, or 308 redirects in ShortPen to ensure accurate tracking and reliable link performance.
- [How to customize Social Share Previews in ShortPen](https://shortpen.com/docs/link-management/links-settings/social-share-previews.md): Customize social share previews in ShortPen. Set custom images, titles, and descriptions to boost clicks and brand consistency.
- [UTMs in ShortPen: What they are and why they matter](https://shortpen.com/docs/link-management/links-settings/utm-overview.md): Understand UTMs in ShortPen. Track sources, campaigns, and conversions accurately to improve marketing attribution.
- [Best Practices and Troubleshooting for ShortPen links](https://shortpen.com/docs/link-management/links/link-best-practices-and-troubleshooting.md): Learn best practices for ShortPen links and fix common issues with slugs, QR codes, and event tracking in minutes.
- [Components of a ShortPen Link](https://shortpen.com/docs/link-management/links/link-components.md): Learn the key components of a ShortPen link, from destination URL and domain to slug, title, folders, tags, and how each part shapes tracking and organization.
- [How to create a link in ShortPen](https://shortpen.com/docs/link-management/links/link-creation.md): Learn how to create and customize links in ShortPen: from basic setup to advanced settings like tracking, QR codes, and privacy options.
- [How to duplicate a link in ShortPen](https://shortpen.com/docs/link-management/links/link-duplication.md): Duplicate ShortPen links in seconds to run A/B tests, track channels separately, or create regional URLs with fresh analytics.
- [How to edit an existing link in ShortPen](https://shortpen.com/docs/link-management/links/link-editing.md): Edit ShortPen links easily. Update destinations, slugs, or metadata without losing analytics or campaign data.
- [How to import links from Bitly into ShortPen](https://shortpen.com/docs/link-management/manage-links-at-scale/bitly-import.md): Import your Bitly links into ShortPen easily. Transfer slugs, titles, and destinations to manage and track them all in one place.
- [How to bulk update or delete links in ShortPen](https://shortpen.com/docs/link-management/manage-links-at-scale/bulk-actions.md): Bulk update or delete links in ShortPen. Move, tag, or remove multiple links at once to manage campaigns efficiently.
- [How to import links from a CSV into ShortPen](https://shortpen.com/docs/link-management/manage-links-at-scale/csv-import.md): Import links into ShortPen via CSV. Upload destinations, slugs, and titles in bulk to create and organize links fast.
- [How to import links from Dub.co into ShortPen](https://shortpen.com/docs/link-management/manage-links-at-scale/dub-import.md): Import your Dub.co links into ShortPen in minutes. Transfer slugs, titles, and destinations while keeping everything organized.
- [How to export links in ShortPen](https://shortpen.com/docs/link-management/manage-links-at-scale/export-links.md): Export all your ShortPen links to CSV. Download link data, UTMs, and tags to analyze or share with your team.
- [How to import links from Rebrandly into ShortPen](https://shortpen.com/docs/link-management/manage-links-at-scale/rebrandly-import.md): Import your Rebrandly links into ShortPen easily. Keep slugs, destinations, and domains while managing all links in one place.
- [How to import links from Short.io into ShortPen](https://shortpen.com/docs/link-management/manage-links-at-scale/short-io-import.md): Import your Short.io links into ShortPen easily. Keep slugs, destinations, and domains organized under one dashboard.
- [What happens to a QR Code after changing a link?](https://shortpen.com/docs/link-management/qr-code/qr-after-link-change.md): Learn when to reprint your QR after editing a ShortPen link and how changes to slugs or domains affect scans and analytics.
- [Best practices for QR Codes in offline campaigns](https://shortpen.com/docs/link-management/qr-code/qr-best-practices.md): Design high-performing QR Codes with ShortPen. Follow print, size, color, and placement best practices to maximize scans.
- [How to create and customize QR Codes in ShortPen](https://shortpen.com/docs/link-management/qr-code/qr-creation.md): Create and customize QR Codes in ShortPen. Add colors, logos, and track scans or conversions with built-in analytics.
- [How to download and use QR Codes in ShortPen](https://shortpen.com/docs/link-management/qr-code/qr-downloading.md): Download QR Codes from ShortPen. Embed them in print or digital assets and track scans with analytics.
- [Why events aren’t tracking on a ShortPen Link](https://shortpen.com/docs/link-management/troubleshooting/events-not-tracking.md): Fix event tracking issues in ShortPen. Check pixel setup, link settings, and triggers to ensure accurate conversion data.
- [How to fix a ShortPen QR Code that doesn’t redirect](https://shortpen.com/docs/link-management/troubleshooting/qr-no-redirect.md): Fix QR Codes in ShortPen that don’t redirect. Check slugs, domains, and print quality to restore scans quickly.
- [How to resolve a slug conflict in ShortPen](https://shortpen.com/docs/link-management/troubleshooting/slug-conflict.md): Fix slug conflicts in ShortPen by renaming the slug, switching domains, or editing existing links to avoid duplicate URLs.
- [How to manage your ShortPen organization settings and branding](https://shortpen.com/docs/organization-management/organization-settings.md): Manage your ShortPen organization settings. Update name, logo, and branding to keep your workspace consistent.
- [How to invite and manage users in ShortPen](https://shortpen.com/docs/organization-management/user-management.md): Invite and manage users in ShortPen. Add teammates, assign roles, and control workspace access with ease.
- [How to assign and change user roles in ShortPen](https://shortpen.com/docs/organization-management/user-roles-settings.md): Assign and change user roles in ShortPen. Manage Owners, Admins, and Users to control access across your organization.
- [How to create, rename and delete workspaces in ShortPen](https://shortpen.com/docs/organization-management/workspace-settings.md): Create, rename, or delete workspaces in ShortPen to organize projects, manage access, and keep data separated.
- [How to view real-time activity in ShortPen analytics](https://shortpen.com/docs/real-time-analyitcs.md): Monitor clicks, QR scans, and tracked events as they happen with Real-time Activity in ShortPen Analytics.
- [API Reference](https://shortpen.com/docs/shortpen-overview/api-reference.md): Jump from the product guides into the developer-focused API documentation.
- [What’s new in ShortPen: Release notes and changelog](https://shortpen.com/docs/shortpen-overview/changelog-and-release-notes.md): All ShortPen product updates in one place. Browse highlights and jump to docs for setup and best practices.
- [What is ShortPen and how can it help you?](https://shortpen.com/docs/shortpen-overview/what-is-shortpen.md): ShortPen is a powerful link management and analytics platform to create branded links and QR codes, track clicks and conversions, and measure performance across all your campaigns.
- [Who ShortPen is for: Use Cases by Audience](https://shortpen.com/docs/shortpen-overview/who-shortpen-is-for.md): ShortPen helps marketing teams, agencies, e-commerce, SaaS, and creators manage branded links and QR codes, track clicks and post-click events, and analyze performance across clients and channels.
- [How to contact ShortPen support](https://shortpen.com/docs/support.md): Contact ShortPen support via in-app form or email. Get quick help with your account, links, or billing issues.

## OpenAPI Specs

- [openapi](https://shortpen.com/docs/api-reference/openapi.json)