CINXE.COM

<!DOCTYPE html> <html lang="en-US"> <head> <meta http-equiv="content-type" content="text/html" charset="UTF-8" /> <meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1, maximum-scale=1" /> <link rel="profile" href="https://gmpg.org/xfn/11" /> <meta name='robots' content='index, follow, max-image-preview:large, max-snippet:-1, max-video-preview:-1' /> <style>img:is([sizes="auto" i], [sizes^="auto," i]) { contain-intrinsic-size: 3000px 1500px }</style>  <title>The Parse.ly API: Overview, options and use | Parse.ly</title> <meta name="description" content="This is the central hub to learn more about the Parse.ly API, its endpoints and metrics, and how to get started using it." /> <link rel="canonical" href="https://docs.parse.ly/api/" /> <meta property="og:locale" content="en_US" /> <meta property="og:type" content="article" /> <meta property="og:title" content="The Parse.ly API: Overview, options and use | Parse.ly" /> <meta property="og:description" content="This is the central hub to learn more about the Parse.ly API, its endpoints and metrics, and how to get started using it." /> <meta property="og:url" content="https://docs.parse.ly/api/" /> <meta property="og:site_name" content="Parse.ly Help & Support Documentation" /> <meta property="article:published_time" content="2022-10-19T19:31:39+00:00" /> <meta property="article:modified_time" content="2024-11-07T19:18:45+00:00" /> <meta name="author" content="joshua" /> <meta name="twitter:card" content="summary_large_image" /> <meta name="twitter:creator" content="@parselysupport" /> <meta name="twitter:site" content="@parselysupport" /> <meta name="twitter:label1" content="Written by" /> <meta name="twitter:data1" content="joshua" /> <meta name="twitter:label2" content="Est. reading time" /> <meta name="twitter:data2" content="1 minute" /> <script type="application/ld+json" class="yoast-schema-graph">{"@context":"https://schema.org","@graph":[{"@type":"Article","@id":"https://docs.parse.ly/api/#article","isPartOf":{"@id":"https://docs.parse.ly/api/"},"author":{"name":"joshua","@id":"https://docs.parse.ly/#/schema/person/4078595635ccc39f9384808b80c2d43e"},"headline":"The Parse.ly API: Overview, options and use","datePublished":"2022-10-19T19:31:39+00:00","dateModified":"2024-11-07T19:18:45+00:00","mainEntityOfPage":{"@id":"https://docs.parse.ly/api/"},"wordCount":171,"publisher":{"@id":"https://docs.parse.ly/#organization"},"articleSection":["API"],"inLanguage":"en-US"},{"@type":"WebPage","@id":"https://docs.parse.ly/api/","url":"https://docs.parse.ly/api/","name":"The Parse.ly API: Overview, options and use | Parse.ly","isPartOf":{"@id":"https://docs.parse.ly/#website"},"datePublished":"2022-10-19T19:31:39+00:00","dateModified":"2024-11-07T19:18:45+00:00","description":"This is the central hub to learn more about the Parse.ly API, its endpoints and metrics, and how to get started using it.","breadcrumb":{"@id":"https://docs.parse.ly/api/#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https://docs.parse.ly/api/"]}]},{"@type":"BreadcrumbList","@id":"https://docs.parse.ly/api/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Home","item":"https://docs.parse.ly/"},{"@type":"ListItem","position":2,"name":"The Parse.ly API: Overview, options and use"}]},{"@type":"WebSite","@id":"https://docs.parse.ly/#website","url":"https://docs.parse.ly/","name":"Parse.ly Help & Support Documentation","description":"Parse.ly help documentation and knowledge base","publisher":{"@id":"https://docs.parse.ly/#organization"},"potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https://docs.parse.ly/?s={search_term_string}"},"query-input":{"@type":"PropertyValueSpecification","valueRequired":true,"valueName":"search_term_string"}}],"inLanguage":"en-US"},{"@type":"Organization","@id":"https://docs.parse.ly/#organization","name":"Parse.ly","url":"https://docs.parse.ly/","logo":{"@type":"ImageObject","inLanguage":"en-US","@id":"https://docs.parse.ly/#/schema/logo/image/","url":"https://docs.parse.ly/wp-content/uploads/sites/5/2022/09/Parsely-Logo-sRGB-Leaf-Green.png","contentUrl":"https://docs.parse.ly/wp-content/uploads/sites/5/2022/09/Parsely-Logo-sRGB-Leaf-Green.png","width":360,"height":390,"caption":"Parse.ly"},"image":{"@id":"https://docs.parse.ly/#/schema/logo/image/"},"sameAs":["https://x.com/parselysupport"]},{"@type":"Person","@id":"https://docs.parse.ly/#/schema/person/4078595635ccc39f9384808b80c2d43e","name":"joshua"}]}</script>  <link rel='dns-prefetch' href='//stats.wp.com' /> <link rel="alternate" type="application/rss+xml" title="Parse.ly Help & Support Documentation » Feed" href="https://docs.parse.ly/feed/" /> <link rel="alternate" type="application/rss+xml" title="Parse.ly Help & Support Documentation » Comments Feed" href="https://docs.parse.ly/comments/feed/" /> <script type="text/javascript"> /* <![CDATA[ */ window._wpemojiSettings = {"baseUrl":"https:\/\/s.w.org\/images\/core\/emoji\/15.0.3\/72x72\/","ext":".png","svgUrl":"https:\/\/s.w.org\/images\/core\/emoji\/15.0.3\/svg\/","svgExt":".svg","source":{"concatemoji":"https:\/\/docs.parse.ly\/wp-includes\/js\/wp-emoji-release.min.js?ver=6.7.1"}}; /*! This file is auto-generated */ !function(i,n){var o,s,e;function c(e){try{var t={supportTests:e,timestamp:(new Date).valueOf()};sessionStorage.setItem(o,JSON.stringify(t))}catch(e){}}function p(e,t,n){e.clearRect(0,0,e.canvas.width,e.canvas.height),e.fillText(t,0,0);var t=new Uint32Array(e.getImageData(0,0,e.canvas.width,e.canvas.height).data),r=(e.clearRect(0,0,e.canvas.width,e.canvas.height),e.fillText(n,0,0),new Uint32Array(e.getImageData(0,0,e.canvas.width,e.canvas.height).data));return t.every(function(e,t){return e===r[t]})}function u(e,t,n){switch(t){case"flag":return n(e,"\ud83c\udff3\ufe0f\u200d\u26a7\ufe0f","\ud83c\udff3\ufe0f\u200b\u26a7\ufe0f")?!1:!n(e,"\ud83c\uddfa\ud83c\uddf3","\ud83c\uddfa\u200b\ud83c\uddf3")&&!n(e,"\ud83c\udff4\udb40\udc67\udb40\udc62\udb40\udc65\udb40\udc6e\udb40\udc67\udb40\udc7f","\ud83c\udff4\u200b\udb40\udc67\u200b\udb40\udc62\u200b\udb40\udc65\u200b\udb40\udc6e\u200b\udb40\udc67\u200b\udb40\udc7f");case"emoji":return!n(e,"\ud83d\udc26\u200d\u2b1b","\ud83d\udc26\u200b\u2b1b")}return!1}function f(e,t,n){var r="undefined"!=typeof WorkerGlobalScope&&self instanceof WorkerGlobalScope?new OffscreenCanvas(300,150):i.createElement("canvas"),a=r.getContext("2d",{willReadFrequently:!0}),o=(a.textBaseline="top",a.font="600 32px Arial",{});return e.forEach(function(e){o[e]=t(a,e,n)}),o}function t(e){var t=i.createElement("script");t.src=e,t.defer=!0,i.head.appendChild(t)}"undefined"!=typeof Promise&&(o="wpEmojiSettingsSupports",s=["flag","emoji"],n.supports={everything:!0,everythingExceptFlag:!0},e=new Promise(function(e){i.addEventListener("DOMContentLoaded",e,{once:!0})}),new Promise(function(t){var n=function(){try{var e=JSON.parse(sessionStorage.getItem(o));if("object"==typeof e&&"number"==typeof e.timestamp&&(new Date).valueOf()<e.timestamp+604800&&"object"==typeof e.supportTests)return e.supportTests}catch(e){}return null}();if(!n){if("undefined"!=typeof Worker&&"undefined"!=typeof OffscreenCanvas&&"undefined"!=typeof URL&&URL.createObjectURL&&"undefined"!=typeof Blob)try{var e="postMessage("+f.toString()+"("+[JSON.stringify(s),u.toString(),p.toString()].join(",")+"));",r=new Blob([e],{type:"text/javascript"}),a=new Worker(URL.createObjectURL(r),{name:"wpTestEmojiSupports"});return void(a.onmessage=function(e){c(n=e.data),a.terminate(),t(n)})}catch(e){}c(n=f(s,u,p))}t(n)}).then(function(e){for(var t in e)n.supports[t]=e[t],n.supports.everything=n.supports.everything&&n.supports[t],"flag"!==t&&(n.supports.everythingExceptFlag=n.supports.everythingExceptFlag&&n.supports[t]);n.supports.everythingExceptFlag=n.supports.everythingExceptFlag&&!n.supports.flag,n.DOMReady=!1,n.readyCallback=function(){n.DOMReady=!0}}).then(function(){return e}).then(function(){var e;n.supports.everything||(n.readyCallback(),(e=n.source||{}).concatemoji?t(e.concatemoji):e.wpemoji&&e.twemoji&&(t(e.twemoji),t(e.wpemoji)))}))}((window,document),window._wpemojiSettings); /* ]]> */ </script> <style id='wp-emoji-styles-inline-css'> img.wp-smiley, img.emoji { display: inline !important; border: none !important; box-shadow: none !important; height: 1em !important; width: 1em !important; margin: 0 0.07em !important; vertical-align: -0.1em !important; background: none !important; padding: 0 !important; } </style> <link rel='stylesheet' id='all-css-2' href='https://docs.parse.ly/wp-includes/css/dist/block-library/style.min.css?m=1732206022g' type='text/css' media='all' /> <style id='safe-svg-svg-icon-style-inline-css'> .safe-svg-cover{text-align:center}.safe-svg-cover .safe-svg-inside{display:inline-block;max-width:100%}.safe-svg-cover svg{height:100%;max-height:100%;max-width:100%;width:100%} </style> <style id='tab-group-tabs-style-inline-css'> .wp-block-tab-group-tabs{margin-bottom:1.41575em}.wp-block-tab-group-tabs ul.tab-labels{margin:0;padding:0}.wp-block-tab-group-tabs ul.tab-labels li{border-bottom-width:0;list-style:none;margin:0;padding:0}.wp-block-tab-group-tabs ul.tab-labels li label{background:#f9f5f5;border:solid #ddd;border-radius:10px 10px 0 0;border-width:1px 1px 0;color:#444;float:left;padding:15px 25px}.wp-block-tab-group-tabs ul.tab-labels li label:hover{background:#f2f2f2;cursor:pointer}.wp-block-tab-group-tabs ul.tab-labels li label:active{background:#fff}.wp-block-tab-group-tabs ul.tab-labels li:not(:last-child) label{border-right-width:0}.wp-block-tab-group-tabs ul.tab-labels li.active label{background:#fff;color:#111;position:relative}.wp-block-tab-group-tabs ul.tab-labels li.active label:hover{cursor:default}.wp-block-tab-group-tabs ul.tab-labels li.active label:after{background:#fff;bottom:-1px;content:"";display:block;height:2px;left:0;position:absolute;width:100%}.wp-block-tab-group-tabs section{background:#fff;border:1px solid #ddd;clear:both;padding:20px;width:100%}.wp-block-tab-group-tabs section div.tab-panel{display:none}.wp-block-tab-group-tabs section div.tab-panel.active{display:block}.wp-block-tab-group-tabs section div.tab-panel p:last-child{margin-bottom:0}@media only screen and (min-width:768px){.wp-block-tab-group-tabs.layout-left{display:flex;width:100%}.wp-block-tab-group-tabs.layout-left ul.tab-labels li{display:flex;flex-direction:column}.wp-block-tab-group-tabs.layout-left ul.tab-labels li label{border-bottom-width:1px;border-radius:10px 0 0 10px;border-right-width:0}.wp-block-tab-group-tabs.layout-left ul.tab-labels li:not(:last-child) label{border-bottom-width:0}.wp-block-tab-group-tabs.layout-left ul.tab-labels li.active label:after{height:100%;left:unset;right:-1px;top:0;width:2px}.wp-block-tab-group-tabs.layout-left .tab-content,.wp-block-tab-group-tabs.layout-left .tab-content .tab-panel.active{display:flex;flex:1;flex-direction:column}.wp-block-tab-group-tabs.layout-left .tab-content .tab-panel.active .wp-block-cgb-block-page-section{flex:1}.wp-block-tab-group-tabs.layout-left .tab-content .tab-panel.active>*{padding:0 2rem}} </style> <style id='wp-parsely-recommendations-style-inline-css'> .parsely-recommendations-list-title{font-size:1.2em}.parsely-recommendations-list{list-style:none;padding:unset}.parsely-recommendations-cardbody{overflow:hidden;padding:.8em;text-overflow:ellipsis;white-space:nowrap}.parsely-recommendations-cardmedia{padding:.8em .8em 0} </style> <style id='elasticpress-facet-style-inline-css'> .widget_ep-facet input[type=search],.wp-block-elasticpress-facet input[type=search]{margin-bottom:1rem}.widget_ep-facet .searchable .inner,.wp-block-elasticpress-facet .searchable .inner{max-height:20em;overflow:scroll}.widget_ep-facet .term.hide,.wp-block-elasticpress-facet .term.hide{display:none}.widget_ep-facet .empty-term,.wp-block-elasticpress-facet .empty-term{opacity:.5;position:relative}.widget_ep-facet .empty-term:after,.wp-block-elasticpress-facet .empty-term:after{bottom:0;content:" ";display:block;left:0;position:absolute;right:0;top:0;width:100%;z-index:2}.widget_ep-facet .level-1,.wp-block-elasticpress-facet .level-1{padding-left:20px}.widget_ep-facet .level-2,.wp-block-elasticpress-facet .level-2{padding-left:40px}.widget_ep-facet .level-3,.wp-block-elasticpress-facet .level-3{padding-left:60px}.widget_ep-facet .level-4,.wp-block-elasticpress-facet .level-4{padding-left:5pc}.widget_ep-facet .level-5,.wp-block-elasticpress-facet .level-5{padding-left:75pt}.widget_ep-facet input[disabled],.wp-block-elasticpress-facet input[disabled]{cursor:pointer;opacity:1}.widget_ep-facet .term a,.wp-block-elasticpress-facet .term a{-webkit-box-align:center;-ms-flex-align:center;align-items:center;display:-webkit-box;display:-ms-flexbox;display:flex;position:relative}.widget_ep-facet .term a:hover .ep-checkbox,.wp-block-elasticpress-facet .term a:hover .ep-checkbox{background-color:#ccc}.ep-checkbox{-webkit-box-align:center;-ms-flex-align:center;-ms-flex-negative:0;-webkit-box-pack:center;-ms-flex-pack:center;align-items:center;background-color:#eee;display:-webkit-box;display:-ms-flexbox;display:flex;flex-shrink:0;height:1em;justify-content:center;margin-right:.25em;width:1em}.ep-checkbox:after{border:solid #fff;border-width:0 .125em .125em 0;content:"";display:none;height:.5em;-webkit-transform:rotate(45deg);transform:rotate(45deg);width:.25em}.ep-checkbox.checked{background-color:#5e5e5e}.ep-checkbox.checked:after{display:block} </style> <link rel='stylesheet' id='all-css-10' href='https://docs.parse.ly/_static/??-eJxVjl0KwkAMhC9kGrVY+yKeZZsNGt0/NlnE27sohfo0wzB8M/gqQDkZJ8PYoIR2k6So7CrdkYNTEyqVVdGLGlI3tcfGHkpWU1hCpieovQPrECUNvbLDjpVEoXlWfChS9hyl1lw39q+9nqAgXWDzxc0EPtO6xF6sY5wqm+LSJHj8rkN0P941Xg7n8Xiapv04fwDWmFOM' type='text/css' media='all' /> <style id='classic-theme-styles-inline-css'> /*! This file is auto-generated */ .wp-block-button__link{color:#fff;background-color:#32373c;border-radius:9999px;box-shadow:none;text-decoration:none;padding:calc(.667em + 2px) calc(1.333em + 2px);font-size:1.125em}.wp-block-file__button{background:#32373c;color:#fff;text-decoration:none} </style> <style id='global-styles-inline-css'> :root{--wp--preset--aspect-ratio--square: 1;--wp--preset--aspect-ratio--4-3: 4/3;--wp--preset--aspect-ratio--3-4: 3/4;--wp--preset--aspect-ratio--3-2: 3/2;--wp--preset--aspect-ratio--2-3: 2/3;--wp--preset--aspect-ratio--16-9: 16/9;--wp--preset--aspect-ratio--9-16: 9/16;--wp--preset--color--black: #000000;--wp--preset--color--cyan-bluish-gray: #abb8c3;--wp--preset--color--white: #ffffff;--wp--preset--color--pale-pink: #f78da7;--wp--preset--color--vivid-red: #cf2e2e;--wp--preset--color--luminous-vivid-orange: #ff6900;--wp--preset--color--luminous-vivid-amber: #fcb900;--wp--preset--color--light-green-cyan: #7bdcb5;--wp--preset--color--vivid-green-cyan: #00d084;--wp--preset--color--pale-cyan-blue: #8ed1fc;--wp--preset--color--vivid-cyan-blue: #0693e3;--wp--preset--color--vivid-purple: #9b51e0;--wp--preset--gradient--vivid-cyan-blue-to-vivid-purple: linear-gradient(135deg,rgba(6,147,227,1) 0%,rgb(155,81,224) 100%);--wp--preset--gradient--light-green-cyan-to-vivid-green-cyan: linear-gradient(135deg,rgb(122,220,180) 0%,rgb(0,208,130) 100%);--wp--preset--gradient--luminous-vivid-amber-to-luminous-vivid-orange: linear-gradient(135deg,rgba(252,185,0,1) 0%,rgba(255,105,0,1) 100%);--wp--preset--gradient--luminous-vivid-orange-to-vivid-red: linear-gradient(135deg,rgba(255,105,0,1) 0%,rgb(207,46,46) 100%);--wp--preset--gradient--very-light-gray-to-cyan-bluish-gray: linear-gradient(135deg,rgb(238,238,238) 0%,rgb(169,184,195) 100%);--wp--preset--gradient--cool-to-warm-spectrum: linear-gradient(135deg,rgb(74,234,220) 0%,rgb(151,120,209) 20%,rgb(207,42,186) 40%,rgb(238,44,130) 60%,rgb(251,105,98) 80%,rgb(254,248,76) 100%);--wp--preset--gradient--blush-light-purple: linear-gradient(135deg,rgb(255,206,236) 0%,rgb(152,150,240) 100%);--wp--preset--gradient--blush-bordeaux: linear-gradient(135deg,rgb(254,205,165) 0%,rgb(254,45,45) 50%,rgb(107,0,62) 100%);--wp--preset--gradient--luminous-dusk: linear-gradient(135deg,rgb(255,203,112) 0%,rgb(199,81,192) 50%,rgb(65,88,208) 100%);--wp--preset--gradient--pale-ocean: linear-gradient(135deg,rgb(255,245,203) 0%,rgb(182,227,212) 50%,rgb(51,167,181) 100%);--wp--preset--gradient--electric-grass: linear-gradient(135deg,rgb(202,248,128) 0%,rgb(113,206,126) 100%);--wp--preset--gradient--midnight: linear-gradient(135deg,rgb(2,3,129) 0%,rgb(40,116,252) 100%);--wp--preset--font-size--small: 13px;--wp--preset--font-size--medium: 20px;--wp--preset--font-size--large: 36px;--wp--preset--font-size--x-large: 42px;--wp--preset--spacing--20: 0.44rem;--wp--preset--spacing--30: 0.67rem;--wp--preset--spacing--40: 1rem;--wp--preset--spacing--50: 1.5rem;--wp--preset--spacing--60: 2.25rem;--wp--preset--spacing--70: 3.38rem;--wp--preset--spacing--80: 5.06rem;--wp--preset--shadow--natural: 6px 6px 9px rgba(0, 0, 0, 0.2);--wp--preset--shadow--deep: 12px 12px 50px rgba(0, 0, 0, 0.4);--wp--preset--shadow--sharp: 6px 6px 0px rgba(0, 0, 0, 0.2);--wp--preset--shadow--outlined: 6px 6px 0px -3px rgba(255, 255, 255, 1), 6px 6px rgba(0, 0, 0, 1);--wp--preset--shadow--crisp: 6px 6px 0px rgba(0, 0, 0, 1);}:where(.is-layout-flex){gap: 0.5em;}:where(.is-layout-grid){gap: 0.5em;}body .is-layout-flex{display: flex;}.is-layout-flex{flex-wrap: wrap;align-items: center;}.is-layout-flex > :is(*, div){margin: 0;}body .is-layout-grid{display: grid;}.is-layout-grid > :is(*, div){margin: 0;}:where(.wp-block-columns.is-layout-flex){gap: 2em;}:where(.wp-block-columns.is-layout-grid){gap: 2em;}:where(.wp-block-post-template.is-layout-flex){gap: 1.25em;}:where(.wp-block-post-template.is-layout-grid){gap: 1.25em;}.has-black-color{color: var(--wp--preset--color--black) !important;}.has-cyan-bluish-gray-color{color: var(--wp--preset--color--cyan-bluish-gray) !important;}.has-white-color{color: var(--wp--preset--color--white) !important;}.has-pale-pink-color{color: var(--wp--preset--color--pale-pink) !important;}.has-vivid-red-color{color: var(--wp--preset--color--vivid-red) !important;}.has-luminous-vivid-orange-color{color: var(--wp--preset--color--luminous-vivid-orange) !important;}.has-luminous-vivid-amber-color{color: var(--wp--preset--color--luminous-vivid-amber) !important;}.has-light-green-cyan-color{color: var(--wp--preset--color--light-green-cyan) !important;}.has-vivid-green-cyan-color{color: var(--wp--preset--color--vivid-green-cyan) !important;}.has-pale-cyan-blue-color{color: var(--wp--preset--color--pale-cyan-blue) !important;}.has-vivid-cyan-blue-color{color: var(--wp--preset--color--vivid-cyan-blue) !important;}.has-vivid-purple-color{color: var(--wp--preset--color--vivid-purple) !important;}.has-black-background-color{background-color: var(--wp--preset--color--black) !important;}.has-cyan-bluish-gray-background-color{background-color: var(--wp--preset--color--cyan-bluish-gray) !important;}.has-white-background-color{background-color: var(--wp--preset--color--white) !important;}.has-pale-pink-background-color{background-color: var(--wp--preset--color--pale-pink) !important;}.has-vivid-red-background-color{background-color: var(--wp--preset--color--vivid-red) !important;}.has-luminous-vivid-orange-background-color{background-color: var(--wp--preset--color--luminous-vivid-orange) !important;}.has-luminous-vivid-amber-background-color{background-color: var(--wp--preset--color--luminous-vivid-amber) !important;}.has-light-green-cyan-background-color{background-color: var(--wp--preset--color--light-green-cyan) !important;}.has-vivid-green-cyan-background-color{background-color: var(--wp--preset--color--vivid-green-cyan) !important;}.has-pale-cyan-blue-background-color{background-color: var(--wp--preset--color--pale-cyan-blue) !important;}.has-vivid-cyan-blue-background-color{background-color: var(--wp--preset--color--vivid-cyan-blue) !important;}.has-vivid-purple-background-color{background-color: var(--wp--preset--color--vivid-purple) !important;}.has-black-border-color{border-color: var(--wp--preset--color--black) !important;}.has-cyan-bluish-gray-border-color{border-color: var(--wp--preset--color--cyan-bluish-gray) !important;}.has-white-border-color{border-color: var(--wp--preset--color--white) !important;}.has-pale-pink-border-color{border-color: var(--wp--preset--color--pale-pink) !important;}.has-vivid-red-border-color{border-color: var(--wp--preset--color--vivid-red) !important;}.has-luminous-vivid-orange-border-color{border-color: var(--wp--preset--color--luminous-vivid-orange) !important;}.has-luminous-vivid-amber-border-color{border-color: var(--wp--preset--color--luminous-vivid-amber) !important;}.has-light-green-cyan-border-color{border-color: var(--wp--preset--color--light-green-cyan) !important;}.has-vivid-green-cyan-border-color{border-color: var(--wp--preset--color--vivid-green-cyan) !important;}.has-pale-cyan-blue-border-color{border-color: var(--wp--preset--color--pale-cyan-blue) !important;}.has-vivid-cyan-blue-border-color{border-color: var(--wp--preset--color--vivid-cyan-blue) !important;}.has-vivid-purple-border-color{border-color: var(--wp--preset--color--vivid-purple) !important;}.has-vivid-cyan-blue-to-vivid-purple-gradient-background{background: var(--wp--preset--gradient--vivid-cyan-blue-to-vivid-purple) !important;}.has-light-green-cyan-to-vivid-green-cyan-gradient-background{background: var(--wp--preset--gradient--light-green-cyan-to-vivid-green-cyan) !important;}.has-luminous-vivid-amber-to-luminous-vivid-orange-gradient-background{background: var(--wp--preset--gradient--luminous-vivid-amber-to-luminous-vivid-orange) !important;}.has-luminous-vivid-orange-to-vivid-red-gradient-background{background: var(--wp--preset--gradient--luminous-vivid-orange-to-vivid-red) !important;}.has-very-light-gray-to-cyan-bluish-gray-gradient-background{background: var(--wp--preset--gradient--very-light-gray-to-cyan-bluish-gray) !important;}.has-cool-to-warm-spectrum-gradient-background{background: var(--wp--preset--gradient--cool-to-warm-spectrum) !important;}.has-blush-light-purple-gradient-background{background: var(--wp--preset--gradient--blush-light-purple) !important;}.has-blush-bordeaux-gradient-background{background: var(--wp--preset--gradient--blush-bordeaux) !important;}.has-luminous-dusk-gradient-background{background: var(--wp--preset--gradient--luminous-dusk) !important;}.has-pale-ocean-gradient-background{background: var(--wp--preset--gradient--pale-ocean) !important;}.has-electric-grass-gradient-background{background: var(--wp--preset--gradient--electric-grass) !important;}.has-midnight-gradient-background{background: var(--wp--preset--gradient--midnight) !important;}.has-small-font-size{font-size: var(--wp--preset--font-size--small) !important;}.has-medium-font-size{font-size: var(--wp--preset--font-size--medium) !important;}.has-large-font-size{font-size: var(--wp--preset--font-size--large) !important;}.has-x-large-font-size{font-size: var(--wp--preset--font-size--x-large) !important;} :where(.wp-block-post-template.is-layout-flex){gap: 1.25em;}:where(.wp-block-post-template.is-layout-grid){gap: 1.25em;} :where(.wp-block-columns.is-layout-flex){gap: 2em;}:where(.wp-block-columns.is-layout-grid){gap: 2em;} :root :where(.wp-block-pullquote){font-size: 1.5em;line-height: 1.6;} </style> <link rel='stylesheet' id='all-css-14' href='https://docs.parse.ly/wp-content/themes/parsely-docs/assets/build/main.css?m=1732566038g' type='text/css' media='all' /> <link rel="https://api.w.org/" href="https://docs.parse.ly/wp-json/" /><link rel="alternate" title="JSON" type="application/json" href="https://docs.parse.ly/wp-json/wp/v2/posts/4571" /><link rel="EditURI" type="application/rsd+xml" title="RSD" href="https://docs.parse.ly/xmlrpc.php?rsd" /> <meta name="generator" content="WordPress 6.7.1" /> <link rel='shortlink' href='https://docs.parse.ly/?p=4571' /> <link rel="alternate" title="oEmbed (JSON)" type="application/json+oembed" href="https://docs.parse.ly/wp-json/oembed/1.0/embed?url=https%3A%2F%2Fdocs.parse.ly%2Fapi%2F" /> <link rel="alternate" title="oEmbed (XML)" type="text/xml+oembed" href="https://docs.parse.ly/wp-json/oembed/1.0/embed?url=https%3A%2F%2Fdocs.parse.ly%2Fapi%2F&format=xml" /> <style>img#wpstats{display:none}</style> <meta name="parsely-title" content="The Parse.ly API: Overview, options and use" /> <meta name="parsely-link" content="https://docs.parse.ly/api/" /> <meta name="parsely-type" content="post" /> <meta name="parsely-pub-date" content="2022-10-19T19:31:39Z" /> <meta name="parsely-section" content="API" /> <meta name="parsely-author" content="joshua" />  <script> (function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start': new Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0], j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src= 'https://www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f); })(window,document,'script','dataLayer','GTM-PT2D8GF');</script>  <link rel="icon" href="https://docs.parse.ly/wp-content/uploads/sites/5/2024/09/cropped-WhiteLeafBlackGround.png?w=32" sizes="32x32" /> <link rel="icon" href="https://docs.parse.ly/wp-content/uploads/sites/5/2024/09/cropped-WhiteLeafBlackGround.png?w=192" sizes="192x192" /> <link rel="apple-touch-icon" href="https://docs.parse.ly/wp-content/uploads/sites/5/2024/09/cropped-WhiteLeafBlackGround.png?w=180" /> <meta name="msapplication-TileImage" content="https://docs.parse.ly/wp-content/uploads/sites/5/2024/09/cropped-WhiteLeafBlackGround.png?w=270" /> <style type="text/css" id="wp-custom-css"> /* Hide table borders on homepage */ .home .wp-block-table { border: none; } .home .wp-block-table th, .home .wp-block-table td { border: none; } </style> </head> <body class="post-template-default single single-post postid-4571 single-format-standard"> <a class="screen-reader-text-focusable" href="#site-content"> Skip to content</a> <div class="a8c-docs-layout"> <header class="a8c-docs-layout__header" role="banner"> <div class="a8c-docs-layout__header__inner"> <a class="a8c-docs-layout__header__brand" href="https://docs.parse.ly/" aria-label="Parse.ly Help & Support Documentation" > <span class="a8c-docs-layout__header__brand__text"> Documentation </span> </a>  <div class="a8c-docs-layout__header__search"> <div class="a8c-docs-search-form-header__wrapper"> <form class="a8c-docs-search-form" action="https://docs.parse.ly" method="get" role="search"> <label for="search" class="a8c-docs-search-form__label visually-hidden">Search</label> <input aria-label="search" class="a8c-docs-search-input a8c-docs-input" placeholder="Search the docs…" type="search" name="s" autocomplete="off" value=""> <button type="submit" class="a8c-docs-search-form__icon">Search</button> </form> </div> </div>  </div>  </header>  <div class="a8c-docs-layout__main" id="site-content"> <div class="a8c-docs-layout__main__inner"> <button aria-controls="menu-navigation-nav-mobile" aria-expanded="false" id="A8C_DOCS_MENU_BUTTON" class="a8c-docs-layout__toggle" onclick="this.setAttribute( 'aria-expanded', 'true' !== this.getAttribute( 'aria-expanded' ) )" > Menu</button> <nav aria-label="Main Menu" class="a8c-docs-layout__sidebar__mobile"> <div class="a8c-docs-search-form-sidebar__wrapper"> <form class="a8c-docs-search-form" action="https://docs.parse.ly" method="get" role="search"> <label for="search" class="a8c-docs-search-form__label visually-hidden">Search</label> <input aria-label="search" class="a8c-docs-search-input a8c-docs-input" placeholder="Search the docs…" type="search" name="s" autocomplete="off" value=""> <button type="submit" class="a8c-docs-search-form__icon">Search</button> </form> </div> <ul class="a8c-docs-sidebar-list"><li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-has-children menu-item-6655"><a href="https://docs.parse.ly/parsely-integration/">Basic Install</a> <button aria-expanded="false" aria-label="Submenu for Basic Install" class="a8c-docs-sidebar-list__toggle"></button> <ul class="sub-menu"> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-has-children menu-item-4672"><a href="https://docs.parse.ly/tracking-code-setup/">Tracking Code</a> <button aria-expanded="false" aria-label="Submenu for Tracking Code" class="a8c-docs-sidebar-list__toggle"></button> <ul class="sub-menu"> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-8279"><a href="https://docs.parse.ly/google-tag-manager/">Google Tag Manager</a></li> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-4605"><a href="https://docs.parse.ly/wordpress-plugin-setup/">WordPress Plugin</a></li> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-8281"><a href="https://docs.parse.ly/tracking-alternative-setup-options/">Alternative Methods</a></li> </ul> </li> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-has-children menu-item-4664"><a href="https://docs.parse.ly/metadata/">Metadata</a> <button aria-expanded="false" aria-label="Submenu for Metadata" class="a8c-docs-sidebar-list__toggle"></button> <ul class="sub-menu"> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-4741"><a href="https://docs.parse.ly/metatags/">Meta Tags</a></li> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-4738"><a href="https://docs.parse.ly/metadata-jsonld/">JSON-LD</a></li> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-4724"><a href="https://docs.parse.ly/network-syndication/">Network Syndication</a></li> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-4819"><a href="https://docs.parse.ly/crawler/">Crawler</a></li> </ul> </li> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-has-children menu-item-4858"><a href="https://docs.parse.ly/test-integration/">Test & Troubleshoot</a> <button aria-expanded="false" aria-label="Submenu for Test & Troubleshoot" class="a8c-docs-sidebar-list__toggle"></button> <ul class="sub-menu"> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-8597"><a href="https://docs.parse.ly/sandbox/">Sandbox</a></li> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-8599"><a href="https://docs.parse.ly/plugin-troubleshooting/">WordPress Plugin</a></li> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-8598"><a href="https://docs.parse.ly/troubleshooting-a-cloudflare-integration/">CloudFlare</a></li> </ul> </li> </ul> </li> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-has-children menu-item-7283"><a href="https://docs.parse.ly/add-on-features/">Advanced Install</a> <button aria-expanded="false" aria-label="Submenu for Advanced Install" class="a8c-docs-sidebar-list__toggle"></button> <ul class="sub-menu"> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-4729"><a href="https://docs.parse.ly/setting-up-audience-segments-parsely/">Audience Segments</a></li> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-7405"><a href="https://docs.parse.ly/setting-up-campaign-tracking-parsely/">Campaign Tracking</a></li> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-has-children menu-item-8282"><a href="https://docs.parse.ly/channels/">Channels</a> <button aria-expanded="false" aria-label="Submenu for Channels" class="a8c-docs-sidebar-list__toggle"></button> <ul class="sub-menu"> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-7248"><a href="https://docs.parse.ly/apple-news/">Apple News</a></li> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-4722"><a href="https://docs.parse.ly/google-amp/">Google AMP</a></li> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-4721"><a href="https://docs.parse.ly/mobile-sdk/">Mobile App Tracking</a></li> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-4727"><a href="https://docs.parse.ly/smartnews/">SmartNews</a></li> </ul> </li> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-7548"><a href="https://docs.parse.ly/set-up-conversion-tracking/">Conversions</a></li> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-8923"><a href="https://docs.parse.ly/gsc-integration-steps/">Google Search Console</a></li> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-5317"><a href="https://docs.parse.ly/video-tracking-v2/">Video Tracking</a></li> </ul> </li> <li class="menu-item menu-item-type-post_type menu-item-object-post current-menu-ancestor current-menu-parent menu-item-has-children menu-item-8284"><a href="https://docs.parse.ly/developer-resources/">Developer Resources</a> <button aria-expanded="true" aria-label="Submenu for Developer Resources" class="a8c-docs-sidebar-list__toggle"></button> <ul class="sub-menu"> <li class="menu-item menu-item-type-post_type menu-item-object-post current-menu-item menu-item-has-children menu-item-4574"><a href="https://docs.parse.ly/api/" aria-current="page">API</a> <button aria-expanded="true" aria-label="Submenu for API" class="a8c-docs-sidebar-list__toggle"></button> <ul class="sub-menu"> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-4576"><a href="https://docs.parse.ly/api-overview/">Overview</a></li> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-9195"><a href="https://docs.parse.ly/api-use-case/">Use Case</a></li> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-4586"><a href="https://docs.parse.ly/api-endpoints/">Endpoints</a></li> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-4575"><a href="https://docs.parse.ly/content-recommendations/">Recommendations</a></li> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-4578"><a href="https://docs.parse.ly/api-available-metrics/">Metrics, Date/Time</a></li> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-4596"><a href="https://docs.parse.ly/api-custom-metadata/">Custom Metadata</a></li> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-4582"><a href="https://docs.parse.ly/api-terms-of-use/">Terms of Use</a></li> </ul> </li> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-has-children menu-item-4643"><a href="https://docs.parse.ly/data-pipeline/">Data Pipeline</a> <button aria-expanded="false" aria-label="Submenu for Data Pipeline" class="a8c-docs-sidebar-list__toggle"></button> <ul class="sub-menu"> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-4651"><a href="https://docs.parse.ly/data-pipeline-metrics/">Metrics overview</a></li> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-4652"><a href="https://docs.parse.ly/data-pipeline-schema/">Raw data schema</a></li> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-4645"><a href="https://docs.parse.ly/data-pipeline-usecases/">Use cases</a></li> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-4648"><a href="https://docs.parse.ly/data-pipeline-code/">Code examples</a></li> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-4649"><a href="https://docs.parse.ly/data-pipeline-access/">Data access how-to</a></li> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-4647"><a href="https://docs.parse.ly/data-pipeline-getting-started/">Tips and advice for getting started</a></li> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-4646"><a href="https://docs.parse.ly/data-pipeline-common-questions/">Common questions</a></li> </ul> </li> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-7687"><a href="https://docs.parse.ly/sso/">Single Sign-On (SSO)</a></li> </ul> </li> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-has-children menu-item-8285"><a href="https://docs.parse.ly/user-guide/">User Guide</a> <button aria-expanded="false" aria-label="Submenu for User Guide" class="a8c-docs-sidebar-list__toggle"></button> <ul class="sub-menu"> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-8327"><a href="https://docs.parse.ly/course-one-getting-started/">Learning Courses</a></li> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-7481"><a href="https://docs.parse.ly/calculations-in-parsely/">Calculations</a></li> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-8595"><a href="https://docs.parse.ly/plugin-content-helper/">Content Helper</a></li> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-has-children menu-item-4795"><a href="https://docs.parse.ly/dashboard/">Dashboard</a> <button aria-expanded="false" aria-label="Submenu for Dashboard" class="a8c-docs-sidebar-list__toggle"></button> <ul class="sub-menu"> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-4624"><a href="https://docs.parse.ly/dashboard-overview/">Overview</a></li> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-4622"><a href="https://docs.parse.ly/posts/">Posts / Pages</a></li> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-6580"><a href="https://docs.parse.ly/parse-ly-video-tracking/">Video</a></li> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-7401"><a href="https://docs.parse.ly/authors/">Authors</a></li> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-4625"><a href="https://docs.parse.ly/sections/">Sections</a></li> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-4626"><a href="https://docs.parse.ly/tags/">Tags</a></li> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-7115"><a href="https://docs.parse.ly/referrers/">Referrers</a></li> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-4623"><a href="https://docs.parse.ly/using-campaign-metrics/">Campaigns</a></li> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-4628"><a href="https://docs.parse.ly/distributed-channels/">Channels</a></li> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-4629"><a href="https://docs.parse.ly/audience-segments/">Segments</a></li> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-4905"><a href="https://docs.parse.ly/conversions/">Conversions</a></li> </ul> </li> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-8823"><a href="https://docs.parse.ly/google-search-console/">Google Search Console</a></li> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-4876"><a href="https://docs.parse.ly/metrics-overview/">Metrics</a></li> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-has-children menu-item-4851"><a href="https://docs.parse.ly/reports/">Reports</a> <button aria-expanded="false" aria-label="Submenu for Reports" class="a8c-docs-sidebar-list__toggle"></button> <ul class="sub-menu"> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-7600"><a href="https://docs.parse.ly/create-new-report/">Create new report</a></li> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-4635"><a href="https://docs.parse.ly/reports-rerun-edit-delete/">Rerun / edit / delete</a></li> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-4639"><a href="https://docs.parse.ly/whats-difference-html-csv-xcl/">HTML / CSV / XLSX</a></li> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-8764"><a href="https://docs.parse.ly/audience-overview-report/">Audience Overview</a></li> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-5397"><a href="https://docs.parse.ly/bottom-listings-report/">Bottom Performers</a></li> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-7939"><a href="https://docs.parse.ly/reports-compare-over-time/">Compare over Time</a></li> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-7871"><a href="https://docs.parse.ly/author-and-sections-comparisons-report/">Comparisons</a></li> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-4638"><a href="https://docs.parse.ly/details-report/">Details</a></li> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-4636"><a href="https://docs.parse.ly/evergreen-report/">Evergreen</a></li> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-4637"><a href="https://docs.parse.ly/stats-over-time-report/">Stats Over Time</a></li> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-4642"><a href="https://docs.parse.ly/stats-over-time-export/">Stats Over Time Export</a></li> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-4641"><a href="https://docs.parse.ly/top-listings-report/">Top Performers</a></li> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-4640"><a href="https://docs.parse.ly/top-listings-export/">Top Performers Export</a></li> </ul> </li> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-has-children menu-item-8287"><a href="https://docs.parse.ly/tools/">Tools</a> <button aria-expanded="false" aria-label="Submenu for Tools" class="a8c-docs-sidebar-list__toggle"></button> <ul class="sub-menu"> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-4630"><a href="https://docs.parse.ly/benchmarks/">Benchmarks</a></li> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-4897"><a href="https://docs.parse.ly/comparison-mode/">Comparison Mode</a></li> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-8706"><a href="https://docs.parse.ly/dashboard-guide/">Dashboard Guide</a></li> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-4859"><a href="https://docs.parse.ly/using-dashboard-filters/">Filters</a></li> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-7254"><a href="https://docs.parse.ly/open-in-parse-ly-bookmarklet/">Open in Parse.ly</a></li> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-4663"><a href="https://docs.parse.ly/parsely-ios-mobile-app-screens-and-features/">Our iOS mobile app</a></li> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-8288"><a href="https://docs.parse.ly/whats-a-recrawl/">Update metadata</a></li> </ul> </li> </ul> </li> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-has-children menu-item-7340"><a href="https://docs.parse.ly/account/">Account Management 👤</a> <button aria-expanded="false" aria-label="Submenu for Account Management 👤" class="a8c-docs-sidebar-list__toggle"></button> <ul class="sub-menu"> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-has-children menu-item-4615"><a href="https://docs.parse.ly/user-management/">Users</a> <button aria-expanded="false" aria-label="Submenu for Users" class="a8c-docs-sidebar-list__toggle"></button> <ul class="sub-menu"> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-4617"><a href="https://docs.parse.ly/sites-networks/">Sites vs. Networks</a></li> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-4616"><a href="https://docs.parse.ly/user-roles-permissions/">Roles and Permissions</a></li> </ul> </li> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-4818"><a href="https://docs.parse.ly/alerts/">Alerts</a></li> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-7341"><a href="https://docs.parse.ly/can-i-share-data-with-individuals-who-do-not-have-a-parse-ly-login/">Shared Links</a></li> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-4618"><a href="https://docs.parse.ly/site-network-preferences/">Preferences</a></li> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-7259"><a href="https://docs.parse.ly/overlay/">Overlay</a></li> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-8413"><a href="https://docs.parse.ly/api-settings/">API Settings</a></li> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-8317"><a href="https://docs.parse.ly/network-rollup-site-groups/">Site Groups</a></li> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-7342"><a href="https://docs.parse.ly/billing/">Billing</a></li> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-7343"><a href="https://docs.parse.ly/parse-ly-usage/">Usage</a></li> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-7240"><a href="https://docs.parse.ly/goals-setup-and-best-practices/">Goals</a></li> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-8409"><a href="https://docs.parse.ly/account-settings/">Account Settings ⚙️</a></li> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-7344"><a href="https://docs.parse.ly/troubleshooting-dashboard-loading-issues/">Logging in</a></li> </ul> </li> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-has-children menu-item-4602"><a href="https://docs.parse.ly/privacy/">Data, Privacy, & Security</a> <button aria-expanded="false" aria-label="Submenu for Data, Privacy, & Security" class="a8c-docs-sidebar-list__toggle"></button> <ul class="sub-menu"> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-8800"><a href="https://docs.parse.ly/content-security-policy/">Content Security Policy</a></li> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-7498"><a href="https://docs.parse.ly/cookies/">Cookies</a></li> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-4820"><a href="https://docs.parse.ly/servers-and-infrastructure/">Servers and infrastructure</a></li> </ul> </li> </ul><ul class="a8c-docs-sidebar-footer is-style-muted"><li class="menu-item menu-item-type-custom menu-item-object-custom menu-item-6185"><a href="mailto:support@parsely.com">Contact Parse.ly Support</a></li> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-8732"><a href="https://docs.parse.ly/dashboard-release-notes/">Dashboard release notes</a></li> <li class="menu-item menu-item-type-custom menu-item-object-custom menu-item-8816"><a href="https://status.parsely.com/">Operational Status</a></li> <li class="menu-item menu-item-type-custom menu-item-object-custom menu-item-4361"><a href="https://parse.ly">Parse.ly Blog</a></li> <li class="menu-item menu-item-type-custom menu-item-object-custom menu-item-4362"><a href="https://docs.wpvip.com">WordPress VIP help</a></li> </ul> </nav>  <nav aria-label="Main menu" class="a8c-docs-layout__sidebar__desktop"> <ul class="a8c-docs-sidebar-list"><li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-has-children menu-item-6655"><a href="https://docs.parse.ly/parsely-integration/">Basic Install</a> <button aria-expanded="false" aria-label="Submenu for Basic Install" class="a8c-docs-sidebar-list__toggle"></button> <ul class="sub-menu"> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-has-children menu-item-4672"><a href="https://docs.parse.ly/tracking-code-setup/">Tracking Code</a> <button aria-expanded="false" aria-label="Submenu for Tracking Code" class="a8c-docs-sidebar-list__toggle"></button> <ul class="sub-menu"> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-8279"><a href="https://docs.parse.ly/google-tag-manager/">Google Tag Manager</a></li> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-4605"><a href="https://docs.parse.ly/wordpress-plugin-setup/">WordPress Plugin</a></li> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-8281"><a href="https://docs.parse.ly/tracking-alternative-setup-options/">Alternative Methods</a></li> </ul> </li> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-has-children menu-item-4664"><a href="https://docs.parse.ly/metadata/">Metadata</a> <button aria-expanded="false" aria-label="Submenu for Metadata" class="a8c-docs-sidebar-list__toggle"></button> <ul class="sub-menu"> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-4741"><a href="https://docs.parse.ly/metatags/">Meta Tags</a></li> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-4738"><a href="https://docs.parse.ly/metadata-jsonld/">JSON-LD</a></li> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-4724"><a href="https://docs.parse.ly/network-syndication/">Network Syndication</a></li> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-4819"><a href="https://docs.parse.ly/crawler/">Crawler</a></li> </ul> </li> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-has-children menu-item-4858"><a href="https://docs.parse.ly/test-integration/">Test & Troubleshoot</a> <button aria-expanded="false" aria-label="Submenu for Test & Troubleshoot" class="a8c-docs-sidebar-list__toggle"></button> <ul class="sub-menu"> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-8597"><a href="https://docs.parse.ly/sandbox/">Sandbox</a></li> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-8599"><a href="https://docs.parse.ly/plugin-troubleshooting/">WordPress Plugin</a></li> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-8598"><a href="https://docs.parse.ly/troubleshooting-a-cloudflare-integration/">CloudFlare</a></li> </ul> </li> </ul> </li> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-has-children menu-item-7283"><a href="https://docs.parse.ly/add-on-features/">Advanced Install</a> <button aria-expanded="false" aria-label="Submenu for Advanced Install" class="a8c-docs-sidebar-list__toggle"></button> <ul class="sub-menu"> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-4729"><a href="https://docs.parse.ly/setting-up-audience-segments-parsely/">Audience Segments</a></li> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-7405"><a href="https://docs.parse.ly/setting-up-campaign-tracking-parsely/">Campaign Tracking</a></li> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-has-children menu-item-8282"><a href="https://docs.parse.ly/channels/">Channels</a> <button aria-expanded="false" aria-label="Submenu for Channels" class="a8c-docs-sidebar-list__toggle"></button> <ul class="sub-menu"> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-7248"><a href="https://docs.parse.ly/apple-news/">Apple News</a></li> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-4722"><a href="https://docs.parse.ly/google-amp/">Google AMP</a></li> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-4721"><a href="https://docs.parse.ly/mobile-sdk/">Mobile App Tracking</a></li> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-4727"><a href="https://docs.parse.ly/smartnews/">SmartNews</a></li> </ul> </li> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-7548"><a href="https://docs.parse.ly/set-up-conversion-tracking/">Conversions</a></li> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-8923"><a href="https://docs.parse.ly/gsc-integration-steps/">Google Search Console</a></li> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-5317"><a href="https://docs.parse.ly/video-tracking-v2/">Video Tracking</a></li> </ul> </li> <li class="menu-item menu-item-type-post_type menu-item-object-post current-menu-ancestor current-menu-parent menu-item-has-children menu-item-8284"><a href="https://docs.parse.ly/developer-resources/">Developer Resources</a> <button aria-expanded="true" aria-label="Submenu for Developer Resources" class="a8c-docs-sidebar-list__toggle"></button> <ul class="sub-menu"> <li class="menu-item menu-item-type-post_type menu-item-object-post current-menu-item menu-item-has-children menu-item-4574"><a href="https://docs.parse.ly/api/" aria-current="page">API</a> <button aria-expanded="true" aria-label="Submenu for API" class="a8c-docs-sidebar-list__toggle"></button> <ul class="sub-menu"> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-4576"><a href="https://docs.parse.ly/api-overview/">Overview</a></li> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-9195"><a href="https://docs.parse.ly/api-use-case/">Use Case</a></li> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-4586"><a href="https://docs.parse.ly/api-endpoints/">Endpoints</a></li> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-4575"><a href="https://docs.parse.ly/content-recommendations/">Recommendations</a></li> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-4578"><a href="https://docs.parse.ly/api-available-metrics/">Metrics, Date/Time</a></li> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-4596"><a href="https://docs.parse.ly/api-custom-metadata/">Custom Metadata</a></li> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-4582"><a href="https://docs.parse.ly/api-terms-of-use/">Terms of Use</a></li> </ul> </li> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-has-children menu-item-4643"><a href="https://docs.parse.ly/data-pipeline/">Data Pipeline</a> <button aria-expanded="false" aria-label="Submenu for Data Pipeline" class="a8c-docs-sidebar-list__toggle"></button> <ul class="sub-menu"> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-4651"><a href="https://docs.parse.ly/data-pipeline-metrics/">Metrics overview</a></li> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-4652"><a href="https://docs.parse.ly/data-pipeline-schema/">Raw data schema</a></li> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-4645"><a href="https://docs.parse.ly/data-pipeline-usecases/">Use cases</a></li> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-4648"><a href="https://docs.parse.ly/data-pipeline-code/">Code examples</a></li> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-4649"><a href="https://docs.parse.ly/data-pipeline-access/">Data access how-to</a></li> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-4647"><a href="https://docs.parse.ly/data-pipeline-getting-started/">Tips and advice for getting started</a></li> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-4646"><a href="https://docs.parse.ly/data-pipeline-common-questions/">Common questions</a></li> </ul> </li> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-7687"><a href="https://docs.parse.ly/sso/">Single Sign-On (SSO)</a></li> </ul> </li> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-has-children menu-item-8285"><a href="https://docs.parse.ly/user-guide/">User Guide</a> <button aria-expanded="false" aria-label="Submenu for User Guide" class="a8c-docs-sidebar-list__toggle"></button> <ul class="sub-menu"> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-8327"><a href="https://docs.parse.ly/course-one-getting-started/">Learning Courses</a></li> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-7481"><a href="https://docs.parse.ly/calculations-in-parsely/">Calculations</a></li> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-8595"><a href="https://docs.parse.ly/plugin-content-helper/">Content Helper</a></li> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-has-children menu-item-4795"><a href="https://docs.parse.ly/dashboard/">Dashboard</a> <button aria-expanded="false" aria-label="Submenu for Dashboard" class="a8c-docs-sidebar-list__toggle"></button> <ul class="sub-menu"> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-4624"><a href="https://docs.parse.ly/dashboard-overview/">Overview</a></li> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-4622"><a href="https://docs.parse.ly/posts/">Posts / Pages</a></li> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-6580"><a href="https://docs.parse.ly/parse-ly-video-tracking/">Video</a></li> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-7401"><a href="https://docs.parse.ly/authors/">Authors</a></li> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-4625"><a href="https://docs.parse.ly/sections/">Sections</a></li> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-4626"><a href="https://docs.parse.ly/tags/">Tags</a></li> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-7115"><a href="https://docs.parse.ly/referrers/">Referrers</a></li> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-4623"><a href="https://docs.parse.ly/using-campaign-metrics/">Campaigns</a></li> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-4628"><a href="https://docs.parse.ly/distributed-channels/">Channels</a></li> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-4629"><a href="https://docs.parse.ly/audience-segments/">Segments</a></li> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-4905"><a href="https://docs.parse.ly/conversions/">Conversions</a></li> </ul> </li> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-8823"><a href="https://docs.parse.ly/google-search-console/">Google Search Console</a></li> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-4876"><a href="https://docs.parse.ly/metrics-overview/">Metrics</a></li> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-has-children menu-item-4851"><a href="https://docs.parse.ly/reports/">Reports</a> <button aria-expanded="false" aria-label="Submenu for Reports" class="a8c-docs-sidebar-list__toggle"></button> <ul class="sub-menu"> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-7600"><a href="https://docs.parse.ly/create-new-report/">Create new report</a></li> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-4635"><a href="https://docs.parse.ly/reports-rerun-edit-delete/">Rerun / edit / delete</a></li> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-4639"><a href="https://docs.parse.ly/whats-difference-html-csv-xcl/">HTML / CSV / XLSX</a></li> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-8764"><a href="https://docs.parse.ly/audience-overview-report/">Audience Overview</a></li> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-5397"><a href="https://docs.parse.ly/bottom-listings-report/">Bottom Performers</a></li> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-7939"><a href="https://docs.parse.ly/reports-compare-over-time/">Compare over Time</a></li> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-7871"><a href="https://docs.parse.ly/author-and-sections-comparisons-report/">Comparisons</a></li> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-4638"><a href="https://docs.parse.ly/details-report/">Details</a></li> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-4636"><a href="https://docs.parse.ly/evergreen-report/">Evergreen</a></li> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-4637"><a href="https://docs.parse.ly/stats-over-time-report/">Stats Over Time</a></li> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-4642"><a href="https://docs.parse.ly/stats-over-time-export/">Stats Over Time Export</a></li> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-4641"><a href="https://docs.parse.ly/top-listings-report/">Top Performers</a></li> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-4640"><a href="https://docs.parse.ly/top-listings-export/">Top Performers Export</a></li> </ul> </li> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-has-children menu-item-8287"><a href="https://docs.parse.ly/tools/">Tools</a> <button aria-expanded="false" aria-label="Submenu for Tools" class="a8c-docs-sidebar-list__toggle"></button> <ul class="sub-menu"> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-4630"><a href="https://docs.parse.ly/benchmarks/">Benchmarks</a></li> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-4897"><a href="https://docs.parse.ly/comparison-mode/">Comparison Mode</a></li> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-8706"><a href="https://docs.parse.ly/dashboard-guide/">Dashboard Guide</a></li> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-4859"><a href="https://docs.parse.ly/using-dashboard-filters/">Filters</a></li> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-7254"><a href="https://docs.parse.ly/open-in-parse-ly-bookmarklet/">Open in Parse.ly</a></li> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-4663"><a href="https://docs.parse.ly/parsely-ios-mobile-app-screens-and-features/">Our iOS mobile app</a></li> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-8288"><a href="https://docs.parse.ly/whats-a-recrawl/">Update metadata</a></li> </ul> </li> </ul> </li> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-has-children menu-item-7340"><a href="https://docs.parse.ly/account/">Account Management 👤</a> <button aria-expanded="false" aria-label="Submenu for Account Management 👤" class="a8c-docs-sidebar-list__toggle"></button> <ul class="sub-menu"> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-has-children menu-item-4615"><a href="https://docs.parse.ly/user-management/">Users</a> <button aria-expanded="false" aria-label="Submenu for Users" class="a8c-docs-sidebar-list__toggle"></button> <ul class="sub-menu"> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-4617"><a href="https://docs.parse.ly/sites-networks/">Sites vs. Networks</a></li> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-4616"><a href="https://docs.parse.ly/user-roles-permissions/">Roles and Permissions</a></li> </ul> </li> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-4818"><a href="https://docs.parse.ly/alerts/">Alerts</a></li> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-7341"><a href="https://docs.parse.ly/can-i-share-data-with-individuals-who-do-not-have-a-parse-ly-login/">Shared Links</a></li> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-4618"><a href="https://docs.parse.ly/site-network-preferences/">Preferences</a></li> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-7259"><a href="https://docs.parse.ly/overlay/">Overlay</a></li> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-8413"><a href="https://docs.parse.ly/api-settings/">API Settings</a></li> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-8317"><a href="https://docs.parse.ly/network-rollup-site-groups/">Site Groups</a></li> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-7342"><a href="https://docs.parse.ly/billing/">Billing</a></li> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-7343"><a href="https://docs.parse.ly/parse-ly-usage/">Usage</a></li> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-7240"><a href="https://docs.parse.ly/goals-setup-and-best-practices/">Goals</a></li> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-8409"><a href="https://docs.parse.ly/account-settings/">Account Settings ⚙️</a></li> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-7344"><a href="https://docs.parse.ly/troubleshooting-dashboard-loading-issues/">Logging in</a></li> </ul> </li> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-has-children menu-item-4602"><a href="https://docs.parse.ly/privacy/">Data, Privacy, & Security</a> <button aria-expanded="false" aria-label="Submenu for Data, Privacy, & Security" class="a8c-docs-sidebar-list__toggle"></button> <ul class="sub-menu"> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-8800"><a href="https://docs.parse.ly/content-security-policy/">Content Security Policy</a></li> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-7498"><a href="https://docs.parse.ly/cookies/">Cookies</a></li> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-4820"><a href="https://docs.parse.ly/servers-and-infrastructure/">Servers and infrastructure</a></li> </ul> </li> </ul><ul class="a8c-docs-sidebar-footer is-style-muted"><li class="menu-item menu-item-type-custom menu-item-object-custom menu-item-6185"><a href="mailto:support@parsely.com">Contact Parse.ly Support</a></li> <li class="menu-item menu-item-type-post_type menu-item-object-post menu-item-8732"><a href="https://docs.parse.ly/dashboard-release-notes/">Dashboard release notes</a></li> <li class="menu-item menu-item-type-custom menu-item-object-custom menu-item-8816"><a href="https://status.parsely.com/">Operational Status</a></li> <li class="menu-item menu-item-type-custom menu-item-object-custom menu-item-4361"><a href="https://parse.ly">Parse.ly Blog</a></li> <li class="menu-item menu-item-type-custom menu-item-object-custom menu-item-4362"><a href="https://docs.wpvip.com">WordPress VIP help</a></li> </ul> </nav>  <div class="a8c-docs-layout__main__content" id="a8c-docs-toc-scroll"> <div id="a8c-docs-toc-content" class="a8c-docs-layout__main__content__inner"> <div class="a8c-docs-layout__main__content__primary"> <main> <article class="a8c-docs-entry post-4571 post type-post status-publish format-standard hentry category-api" aria-label="The Parse.ly API: Overview, options and use" id="post-4571" > <header class="a8c-docs-entry__header"> <h1 class="a8c-docs-entry__title"> The Parse.ly API: Overview, options and use</h1> </header>  <div class="a8c-docs-entry__content"> <p>The Parse.ly API enables you to look at your top performing content and have a means of promoting this content throughout your site. </p> <div class="a8c-docs-note-block pro-tip"> <p><strong>Before you begin</strong></p> <p>Ensure that you’ve purchased the Parse.ly API by reviewing your contract. Contact your Relationship Manger with questions.</p> </div> <p>Admins can access the <a href="https://docs.parse.ly/api-settings/">API Settings</a> by navigating to the Account👤 menu in the Dashboard <a href="https://docs.parse.ly/api-top-10-endpoint/-bar/">top bar</a>.</p> <p><strong><a href="https://docs.parse.ly/api-overview/">Overview</a></strong><br>We cover the foundation of our API and provide instructions for making your first query</p> <p><strong><a href="https://docs.parse.ly/api-available-metrics/">Metrics, Date/Time Parameters</a></strong><br>Take a look at the metrics you can access as well as date/time parameters that you can pair in queries</p> <p><strong><a href="https://docs.parse.ly/api-endpoints/">Endpoints</a></strong><br>Find your most performant content and recommend it to your readers.</p> <p><strong><a href="https://docs.parse.ly/content-recommendations/">Recommendations</a></strong><br>Learn more about how the Parse.ly API can serve personalized content recommendations or recommendations around trending content</p> <p><a href="https://docs.parse.ly/api-browser/"><strong>API Browser</strong></a><br>Test your API calls here</p> <p><a href="https://docs.parse.ly/api-terms-of-use/"><strong>Legal</strong></a><br>Our API terms of use and other agreements</p> <p>Read more about our API and its use cases on <a href="https://blog.parse.ly/?s=API">our blog</a>.</p> </div>  <p class='a8c-docs-last-updated-text'>Last updated: November 07, 2024</p> </article>  </main> <footer class="a8c-docs-layout__main__content__footer"> <hr /> <p class="has-text-align-center a8c-docs-gutter-bottom-none font-small"> Documentation is licensed under a </p> <p class="has-text-align-center font-small"> <a href="https://creativecommons.org/licenses/by-sa/4.0/"> Creative Commons Attribution-ShareAlike 4.0 International License </a> </p> <div class="a8c-docs-automattic-block"> <p> <a href="https://automattic.com/"> An <span class="screen-reader-text">Automattic</span><svg class="svg-icon svg-icon-automattic" aria-hidden="true" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 200 15.4"><path d="M72.5 15.4c-5.1 0-8.4-3.7-8.4-7.5v-.4c0-3.9 3.3-7.5 8.4-7.5 5.1 0 8.4 3.6 8.4 7.5V8c0 3.8-3.3 7.4-8.4 7.4zm5.7-7.9c0-2.8-2-5.3-5.7-5.3s-5.7 2.5-5.7 5.3v.3c0 2.8 2 5.3 5.7 5.3s5.7-2.5 5.7-5.3v-.3z" fill="#3298CB"/><path d="M15 14.9l-1.9-3.6H4.7l-1.8 3.6H0L7.8.5H10l7.9 14.4H15zM8.8 3.3l-3.1 6h6.4l-3.3-6zm21.4 12.1c-5.2 0-7.6-2.8-7.6-6.5V.5h2.7V9c0 2.7 1.7 4.2 5.1 4.2 3.4 0 4.8-1.6 4.8-4.2V.5h2.7v8.4c0 3.6-2.3 6.5-7.7 6.5zM52.9 2.8v12.1h-2.7V2.8h-6.3V.5h15.3v2.2h-6.3zM105 14.9V3.5l-.7 1.3-6 10.1H97L91 4.8l-.7-1.3v11.4h-2.6V.5h3.7l5.7 9.9.7 1.2.7-1.2 5.6-9.9h3.7v14.4H105zm23.1 0l-1.9-3.6h-8.4l-1.8 3.6h-3L120.8.5h2.2l7.9 14.4h-2.8zm-6.2-11.6l-3.1 6h6.4l-3.3-6zm19.9-.5v12.1h-2.7V2.8h-6.3V.5h15.3v2.2h-6.3zm19.8 0v12.1h-2.7V2.8h-6.3V.5h15.3v2.2h-6.3zm12.9 12.1v-13c1.1 0 1.5-.6 1.5-1.4h1.1v14.4h-2.6zm23.8-10.3c-1.3-1.2-3.2-2.3-5.8-2.3-3.8 0-6 2.6-6 5.4V8c0 2.7 2.2 5.3 6.2 5.3 2.4 0 4.4-1.1 5.6-2.3l1.6 1.7c-1.6 1.6-4.3 2.9-7.4 2.9-5.4 0-8.7-3.5-8.7-7.4v-.6c0-3.9 3.6-7.6 8.9-7.6 3 0 5.8 1.3 7.3 2.9l-1.7 1.7zM74.3 5c.5.3.6 1 .3 1.5l-2.5 3.8c-.3.5-1 .6-1.5.3s-.6-1-.3-1.5l2.5-3.8c.4-.5 1-.6 1.5-.3z"/></svg> Creation </a> </p> </div>  </footer>  </div>  <div class="a8c-docs-layout__main__content__secondary"> <nav id="docs-toc-nav" class="a8c-docs-table-of-contents__sticky" aria-label="Table of Contents"> </nav> </div>  </div>  </div>  </div>  </div>  </div>   <script defer id="bilmur" data-provider="vip" data-service="k8s-a8c" src="https://s0.wp.com/wp-content/js/bilmur.min.js?m=202448"></script> <script type="text/javascript" src="https://docs.parse.ly/wp-content/themes/a8c-docs/assets/build/main.js?m=1732566038g" ></script><script type="text/javascript" src="https://stats.wp.com/e-202448.js" id="jetpack-stats-js" data-wp-strategy="defer"></script> <script type="text/javascript" id="jetpack-stats-js-after"> /* <![CDATA[ */ _stq = window._stq || []; _stq.push([ "view", JSON.parse("{\"v\":\"ext\",\"blog\":\"209021633\",\"post\":\"4571\",\"tz\":\"0\",\"srv\":\"docs.parse.ly\",\"hp\":\"vip\",\"j\":\"1:14.0\"}") ]); _stq.push([ "clickTrackerInit", "209021633", "4571" ]); /* ]]> */ </script> </body> </html>