{
"message": "end_date must be on or after start_date"
}
{
"message": "end_date must be on or after start_date"
}
{
"message": "end_date must be on or after start_date"
}
{
"message": "rate limit exceeded"
}
Analytics APIs
Ask AI Analytics
Publisher-facing Ask AI engagement rollup: summary KPIs plus a daily time-series. Numbers match the Dappier platform analytics dashboard for the same filters.
{
"message": "end_date must be on or after start_date"
}
{
"message": "end_date must be on or after start_date"
}
{
"message": "end_date must be on or after start_date"
}
{
"message": "rate limit exceeded"
}
Data is sourced from BigQuery — expect a 5–15 minute lag for the most recent events. All dates and timestamps are UTC. Responses are tenant-scoped to the API key and are rate limited (default 60 requests/minute per key; X-RateLimit-* headers are returned, 429 with Retry-After when exceeded) and cached server-side for up to 30 minutes (send Cache-Control: no-cache to skip the cache read; the X-Cache response header reports HIT, MISS, BYPASS, or DISABLED).
If either start_date or end_date is omitted, both default to the trailing 7-day window ending today UTC. Explicit ranges must be ≤ 365 days. widget_id is validated against the key’s tenant — an unknown or other-tenant id returns 400 widget_id not found.
creative_id / line_item_id / publisher_id match the publisher-supplied values the widget was loaded with. Once a session enters a sponsored conversation these fields are overridden with the matched DSP ad-render IDs, so filtering by your own publisher macros excludes most sponsored-conversation events. For sponsored conversion data use the Sponsored Conversations Analytics endpoint instead.
Inclusive start of the analytics window, formatted YYYY-MM-DD (UTC). Optional — if either start_date or end_date is omitted, both default to the trailing 7-day window ending today_UTC (i.e., start_date = today_UTC - 6).
Inclusive end of the analytics window, formatted YYYY-MM-DD (UTC). Optional — if either start_date or end_date is omitted, both default to the trailing 7-day window ending today_UTC. Must be on or after start_date; the total range must be ≤ 365 days.
External widget id (e.g. wd_...). Validated against the key's tenant — an unknown or other-tenant id returns 400 widget_id not found. Scopes results to that widget's AI agent. Omit for all of the tenant's widgets.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Dappier API Guide","colors":{"primary":"#8353E2","light":"#AB8AEB","dark":"#8353E2"},"logo":{"light":"https://mintcdn.com/dappier-20/GPubPuGcoHagv5PD/logo/dappier_logo.png?fit=max\u0026auto=format\u0026n=GPubPuGcoHagv5PD\u0026q=85\u0026s=9ab322122aad9dbcc85d331f1bc31c1d","dark":"https://mintcdn.com/dappier-20/GPubPuGcoHagv5PD/logo/dappier_logo_white.png?fit=max\u0026auto=format\u0026n=GPubPuGcoHagv5PD\u0026q=85\u0026s=edb347c59a1f656d157ce352138005b3"},"favicon":"https://mintcdn.com/dappier-20/GPubPuGcoHagv5PD/images/dappier_icon.png?fit=max\u0026auto=format\u0026n=GPubPuGcoHagv5PD\u0026q=85\u0026s=b6db99cdbd8ed22985ab881398fc09da","navbar":{"links":[{"href":"mailto:[email protected]","label":"Support"},{"href":"https://platform.dappier.com","label":"Dashboard"}],"primary":{"type":"button","label":"View on GitHub","href":"https://github.com/DappierAI"}},"footer":{"socials":{"instagram":"https://www.instagram.com/dappierai","twitter":"https://twitter.com/dappierai","linkedin":"https://www.linkedin.com/company/dappier","discord":"https://discord.com/invite/sSG77qEUSU","github":"https://github.com/DappierAI"}},"integrations":{"ga4":{"measurementId":"G-M7EJNC2L88"},"gtm":{"tagId":"GTM-NSH85QD9"}},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"Playground","icon":"play","href":"https://docs.dappier.com/api-reference/endpoint/real-time-search"},{"anchor":"Blog","icon":"blogger","href":"https://dappier.com/blog"},{"anchor":"Community","icon":"discord","href":"https://discord.com/invite/sSG77qEUSU"},{"anchor":"Talk to Us","icon":"comments","href":"https://dappier.com/demo/"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"dappier-20","hasAudioNarration":false,"actualSubdomain":"dappier-20","customDomains":["docs.dappier.com"],"gitSource":{"type":"github","owner":"dappierai","repo":"mintlify-docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6a8629283c7a2cffd4970e2d","collectionId":"a34a9142-e8c3-4198-b9d7-1caf8dbdcf3c","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6a8629283c7a2cffd4970e2d"},"entitlements":{},"buildId":"6a8629283c7a2cffd4970e2d:success","clientVersion":"0.0.3964","searchFilterCounts":[{"language":"default","tag":"Cookbook","count":43},{"language":"default","tag":"Integrations","count":25},{"language":"default","tag":"Platform Integrations","count":21},{"language":"default","tag":"Home","count":14},{"language":"default","tag":"Publishers","count":9},{"language":"default","tag":"API Reference","count":8},{"language":"default","tag":"Analytics APIs","count":4},{"language":"default","tag":"Zapier","count":4},{"language":"default","tag":"Agent.ai","count":3},{"language":"default","tag":"LlamaIndex","count":3}]},"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":[],"page":{"pagePath":"api-reference/endpoint/ask-ai-analytics","slug":"/api-reference/endpoint/ask-ai-analytics","pageMetadata":{"title":"Ask AI Analytics","openapi":"get /v1/analytics/ask-ai","description":"Publisher-facing Ask AI engagement rollup: summary KPIs plus a daily time-series. Numbers match the Dappier platform analytics dashboard for the same filters.","href":"/api-reference/endpoint/ask-ai-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: \"Publisher-facing Ask AI engagement rollup: summary KPIs plus a daily time-series. Numbers match the Dappier platform analytics dashboard for the same filters.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={code:`code`,p:`p`,strong:`strong`,..._provideComponents(),...props.components},{Info,Warning}=_components;if(!Info)_missingMdxReference(`Info`,true);if(!Warning)_missingMdxReference(`Warning`,true);return _jsxs(_Fragment,{children:[_jsx(Info,{children:_jsxs(_components.p,{children:[`Data is sourced from BigQuery — expect a `,_jsx(_components.strong,{children:`5–15 minute lag`}),` for the most recent events. All dates and timestamps are `,_jsx(_components.strong,{children:`UTC`}),`. Responses are tenant-scoped to the API key and are rate limited (default `,_jsx(_components.strong,{children:`60 requests/minute`}),` per key; `,_jsx(_components.code,{children:`X-RateLimit-*`}),` headers are returned, `,_jsx(_components.code,{children:`429`}),` with `,_jsx(_components.code,{children:`Retry-After`}),` when exceeded) and cached server-side for up to `,_jsx(_components.strong,{children:`30 minutes`}),` (send `,_jsx(_components.code,{children:`Cache-Control: no-cache`}),` to skip the cache read; the `,_jsx(_components.code,{children:`X-Cache`}),` response header reports `,_jsx(_components.code,{children:`HIT`}),`, `,_jsx(_components.code,{children:`MISS`}),`, `,_jsx(_components.code,{children:`BYPASS`}),`, or `,_jsx(_components.code,{children:`DISABLED`}),`).`]})}),`\n`,_jsx(Warning,{children:_jsxs(_components.p,{children:[`If either `,_jsx(_components.code,{children:`start_date`}),` or `,_jsx(_components.code,{children:`end_date`}),` is omitted, `,_jsx(_components.strong,{children:`both`}),` default to the trailing 7-day window ending today UTC. Explicit ranges must be ≤ `,_jsx(_components.strong,{children:`365 days`}),`. `,_jsx(_components.code,{children:`widget_id`}),` is validated against the key’s tenant — an unknown or other-tenant id returns `,_jsx(_components.code,{children:`400 widget_id not found`}),`.`]})}),`\n`,_jsx(Warning,{children:_jsxs(_components.p,{children:[_jsx(_components.code,{children:`creative_id`}),` / `,_jsx(_components.code,{children:`line_item_id`}),` / `,_jsx(_components.code,{children:`publisher_id`}),` match the publisher-supplied values the widget was loaded with. Once a session enters a sponsored conversation these fields are overridden with the matched DSP ad-render IDs, so filtering by your own publisher macros excludes most sponsored-conversation events. For sponsored conversion data use the Sponsored Conversations Analytics endpoint instead.`]})})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Ask AI Analytics","openapi":"get /v1/analytics/ask-ai","description":"Publisher-facing Ask AI engagement rollup: summary KPIs plus a daily time-series. Numbers match the Dappier platform analytics dashboard for the same filters.","href":"/api-reference/endpoint/ask-ai-analytics"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"summary":"Get Ask AI Analytics","description":"Publisher-facing Ask AI engagement rollup: summary KPIs plus a daily time-series. Numbers match the Dappier platform analytics dashboard for the same filters.","operationId":"get_AskAi_analytics","parameters":["9dae047e-dae6-4305-bbe1-17a6b0185a89","86027a25-f5dd-4ab5-b0c0-2c050896965d","4ec1dba9-20fe-4cf5-8efb-0c8e53b634e1","03f8c96c-0a14-4240-a3e5-99decef68e8b","106f6afa-db9a-47b2-b720-b35e6a0b9025","35507b86-8754-4352-a3a6-0475c7685349","fe895db4-ec2f-41bb-9109-1e58269c2d0a","6e4d27bd-e094-4ea0-ade3-eee11edf7bf3"],"responses":{"200":"ff2ed86c-173d-4280-b525-19b55f66b518","400":"798e5a5d-85ec-4535-996c-73ce376f2d52","401":"f387cd80-e718-4ccf-89a0-b99762a64eda","403":"6d3b3430-754f-4b87-b6f1-639713621dd3","429":"b7c9db89-33c7-4dda-bc7b-14597eaecd10","500":"ccdb9e1e-ce91-4c82-ae3c-cf35d1489f4c"},"security":["6fdb50f3-fd97-4aee-8ddc-0bed97912374"],"method":"get","type":"path","servers":["3a48964c-e293-4b35-b889-b8ee02535690"],"path":"/v1/analytics/ask-ai","baseUrlOptions":["https://api.dappier.com"],"title":"Get Ask AI Analytics","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"9dae047e-dae6-4305-bbe1-17a6b0185a89":{"name":"start_date","in":"query","required":false,"description":"Inclusive start of the analytics window, formatted `YYYY-MM-DD` (UTC). Optional — if either `start_date` or `end_date` is omitted, both default to the trailing **7-day window** ending `today_UTC` (i.e., `start_date = today_UTC - 6`).","schema":{"type":"string","format":"date","example":"2026-04-01","isRequired":false,"description":"Inclusive start of the analytics window, formatted `YYYY-MM-DD` (UTC). Optional — if either `start_date` or `end_date` is omitted, both default to the trailing **7-day window** ending `today_UTC` (i.e., `start_date = today_UTC - 6`).","uniqueKey":"","typeLabel":"string\u003cdate>"}},"86027a25-f5dd-4ab5-b0c0-2c050896965d":{"name":"end_date","in":"query","required":false,"description":"Inclusive end of the analytics window, formatted `YYYY-MM-DD` (UTC). Optional — if either `start_date` or `end_date` is omitted, both default to the trailing **7-day window** ending `today_UTC`. Must be on or after `start_date`; the total range must be ≤ **365 days**.","schema":{"type":"string","format":"date","example":"2026-04-30","isRequired":false,"description":"Inclusive end of the analytics window, formatted `YYYY-MM-DD` (UTC). Optional — if either `start_date` or `end_date` is omitted, both default to the trailing **7-day window** ending `today_UTC`. Must be on or after `start_date`; the total range must be ≤ **365 days**.","uniqueKey":"","typeLabel":"string\u003cdate>"}},"4ec1dba9-20fe-4cf5-8efb-0c8e53b634e1":{"name":"widget_id","in":"query","required":false,"description":"External widget id (e.g. `wd_...`). Validated against the key's tenant — an unknown or other-tenant id returns `400 widget_id not found`. Scopes results to that widget's AI agent. Omit for all of the tenant's widgets.","schema":{"type":"string","example":"wd_92831","isRequired":false,"description":"External widget id (e.g. `wd_...`). Validated against the key's tenant — an unknown or other-tenant id returns `400 widget_id not found`. Scopes results to that widget's AI agent. Omit for all of the tenant's widgets.","uniqueKey":"","typeLabel":"string"}},"03f8c96c-0a14-4240-a3e5-99decef68e8b":{"name":"placement_id","in":"query","required":false,"description":"External placement id.","schema":{"type":"string","isRequired":false,"description":"External placement id.","uniqueKey":"","typeLabel":"string"}},"106f6afa-db9a-47b2-b720-b35e6a0b9025":{"name":"deployment_type","in":"query","required":false,"description":"Deployment type, e.g. `brand_agent`, `sponsored_conversation`, `embed`. Omit for all.","schema":{"type":"string","example":"brand_agent","isRequired":false,"description":"Deployment type, e.g. `brand_agent`, `sponsored_conversation`, `embed`. Omit for all.","uniqueKey":"","typeLabel":"string"}},"35507b86-8754-4352-a3a6-0475c7685349":{"name":"creative_id","in":"query","required":false,"description":"Publisher-supplied ad-tracking macro filter (HTML attribute on `\u003cdappier-ask-ai-widget>`).","schema":{"type":"string","isRequired":false,"description":"Publisher-supplied ad-tracking macro filter (HTML attribute on `\u003cdappier-ask-ai-widget>`).","uniqueKey":"","typeLabel":"string"}},"fe895db4-ec2f-41bb-9109-1e58269c2d0a":{"name":"line_item_id","in":"query","required":false,"description":"Publisher-supplied ad-tracking macro filter.","schema":{"type":"string","isRequired":false,"description":"Publisher-supplied ad-tracking macro filter.","uniqueKey":"","typeLabel":"string"}},"6e4d27bd-e094-4ea0-ade3-eee11edf7bf3":{"name":"publisher_id","in":"query","required":false,"description":"Publisher-supplied ad-tracking macro filter.","schema":{"type":"string","isRequired":false,"description":"Publisher-supplied ad-tracking macro filter.","uniqueKey":"","typeLabel":"string"}}},"responses":{"ff2ed86c-173d-4280-b525-19b55f66b518":{"description":"Engagement rollup for the requested window and filters.","content":{"application/json":{"schema":{"type":"object","title":"AskAiAnalyticsResponse","properties":{"success":{"type":"boolean","description":"Always `true` for a 200 response.","example":true,"uniqueKey":"success","typeLabel":"boolean"},"filters":{"type":"object","description":"Echoes back only the filters you supplied in the request.","properties":{"start_date":{"type":"string","format":"date","example":"2026-04-01","uniqueKey":"filters.start_date","typeLabel":"string\u003cdate>"},"end_date":{"type":"string","format":"date","example":"2026-04-30","uniqueKey":"filters.end_date","typeLabel":"string\u003cdate>"},"deployment_type":{"type":"string","example":"brand_agent","uniqueKey":"filters.deployment_type","typeLabel":"string"},"widget_id":{"type":"string","example":"wd_92831","uniqueKey":"filters.widget_id","typeLabel":"string"},"placement_id":{"type":"string","uniqueKey":"filters.placement_id","typeLabel":"string"},"creative_id":{"type":"string","example":"cr_123","uniqueKey":"filters.creative_id","typeLabel":"string"},"line_item_id":{"type":"string","uniqueKey":"filters.line_item_id","typeLabel":"string"},"publisher_id":{"type":"string","uniqueKey":"filters.publisher_id","typeLabel":"string"}},"uniqueKey":"filters","typeLabel":"object"},"summary":{"type":"object","description":"Full 13-metric rollup for the window. The block is internally self-consistent; all percentages are rounded to 2 decimals.","properties":{"widget_loads":{"type":"integer","description":"Times the widget script initialized on a page.","example":124550,"uniqueKey":"summary.widget_loads","typeLabel":"integer"},"viewable_sessions":{"type":"integer","description":"Sessions where the widget entered the viewport.","example":38122,"uniqueKey":"summary.viewable_sessions","typeLabel":"integer"},"viewability_rate":{"type":"number","description":"`viewable_sessions / widget_loads * 100`.","example":30.6,"uniqueKey":"summary.viewability_rate","typeLabel":"number"},"engagement_queries":{"type":"integer","description":"All user-originated queries — free-form, brand-agent, search, click-to-brand-agent, sponsored, automated follow-ups.","example":6421,"uniqueKey":"summary.engagement_queries","typeLabel":"integer"},"engagement_rate":{"type":"number","description":"`engagement_queries / viewable_sessions * 100`.","example":16.8,"uniqueKey":"summary.engagement_rate","typeLabel":"number"},"total_clicks":{"type":"integer","description":"Article-body + ad + amplify + brand-agent answer + brand-agent CTA clicks.","example":2310,"uniqueKey":"summary.total_clicks","typeLabel":"integer"},"article_clicks":{"type":"integer","description":"Subset of `total_clicks` on a URL inside the AI answer body.","example":1240,"uniqueKey":"summary.article_clicks","typeLabel":"integer"},"cta_clicks":{"type":"integer","description":"Subset of `total_clicks` on a brand-agent CTA button.","example":1070,"uniqueKey":"summary.cta_clicks","typeLabel":"integer"},"sessions":{"type":"integer","description":"Unique sessions with ≥1 engagement query.","example":5120,"uniqueKey":"summary.sessions","typeLabel":"integer"},"avg_session_duration_seconds":{"type":"integer","description":"Mean active time per engaged session (5s beacon resolution).","example":142,"uniqueKey":"summary.avg_session_duration_seconds","typeLabel":"integer"},"engagement_session_rate":{"type":"number","description":"`sessions / viewable_sessions * 100`.","example":13.4,"uniqueKey":"summary.engagement_session_rate","typeLabel":"number"},"total_session_time_seconds":{"type":"integer","description":"Sum of active time across engaged sessions.","example":727040,"uniqueKey":"summary.total_session_time_seconds","typeLabel":"integer"},"query_to_click_rate":{"type":"number","description":"`total_clicks / engagement_queries * 100`.","example":36,"uniqueKey":"summary.query_to_click_rate","typeLabel":"number"}},"uniqueKey":"summary","typeLabel":"object"},"daily_breakdown":{"type":"array","description":"Per-day subset for charting, ascending by date.","items":{"type":"object","properties":{"date":{"type":"string","format":"date","example":"2026-04-28","uniqueKey":"daily_breakdown.items.[INDEX].date","typeLabel":"string\u003cdate>"},"widget_loads":{"type":"integer","example":4211,"uniqueKey":"daily_breakdown.items.[INDEX].widget_loads","typeLabel":"integer"},"viewable_sessions":{"type":"integer","example":1312,"uniqueKey":"daily_breakdown.items.[INDEX].viewable_sessions","typeLabel":"integer"},"engagement_queries":{"type":"integer","example":248,"uniqueKey":"daily_breakdown.items.[INDEX].engagement_queries","typeLabel":"integer"},"total_clicks":{"type":"integer","example":94,"uniqueKey":"daily_breakdown.items.[INDEX].total_clicks","typeLabel":"integer"},"sessions":{"type":"integer","example":201,"uniqueKey":"daily_breakdown.items.[INDEX].sessions","typeLabel":"integer"}},"uniqueKey":"daily_breakdown.items.[INDEX]","typeLabel":"object"},"uniqueKey":"daily_breakdown","typeLabel":"object[]"},"meta":{"type":"object","properties":{"timezone":{"type":"string","example":"UTC","uniqueKey":"meta.timezone","typeLabel":"string"},"generated_at":{"type":"string","format":"date-time","example":"2026-05-11T18:45:00Z","uniqueKey":"meta.generated_at","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"meta","typeLabel":"object"}},"uniqueKey":"","typeLabel":"AskAiAnalyticsResponse · object"},"examples":{"Example":{"title":"Example","value":{"success":true,"filters":{"start_date":"2026-04-01","end_date":"2026-04-30","deployment_type":"brand_agent","widget_id":"wd_92831","placement_id":"\u003cstring>","creative_id":"cr_123","line_item_id":"\u003cstring>","publisher_id":"\u003cstring>"},"summary":{"widget_loads":124550,"viewable_sessions":38122,"viewability_rate":30.6,"engagement_queries":6421,"engagement_rate":16.8,"total_clicks":2310,"article_clicks":1240,"cta_clicks":1070,"sessions":5120,"avg_session_duration_seconds":142,"engagement_session_rate":13.4,"total_session_time_seconds":727040,"query_to_click_rate":36},"daily_breakdown":[{"date":"2026-04-28","widget_loads":4211,"viewable_sessions":1312,"engagement_queries":248,"total_clicks":94,"sessions":201}],"meta":{"timezone":"UTC","generated_at":"2026-05-11T18:45:00Z"}}}},"exampleType":"generated"}},"exampleType":"generated"},"798e5a5d-85ec-4535-996c-73ce376f2d52":{"description":"Missing or invalid dates, range greater than 365 days, or unknown `widget_id`.","content":{"application/json":{"schema":{"type":"object","title":"AnalyticsError","properties":{"message":{"type":"string","description":"Human-readable error description.","example":"end_date must be on or after start_date","uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"AnalyticsError · object"},"examples":{"Example":{"title":"Example","value":{"message":"end_date must be on or after start_date"}}},"exampleType":"generated"}},"exampleType":"generated"},"f387cd80-e718-4ccf-89a0-b99762a64eda":{"description":"`Authorization` header missing, or token does not start with `ak_`.","content":{"application/json":{"schema":{"type":"object","title":"AnalyticsError","properties":{"message":{"type":"string","description":"Human-readable error description.","example":"end_date must be on or after start_date","uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"AnalyticsError · object"},"examples":{"Example":{"title":"Example","value":{"message":"end_date must be on or after start_date"}}},"exampleType":"generated"}},"exampleType":"generated"},"6d3b3430-754f-4b87-b6f1-639713621dd3":{"description":"API key not found, or key is inactive.","content":{"application/json":{"schema":{"type":"object","title":"AnalyticsError","properties":{"message":{"type":"string","description":"Human-readable error description.","example":"end_date must be on or after start_date","uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"AnalyticsError · object"},"examples":{"Example":{"title":"Example","value":{"message":"end_date must be on or after start_date"}}},"exampleType":"generated"}},"exampleType":"generated"},"b7c9db89-33c7-4dda-bc7b-14597eaecd10":{"description":"Rate limit exceeded. A `Retry-After` header (seconds) is returned.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"rate limit exceeded","uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"rate limit exceeded"}}},"exampleType":"generated"}},"exampleType":"generated"},"ccdb9e1e-ce91-4c82-ae3c-cf35d1489f4c":{"description":"Internal or BigQuery failure (empty body).","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}}},"security":{"6fdb50f3-fd97-4aee-8ddc-0bed97912374":{"ApiKeyBearer":{"type":"http","scheme":"bearer","description":"Bearer token authentication using your Dappier API key. Get your API key at https://platform.dappier.com/profile/api-keys.","scopes":[]}}},"servers":{"3a48964c-e293-4b35-b889-b8ee02535690":{"url":"https://api.dappier.com"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"Bearer token authentication using your Dappier API key. Get your API key at https://platform.dappier.com/profile/api-keys.","scopes":[]},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer token authentication using your Dappier API key. Get your API key at https://platform.dappier.com/profile/api-keys.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"ApiKeyBearer","name":"Authorization"}],"title":"ApiKeyBearer"}]},"originalFileLocation":"api-reference/endpoint/openapi.json"},"subdomain":"dappier-20","siteName":"Dappier API Guide","title":"Ask AI Analytics - Dappier API Guide","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-05-21T07:51:46.567Z","originalFileLocation":"api-reference/endpoint/ask-ai-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=\"Publisher-facing Ask AI engagement rollup: summary KPIs plus a daily time-series. Numbers match the Dappier platform analytics dashboard for the same filters.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Dappier API Guide\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/dappier-20/iMN6BFXJH0k3h8Ge/_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/dappier-20/iMN6BFXJH0k3h8Ge/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/dappier-20/iMN6BFXJH0k3h8Ge/_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/dappier-20/iMN6BFXJH0k3h8Ge/_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/dappier-20/iMN6BFXJH0k3h8Ge/_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/dappier-20/iMN6BFXJH0k3h8Ge/_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/dappier-20/iMN6BFXJH0k3h8Ge/_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/dappier-20/iMN6BFXJH0k3h8Ge/_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/dappier-20/iMN6BFXJH0k3h8Ge/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Ask AI Analytics - Dappier API Guide\">\u003cmeta data-mint-head property=\"og:description\" content=\"Publisher-facing Ask AI engagement rollup: summary KPIs plus a daily time-series. Numbers match the Dappier platform analytics dashboard for the same filters.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Dappier API Guide\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.dappier.com/api-reference/endpoint/ask-ai-analytics\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://dappier-20.mintlify.app/_mintlify/api/og/v2?division=Analytics+APIs\u0026amp;title=Ask+AI+Analytics\u0026amp;description=Publisher-facing+Ask+AI+engagement+rollup%3A+summary+KPIs+plus+a+daily+time-series.+Numbers+match+the+Dappier+platform+analytics+dashboard+for+the+same+filters.\u0026amp;theme=c18ee20af573e9a9313fbb2b\u0026amp;signature=8ce373be009eba2c6cbde79c148e9c35e7196f60954ec0a05325f7ad997129c7\">\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=\"Ask AI Analytics - Dappier API Guide\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Publisher-facing Ask AI engagement rollup: summary KPIs plus a daily time-series. Numbers match the Dappier platform analytics dashboard for the same filters.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://dappier-20.mintlify.app/_mintlify/api/og/v2?division=Analytics+APIs\u0026amp;title=Ask+AI+Analytics\u0026amp;description=Publisher-facing+Ask+AI+engagement+rollup%3A+summary+KPIs+plus+a+daily+time-series.+Numbers+match+the+Dappier+platform+analytics+dashboard+for+the+same+filters.\u0026amp;theme=c18ee20af573e9a9313fbb2b\u0026amp;signature=8ce373be009eba2c6cbde79c148e9c35e7196f60954ec0a05325f7ad997129c7\">\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/dappier-20/iMN6BFXJH0k3h8Ge/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Dappier API Guide\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#8353E2\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.dappier.com/api-reference/endpoint/ask-ai-analytics\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/endpoint/ask-ai-analytics.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.dappier.com/#organization\",\"name\":\"Dappier API Guide\",\"url\":\"https://docs.dappier.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/dappier-20/GPubPuGcoHagv5PD/logo/dappier_logo.png?fit=max\u0026auto=format\u0026n=GPubPuGcoHagv5PD\u0026q=85\u0026s=9ab322122aad9dbcc85d331f1bc31c1d\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.dappier.com#website\",\"name\":\"Dappier API Guide\",\"url\":\"https://docs.dappier.com\",\"publisher\":{\"@id\":\"https://docs.dappier.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.dappier.com/api-reference/endpoint/ask-ai-analytics#webpage\",\"url\":\"https://docs.dappier.com/api-reference/endpoint/ask-ai-analytics\",\"name\":\"Ask AI Analytics\",\"description\":\"Publisher-facing Ask AI engagement rollup: summary KPIs plus a daily time-series. Numbers match the Dappier platform analytics dashboard for the same filters.\",\"dateModified\":\"2026-05-21T07:51:46.567Z\",\"isPartOf\":{\"@id\":\"https://docs.dappier.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.dappier.com/api-reference/endpoint/ask-ai-analytics#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.dappier.com/api-reference/endpoint/ask-ai-analytics#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Dappier API Guide\",\"item\":\"https://docs.dappier.com\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Ask AI Analytics\",\"item\":\"https://docs.dappier.com/api-reference/endpoint/ask-ai-analytics\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.dappier.com/api-reference/endpoint/ask-ai-analytics#apireference\",\"headline\":\"Ask AI Analytics\",\"name\":\"Ask AI Analytics\",\"description\":\"Publisher-facing Ask AI engagement rollup: summary KPIs plus a daily time-series. Numbers match the Dappier platform analytics dashboard for the same filters.\",\"url\":\"https://docs.dappier.com/api-reference/endpoint/ask-ai-analytics\",\"mainEntityOfPage\":{\"@id\":\"https://docs.dappier.com/api-reference/endpoint/ask-ai-analytics#webpage\"},\"dateModified\":\"2026-05-21T07:51:46.567Z\",\"publisher\":{\"@id\":\"https://docs.dappier.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.dappier.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Dappier API Guide\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Dappier API Guide","nav":{"global":{"anchors":[{"anchor":"Playground","icon":"play","href":"https://docs.dappier.com/api-reference/endpoint/real-time-search"},{"anchor":"Blog","icon":"blogger","href":"https://dappier.com/blog"},{"anchor":"Community","icon":"discord","href":"https://discord.com/invite/sSG77qEUSU"},{"anchor":"Talk to Us","icon":"comments","href":"https://dappier.com/demo/"}]},"tabs":[{"tab":"Home","pages":[{"title":"Home","href":"/quickstart"}]},{"tab":"API Reference","groups":[{"group":"Developer APIs","pages":[{"title":"Real Time Search","openapi":"post /app/aimodel/{ai_model_id}","href":"/api-reference/endpoint/real-time-search"}]},{"group":"Publisher APIs","pages":[{"title":"AI Recommendations API","openapi":"post /app/v2/search","href":"/api-reference/endpoint/ai-recommendations"}]},{"group":"ZeroClick APIs","pages":[{"title":"Real Time Search (ZeroClick)","openapi":"api-reference/endpoint/zeroclick.openapi.json POST /zeroclick/aimodel/{aimodel_external_id}","href":"/api-reference/endpoint/zeroclick-real-time-search"},{"title":"AI Recommendations (ZeroClick)","openapi":"api-reference/endpoint/zeroclick.openapi.json POST /zeroclick/v2/search","description":"Semantic article search against a Dappier data model, authenticated by\nverifying the `zc-signature` HMAC over the raw request bytes. The same\norchestration as `POST /app/v2/search` runs behind it.\n\nOnly marketplace-enabled data models are reachable — ZeroClick traffic\ncarries no Dappier tenant, so a private data model resolves to `404`.\n\nOn success, usage is settled with ZeroClick and reported via the `zc-usage`\nresponse header. The request is not charged on the Dappier platform.\n","href":"/api-reference/endpoint/zeroclick-ai-recommendations"}]},{"group":"Analytics APIs","pages":[{"title":"Ask AI Analytics","openapi":"get /v1/analytics/ask-ai","href":"/api-reference/endpoint/ask-ai-analytics"},{"title":"Ask AI Logs","openapi":"get /v1/analytics/ask-ai/logs","description":"Raw, paginated Ask AI conversation log rows — the same data the internal Logs → Ask AI dashboard table serves. Use this for record-level inspection; use Ask AI Analytics for aggregate reporting. Results are sorted newest-first by `timestamp`.","href":"/api-reference/endpoint/ask-ai-logs"},{"title":"Sponsored Conversations Analytics","openapi":"get /v1/analytics/sponsored-conversations","href":"/api-reference/endpoint/sponsored-conversations-analytics"},{"title":"Session Intelligence","openapi":"get /v1/analytics/session-intelligence","href":"/api-reference/endpoint/session-intelligence"}]}]},{"tab":"Integrations","pages":[{"title":"Integrations","href":"/integrations/introduction-integration"}]},{"tab":"Cookbook","pages":[{"title":"Cookbook","href":"/cookbook/recipes/dappier-ai-recommendations"}]}]},"title":"Ask AI Analytics - Dappier API Guide","buildId":"dpl_HcHmUS6i3UwswnTHJUEdcTtwfdTQ","deploymentId":"dpl_HcHmUS6i3UwswnTHJUEdcTtwfdTQ","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-BRm_l__d.js","utils-f1l1Oc-G.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-BlhqDhJO.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-DHCB7rsC.js","snippetPresets-CYXLx6Hv.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-B78P2dEq.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-C4YLPVAh.js","shallow-vlLnTDkQ.js","getApiPlaygroundDisplay-D_98hhvf.js","CodeSnippet-DtnZHGqq.js","CodeSnippets-CLFb8KJt.js","Page-kQh739Uz.js","getPastedJson-Cq-zlbnU.js","icon-sN3t983t.js","MethodPill-P_YQ2s09.js","DuplicateIcon-BVzyNsGJ.js","createIcon-B3jqgqC6.js","DynamicMarkdown-Crwq6WG_.js","SectionHeading-C7pGS2Bb.js","axios-vUo_bRtp.js","Markdown-BuPH8yuW.js","clsx-CCOYKgaU.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-BnkC_6oA.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BM4S31-f.js"]}