CINXE.COM

<!DOCTYPE html><html let mediaQuery = window.matchMedia(' function updateTheme(savedTheme) { let theme = 'system' try { if (!savedTheme) { savedTheme = window.localStorage.t } if (savedTheme === 'dark') theme = 'dark' document.documentElement.classList } else if (savedTheme === 'light') theme = 'light' document.documentElement.classList } else if (mediaQuery.matches) { document.documentElement.classList } else { document.documentElement.classList } } catch { theme = 'light' document.documentElement.classList.r } return theme } function updateThemeWithoutTransitions(savedTheme) updateTheme(savedTheme) document.documentElement.classList.add window.setTimeout(() => { document.documentElement.classList.r }, 0) } document.documentElement.setAttribute(&# new MutationObserver(([{ oldValue let newValue = document.documentElemen if (newValue !== oldValue) { try { window.localStorage.setItem('theme', } catch {} updateThemeWithoutTransitions(newVal } }).observe(document.documentElement, mediaQuery.addEventListener('change', window.addEventListener('storage', </script><script defer="" window.plausible = window.plausible </script><link </code></pre><h3 id="p -H -H </code></pre><h3 id="r </code></pre></div></ class="antialiased [font-feature-settings:'ss01']" lang="en"><head><meta charSet="utf-8"/><meta name="viewport" content="width=device-width"/><title>Analytics (API) - Pxl Help</title><meta name="description" content="Read your analytics programmatically through the Pxl API. Gain insights from your analytics through the following API requests."/><meta name="next-head-count" content="4"/><meta property="og:image" content="https://help.pxl.to/tiny.png"/><meta name="twitter:image" content="https://help.pxl.to/tiny.png"/><script> ;(prefers-color-scheme: light)') heme { .add('dark') { .remove('dark') .add('dark') .remove('dark') emove('dark') { ('[&_*]:!transition-none') emove('[&_*]:!transition-none') 039;data-theme', updateTheme()) }]) => { t.getAttribute('data-theme') newValue) ue) { attributeFilter: ['data-theme'], attributeOldValue: true }) updateThemeWithoutTransitions) updateThemeWithoutTransitions) data-domain="help.pxl.to" data-api="/pa/api/event" src="/pa/js/script.js"></script><script> || function() { (window.plausible.q = window.plausible.q || []).push(arguments) } rel="preload" href="/_next/static/css/cc0c89da4477359a.css" as="style"/><link rel="stylesheet" href="/_next/static/css/cc0c89da4477359a.css" data-n-g=""/><noscript data-n-css=""></noscript><script defer="" nomodule="" src="/_next/static/chunks/polyfills-0d1b80a048d4787e.js"></script><script src="/_next/static/chunks/webpack-5752944655d749a0.js" defer=""></script><script src="/_next/static/chunks/framework-4556c45dd113b893.js" defer=""></script><script src="/_next/static/chunks/main-c7a0ff793fffb508.js" defer=""></script><script src="/_next/static/chunks/pages/_app-f6d2f5d118e3834c.js" defer=""></script><script src="/_next/static/chunks/605040ef-b1de146bca0cbdd3.js" defer=""></script><script src="/_next/static/chunks/951-1eccf3723e92029a.js" defer=""></script><script src="/_next/static/chunks/909-64cbdfde64ae71ab.js" defer=""></script><script src="/_next/static/chunks/pages/docs/api-insight-966b565f9ebd7ac9.js" defer=""></script><script src="/_next/static/PkQ8gH5vl9Ff98ShyLQes/_buildManifest.js" defer=""></script><script src="/_next/static/PkQ8gH5vl9Ff98ShyLQes/_ssgManifest.js" defer=""></script></head><body class="bg-white dark:bg-slate-900"><div id="__next"><header class="sticky top-0 z-50 flex flex-wrap items-center justify-between bg-white px-4 py-5 transition duration-500 sm:px-6 lg:px-8 dark:bg-transparent"><div class="mr-6 flex lg:hidden"><button type="button" class="relative" aria-label="Open navigation"><svg aria-hidden="true" viewBox="0 0 24 24" fill="none" stroke-width="2" stroke-linecap="round" class="h-6 w-6 stroke-slate-500"><path d="M4 7h16M4 12h16M4 17h16"></path></svg></button><div style="position:absolute;width:1px;height:1px;padding:0;margin:-1px;overflow:hidden;clip:rect(0, 0, 0, 0);white-space:nowrap;border-width:0;display:none"></div></div><div class="relative flex flex-grow basis-0 items-center"><a aria-label="Home page" class="mt-1" href="/"><div class="hidden [[data-theme=light]_&]:block"><img style="display:block;max-width:100%;width:initial;height:initial;background:none;opacity:1;border:0;margin:0;padding:0" alt="" aria-hidden="true" src="data:image/svg+xml,%3csvg%20xmlns=%27http://www.w3.org/2000/svg%27%20version=%271.1%27%20width=%27100%27%20height=%2738%27/%3e"/><img alt="pxl.to" src="data:image/gif;base64,R0lGODlhAQABAIAAAAAAAP///yH5BAEAAAAALAAAAAABAAEAAAIBRAA7" decoding="async" data-nimg="intrinsic" style="position:absolute;top:0;left:0;bottom:0;right:0;box-sizing:border-box;padding:0;border:none;margin:auto;display:block;width:0;height:0;min-width:100%;max-width:100%;min-height:100%;max-height:100%"/><noscript><img alt="pxl.to" srcSet="/_next/static/media/tiny.58a8ac3c.svg 1x, /_next/static/media/tiny.58a8ac3c.svg 2x" src="/_next/static/media/tiny.58a8ac3c.svg" decoding="async" data-nimg="intrinsic" style="position:absolute;top:0;left:0;bottom:0;right:0;box-sizing:border-box;padding:0;border:none;margin:auto;display:block;width:0;height:0;min-width:100%;max-width:100%;min-height:100%;max-height:100%" loading="lazy"/></noscript></div><div class="hidden [[data-theme=dark]_&]:block"><img style="display:block;max-width:100%;width:initial;height:initial;background:none;opacity:1;border:0;margin:0;padding:0" alt="" aria-hidden="true" src="data:image/svg+xml,%3csvg%20xmlns=%27http://www.w3.org/2000/svg%27%20version=%271.1%27%20width=%27100%27%20height=%2738%27/%3e"/><img alt="pxl.to" src="data:image/gif;base64,R0lGODlhAQABAIAAAAAAAP///yH5BAEAAAAALAAAAAABAAEAAAIBRAA7" decoding="async" data-nimg="intrinsic" style="position:absolute;top:0;left:0;bottom:0;right:0;box-sizing:border-box;padding:0;border:none;margin:auto;display:block;width:0;height:0;min-width:100%;max-width:100%;min-height:100%;max-height:100%"/><noscript><img alt="pxl.to" srcSet="/_next/static/media/tinywhite.93d07320.svg 1x, /_next/static/media/tinywhite.93d07320.svg 2x" src="/_next/static/media/tinywhite.93d07320.svg" decoding="async" data-nimg="intrinsic" style="position:absolute;top:0;left:0;bottom:0;right:0;box-sizing:border-box;padding:0;border:none;margin:auto;display:block;width:0;height:0;min-width:100%;max-width:100%;min-height:100%;max-height:100%" loading="lazy"/></noscript></div><div class="hidden [:not(.dark)[data-theme=system]_&]:block"><img style="display:block;max-width:100%;width:initial;height:initial;background:none;opacity:1;border:0;margin:0;padding:0" alt="" aria-hidden="true" src="data:image/svg+xml,%3csvg%20xmlns=%27http://www.w3.org/2000/svg%27%20version=%271.1%27%20width=%27100%27%20height=%2738%27/%3e"/><img alt="pxl.to" src="data:image/gif;base64,R0lGODlhAQABAIAAAAAAAP///yH5BAEAAAAALAAAAAABAAEAAAIBRAA7" decoding="async" data-nimg="intrinsic" style="position:absolute;top:0;left:0;bottom:0;right:0;box-sizing:border-box;padding:0;border:none;margin:auto;display:block;width:0;height:0;min-width:100%;max-width:100%;min-height:100%;max-height:100%"/><noscript><img alt="pxl.to" srcSet="/_next/static/media/tiny.58a8ac3c.svg 1x, /_next/static/media/tiny.58a8ac3c.svg 2x" src="/_next/static/media/tiny.58a8ac3c.svg" decoding="async" data-nimg="intrinsic" style="position:absolute;top:0;left:0;bottom:0;right:0;box-sizing:border-box;padding:0;border:none;margin:auto;display:block;width:0;height:0;min-width:100%;max-width:100%;min-height:100%;max-height:100%" loading="lazy"/></noscript></div><div class="hidden [.dark[data-theme=system]_&]:block"><img style="display:block;max-width:100%;width:initial;height:initial;background:none;opacity:1;border:0;margin:0;padding:0" alt="" aria-hidden="true" src="data:image/svg+xml,%3csvg%20xmlns=%27http://www.w3.org/2000/svg%27%20version=%271.1%27%20width=%27100%27%20height=%2738%27/%3e"/><img alt="pxl.to" src="data:image/gif;base64,R0lGODlhAQABAIAAAAAAAP///yH5BAEAAAAALAAAAAABAAEAAAIBRAA7" decoding="async" data-nimg="intrinsic" style="position:absolute;top:0;left:0;bottom:0;right:0;box-sizing:border-box;padding:0;border:none;margin:auto;display:block;width:0;height:0;min-width:100%;max-width:100%;min-height:100%;max-height:100%"/><noscript><img alt="pxl.to" srcSet="/_next/static/media/tinywhite.93d07320.svg 1x, /_next/static/media/tinywhite.93d07320.svg 2x" src="/_next/static/media/tinywhite.93d07320.svg" decoding="async" data-nimg="intrinsic" style="position:absolute;top:0;left:0;bottom:0;right:0;box-sizing:border-box;padding:0;border:none;margin:auto;display:block;width:0;height:0;min-width:100%;max-width:100%;min-height:100%;max-height:100%" loading="lazy"/></noscript></div></a></div><div class="-my-5 mr-6 sm:mr-8 md:mr-0"><button type="button" class="group flex h-6 w-6 items-center justify-center sm:justify-start md:h-auto md:w-80 md:flex-none md:rounded-lg md:py-2.5 md:pl-4 md:pr-3.5 md:text-sm md:ring-1 md:ring-slate-200 md:hover:ring-slate-300 dark:md:bg-slate-800/75 dark:md:ring-inset dark:md:ring-white/5 dark:md:hover:bg-slate-700/40 dark:md:hover:ring-slate-500 lg:w-96"><svg aria-hidden="true" viewBox="0 0 20 20" class="h-5 w-5 flex-none fill-slate-400 group-hover:fill-slate-500 dark:fill-slate-500 md:group-hover:fill-slate-400"><path d="M16.293 17.707a1 1 0 0 0 1.414-1.414l-1.414 1.414ZM9 14a5 5 0 0 1-5-5H2a7 7 0 0 0 7 7v-2ZM4 9a5 5 0 0 1 5-5V2a7 7 0 0 0-7 7h2Zm5-5a5 5 0 0 1 5 5h2a7 7 0 0 0-7-7v2Zm8.707 12.293-3.757-3.757-1.414 1.414 3.757 3.757 1.414-1.414ZM14 9a4.98 4.98 0 0 1-1.464 3.536l1.414 1.414A6.98 6.98 0 0 0 16 9h-2Zm-1.464 3.536A4.98 4.98 0 0 1 9 14v2a6.98 6.98 0 0 0 4.95-2.05l-1.414-1.414Z"></path></svg>Search docs</button></div><div class="relative flex basis-0 justify-end gap-6 sm:gap-8 md:flex-grow"><div class="relative z-10"><label class="sr-only" id="headlessui-listbox-label-:Rd36:">Theme</label><button class="flex h-6 w-6 items-center justify-center rounded-lg shadow-md shadow-black/5 ring-1 ring-black/5 dark:bg-slate-700 dark:ring-inset dark:ring-white/5" id="headlessui-listbox-button-:Rl36:" type="button" aria-haspopup="true" aria-expanded="false"><svg aria-hidden="true" viewBox="0 0 16 16" class="hidden h-4 w-4 fill-sky-400 [[data-theme=light]_&]:block"><path fill-rule="evenodd" clip-rule="evenodd" d="M7 1a1 1 0 0 1 2 0v1a1 1 0 1 1-2 0V1Zm4 7a3 3 0 1 1-6 0 3 3 0 0 1 6 0Zm2.657-5.657a1 1 0 0 0-1.414 0l-.707.707a1 1 0 0 0 1.414 1.414l.707-.707a1 1 0 0 0 0-1.414Zm-1.415 11.313-.707-.707a1 1 0 0 1 1.415-1.415l.707.708a1 1 0 0 1-1.415 1.414ZM16 7.999a1 1 0 0 0-1-1h-1a1 1 0 1 0 0 2h1a1 1 0 0 0 1-1ZM7 14a1 1 0 1 1 2 0v1a1 1 0 1 1-2 0v-1Zm-2.536-2.464a1 1 0 0 0-1.414 0l-.707.707a1 1 0 0 0 1.414 1.414l.707-.707a1 1 0 0 0 0-1.414Zm0-8.486A1 1 0 0 1 3.05 4.464l-.707-.707a1 1 0 0 1 1.414-1.414l.707.707ZM3 8a1 1 0 0 0-1-1H1a1 1 0 0 0 0 2h1a1 1 0 0 0 1-1Z"></path></svg><svg aria-hidden="true" viewBox="0 0 16 16" class="hidden h-4 w-4 fill-sky-400 [[data-theme=dark]_&]:block"><path fill-rule="evenodd" clip-rule="evenodd" d="M7.23 3.333C7.757 2.905 7.68 2 7 2a6 6 0 1 0 0 12c.68 0 .758-.905.23-1.332A5.989 5.989 0 0 1 5 8c0-1.885.87-3.568 2.23-4.668ZM12 5a1 1 0 0 1 1 1 1 1 0 0 0 1 1 1 1 0 1 1 0 2 1 1 0 0 0-1 1 1 1 0 1 1-2 0 1 1 0 0 0-1-1 1 1 0 1 1 0-2 1 1 0 0 0 1-1 1 1 0 0 1 1-1Z"></path></svg><svg aria-hidden="true" viewBox="0 0 16 16" class="hidden h-4 w-4 fill-slate-400 [:not(.dark)[data-theme=system]_&]:block"><path fill-rule="evenodd" clip-rule="evenodd" d="M7 1a1 1 0 0 1 2 0v1a1 1 0 1 1-2 0V1Zm4 7a3 3 0 1 1-6 0 3 3 0 0 1 6 0Zm2.657-5.657a1 1 0 0 0-1.414 0l-.707.707a1 1 0 0 0 1.414 1.414l.707-.707a1 1 0 0 0 0-1.414Zm-1.415 11.313-.707-.707a1 1 0 0 1 1.415-1.415l.707.708a1 1 0 0 1-1.415 1.414ZM16 7.999a1 1 0 0 0-1-1h-1a1 1 0 1 0 0 2h1a1 1 0 0 0 1-1ZM7 14a1 1 0 1 1 2 0v1a1 1 0 1 1-2 0v-1Zm-2.536-2.464a1 1 0 0 0-1.414 0l-.707.707a1 1 0 0 0 1.414 1.414l.707-.707a1 1 0 0 0 0-1.414Zm0-8.486A1 1 0 0 1 3.05 4.464l-.707-.707a1 1 0 0 1 1.414-1.414l.707.707ZM3 8a1 1 0 0 0-1-1H1a1 1 0 0 0 0 2h1a1 1 0 0 0 1-1Z"></path></svg><svg aria-hidden="true" viewBox="0 0 16 16" class="hidden h-4 w-4 fill-slate-400 [.dark[data-theme=system]_&]:block"><path fill-rule="evenodd" clip-rule="evenodd" d="M7.23 3.333C7.757 2.905 7.68 2 7 2a6 6 0 1 0 0 12c.68 0 .758-.905.23-1.332A5.989 5.989 0 0 1 5 8c0-1.885.87-3.568 2.23-4.668ZM12 5a1 1 0 0 1 1 1 1 1 0 0 0 1 1 1 1 0 1 1 0 2 1 1 0 0 0-1 1 1 1 0 1 1-2 0 1 1 0 0 0-1-1 1 1 0 1 1 0-2 1 1 0 0 0 1-1 1 1 0 0 1 1-1Z"></path></svg></button></div></div></header><div class="relative mx-auto flex max-w-8xl justify-center sm:px-2 lg:px-8 xl:px-12" id="article"><div class="hidden lg:relative lg:block lg:flex-none"><div class="absolute inset-y-0 right-0 w-[50vw] bg-slate-50 dark:hidden"></div><div class="sticky top-[4.5rem] -ml-0.5 h-[calc(100vh-4.5rem)] overflow-y-auto py-16 pl-0.5"><div class="absolute top-16 bottom-0 right-0 hidden h-12 w-px bg-gradient-to-t from-slate-800 dark:block"></div><div class="absolute top-28 bottom-0 right-0 hidden w-px bg-slate-800 dark:block"></div><nav class="text-base lg:text-sm w-64 pr-8 xl:w-72 xl:pr-16"><ul role="list" class="space-y-9"><li><h2 class="font-display font-medium text-slate-900 dark:text-white">Introduction</h2><ul role="list" class="mt-2 space-y-2 border-l-2 border-slate-100 dark:border-slate-800 lg:mt-4 lg:space-y-4 lg:border-slate-200"><li class="relative"><a class="block w-full pl-3.5 before:pointer-events-none before:absolute before:-left-1 before:top-1/2 before:h-1.5 before:w-1.5 before:-translate-y-1/2 before:rounded-full text-slate-500 before:hidden before:bg-slate-300 hover:text-slate-600 hover:before:block dark:text-slate-400 dark:before:bg-slate-700 dark:hover:text-slate-300" href="/">Getting Started</a></li><li class="relative"><a class="block w-full pl-3.5 before:pointer-events-none before:absolute before:-left-1 before:top-1/2 before:h-1.5 before:w-1.5 before:-translate-y-1/2 before:rounded-full text-slate-500 before:hidden before:bg-slate-300 hover:text-slate-600 hover:before:block dark:text-slate-400 dark:before:bg-slate-700 dark:hover:text-slate-300" href="/docs/faq">Frequently Asked Questions</a></li><li class="relative"><a class="block w-full pl-3.5 before:pointer-events-none before:absolute before:-left-1 before:top-1/2 before:h-1.5 before:w-1.5 before:-translate-y-1/2 before:rounded-full text-slate-500 before:hidden before:bg-slate-300 hover:text-slate-600 hover:before:block dark:text-slate-400 dark:before:bg-slate-700 dark:hover:text-slate-300" href="/docs/troubleshooting">Troubleshooting</a></li></ul></li><li><h2 class="font-display font-medium text-slate-900 dark:text-white">Core Features</h2><ul role="list" class="mt-2 space-y-2 border-l-2 border-slate-100 dark:border-slate-800 lg:mt-4 lg:space-y-4 lg:border-slate-200"><li class="relative"><a class="block w-full pl-3.5 before:pointer-events-none before:absolute before:-left-1 before:top-1/2 before:h-1.5 before:w-1.5 before:-translate-y-1/2 before:rounded-full text-slate-500 before:hidden before:bg-slate-300 hover:text-slate-600 hover:before:block dark:text-slate-400 dark:before:bg-slate-700 dark:hover:text-slate-300" href="/docs/links">Short Links</a></li><li class="relative"><a class="block w-full pl-3.5 before:pointer-events-none before:absolute before:-left-1 before:top-1/2 before:h-1.5 before:w-1.5 before:-translate-y-1/2 before:rounded-full text-slate-500 before:hidden before:bg-slate-300 hover:text-slate-600 hover:before:block dark:text-slate-400 dark:before:bg-slate-700 dark:hover:text-slate-300" href="/docs/dynamic-qr-codes">Dynamic QR Codes</a></li><li class="relative"><a class="block w-full pl-3.5 before:pointer-events-none before:absolute before:-left-1 before:top-1/2 before:h-1.5 before:w-1.5 before:-translate-y-1/2 before:rounded-full text-slate-500 before:hidden before:bg-slate-300 hover:text-slate-600 hover:before:block dark:text-slate-400 dark:before:bg-slate-700 dark:hover:text-slate-300" href="/docs/microsites">Microsites</a></li></ul></li><li><h2 class="font-display font-medium text-slate-900 dark:text-white">Additional Features</h2><ul role="list" class="mt-2 space-y-2 border-l-2 border-slate-100 dark:border-slate-800 lg:mt-4 lg:space-y-4 lg:border-slate-200"><li class="relative"><a class="block w-full pl-3.5 before:pointer-events-none before:absolute before:-left-1 before:top-1/2 before:h-1.5 before:w-1.5 before:-translate-y-1/2 before:rounded-full text-slate-500 before:hidden before:bg-slate-300 hover:text-slate-600 hover:before:block dark:text-slate-400 dark:before:bg-slate-700 dark:hover:text-slate-300" href="/docs/analytics">Analytics</a></li><li class="relative"><a class="block w-full pl-3.5 before:pointer-events-none before:absolute before:-left-1 before:top-1/2 before:h-1.5 before:w-1.5 before:-translate-y-1/2 before:rounded-full text-slate-500 before:hidden before:bg-slate-300 hover:text-slate-600 hover:before:block dark:text-slate-400 dark:before:bg-slate-700 dark:hover:text-slate-300" href="/docs/custom-domains">Custom Domains</a></li><li class="relative"><a class="block w-full pl-3.5 before:pointer-events-none before:absolute before:-left-1 before:top-1/2 before:h-1.5 before:w-1.5 before:-translate-y-1/2 before:rounded-full text-slate-500 before:hidden before:bg-slate-300 hover:text-slate-600 hover:before:block dark:text-slate-400 dark:before:bg-slate-700 dark:hover:text-slate-300" href="/docs/integrations">Integrations</a></li><li class="relative"><a class="block w-full pl-3.5 before:pointer-events-none before:absolute before:-left-1 before:top-1/2 before:h-1.5 before:w-1.5 before:-translate-y-1/2 before:rounded-full text-slate-500 before:hidden before:bg-slate-300 hover:text-slate-600 hover:before:block dark:text-slate-400 dark:before:bg-slate-700 dark:hover:text-slate-300" href="/docs/retargeting">Retargeting & Tracking</a></li><li class="relative"><a class="block w-full pl-3.5 before:pointer-events-none before:absolute before:-left-1 before:top-1/2 before:h-1.5 before:w-1.5 before:-translate-y-1/2 before:rounded-full text-slate-500 before:hidden before:bg-slate-300 hover:text-slate-600 hover:before:block dark:text-slate-400 dark:before:bg-slate-700 dark:hover:text-slate-300" href="/docs/smart-links">Smart Links</a></li><li class="relative"><a class="block w-full pl-3.5 before:pointer-events-none before:absolute before:-left-1 before:top-1/2 before:h-1.5 before:w-1.5 before:-translate-y-1/2 before:rounded-full text-slate-500 before:hidden before:bg-slate-300 hover:text-slate-600 hover:before:block dark:text-slate-400 dark:before:bg-slate-700 dark:hover:text-slate-300" href="/docs/spam-protection">Spam Protection</a></li><li class="relative"><a class="block w-full pl-3.5 before:pointer-events-none before:absolute before:-left-1 before:top-1/2 before:h-1.5 before:w-1.5 before:-translate-y-1/2 before:rounded-full text-slate-500 before:hidden before:bg-slate-300 hover:text-slate-600 hover:before:block dark:text-slate-400 dark:before:bg-slate-700 dark:hover:text-slate-300" href="/docs/team-members">Team Members</a></li><li class="relative"><a class="block w-full pl-3.5 before:pointer-events-none before:absolute before:-left-1 before:top-1/2 before:h-1.5 before:w-1.5 before:-translate-y-1/2 before:rounded-full text-slate-500 before:hidden before:bg-slate-300 hover:text-slate-600 hover:before:block dark:text-slate-400 dark:before:bg-slate-700 dark:hover:text-slate-300" href="/docs/workspaces">Workspaces</a></li></ul></li><li><h2 class="font-display font-medium text-slate-900 dark:text-white">API Reference</h2><ul role="list" class="mt-2 space-y-2 border-l-2 border-slate-100 dark:border-slate-800 lg:mt-4 lg:space-y-4 lg:border-slate-200"><li class="relative"><a class="block w-full pl-3.5 before:pointer-events-none before:absolute before:-left-1 before:top-1/2 before:h-1.5 before:w-1.5 before:-translate-y-1/2 before:rounded-full text-slate-500 before:hidden before:bg-slate-300 hover:text-slate-600 hover:before:block dark:text-slate-400 dark:before:bg-slate-700 dark:hover:text-slate-300" href="/docs/api-requests">Getting Started</a></li><li class="relative"><a class="block w-full pl-3.5 before:pointer-events-none before:absolute before:-left-1 before:top-1/2 before:h-1.5 before:w-1.5 before:-translate-y-1/2 before:rounded-full text-slate-500 before:hidden before:bg-slate-300 hover:text-slate-600 hover:before:block dark:text-slate-400 dark:before:bg-slate-700 dark:hover:text-slate-300" href="/docs/api-shorts">Short Links</a></li><li class="relative"><a class="block w-full pl-3.5 before:pointer-events-none before:absolute before:-left-1 before:top-1/2 before:h-1.5 before:w-1.5 before:-translate-y-1/2 before:rounded-full font-semibold text-sky-500 before:bg-sky-500" href="/docs/api-insight">Analytics</a></li></ul></li><li><h2 class="font-display font-medium text-slate-900 dark:text-white">Earning Money with Pxl</h2><ul role="list" class="mt-2 space-y-2 border-l-2 border-slate-100 dark:border-slate-800 lg:mt-4 lg:space-y-4 lg:border-slate-200"><li class="relative"><a class="block w-full pl-3.5 before:pointer-events-none before:absolute before:-left-1 before:top-1/2 before:h-1.5 before:w-1.5 before:-translate-y-1/2 before:rounded-full text-slate-500 before:hidden before:bg-slate-300 hover:text-slate-600 hover:before:block dark:text-slate-400 dark:before:bg-slate-700 dark:hover:text-slate-300" href="/docs/pxl-partner-program">Pxl Partner Program</a></li></ul></li><li><h2 class="font-display font-medium text-slate-900 dark:text-white">Moving to Pxl</h2><ul role="list" class="mt-2 space-y-2 border-l-2 border-slate-100 dark:border-slate-800 lg:mt-4 lg:space-y-4 lg:border-slate-200"><li class="relative"><a class="block w-full pl-3.5 before:pointer-events-none before:absolute before:-left-1 before:top-1/2 before:h-1.5 before:w-1.5 before:-translate-y-1/2 before:rounded-full text-slate-500 before:hidden before:bg-slate-300 hover:text-slate-600 hover:before:block dark:text-slate-400 dark:before:bg-slate-700 dark:hover:text-slate-300" href="/docs/import-bitly-links-to-pxl">Import Bitly Links to Pxl</a></li></ul></li><li><h2 class="font-display font-medium text-slate-900 dark:text-white">Data & Privacy</h2><ul role="list" class="mt-2 space-y-2 border-l-2 border-slate-100 dark:border-slate-800 lg:mt-4 lg:space-y-4 lg:border-slate-200"><li class="relative"><a class="block w-full pl-3.5 before:pointer-events-none before:absolute before:-left-1 before:top-1/2 before:h-1.5 before:w-1.5 before:-translate-y-1/2 before:rounded-full text-slate-500 before:hidden before:bg-slate-300 hover:text-slate-600 hover:before:block dark:text-slate-400 dark:before:bg-slate-700 dark:hover:text-slate-300" href="/docs/retargeting-consent">Consent for Retargeting</a></li><li class="relative"><a class="block w-full pl-3.5 before:pointer-events-none before:absolute before:-left-1 before:top-1/2 before:h-1.5 before:w-1.5 before:-translate-y-1/2 before:rounded-full text-slate-500 before:hidden before:bg-slate-300 hover:text-slate-600 hover:before:block dark:text-slate-400 dark:before:bg-slate-700 dark:hover:text-slate-300" href="/docs/gdpr-compliance">GDPR Compliance</a></li></ul></li></ul></nav></div></div><div class="min-w-0 max-w-2xl flex-auto px-4 py-16 lg:max-w-none lg:pr-0 lg:pl-8 xl:px-16"><article><header class="mb-9 space-y-1">API Reference<h1 class="font-display text-3xl tracking-tight text-slate-900 dark:text-white">Analytics (API)</h1></header><div class="prose prose-slate max-w-none dark:prose-invert dark:text-slate-400 prose-headings:scroll-mt-28 prose-headings:font-display prose-headings:font-normal lg:prose-headings:scroll-mt-[8.5rem] prose-lead:text-slate-500 dark:prose-lead:text-slate-400 prose-a:font-semibold dark:prose-a:text-sky-400 prose-a:no-underline prose-a:shadow-[inset_0_-2px_0_0_var(--tw-prose-background,#fff),inset_0_calc(-1*(var(--tw-prose-underline-size,4px)+2px))_0_0_var(--tw-prose-underline,theme(colors.sky.300))] hover:prose-a:[--tw-prose-underline-size:6px] dark:[--tw-prose-background:theme(colors.slate.900)] dark:prose-a:shadow-[inset_0_calc(-1*var(--tw-prose-underline-size,2px))_0_0_var(--tw-prose-underline,theme(colors.sky.800))] dark:hover:prose-a:[--tw-prose-underline-size:6px] prose-pre:rounded-xl prose-pre:bg-slate-900 prose-pre:shadow-lg dark:prose-pre:bg-slate-800/60 dark:prose-pre:shadow-none dark:prose-pre:ring-1 dark:prose-pre:ring-slate-300/10 dark:prose-hr:border-slate-800">Read your analytics through the Pxl API. Get insights from you analytics through the following API requests.Related guide: <a href="/docs/analytics">Analytics</a>.<div class="my-4 flex flex-col rounded-xl px-2 py-0 pb-5 bg-sky-50 dark:bg-slate-800/60 dark:ring-1 dark:ring-slate-300/10"><div class="prose"><div class="flex items-center"><svg xmlns="http://www.w3.org/2000/svg" class="h-6 w-6 flex-none" fill="none" viewBox="0 0 24 24" stroke="#7dd3fc"><path stroke-linecap="round" stroke-linejoin="round" stroke-width="2" d="M9 5l7 7-7 7"></path></svg><div class="ml-3"><div class="text-sky-800 [--tw-prose-background:theme(colors.sky.50)] prose-a:text-sky-900 prose-code:text-sky-900 dark:text-slate-300 dark:prose-code:text-slate-300">This feature is available on all plans.</div></div></div></div><div class="not-prose pl-9"><a href="https://www.pxl.to/?ref=help-cta" target="_blank" class="rounded-full bg-blue-500 p-2 px-5 text-center text-sm text-white hover:bg-blue-400 hover:text-white focus:outline-none active:bg-blue-600 w-full md:w-auto">Get started for free</a></div></div><hr/><h2 id="the-insight-object">The insight object</h2><h4>recent: number</h4>Example: 100The number of page views that occured within the last 30 minutes.<h4>total: number</h4>Example: 500The total number of page views that occured within the specified period.<h4>unique: number</h4>Example: 400The number of unique page views that occured within the specified period.<h4>grouped: object</h4>An array of objects containing the total page views and unique page views for each consecutive day (or hour) within the specified period.<h4>properties: object</h4>An object containing the total page views and unique page views of each distinct property value, grouped by property category (city, country, device, browser) within the specified period.<h2 id="list-insight">List insight</h2>To return all insight associated with your organisation, you will make a GET request.<pre class="prism-code language-bash"><code>GET https://api.pxl.to/api/v1/insight arameters">Parameters</h3><h4>datefrom: _string</h4>Example: 2024-12-01The start date of the range for which data will be returned, formatted as YYYY-MM-DD. Defaults to 7 days before the current date.<h4>dateto: _string</h4>Example: 2024-12-31The end date of the range for which data will be returned, formatted as YYYY-MM-DD. Defaults as the current date.<h4>timezone: string</h4>Example: Europe/ViennaThe timezone for which any returned data will be offset. Defaults to UTC.<h4>link: string</h4>Example: pxl.to/mylinkThe specific link for which analytics data will be returned.<h4>domain: string</h4>Example: pxl.toThe specific domain for which analytics data will be returned.<h4>device: string</h4>Example: DesktopThe device type for which analytics data will be returned.<h4>browser: string</h4>Example: ChromeThe specific browser for which analytics data will be returned.<h4>OS: string</h4>Example: WindowsThe specific OS for which analytics data will be returned.<h4>country: string</h4>Example: USThe specific country for which analytics data will be returned, formatted as an ISO 3166 2-digit code.<h4>city: string</h4>Example: WashingtonThe specific city for which analytics data will be returned.<h4>medium: string</h4>Example: ClickThe specific medium for which analytics data will be returned.<h4>source: string</h4>Example: footerThe specific source for which analytics data will be returned.<h3 id="returns">Returns</h3>Returns an insight object representing the analytics performance of every link within your organisation.<h3 id="request">Request</h3>An example CURL request:<pre class="prism-code language-bash"><code>curl -X GET --compressed "https://api.pxl.to/api/v1/insight?timezone=Europe/London&country=US&date_from=2023-06-16&date_to=2023-06-22" \ "Accept-Encoding: gzip" \ "Authorization: Bearer <YOUR_ACCESS_TOKEN>" \ esponse">Response</h3>An example JSON response:<pre class="prism-code language-json"><code>{ "data": { "unique": 91, "total": 108, "recent": 4, "grouped": [ { "t": "2023-06-16", "visits": 7, "hits": 8 }, { "t": "2023-06-17", "visits": 11, "hits": 12 }, { "t": "2023-06-18", "visits": 10, "hits": 11 }, { "t": "2023-06-19", "visits": 11, "hits": 12 }, { "t": "2023-06-20", "visits": 15, "hits": 16 }, { "t": "2023-06-21", "visits": 14, "hits": 16 }, { "t": "2023-06-22", "visits": 23, "hits": 33 } ], "properties": { "source": [ { "type": "banner", "visits": 52, "hits": 52 }, { "type": "app", "visits": 18, "hits": 23 } ], "browser": [ { "type": "Chrome", "visits": 74, "hits": 89 }, { "type": "Edge", "visits": 4, "hits": 6 }, { "type": "Firefox", "visits": 3, "hits": 3 } ], "link": [ { "type": "pxl.to/example", "visits": 52, "hits": 52 }, { "type": "pxl.to/example/2", "visits": 13, "hits": 15 } ], "country": [ { "type": "US", "visits": 91, "hits": 108 } ], "city": [ { "type": "Charlotte", "visits": 27, "hits": 33 }, { "type": "Boardman", "visits": 6, "hits": 6 }, { "type": "Los Angeles", "visits": 5, "hits": 5 }, { "type": "San Jose", "visits": 3, "hits": 4 }, { "type": "Dallas", "visits": 3, "hits": 3 } ], "device": [ { "type": "desktop", "visits": 87, "hits": 103 }, { "type": "mobile", "visits": 3, "hits": 4 }, { "type": "tablet", "visits": 1, "hits": 1 } ], "domain": [ { "type": "pxl.to", "visits": 78, "hits": 93 } ], "medium": [ { "type": "Click", "visits": 91, "hits": 108 } ], "OS": [ { "type": "Windows", "visits": 39, "hits": 47 }, { "type": "Mac OS", "visits": 19, "hits": 23 }, { "type": "Linux", "visits": 17, "hits": 21 } ] } } } article><dl class="mt-12 flex border-t border-slate-200 pt-6 dark:border-slate-800"><div><dt class="font-display text-sm font-medium text-slate-900 dark:text-white">Previous</dt><dd class="mt-1"><a class="text-base font-semibold text-slate-500 hover:text-slate-600 dark:text-slate-400 dark:hover:text-slate-300" href="/docs/api-shorts">← Short Links</a></dd></div><div class="ml-auto text-right"><dt class="font-display text-sm font-medium text-slate-900 dark:text-white">Next</dt><dd class="mt-1"><a class="text-base font-semibold text-slate-500 hover:text-slate-600 dark:text-slate-400 dark:hover:text-slate-300" href="/docs/pxl-partner-program">Pxl Partner Program →</a></dd></div></dl></div><div class="hidden xl:sticky xl:top-[4.5rem] xl:-mr-6 xl:block xl:h-[calc(100vh-4.5rem)] xl:flex-none xl:overflow-y-auto xl:py-16 xl:pr-6"><nav aria-labelledby="on-this-page-title" class="w-56"><h2 id="on-this-page-title" class="font-display text-sm font-medium text-slate-900 dark:text-white">On this page</h2><ol role="list" class="mt-4 space-y-3 text-sm"><li><h3><a class="text-sky-500" href="/docs/api-insight#the-insight-object">The insight object</a></h3></li><li><h3><a class="font-normal text-slate-500 hover:text-slate-700 dark:text-slate-400 dark:hover:text-slate-300" href="/docs/api-insight#list-insight">List insight</a></h3><ol role="list" class="mt-2 space-y-3 pl-5 text-slate-500 dark:text-slate-400"><li><a class="hover:text-slate-600 dark:hover:text-slate-300" href="/docs/api-insight#parameters">Parameters</a></li><li><a class="hover:text-slate-600 dark:hover:text-slate-300" href="/docs/api-insight#returns">Returns</a></li><li><a class="hover:text-slate-600 dark:hover:text-slate-300" href="/docs/api-insight#request">Request</a></li><li><a class="hover:text-slate-600 dark:hover:text-slate-300" href="/docs/api-insight#response">Response</a></li></ol></li></ol></nav></div></div></div><script id="__NEXT_DATA__" type="application/json">{"props":{"pageProps":{"markdoc":{"content":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Read your analytics through the Pxl API. Get insights from you analytics through the following API requests."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Related guide: ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/docs/analytics"},"children":["Analytics"]},"."]},{"$$mdtype":"Tag","name":"Availability","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This feature is available on ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["all plans"]},"."]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"h2","attributes":{"id":"the-insight-object"},"children":["The ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["insight"]}," object"]},{"$$mdtype":"Tag","name":"h4","attributes":{},"children":["recent: ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["number"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Example: ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["100"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The number of page views that occured within the last 30 minutes."]},{"$$mdtype":"Tag","name":"h4","attributes":{},"children":["total: ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["number"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Example: ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["500"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The total number of page views that occured within the specified period."]},{"$$mdtype":"Tag","name":"h4","attributes":{},"children":["unique: ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["number"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Example: ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["400"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The number of unique page views that occured within the specified period."]},{"$$mdtype":"Tag","name":"h4","attributes":{},"children":["grouped: ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["object"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["An array of objects containing the total page views and unique page views for each consecutive day (or hour) within the specified period."]},{"$$mdtype":"Tag","name":"h4","attributes":{},"children":["properties: ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["object"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["An object containing the total page views and unique page views of each distinct property value, grouped by property category (city, country, device, browser) within the specified period."]},{"$$mdtype":"Tag","name":"h2","attributes":{"id":"list-insight"},"children":["List insight"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To return all insight associated with your organisation, you will make a GET request."]},{"$$mdtype":"Tag","name":"Fence","attributes":{"language":"bash"},"children":["GET https://api.pxl.to/api/v1/insight\n"]},{"$$mdtype":"Tag","name":"h3","attributes":{"id":"parameters"},"children":["Parameters"]},{"$$mdtype":"Tag","name":"h4","attributes":{},"children":["date",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["from: _string"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Example: ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["2024-12-01"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The start date of the range for which data will be returned, formatted as YYYY-MM-DD. Defaults to 7 days before the current date."]},{"$$mdtype":"Tag","name":"h4","attributes":{},"children":["date",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["to: _string"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Example: ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["2024-12-31"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The end date of the range for which data will be returned, formatted as YYYY-MM-DD. Defaults as the current date."]},{"$$mdtype":"Tag","name":"h4","attributes":{},"children":["timezone: ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["string"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Example: ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Europe/Vienna"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The timezone for which any returned data will be offset. Defaults to UTC."]},{"$$mdtype":"Tag","name":"h4","attributes":{},"children":["link: ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["string"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Example: ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["pxl.to/mylink"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The specific link for which analytics data will be returned."]},{"$$mdtype":"Tag","name":"h4","attributes":{},"children":["domain: ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["string"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Example: ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["pxl.to"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The specific domain for which analytics data will be returned."]},{"$$mdtype":"Tag","name":"h4","attributes":{},"children":["device: ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["string"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Example: ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Desktop"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The device type for which analytics data will be returned."]},{"$$mdtype":"Tag","name":"h4","attributes":{},"children":["browser: ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["string"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Example: ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Chrome"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The specific browser for which analytics data will be returned."]},{"$$mdtype":"Tag","name":"h4","attributes":{},"children":["OS: ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["string"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Example: ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Windows"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The specific OS for which analytics data will be returned."]},{"$$mdtype":"Tag","name":"h4","attributes":{},"children":["country: ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["string"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Example: ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["US"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The specific country for which analytics data will be returned, formatted as an ISO 3166 2-digit code."]},{"$$mdtype":"Tag","name":"h4","attributes":{},"children":["city: ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["string"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Example: ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Washington"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The specific city for which analytics data will be returned."]},{"$$mdtype":"Tag","name":"h4","attributes":{},"children":["medium: ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["string"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Example: ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Click"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The specific medium for which analytics data will be returned."]},{"$$mdtype":"Tag","name":"h4","attributes":{},"children":["source: ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["string"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Example: ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["footer"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The specific source for which analytics data will be returned."]},{"$$mdtype":"Tag","name":"h3","attributes":{"id":"returns"},"children":["Returns"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Returns an insight object representing the analytics performance of every link within your organisation."]},{"$$mdtype":"Tag","name":"h3","attributes":{"id":"request"},"children":["Request"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["An example CURL request:"]},{"$$mdtype":"Tag","name":"Fence","attributes":{"language":"bash"},"children":["curl -X GET --compressed \"https://api.pxl.to/api/v1/insight?timezone=Europe/London\u0026country=US\u0026date_from=2023-06-16\u0026date_to=2023-06-22\" \\\n-H \"Accept-Encoding: gzip\" \\\n-H \"Authorization: Bearer \u003cYOUR_ACCESS_TOKEN\u003e\" \\\n"]},{"$$mdtype":"Tag","name":"h3","attributes":{"id":"response"},"children":["Response"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["An example JSON response:"]},{"$$mdtype":"Tag","name":"Fence","attributes":{"language":"json"},"children":["{\n \"data\": {\n \"unique\": 91,\n \"total\": 108,\n \"recent\": 4,\n \"grouped\": [\n {\n \"t\": \"2023-06-16\",\n \"visits\": 7,\n \"hits\": 8\n },\n {\n \"t\": \"2023-06-17\",\n \"visits\": 11,\n \"hits\": 12\n },\n {\n \"t\": \"2023-06-18\",\n \"visits\": 10,\n \"hits\": 11\n },\n {\n \"t\": \"2023-06-19\",\n \"visits\": 11,\n \"hits\": 12\n },\n {\n \"t\": \"2023-06-20\",\n \"visits\": 15,\n \"hits\": 16\n },\n {\n \"t\": \"2023-06-21\",\n \"visits\": 14,\n \"hits\": 16\n },\n {\n \"t\": \"2023-06-22\",\n \"visits\": 23,\n \"hits\": 33\n }\n ],\n \"properties\": {\n \"source\": [\n {\n \"type\": \"banner\",\n \"visits\": 52,\n \"hits\": 52\n },\n {\n \"type\": \"app\",\n \"visits\": 18,\n \"hits\": 23\n }\n ],\n \"browser\": [\n {\n \"type\": \"Chrome\",\n \"visits\": 74,\n \"hits\": 89\n },\n {\n \"type\": \"Edge\",\n \"visits\": 4,\n \"hits\": 6\n },\n {\n \"type\": \"Firefox\",\n \"visits\": 3,\n \"hits\": 3\n }\n ],\n \"link\": [\n {\n \"type\": \"pxl.to/example\",\n \"visits\": 52,\n \"hits\": 52\n },\n {\n \"type\": \"pxl.to/example/2\",\n \"visits\": 13,\n \"hits\": 15\n }\n ],\n \"country\": [\n {\n \"type\": \"US\",\n \"visits\": 91,\n \"hits\": 108\n }\n ],\n \"city\": [\n {\n \"type\": \"Charlotte\",\n \"visits\": 27,\n \"hits\": 33\n },\n {\n \"type\": \"Boardman\",\n \"visits\": 6,\n \"hits\": 6\n },\n {\n \"type\": \"Los Angeles\",\n \"visits\": 5,\n \"hits\": 5\n },\n {\n \"type\": \"San Jose\",\n \"visits\": 3,\n \"hits\": 4\n },\n {\n \"type\": \"Dallas\",\n \"visits\": 3,\n \"hits\": 3\n }\n ],\n \"device\": [\n {\n \"type\": \"desktop\",\n \"visits\": 87,\n \"hits\": 103\n },\n {\n \"type\": \"mobile\",\n \"visits\": 3,\n \"hits\": 4\n },\n {\n \"type\": \"tablet\",\n \"visits\": 1,\n \"hits\": 1\n }\n ],\n \"domain\": [\n {\n \"type\": \"pxl.to\",\n \"visits\": 78,\n \"hits\": 93\n }\n ],\n \"medium\": [\n {\n \"type\": \"Click\",\n \"visits\": 91,\n \"hits\": 108\n }\n ],\n \"OS\": [\n {\n \"type\": \"Windows\",\n \"visits\": 39,\n \"hits\": 47\n },\n {\n \"type\": \"Mac OS\",\n \"visits\": 19,\n \"hits\": 23\n },\n {\n \"type\": \"Linux\",\n \"visits\": 17,\n \"hits\": 21\n }\n ]\n }\n }\n}\n"]}],"frontmatter":{"title":"Analytics (API)","description":"Read your analytics programmatically through the Pxl API. Gain insights from your analytics through the following API requests."},"file":{"path":"/docs/api-insight.md"}}},"__N_SSG":true},"page":"/docs/api-insight","query":{},"buildId":"PkQ8gH5vl9Ff98ShyLQes","isFallback":false,"gsp":true,"scriptLoader":[]}</script></body></html>