The way to aggregate the analytics. Possible values are all (aggregate all data together), year (aggregate data on a yearly basis), month (aggregate data on a yearly basis), week (aggregate data on a yearly basis), day (aggregate data on a yearly basis), or hour (aggregate data on an hourly basis, limited to a time_range 7 days or less).
The end date of the aggregation period. The value of this property should be a string
in the format yyyy-mm-dd according to ISO 8601. If this is set to today, the current day is still
in progress and therefore only partial analytics data is returned until the day ends.
{"docsConfig":{"theme":"maple","$schema":"https://mintlify.com/docs.json","name":"Docs and guides","colors":{"primary":"#943AFC","light":"#943AFC","dark":"#943AFC"},"logo":{"light":"https://mintcdn.com/beyondwords/-xTOVbYlCFtcbESd/assets/images/beyondwords/logo-mono-light.svg?fit=max\u0026auto=format\u0026n=-xTOVbYlCFtcbESd\u0026q=85\u0026s=f7ef97de700b0d66a30f62003ea5e846","dark":"https://mintcdn.com/beyondwords/-xTOVbYlCFtcbESd/assets/images/beyondwords/logo-mono-dark.svg?fit=max\u0026auto=format\u0026n=-xTOVbYlCFtcbESd\u0026q=85\u0026s=029293973c9fcd45d9051658232abb68","href":"https://beyondwords.io"},"favicon":"https://mintcdn.com/beyondwords/LPNO5XJIxY-ynytX/favicon.svg?fit=max\u0026auto=format\u0026n=LPNO5XJIxY-ynytX\u0026q=85\u0026s=27326b9aa36c9b9d02daa183f90a22d9","api":{"openapi":"https://api.beyondwords.io/swagger/v1/swagger.yaml","mdx":{"server":"https://api.beyondwords.io"}},"navbar":{"links":[{"href":"mailto:[email protected]","label":"Email support"}],"primary":{"type":"button","label":"Dashboard","href":"https://dash.beyondwords.io"}},"footer":{"socials":{"x":"https://x.com/BeyondWords_io","linkedin":"https://www.linkedin.com/company/beyondwordsio"}},"contextual":{"options":["copy","view","chatgpt","claude","mcp"],"display":"header"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"beyondwords","hasAudioNarration":false,"actualSubdomain":"beyondwords","customDomains":["docs.beyondwords.io"],"gitSource":{"type":"github","owner":"beyondwords-io","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6adb2433fef607a6618480d8","collectionId":"9a7f01be-22bb-4065-9c51-69e2e842c2db","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6adb2433fef607a6618480d8"},"feedback":{"thumbs":true},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6adb2433fef607a6618480d8","clientVersion":"0.0.3965","searchFilterCounts":[{"language":"default","tag":"API reference","count":111},{"language":"default","tag":"Components","count":96},{"language":"default","tag":"Documentation","count":60},{"language":"default","tag":"Distribution","count":36},{"language":"default","tag":"Integrations","count":29},{"language":"default","tag":"React","count":29},{"language":"default","tag":"HTML","count":28},{"language":"default","tag":"Voices","count":25},{"language":"default","tag":"Content","count":21},{"language":"default","tag":"Player","count":18}]},"assistantConfig":{},"hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-v7-file-tree","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"per-site-search-delta","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-private-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-nav-generations","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"isAtlas":false,"googleFontsInlined":false},"customCss":[{"filePath":"assets/css/styles.css","content":"#navigation-items>ul li:nth-child(3){display:none}#navigation-items li#\\/docs-and-guides\\/changelog{display:none}#content-side-layout{max-height:80vh}img.icon{margin:0}"}],"page":{"pagePath":"full-api-reference/analytics/project-analytics","slug":"/full-api-reference/analytics/project-analytics","pageMetadata":{"noindex":true,"openapi":"get /projects/{id}/analytics","title":"Project analytics","description":"Retrieves analytics for a project","href":"/full-api-reference/analytics/project-analytics"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Retrieves analytics for a project\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"noindex":true,"openapi":"get /projects/{id}/analytics","title":"Project analytics","description":"Retrieves analytics for a project","href":"/full-api-reference/analytics/project-analytics"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/beyondwords/723443eabf3ede01/assets/js/script.js","/_mintlify/custom/beyondwords/0936094f27631aa2/assets/js/components-web-components.js"],"openApiReferenceData":{"operation":{"summary":"Project analytics","tags":["Analytics"],"description":"Retrieves analytics for a project","operationId":"project#analytics","parameters":["534e3400-1fa5-4365-9f9a-158115eeb148","2ea87f0e-5db6-426e-8793-189b4a572bd6","4f803e09-8f0b-4ac6-8cb1-18bc56765b9f","100d25d8-1d5f-4ce7-acc6-c72450995f3b","8575a5ff-9129-4b6d-813a-0f0544bf49d7","8e7dc3a0-86a7-4c24-a2a0-d7a99ac90896","5a4a68f1-c3de-4f64-802a-e8ac4d496f5a"],"security":["24145961-22e7-4da4-ab41-0c7b020e13e4"],"responses":{"200":"4dfd8bf3-7622-4971-89bb-62775abc63ca"},"method":"get","type":"path","servers":["3385dc30-b616-4ef6-933f-95aa88eb2189"],"path":"/projects/{id}/analytics","baseUrlOptions":["https://api.beyondwords.io/v1"],"title":"Project analytics","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"534e3400-1fa5-4365-9f9a-158115eeb148":{"name":"aggregation","in":"query","schema":{"type":"string","enum":["all","hour","day","week","month","year"],"isRequired":false,"description":"\n The way to aggregate the analytics. Possible values are all (aggregate all data together),\n year (aggregate data on a yearly basis), month (aggregate data on a yearly basis),\n week (aggregate data on a yearly basis), day (aggregate data on a yearly basis), or hour\n (aggregate data on an hourly basis, limited to a time_range 7 days or less).","uniqueKey":"","typeLabel":"enum\u003cstring>"},"required":false,"description":"\n The way to aggregate the analytics. Possible values are all (aggregate all data together),\n year (aggregate data on a yearly basis), month (aggregate data on a yearly basis),\n week (aggregate data on a yearly basis), day (aggregate data on a yearly basis), or hour\n (aggregate data on an hourly basis, limited to a time_range 7 days or less)."},"2ea87f0e-5db6-426e-8793-189b4a572bd6":{"name":"time_range[start]","in":"query","required":false,"description":"The start date of the aggregation period. The value of this property should be a string in\n the format yyyy-mm-dd according to ISO 8601.","schema":{"type":"string","isRequired":false,"description":"The start date of the aggregation period. The value of this property should be a string in\n the format yyyy-mm-dd according to ISO 8601.","uniqueKey":"","typeLabel":"string"}},"4f803e09-8f0b-4ac6-8cb1-18bc56765b9f":{"name":"time_range[end]","in":"query","required":false,"description":"The end date of the aggregation period. The value of this property should be a string\n in the format yyyy-mm-dd according to ISO 8601. If this is set to today, the current day is still\n in progress and therefore only partial analytics data is returned until the day ends.","schema":{"type":"string","isRequired":false,"description":"The end date of the aggregation period. The value of this property should be a string\n in the format yyyy-mm-dd according to ISO 8601. If this is set to today, the current day is still\n in progress and therefore only partial analytics data is returned until the day ends.","uniqueKey":"","typeLabel":"string"}},"100d25d8-1d5f-4ce7-acc6-c72450995f3b":{"name":"metrics[]","in":"query","schema":{"type":"array","items":{"type":"string","uniqueKey":"items.[INDEX]","typeLabel":"string"},"isRequired":false,"description":"The metrics that you want to fetch data for","uniqueKey":"","typeLabel":"string[]"},"required":false,"description":"The metrics that you want to fetch data for"},"8575a5ff-9129-4b6d-813a-0f0544bf49d7":{"name":"media_variants[]","in":"query","schema":{"type":"array","items":{"type":"string","enum":["article","summary"],"uniqueKey":"items.[INDEX]","typeLabel":"enum\u003cstring>"},"isRequired":false,"description":"The media variants to fetch data for","uniqueKey":"","typeLabel":"enum\u003cstring>[]"},"required":false,"description":"The media variants to fetch data for"},"8e7dc3a0-86a7-4c24-a2a0-d7a99ac90896":{"name":"media_formats[]","in":"query","schema":{"type":"array","items":{"type":"string","enum":["audio","video"],"uniqueKey":"items.[INDEX]","typeLabel":"enum\u003cstring>"},"isRequired":false,"description":"The media formats to fetch data for","uniqueKey":"","typeLabel":"enum\u003cstring>[]"},"required":false,"description":"The media formats to fetch data for"},"5a4a68f1-c3de-4f64-802a-e8ac4d496f5a":{"name":"access_tiers[]","in":"query","schema":{"type":"array","items":{"type":"string","uniqueKey":"items.[INDEX]","typeLabel":"string"},"isRequired":false,"description":"The access tiers to fetch data for","uniqueKey":"","typeLabel":"string[]"},"required":false,"description":"The access tiers to fetch data for"},"d1e47153-8299-4207-a526-83ca2217c95e":{"name":"id","in":"path","description":"project id","required":true,"schema":{"type":"string","isRequired":true,"description":"project id","uniqueKey":"","typeLabel":"string"}}},"responses":{"4dfd8bf3-7622-4971-89bb-62775abc63ca":{"description":"OK","content":{"application/json":{"examples":{"example":{"title":"example","value":[{"start":"2017-02-01T10:05:03Z,","player_impressions":{"total":67875276,"desktop":14265647,"tablet":998538,"mobile_web":52611091,"ios":0,"andriod":0},"listens":{"total":313957,"desktop":92501,"tablet":6751,"mobile_web":214705,"ios":0,"android":0},"listen_rate":{"total":0.46,"desktop":0.65,"tablet":0.68,"mobile_web":0.41,"ios":0,"android":0},"unique_listeners":{"total":86919,"desktop":18255,"tablet":1308,"mobile_web":67953,"ios":0,"android":0},"avg_listen_time":{"total":199,"desktop":216,"tablet":183,"mobile_web":190,"ios":0,"android":0},"avg_listen_duration":{"total":52.05,"desktop":52.89,"tablet":50.88,"mobile_web":51.6,"ios":0,"android":0},"listen_time":{"total":251364691,"desktop":98599149,"tablet":5830722,"mobile_web":146934820,"ios":0,"android":0},"listener_retention":{"total":[1257519,1085792,937625,804105,679397,562031,451122,345526,245664,148510],"desktop":[454770,400038,348792,300627,254450,210087,167446,126271,86868,48272],"tablet":[31818,27498,23544,20005,16728,13704,10874,8223,5752,3367],"mobile_web":[770931,658256,565289,483473,408219,338240,272802,211032,153044,96871],"ios":[0,0,0,0,0,0,0,0,0,0],"android":[0,0,0,0,0,0,0,0,0,0]}}]}},"schema":{"nullable":false,"type":"array","items":{"type":"object","properties":{"start":{"type":"string","format":"date-time","description":"The start date of the aggregation period (ISO 8601).","uniqueKey":"items.[INDEX].start","typeLabel":"string\u003cdate-time>"},"player_impressions":{"type":"object","properties":{"total":{"type":"integer","description":"Total player loads in the period","uniqueKey":"items.[INDEX].player_impressions.total","typeLabel":"integer"},"desktop":{"type":"integer","description":"Player loads on desktop devices","uniqueKey":"items.[INDEX].player_impressions.desktop","typeLabel":"integer"},"tablet":{"type":"integer","description":"Player loads on tablets","uniqueKey":"items.[INDEX].player_impressions.tablet","typeLabel":"integer"},"mobile_web":{"type":"integer","description":"Player loads on mobile web","uniqueKey":"items.[INDEX].player_impressions.mobile_web","typeLabel":"integer"},"ios":{"type":"integer","description":"Player loads on iOS devices","uniqueKey":"items.[INDEX].player_impressions.ios","typeLabel":"integer"},"android":{"type":"integer","description":"Player loads on Android devices","uniqueKey":"items.[INDEX].player_impressions.android","typeLabel":"integer"}},"uniqueKey":"items.[INDEX].player_impressions","typeLabel":"object"},"listens":{"type":"object","properties":{"total":{"type":"integer","description":"Total plays in the period","uniqueKey":"items.[INDEX].listens.total","typeLabel":"integer"},"desktop":{"type":"integer","description":"Plays on desktop devices","uniqueKey":"items.[INDEX].listens.desktop","typeLabel":"integer"},"tablet":{"type":"integer","description":"Plays on tablets","uniqueKey":"items.[INDEX].listens.tablet","typeLabel":"integer"},"mobile_web":{"type":"integer","description":"Plays on mobile web","uniqueKey":"items.[INDEX].listens.mobile_web","typeLabel":"integer"},"ios":{"type":"integer","description":"Plays on iOS devices","uniqueKey":"items.[INDEX].listens.ios","typeLabel":"integer"},"android":{"type":"integer","description":"Plays on Android devices","uniqueKey":"items.[INDEX].listens.android","typeLabel":"integer"}},"uniqueKey":"items.[INDEX].listens","typeLabel":"object"},"listen_rate":{"type":"object","properties":{"total":{"type":"number","description":"Percentage of impressions that resulted in a play (0–100)","uniqueKey":"items.[INDEX].listen_rate.total","typeLabel":"number"},"desktop":{"type":"number","description":"Desktop listen rate (0–100)","uniqueKey":"items.[INDEX].listen_rate.desktop","typeLabel":"number"},"tablet":{"type":"number","description":"Tablet listen rate (0–100)","uniqueKey":"items.[INDEX].listen_rate.tablet","typeLabel":"number"},"mobile_web":{"type":"number","description":"Mobile web listen rate (0–100)","uniqueKey":"items.[INDEX].listen_rate.mobile_web","typeLabel":"number"},"ios":{"type":"number","description":"iOS listen rate (0–100)","uniqueKey":"items.[INDEX].listen_rate.ios","typeLabel":"number"},"android":{"type":"number","description":"Android listen rate (0–100)","uniqueKey":"items.[INDEX].listen_rate.android","typeLabel":"number"}},"uniqueKey":"items.[INDEX].listen_rate","typeLabel":"object"},"unique_listeners":{"type":"object","properties":{"total":{"type":"integer","description":"Approximate unique browser profiles per domain counted once per period (HyperLogLog). This is not a unique person count, and users who opt out of analytics storage are excluded entirely.","uniqueKey":"items.[INDEX].unique_listeners.total","typeLabel":"integer"},"desktop":{"type":"integer","description":"Approximate unique browser profiles per domain on desktop devices (HyperLogLog). This is not a unique person count, and users who opt out of analytics storage are excluded entirely.","uniqueKey":"items.[INDEX].unique_listeners.desktop","typeLabel":"integer"},"tablet":{"type":"integer","description":"Approximate unique browser profiles per domain on tablet devices (HyperLogLog). This is not a unique person count, and users who opt out of analytics storage are excluded entirely.","uniqueKey":"items.[INDEX].unique_listeners.tablet","typeLabel":"integer"},"mobile_web":{"type":"integer","description":"Approximate unique browser profiles per domain on mobile web (HyperLogLog). This is not a unique person count, and users who opt out of analytics storage are excluded entirely.","uniqueKey":"items.[INDEX].unique_listeners.mobile_web","typeLabel":"integer"},"ios":{"type":"integer","description":"Approximate unique browser profiles per domain on iOS devices (HyperLogLog). This is not a unique person count, and users who opt out of analytics storage are excluded entirely.","uniqueKey":"items.[INDEX].unique_listeners.ios","typeLabel":"integer"},"android":{"type":"integer","description":"Approximate unique browser profiles per domain on Android devices (HyperLogLog). This is not a unique person count, and users who opt out of analytics storage are excluded entirely.","uniqueKey":"items.[INDEX].unique_listeners.android","typeLabel":"integer"}},"uniqueKey":"items.[INDEX].unique_listeners","typeLabel":"object"},"avg_listen_time":{"type":"object","properties":{"total":{"type":"integer","description":"Average play time per session in seconds (audio or video). This metric may be understated when play progress is stored as every 10% milestone event per session instead of only a final event.","uniqueKey":"items.[INDEX].avg_listen_time.total","typeLabel":"integer"},"desktop":{"type":"integer","description":"Average play time on desktop in seconds. This metric may be understated when play progress is stored as every 10% milestone event per session instead of only a final event.","uniqueKey":"items.[INDEX].avg_listen_time.desktop","typeLabel":"integer"},"tablet":{"type":"integer","description":"Average play time on tablets in seconds. This metric may be understated when play progress is stored as every 10% milestone event per session instead of only a final event.","uniqueKey":"items.[INDEX].avg_listen_time.tablet","typeLabel":"integer"},"mobile_web":{"type":"integer","description":"Average play time on mobile web in seconds. This metric may be understated when play progress is stored as every 10% milestone event per session instead of only a final event.","uniqueKey":"items.[INDEX].avg_listen_time.mobile_web","typeLabel":"integer"},"ios":{"type":"integer","description":"Average play time on iOS in seconds. This metric may be understated when play progress is stored as every 10% milestone event per session instead of only a final event.","uniqueKey":"items.[INDEX].avg_listen_time.ios","typeLabel":"integer"},"android":{"type":"integer","description":"Average play time on Android in seconds. This metric may be understated when play progress is stored as every 10% milestone event per session instead of only a final event.","uniqueKey":"items.[INDEX].avg_listen_time.android","typeLabel":"integer"}},"uniqueKey":"items.[INDEX].avg_listen_time","typeLabel":"object"},"avg_listen_duration":{"type":"object","properties":{"total":{"type":"number","description":"Average percentage of the item consumed (0-100). This metric may be understated when play progress is stored as every 10% milestone event per session instead of only a final event.","uniqueKey":"items.[INDEX].avg_listen_duration.total","typeLabel":"number"},"desktop":{"type":"number","description":"Desktop consumption percentage (0-100). This metric may be understated when play progress is stored as every 10% milestone event per session instead of only a final event.","uniqueKey":"items.[INDEX].avg_listen_duration.desktop","typeLabel":"number"},"tablet":{"type":"number","description":"Tablet consumption percentage (0-100). This metric may be understated when play progress is stored as every 10% milestone event per session instead of only a final event.","uniqueKey":"items.[INDEX].avg_listen_duration.tablet","typeLabel":"number"},"mobile_web":{"type":"number","description":"Mobile web consumption percentage (0-100). This metric may be understated when play progress is stored as every 10% milestone event per session instead of only a final event.","uniqueKey":"items.[INDEX].avg_listen_duration.mobile_web","typeLabel":"number"},"ios":{"type":"number","description":"iOS consumption percentage (0-100). This metric may be understated when play progress is stored as every 10% milestone event per session instead of only a final event.","uniqueKey":"items.[INDEX].avg_listen_duration.ios","typeLabel":"number"},"android":{"type":"number","description":"Android consumption percentage (0-100). This metric may be understated when play progress is stored as every 10% milestone event per session instead of only a final event.","uniqueKey":"items.[INDEX].avg_listen_duration.android","typeLabel":"number"}},"uniqueKey":"items.[INDEX].avg_listen_duration","typeLabel":"object"},"listen_time":{"type":"object","properties":{"total":{"type":"integer","description":"Total play time in milliseconds (audio or video)","uniqueKey":"items.[INDEX].listen_time.total","typeLabel":"integer"},"desktop":{"type":"integer","description":"Total play time on desktop (ms)","uniqueKey":"items.[INDEX].listen_time.desktop","typeLabel":"integer"},"tablet":{"type":"integer","description":"Total play time on tablets (ms)","uniqueKey":"items.[INDEX].listen_time.tablet","typeLabel":"integer"},"mobile_web":{"type":"integer","description":"Total play time on mobile web (ms)","uniqueKey":"items.[INDEX].listen_time.mobile_web","typeLabel":"integer"},"ios":{"type":"integer","description":"Total play time on iOS (ms)","uniqueKey":"items.[INDEX].listen_time.ios","typeLabel":"integer"},"android":{"type":"integer","description":"Total play time on Android (ms)","uniqueKey":"items.[INDEX].listen_time.android","typeLabel":"integer"}},"uniqueKey":"items.[INDEX].listen_time","typeLabel":"object"},"listener_retention":{"type":"object","properties":{"total":{"type":"array","items":{"type":"integer","uniqueKey":"items.[INDEX].listener_retention.total.items.[INDEX]","typeLabel":"integer"},"description":"Retention curve as an array of percentages (0–100)","uniqueKey":"items.[INDEX].listener_retention.total","typeLabel":"integer[]"},"desktop":{"type":"array","items":{"type":"integer","uniqueKey":"items.[INDEX].listener_retention.desktop.items.[INDEX]","typeLabel":"integer"},"uniqueKey":"items.[INDEX].listener_retention.desktop","typeLabel":"integer[]"},"tablet":{"type":"array","items":{"type":"integer","uniqueKey":"items.[INDEX].listener_retention.tablet.items.[INDEX]","typeLabel":"integer"},"uniqueKey":"items.[INDEX].listener_retention.tablet","typeLabel":"integer[]"},"mobile_web":{"type":"array","items":{"type":"integer","uniqueKey":"items.[INDEX].listener_retention.mobile_web.items.[INDEX]","typeLabel":"integer"},"uniqueKey":"items.[INDEX].listener_retention.mobile_web","typeLabel":"integer[]"},"ios":{"type":"array","items":{"type":"integer","uniqueKey":"items.[INDEX].listener_retention.ios.items.[INDEX]","typeLabel":"integer"},"uniqueKey":"items.[INDEX].listener_retention.ios","typeLabel":"integer[]"},"android":{"type":"array","items":{"type":"integer","uniqueKey":"items.[INDEX].listener_retention.android.items.[INDEX]","typeLabel":"integer"},"uniqueKey":"items.[INDEX].listener_retention.android","typeLabel":"integer[]"}},"uniqueKey":"items.[INDEX].listener_retention","typeLabel":"object"}},"uniqueKey":"items.[INDEX]","typeLabel":"object"},"uniqueKey":"","typeLabel":"object[]"},"exampleType":"examples"}},"headers":{"X-BeyondWords-Aggregation":{"description":"Analytics aggregation","schema":{"type":"string"},"required":false},"X-BeyondWords-Time-Range-Start":{"description":"Analytics start time","schema":{"type":"string"},"required":false},"X-BeyondWords-Time-Range-End":{"description":"Analytics end time","schema":{"type":"string"},"required":false}},"exampleType":"examples"}},"security":{"24145961-22e7-4da4-ab41-0c7b020e13e4":{"apiKey":{"type":"apiKey","name":"X-Api-Key","in":"header","scopes":[],"schemeName":"apiKey"}}},"servers":{"3385dc30-b616-4ef6-933f-95aa88eb2189":{"url":"https://api.beyondwords.io/v1"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","name":"X-Api-Key","in":"header","scopes":[],"schemeName":"apiKey"},"schema":{"title":"X-Api-Key","type":"string","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"apiKey","name":"X-Api-Key"}],"title":"apiKey"}]},"originalFileLocation":"https://api.beyondwords.io/swagger/v1/swagger.yaml"},"subdomain":"beyondwords","siteName":"Docs and guides","title":"Project analytics - Docs and guides","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2025-08-07T06:24:51.176Z","originalFileLocation":"full-api-reference/analytics/project-analytics.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Retrieves analytics for a project\">\u003cmeta data-mint-head name=\"application-name\" content=\"Docs and guides\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003cmeta data-mint-head name=\"robots\" content=\"noindex\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/beyondwords/XS-CwsB9cNWQe75s/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/beyondwords/XS-CwsB9cNWQe75s/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/beyondwords/XS-CwsB9cNWQe75s/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/beyondwords/XS-CwsB9cNWQe75s/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/beyondwords/XS-CwsB9cNWQe75s/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/beyondwords/XS-CwsB9cNWQe75s/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/beyondwords/XS-CwsB9cNWQe75s/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/beyondwords/XS-CwsB9cNWQe75s/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/beyondwords/XS-CwsB9cNWQe75s/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Project analytics - Docs and guides\">\u003cmeta data-mint-head property=\"og:description\" content=\"Retrieves analytics for a project\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Docs and guides\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.beyondwords.io/full-api-reference/analytics/project-analytics\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://beyondwords.mintlify.app/_mintlify/api/og/v2?division=Projects\u0026amp;title=Project+analytics\u0026amp;description=Retrieves+analytics+for+a+project\u0026amp;theme=da5a4d958d74bb06b00d7af5\u0026amp;signature=85431f9b8cfccc3d9f4981bd40992b78e35fedb5be4523ed90076a766913b7fa\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Project analytics - Docs and guides\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Retrieves analytics for a project\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://beyondwords.mintlify.app/_mintlify/api/og/v2?division=Projects\u0026amp;title=Project+analytics\u0026amp;description=Retrieves+analytics+for+a+project\u0026amp;theme=da5a4d958d74bb06b00d7af5\u0026amp;signature=85431f9b8cfccc3d9f4981bd40992b78e35fedb5be4523ed90076a766913b7fa\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/beyondwords/XS-CwsB9cNWQe75s/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Docs and guides\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#943AFC\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.beyondwords.io/full-api-reference/analytics/project-analytics\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/full-api-reference/analytics/project-analytics.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Docs and guides\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Docs and guides","nav":{"global":null,"anchors":[{"anchor":"Documentation","icon":"book-open","pages":[{"title":"Documentation","href":"/docs-and-guides/get-started/introduction"}]},{"anchor":"API reference","icon":"rectangle-terminal","pages":[{"title":"API reference","href":"/api-reference/overview"}]},{"anchor":"Full reference","icon":"rectangle-terminal","groups":[{"group":"Getting started","pages":[{"title":"Overview","href":"/full-api-reference/overview"}]},{"group":"Content","pages":[{"group":"Items","pages":[{"group":"Developer guide","pages":[{"title":"Generating content","sidebarTitle":"Overview","href":"/api-reference/content/introduction"},{"title":"Content object","sidebarTitle":"Content object","href":"/api-reference/content/overview"},{"title":"Processing types","sidebarTitle":"Processing types","href":"/api-reference/content/processing-types"},{"title":"Replace audio","sidebarTitle":"Replace audio","href":"/api-reference/content/replace-audio"},{"title":"Syndication","sidebarTitle":"Syndication","href":"/api-reference/content/syndicated"}]},{"openapi":"post /projects/{project_id}/content","title":"Create content item","href":"/full-api-reference/content/create"},{"openapi":"get /projects/{project_id}/content/{id}","title":"Get content item","href":"/full-api-reference/content/show"},{"openapi":"put /projects/{project_id}/content/{id}","title":"Update content item","href":"/full-api-reference/content/update"},{"openapi":"delete /projects/{project_id}/content/{id}","title":"Delete content item","href":"/full-api-reference/content/delete"},{"openapi":"post /projects/{project_id}/content/{id}/regenerate","title":"Regenerate content","href":"/full-api-reference/content/regenerate"},{"title":"Summarize content","openapi":"post /projects/{project_id}/content/{id}/summarize","href":"/full-api-reference/content/summarize"},{"title":"Upload file","openapi":"post /upload","href":"/full-api-reference/content/upload"},{"openapi":"get /projects/{project_id}/content","title":"List content items","href":"/full-api-reference/content/list"},{"title":"Duplicate content","openapi":"post /projects/{project_id}/content/{id}/duplicate","href":"/full-api-reference/content/duplicate"},{"title":"Get content search fields","openapi":"get /projects/{project_id}/content/search_fields","href":"/full-api-reference/content/search-fields"},{"title":"Search content assets","openapi":"post /projects/{project_id}/content/assets/search","href":"/full-api-reference/content/search-assets"},{"title":"Get content asset","openapi":"get /projects/{project_id}/content/assets/{asset_id}","href":"/full-api-reference/content/get-asset"}]}]},{"group":"Extraction","pages":[{"group":"Filters","pages":[{"title":"Content filters overview","sidebarTitle":"Overview","href":"/full-api-reference/content-filters/overview"},{"title":"List content filters","openapi":"get /html_filters","href":"/full-api-reference/content-filters/list"},{"title":"Create content filter","openapi":"post /html_filters","href":"/full-api-reference/content-filters/create"},{"title":"Get content filter","openapi":"get /html_filters/{id}","href":"/full-api-reference/content-filters/show"},{"title":"Update content filter","openapi":"put /html_filters/{id}","href":"/full-api-reference/content-filters/update"},{"title":"Delete content filter","openapi":"delete /html_filters/{id}","href":"/full-api-reference/content-filters/delete"}]},{"group":"Extraction settings","pages":[{"title":"Get content extraction settings","openapi":"get /projects/{project_id}/content_extraction_settings","href":"/full-api-reference/content-extraction-settings/show"},{"title":"Update content extraction settings","openapi":"put /projects/{project_id}/content_extraction_settings","href":"/full-api-reference/content-extraction-settings/update"}]},{"group":"Preprocessing settings","pages":[{"title":"Get preprocessing settings","openapi":"get /projects/{project_id}/preprocessing_settings","href":"/full-api-reference/preprocessing-settings/show"},{"title":"Update preprocessing settings","openapi":"put /projects/{project_id}/preprocessing_settings","href":"/full-api-reference/preprocessing-settings/update"}]}]},{"group":"Pronunciation settings","pages":[{"openapi":"get /rules","title":"List rules","href":"/full-api-reference/rules/list"},{"openapi":"post /rules","title":"Create rule","href":"/full-api-reference/rules/create"},{"openapi":"get /rules/{id}","title":"Get rule","href":"/full-api-reference/rules/show"},{"openapi":"put /rules/{id}","title":"Update rule","href":"/full-api-reference/rules/update"},{"openapi":"delete /rules/{id}","title":"Delete rule","href":"/full-api-reference/rules/delete"},{"openapi":"post /rules/{id}/regenerate_preview","title":"Regenerate rule preview","href":"/full-api-reference/rules/regenerate-preview"},{"openapi":"post /rules/preview","title":"Preview rule audio","href":"/full-api-reference/rules/preview"},{"openapi":"get /rules/phonemes","title":"List rule phonemes","href":"/full-api-reference/rules/phonemes"},{"openapi":"post /rules/transcribe","title":"Transcribe rule text","href":"/full-api-reference/rules/transcribe"},{"openapi":"post /rules/matches","title":"Match rule text","href":"/full-api-reference/rules/matches"}]},{"group":"Summary settings","pages":[{"title":"Get project summary settings","openapi":"get /projects/{project_id}/summarization_settings","href":"/full-api-reference/summarization-settings/show"},{"title":"Update project summary settings","openapi":"put /projects/{project_id}/summarization_settings","href":"/full-api-reference/summarization-settings/update"},{"group":"Summary templates","pages":[{"title":"List summary templates","openapi":"get /summarization_settings_templates","href":"/full-api-reference/summarization-settings-templates/list"},{"title":"Create summary template","openapi":"post /summarization_settings_templates","href":"/full-api-reference/summarization-settings-templates/create"},{"title":"Get summary template","openapi":"get /summarization_settings_templates/{slug}","href":"/full-api-reference/summarization-settings-templates/show"},{"title":"Update summary template","openapi":"put /summarization_settings_templates/{slug}","href":"/full-api-reference/summarization-settings-templates/update"},{"title":"Delete summary template","openapi":"delete /summarization_settings_templates/{slug}","href":"/full-api-reference/summarization-settings-templates/delete"}]}]},{"group":"Video settings","pages":[{"openapi":"get /projects/{project_id}/video_settings","title":"Get video settings","href":"/full-api-reference/video-settings/show"},{"openapi":"put /projects/{project_id}/video_settings","title":"Update video settings","href":"/full-api-reference/video-settings/update"},{"group":"Video templates","pages":[{"openapi":"get /video_settings_templates","title":"List video settings templates","href":"/full-api-reference/video-settings-templates/list"},{"openapi":"post /video_settings_templates","title":"Create video settings template","href":"/full-api-reference/video-settings-templates/create"},{"openapi":"get /video_settings_templates/{slug}","title":"Get video settings template","href":"/full-api-reference/video-settings-templates/show"},{"openapi":"put /video_settings_templates/{slug}","title":"Update video settings template","href":"/full-api-reference/video-settings-templates/update"},{"openapi":"delete /video_settings_templates/{slug}","title":"Delete video settings template","href":"/full-api-reference/video-settings-templates/delete"},{"title":"Preview video settings template","openapi":"post /video_settings_templates/preview","href":"/full-api-reference/video-settings-templates/preview"}]}]},{"group":"Background music settings","pages":[{"title":"List background tracks","openapi":"get /background_tracks","href":"/full-api-reference/background-tracks/list"},{"title":"Create background tracks","openapi":"post /background_tracks","href":"/full-api-reference/background-tracks/create"},{"title":"Get background track","openapi":"get /background_tracks/{id}","href":"/full-api-reference/background-tracks/show"},{"title":"Update background track","openapi":"put /background_tracks/{id}","href":"/full-api-reference/background-tracks/update"},{"title":"Delete background track","openapi":"delete /background_tracks/{id}","href":"/full-api-reference/background-tracks/delete"}]},{"group":"Voices","pages":[{"group":"Voices","pages":[{"title":"List voices","openapi":"get /organization/voices","href":"/full-api-reference/voices/list"},{"title":"Get voice","openapi":"get /organization/voices/{id}","href":"/full-api-reference/voices/show"},{"title":"Update voice","openapi":"put /organization/voices/{id}","href":"/full-api-reference/voices/update"},{"title":"Delete voice","openapi":"delete /organization/voices/{id}","href":"/full-api-reference/voices/delete"}]},{"group":"Voice generation","pages":[{"title":"Design voice previews","openapi":"post /organization/voices/design_previews","href":"/full-api-reference/voices/design-previews"},{"title":"Finalize voice design","openapi":"post /organization/voices/finalize_design","href":"/full-api-reference/voices/finalize-design"}]},{"group":"Speakers","pages":[{"title":"List speakers","openapi":"get /speakers","href":"/full-api-reference/speakers/list"},{"title":"Create speaker","openapi":"post /speakers","href":"/full-api-reference/speakers/create"},{"title":"Get speaker","openapi":"get /speakers/{id}","href":"/full-api-reference/speakers/show"},{"title":"Update speaker","openapi":"put /speakers/{id}","href":"/full-api-reference/speakers/update"},{"title":"Delete speaker","openapi":"delete /speakers/{id}","href":"/full-api-reference/speakers/delete"}]},{"group":"Voice cloning","pages":[{"title":"Create voice","openapi":"post /organization/voices","href":"/full-api-reference/voices/create"},{"title":"Clone instant voice","openapi":"post /organization/voices/{id}/clone","href":"/full-api-reference/voices/clone"}]},{"group":"Speaker verifications","pages":[{"title":"Get speaker verification","openapi":"get /organization/voices/{voice_id}/speaker_verification","href":"/full-api-reference/speaker-verifications/show"},{"title":"Create speaker verification","openapi":"post /organization/voices/{voice_id}/speaker_verification","href":"/full-api-reference/speaker-verifications/create"},{"title":"Update speaker verification","openapi":"put /organization/voices/{voice_id}/speaker_verification","href":"/full-api-reference/speaker-verifications/update"},{"title":"Delete speaker verification","openapi":"delete /organization/voices/{voice_id}/speaker_verification","href":"/full-api-reference/speaker-verifications/delete"}]},{"group":"Speaker verification evidences","pages":[{"title":"List speaker verification evidences","openapi":"get /organization/voices/{voice_id}/speaker_verification/evidences","href":"/full-api-reference/speaker-verification-evidences/list"},{"title":"Create speaker verification evidence","openapi":"post /organization/voices/{voice_id}/speaker_verification/evidences","href":"/full-api-reference/speaker-verification-evidences/create"},{"title":"Delete speaker verification evidence","openapi":"delete /organization/voices/{voice_id}/speaker_verification/evidences/{id}","href":"/full-api-reference/speaker-verification-evidences/delete"}]},{"group":"Languages","pages":[{"title":"List languages","openapi":"get /organization/languages","href":"/full-api-reference/languages/list"}]},{"group":"Project voice permissions","pages":[{"title":"List project voices","openapi":"get /organization/voices/permissions","href":"/full-api-reference/project-voices/list"},{"title":"Create a project voice","openapi":"post /organization/voices/permissions","href":"/full-api-reference/project-voices/create"},{"title":"Get project voice","openapi":"get /organization/voices/permissions/{id}","href":"/full-api-reference/project-voices/show"},{"title":"Delete a project voice","openapi":"delete /organization/voices/permissions/{id}","href":"/full-api-reference/project-voices/delete"}]}]},{"group":"Distribution","pages":[{"group":"Player","pages":[{"title":"Get player by content ID","openapi":"get /projects/{project_id}/player/by_content_id/{id}","href":"/full-api-reference/player/by-content-id"},{"title":"Get player by source ID","openapi":"get /projects/{project_id}/player/by_source_id/{id}","href":"/full-api-reference/player/by-source-id"},{"title":"Get player by source URL","openapi":"get /projects/{project_id}/player/by_source_url/{url}","href":"/full-api-reference/player/by-source-url"},{"title":"Get player by playlist ID","openapi":"get /projects/{project_id}/player/by_playlist_id/{id}","href":"/full-api-reference/player/by-playlist-id"},{"title":"Get player by multiple identifiers","openapi":"get /projects/{project_id}/player/by_identifiers/{array}","href":"/full-api-reference/player/by-identifiers"}]},{"group":"Player settings","pages":[{"title":"Get player settings","openapi":"get /projects/{project_id}/player_settings","href":"/full-api-reference/player-settings/show"},{"title":"Update player settings","openapi":"put /projects/{project_id}/player_settings","href":"/full-api-reference/player-settings/update"}]},{"group":"Access tiers","pages":[{"title":"List access tiers","openapi":"get /projects/{project_id}/player_settings/access_tiers","href":"/full-api-reference/access-tiers/list"},{"title":"Create access tier","openapi":"post /projects/{project_id}/player_settings/access_tiers","href":"/full-api-reference/access-tiers/create"},{"title":"Get access tier","openapi":"get /projects/{project_id}/player_settings/access_tiers/{id}","href":"/full-api-reference/access-tiers/show"},{"title":"Update access tier","openapi":"put /projects/{project_id}/player_settings/access_tiers/{id}","href":"/full-api-reference/access-tiers/update"}]},{"group":"Playlists","pages":[{"title":"List playlists","openapi":"get /projects/{project_id}/playlists","href":"/full-api-reference/playlists/list"},{"title":"Create playlist","openapi":"post /projects/{project_id}/playlists","href":"/full-api-reference/playlists/create"},{"title":"Get playlist","openapi":"get /projects/{project_id}/playlists/{id}","href":"/full-api-reference/playlists/show"},{"title":"Update playlist","openapi":"put /projects/{project_id}/playlists/{id}","href":"/full-api-reference/playlists/update"},{"title":"Delete playlist","openapi":"delete /projects/{project_id}/playlists/{id}","href":"/full-api-reference/playlists/delete"}]},{"group":"Podcast feeds","pages":[{"title":"Get podcast feed settings","openapi":"get /projects/{project_id}/playlists/{playlist_id}/settings","href":"/full-api-reference/podcast-feeds/get-settings"},{"title":"Update podcast feed settings","openapi":"put /projects/{project_id}/playlists/{playlist_id}/settings","href":"/full-api-reference/podcast-feeds/update-settings"}]}]},{"group":"Integrations","pages":[{"group":"Webhooks","pages":[{"title":"List webhooks","openapi":"get /projects/{project_id}/webhooks","href":"/full-api-reference/webhooks/list"},{"title":"Create webhook","openapi":"post /projects/{project_id}/webhooks","href":"/full-api-reference/webhooks/create"},{"title":"Get webhook","openapi":"get /projects/{project_id}/webhooks/{id}","href":"/full-api-reference/webhooks/show"},{"title":"Update webhook","openapi":"put /projects/{project_id}/webhooks/{id}","href":"/full-api-reference/webhooks/update"},{"title":"Delete webhook","openapi":"delete /projects/{project_id}/webhooks/{id}","href":"/full-api-reference/webhooks/delete"},{"title":"Test webhook","openapi":"post /projects/{project_id}/webhooks/test","href":"/full-api-reference/webhooks/test"}]},{"group":"RSS feed importer","pages":[{"title":"List RSS feed imports","openapi":"get /projects/{project_id}/integrations/rss_importer/feeds","href":"/full-api-reference/rss-feed/list"},{"title":"Create RSS feed import","openapi":"post /projects/{project_id}/integrations/rss_importer/feeds","href":"/full-api-reference/rss-feed/create"},{"title":"Get RSS feed import","openapi":"get /projects/{project_id}/integrations/rss_importer/feeds/{id}","href":"/full-api-reference/rss-feed/show"},{"title":"Update RSS feed import","openapi":"put /projects/{project_id}/integrations/rss_importer/feeds/{id}","href":"/full-api-reference/rss-feed/update"},{"title":"Delete RSS feed import","openapi":"delete /projects/{project_id}/integrations/rss_importer/feeds/{id}","href":"/full-api-reference/rss-feed/delete"},{"title":"Run RSS feed import","openapi":"post /projects/{project_id}/integrations/rss_importer/feeds/{id}/run","href":"/full-api-reference/rss-feed/run"},{"title":"Test RSS feed import","openapi":"post /projects/{project_id}/integrations/rss_importer/feeds/test","href":"/full-api-reference/rss-feed/test"}]},{"group":"Magic Embed","pages":[{"title":"Get Magic Embed settings","openapi":"get /projects/{project_id}/integrations/client_side","href":"/full-api-reference/magic-embed/show"},{"title":"Update Magic Embed settings","openapi":"put /projects/{project_id}/integrations/client_side","href":"/full-api-reference/magic-embed/update"}]},{"group":"Ghost","pages":[{"title":"Get Ghost integration","openapi":"get /projects/{project_id}/integrations/ghost","href":"/full-api-reference/ghost/show"},{"title":"Update Ghost integration","openapi":"put /projects/{project_id}/integrations/ghost","href":"/full-api-reference/ghost/update"},{"title":"Test Ghost integration","openapi":"post /projects/{project_id}/integrations/ghost/test","href":"/full-api-reference/ghost/test"},{"title":"Ghost posts webhook","openapi":"post /projects/{project_id}/integrations/ghost/posts","href":"/full-api-reference/ghost/posts"}]}]},{"group":"Analytics","pages":[{"group":"Organization","pages":[{"openapi":"get /organization/analytics","title":"Organization analytics","href":"/full-api-reference/analytics/organization-analytics"},{"title":"Get billing analytics","openapi":"get /organization/billing_analytics","href":"/full-api-reference/analytics/billing-analytics"}]},{"group":"Projects","pages":[{"openapi":"get /projects/analytics","title":"Projects analytics","description":"Retrieves an analytics overview for all projects within an organization","href":"/full-api-reference/analytics/projects-analytics"},{"openapi":"get /projects/{id}/analytics","title":"Project analytics","href":"/full-api-reference/analytics/project-analytics"}]},{"group":"Content","pages":[{"openapi":"get /projects/{project_id}/content/analytics","title":"Contents analytics","description":"Retrieves an analytics overview for all content items in a project","href":"/full-api-reference/analytics/contents-analytics"},{"openapi":"get /projects/{project_id}/content/{id}/analytics","title":"Content analytics","href":"/full-api-reference/analytics/content-analytics"}]},{"group":"Ads","pages":[{"openapi":"get /projects/{project_id}/ads/analytics","title":"Ads analytics","href":"/full-api-reference/analytics/ads-analytics"},{"openapi":"get /projects/{project_id}/ads/{id}/analytics","title":"Ad analytics","href":"/full-api-reference/analytics/ad-analytics"}]}]},{"group":"Monetization","pages":[{"group":"Ads","pages":[{"title":"List ads","openapi":"get /projects/{project_id}/ads","href":"/full-api-reference/ads/list"},{"title":"Create ad","openapi":"post /projects/{project_id}/ads","href":"/full-api-reference/ads/create"},{"title":"Get ad","openapi":"get /projects/{project_id}/ads/{id}","href":"/full-api-reference/ads/show"},{"title":"Update ad","openapi":"put /projects/{project_id}/ads/{id}","href":"/full-api-reference/ads/update"},{"title":"Delete ad","openapi":"delete /projects/{project_id}/ads/{id}","href":"/full-api-reference/ads/delete"}]}]},{"group":"Organization","pages":[{"group":"Projects","pages":[{"openapi":"get /projects","title":"List projects","href":"/full-api-reference/projects/list"},{"openapi":"post /projects","title":"Create project","href":"/full-api-reference/projects/create"},{"openapi":"get /projects/{id}","title":"Get project","href":"/full-api-reference/projects/show"},{"openapi":"put /projects/{id}","title":"Update project","href":"/full-api-reference/projects/update"},{"openapi":"delete /projects/{id}","title":"Delete project","href":"/full-api-reference/projects/delete"},{"openapi":"get /projects/{id}/voices","title":"Get project voices","href":"/full-api-reference/projects/voices"}]},{"group":"Project members","pages":[{"title":"Get project members","openapi":"get /projects/{project_id}/members","href":"/full-api-reference/project-members/list"},{"openapi":"post /projects/{project_id}/members/add","title":"Add member to project","href":"/full-api-reference/project-members/add-member-to-project"},{"title":"Delete a project member","openapi":"delete /projects/{project_id}/members/{id}","href":"/full-api-reference/project-members/delete"}]},{"group":"Roles","pages":[{"title":"Get roles","openapi":"get /roles","href":"/full-api-reference/roles/list"},{"title":"Create a role","openapi":"post /roles","href":"/full-api-reference/roles/create"},{"title":"Get a role","openapi":"get /roles/{id}","href":"/full-api-reference/roles/show"},{"title":"Update a role","openapi":"put /roles/{id}","href":"/full-api-reference/roles/update"},{"title":"Delete a role","openapi":"delete /roles/{id}","href":"/full-api-reference/roles/delete"},{"title":"Get role permissions","openapi":"get /roles/permissions","href":"/full-api-reference/roles/permissions"}]},{"group":"Organization settings","pages":[{"title":"Get settings","openapi":"get /organization/settings","href":"/full-api-reference/organization-settings/show"},{"title":"Update quota settings","openapi":"put /organization/settings/quota","href":"/full-api-reference/organization-settings/update-quota-settings"}]},{"group":"Fonts","pages":[{"title":"List fonts","openapi":"get /organization/fonts","href":"/full-api-reference/fonts/list"},{"title":"Create font","openapi":"post /organization/fonts","href":"/full-api-reference/fonts/create"},{"title":"Get font","openapi":"get /organization/fonts/{id}","href":"/full-api-reference/fonts/show"},{"title":"Update font","openapi":"put /organization/fonts/{id}","href":"/full-api-reference/fonts/update"},{"title":"Delete font","openapi":"delete /organization/fonts/{id}","href":"/full-api-reference/fonts/delete"}]},{"group":"Plans","pages":[{"title":"List plans","openapi":"get /plans","href":"/full-api-reference/plans/list"}]},{"group":"Member projects","pages":[{"title":"Update member project","openapi":"put /members/{member_id}/projects/{id}","href":"/full-api-reference/member-projects/update"}]}]}]},{"anchor":"Components","icon":"puzzle-piece","pages":[{"title":"Components","href":"/components/react/introduction"}]},{"anchor":"Changelog","icon":"file-code","pages":[{"title":"Changelog","href":"/docs-and-guides/changelog"}]}]},"title":"Project analytics - Docs and guides","buildId":"dpl_849ArpqvBiCczQiT1Y1stNGpbqHT","deploymentId":"dpl_849ArpqvBiCczQiT1Y1stNGpbqHT","dynamics":["c2aa737661","b0f84f53ff","a9bb46feb3","2b790eda92"],"chunks":["OpenApiReferenceProvider-Bbp7I60D.js","utils-C3RIvJha.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DqD-vLt8.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-B31Loprg.js","snippetPresets-DKpk-b8t.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","Page-n7I5XbKb.js","ApiExamples-Cj65AhOR.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BXtn5gcC.js","shallow-RY2b03Cp.js","getApiPlaygroundDisplay-B0jeiPk3.js","CodeSnippet-CYgBjjwn.js","CodeSnippets-DOngDrYB.js","getPastedJson-DRQbJx-T.js","icon-CQiQCicY.js","MethodPill-BKTLdNtu.js","DuplicateIcon-B9jpAdat.js","createIcon-DCddRrXv.js","DynamicMarkdown-a8hUKrw6.js","SectionHeading-eECVV2eH.js","axios-vUo_bRtp.js","Markdown--GF7ZIpf.js","clsx-DZLdJUrt.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-2LoAhjKH.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-Zwc0ZncM.js"]}