{
"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
Brand Agents Analytics
Advertiser-facing rollup for the campaigns the API key’s tenant owns: summary KPIs, daily timeline, plus per-campaign, per-prompt, and click-type breakdowns. Numbers match the Dappier platform 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. agent_id is validated against the key’s tenant — an unknown or other-tenant id returns 400 agent_id not found.
creative_id / line_item_id / publisher_id reflect DSP ad-render values (the creative that matched the campaign and triggered the Brand Agent conversation), snapshotted at Brand Agent entry and frozen for the lifetime of the conversation. publisher_id is absent on GAM-derived events (GAM has no per-impression publisher id) — only Dianomi-served events carry it, so filtering by publisher_id scopes to Dianomi-derived traffic only. prompt_breakdown is grouped by prompt text and includes user-typed follow-ups (impressions == 0, queries > 0); filter client-side to impressions > 0 for configured prompts only.
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.
Per-campaign rollup, sorted by impressions desc. creative_ids is the list of DSP creative IDs configured on the campaign (from campaign setup, not per-event data) — use it to cross-reference your DSP/ad-server reports.
Top rows by engagement, grouped by prompt text (not prompt id). Configured sponsored prompts appear with impressions > 0; user-typed follow-ups inside the Brand Agent appear with impressions == 0 and queries > 0. prompt_id is currently always "" (reserved for a future release).
{"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":""},"entitlements":{},"buildId":"6af2dbd8734ccd78509b4cbb","clientVersion":"0.0.4094","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":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","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":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","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":"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":"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":"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":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","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":"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":"workos-sso-scim","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},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/endpoint/brand-agents-analytics","slug":"/api-reference/endpoint/brand-agents-analytics","pageMetadata":{"title":"Brand Agents Analytics","openapi":"get /v1/analytics/brand-agents","description":"Advertiser-facing rollup for the campaigns the API key's tenant owns: summary KPIs, daily timeline, plus per-campaign, per-prompt, and click-type breakdowns. Numbers match the Dappier platform dashboard for the same filters.","href":"/api-reference/endpoint/brand-agents-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: \"Advertiser-facing rollup for the campaigns the API key’s tenant owns: summary KPIs, daily timeline, plus per-campaign, per-prompt, and click-type breakdowns. Numbers match the Dappier platform 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:`agent_id`}),` is validated against the key’s tenant — an unknown or other-tenant id returns `,_jsx(_components.code,{children:`400 agent_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`}),` reflect `,_jsx(_components.strong,{children:`DSP ad-render values`}),` (the creative that matched the campaign and triggered the Brand Agent conversation), snapshotted at Brand Agent entry and frozen for the lifetime of the conversation. `,_jsx(_components.code,{children:`publisher_id`}),` is `,_jsx(_components.strong,{children:`absent on GAM-derived events`}),` (GAM has no per-impression publisher id) — only Dianomi-served events carry it, so filtering by `,_jsx(_components.code,{children:`publisher_id`}),` scopes to Dianomi-derived traffic only. `,_jsx(_components.code,{children:`prompt_breakdown`}),` is grouped by prompt text and includes user-typed follow-ups (`,_jsx(_components.code,{children:`impressions == 0`}),`, `,_jsx(_components.code,{children:`queries > 0`}),`); filter client-side to `,_jsx(_components.code,{children:`impressions > 0`}),` for configured prompts only.`]})})]})}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":"Brand Agents Analytics","openapi":"get /v1/analytics/brand-agents","description":"Advertiser-facing rollup for the campaigns the API key's tenant owns: summary KPIs, daily timeline, plus per-campaign, per-prompt, and click-type breakdowns. Numbers match the Dappier platform dashboard for the same filters.","href":"/api-reference/endpoint/brand-agents-analytics"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"summary":"Get Brand Agents Analytics","description":"Advertiser-facing rollup for the campaigns the API key's tenant owns: summary KPIs, daily timeline, plus per-campaign, per-prompt, and click-type breakdowns. Numbers match the Dappier platform dashboard for the same filters.","operationId":"get_BrandAgents_analytics","parameters":["dfd3083b-10b0-43d1-bb0b-ae5f0c2b28e3","922c1052-4529-4f13-856c-715dad3033a7","8af41009-56c4-47da-8467-802d688bdcc2","496736a7-bca1-4fb9-b643-0f218c8b6226","9ec69642-8bde-415d-a8e7-9bc90c67621c","86baac20-d32f-4e32-8d16-dd7ed4bac49f","e468c34b-ad2b-4f1a-8772-0ddabe44067e","d6fbcf00-aec4-4851-816a-46fee45444a3","94784a3c-ee7d-4aab-9fb7-5f29e941d914"],"responses":{"200":"fdc68a62-019f-4efa-8d46-6360b223af0a","400":"875eb48d-376e-4c8a-9313-ee61e8ea202c","401":"1b1ca332-6b4f-4395-b6cd-75d87786d6c2","403":"f795aef0-81dc-42ec-aab9-8ec34ce220b5","429":"d60889b8-cc34-4b93-969e-f81d7e97042f","500":"402a268b-c5a1-4bea-9b8c-88be053317ba"},"security":["e8408c03-8c2b-4a55-8a51-e0ae9e88778a"],"method":"get","type":"path","servers":["af957281-a0c3-4b93-95a7-52f24fbce262"],"path":"/v1/analytics/brand-agents","baseUrlOptions":["https://api.dappier.com"],"title":"Get Brand Agents Analytics","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"dfd3083b-10b0-43d1-bb0b-ae5f0c2b28e3":{"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>"}},"922c1052-4529-4f13-856c-715dad3033a7":{"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>"}},"8af41009-56c4-47da-8467-802d688bdcc2":{"name":"campaign_id","in":"query","required":false,"description":"External campaign id (e.g. `cp_...`).","schema":{"type":"string","example":"cp_xxx","isRequired":false,"description":"External campaign id (e.g. `cp_...`).","uniqueKey":"","typeLabel":"string"}},"496736a7-bca1-4fb9-b643-0f218c8b6226":{"name":"agent_id","in":"query","required":false,"description":"AI model external id (e.g. `am_...`). Validated against the tenant — an unknown or other-tenant id returns `400 agent_id not found`.","schema":{"type":"string","example":"am_01j06ytn18ejftedz6dyhz2b15","isRequired":false,"description":"AI model external id (e.g. `am_...`). Validated against the tenant — an unknown or other-tenant id returns `400 agent_id not found`.","uniqueKey":"","typeLabel":"string"}},"9ec69642-8bde-415d-a8e7-9bc90c67621c":{"name":"placement_id","in":"query","required":false,"description":"External placement id.","schema":{"type":"string","isRequired":false,"description":"External placement id.","uniqueKey":"","typeLabel":"string"}},"86baac20-d32f-4e32-8d16-dd7ed4bac49f":{"name":"prompt_id","in":"query","required":false,"description":"External prompt id (e.g. `pm_...`).","schema":{"type":"string","isRequired":false,"description":"External prompt id (e.g. `pm_...`).","uniqueKey":"","typeLabel":"string"}},"e468c34b-ad2b-4f1a-8772-0ddabe44067e":{"name":"creative_id","in":"query","required":false,"description":"DSP-served ad creative id (GAM/Dianomi) that triggered the Brand Agent conversation.","schema":{"type":"string","example":"391487","isRequired":false,"description":"DSP-served ad creative id (GAM/Dianomi) that triggered the Brand Agent conversation.","uniqueKey":"","typeLabel":"string"}},"d6fbcf00-aec4-4851-816a-46fee45444a3":{"name":"line_item_id","in":"query","required":false,"description":"DSP-served line item id.","schema":{"type":"string","isRequired":false,"description":"DSP-served line item id.","uniqueKey":"","typeLabel":"string"}},"94784a3c-ee7d-4aab-9fb7-5f29e941d914":{"name":"publisher_id","in":"query","required":false,"description":"Publisher id. Present on Dianomi-served events only — filtering by this scopes results to Dianomi-derived traffic.","schema":{"type":"string","isRequired":false,"description":"Publisher id. Present on Dianomi-served events only — filtering by this scopes results to Dianomi-derived traffic.","uniqueKey":"","typeLabel":"string"}}},"responses":{"fdc68a62-019f-4efa-8d46-6360b223af0a":{"description":"Brand Agent rollup for the requested window and filters.","content":{"application/json":{"schema":{"type":"object","title":"BrandAgentsResponse","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>"},"campaign_id":{"type":"string","example":"cp_xxx","uniqueKey":"filters.campaign_id","typeLabel":"string"},"agent_id":{"type":"string","uniqueKey":"filters.agent_id","typeLabel":"string"},"placement_id":{"type":"string","uniqueKey":"filters.placement_id","typeLabel":"string"},"prompt_id":{"type":"string","uniqueKey":"filters.prompt_id","typeLabel":"string"},"creative_id":{"type":"string","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":"Rollup for the window. Internally self-consistent; percentages rounded to 2 decimals.","properties":{"impressions":{"type":"integer","description":"Times a sponsored prompt was rendered and visible inside a publisher's widget.","example":36470,"uniqueKey":"summary.impressions","typeLabel":"integer"},"queries":{"type":"integer","description":"User queries inside the Brand Agent conversation (`deployment_type='sponsored_conversation'`).","example":7900,"uniqueKey":"summary.queries","typeLabel":"integer"},"sessions":{"type":"integer","description":"Distinct sessions with ≥1 Brand Agent query.","example":2820,"uniqueKey":"summary.sessions","typeLabel":"integer"},"engagement_rate":{"type":"number","description":"`queries / sessions × 100`. Can exceed 100% (multiple queries per session).","example":280.14,"uniqueKey":"summary.engagement_rate","typeLabel":"number"},"avg_session_duration_seconds":{"type":"integer","description":"Mean active time per engaged Brand Agent session (5s beacon resolution).","example":182,"uniqueKey":"summary.avg_session_duration_seconds","typeLabel":"integer"},"total_clicks":{"type":"integer","description":"All Brand Agent clicks (`sponsored_cta_click` + `sponsored_answer_click`).","example":1282,"uniqueKey":"summary.total_clicks","typeLabel":"integer"},"article_clicks":{"type":"integer","description":"Subset on a URL inside the AI answer body (`sponsored_answer_click`).","example":312,"uniqueKey":"summary.article_clicks","typeLabel":"integer"},"cta_clicks":{"type":"integer","description":"Subset on the brand-agent CTA button (`sponsored_cta_click`).","example":970,"uniqueKey":"summary.cta_clicks","typeLabel":"integer"},"conversion_rate":{"type":"number","description":"`total_clicks / sessions × 100`.","example":45.46,"uniqueKey":"summary.conversion_rate","typeLabel":"number"},"avg_queries_per_session":{"type":"number","description":"`queries / sessions`.","example":2.8,"uniqueKey":"summary.avg_queries_per_session","typeLabel":"number"}},"uniqueKey":"summary","typeLabel":"object"},"daily_breakdown":{"type":"array","description":"Mirrors the dashboard \"Performance Timeline\".","items":{"type":"object","properties":{"date":{"type":"string","format":"date","example":"2026-04-29","uniqueKey":"daily_breakdown.items.[INDEX].date","typeLabel":"string\u003cdate>"},"queries":{"type":"integer","example":248,"uniqueKey":"daily_breakdown.items.[INDEX].queries","typeLabel":"integer"},"engagement_rate":{"type":"number","example":21.4,"uniqueKey":"daily_breakdown.items.[INDEX].engagement_rate","typeLabel":"number"},"total_clicks":{"type":"integer","example":31,"uniqueKey":"daily_breakdown.items.[INDEX].total_clicks","typeLabel":"integer"}},"uniqueKey":"daily_breakdown.items.[INDEX]","typeLabel":"object"},"uniqueKey":"daily_breakdown","typeLabel":"object[]"},"campaign_breakdown":{"type":"array","description":"Per-campaign rollup, sorted by impressions desc. `creative_ids` is the list of DSP creative IDs configured on the campaign (from campaign setup, not per-event data) — use it to cross-reference your DSP/ad-server reports.","items":{"type":"object","properties":{"campaign_id":{"type":"string","example":"cp_xxx","uniqueKey":"campaign_breakdown.items.[INDEX].campaign_id","typeLabel":"string"},"campaign_name":{"type":"string","example":"StateFarm Q2","uniqueKey":"campaign_breakdown.items.[INDEX].campaign_name","typeLabel":"string"},"creative_ids":{"type":"array","items":{"type":"string","uniqueKey":"campaign_breakdown.items.[INDEX].creative_ids.items.[INDEX]","typeLabel":"string"},"example":["391487","391840"],"uniqueKey":"campaign_breakdown.items.[INDEX].creative_ids","typeLabel":"string[]"},"impressions":{"type":"integer","example":12000,"uniqueKey":"campaign_breakdown.items.[INDEX].impressions","typeLabel":"integer"},"queries":{"type":"integer","example":2500,"uniqueKey":"campaign_breakdown.items.[INDEX].queries","typeLabel":"integer"},"total_clicks":{"type":"integer","example":320,"uniqueKey":"campaign_breakdown.items.[INDEX].total_clicks","typeLabel":"integer"},"engagement_rate":{"type":"number","example":20.8,"uniqueKey":"campaign_breakdown.items.[INDEX].engagement_rate","typeLabel":"number"}},"uniqueKey":"campaign_breakdown.items.[INDEX]","typeLabel":"object"},"uniqueKey":"campaign_breakdown","typeLabel":"object[]"},"prompt_breakdown":{"type":"array","description":"Top rows by engagement, grouped by prompt text (not prompt id). Configured sponsored prompts appear with `impressions > 0`; user-typed follow-ups inside the Brand Agent appear with `impressions == 0` and `queries > 0`. `prompt_id` is currently always `\"\"` (reserved for a future release).","items":{"type":"object","properties":{"prompt_id":{"type":"string","example":"","uniqueKey":"prompt_breakdown.items.[INDEX].prompt_id","typeLabel":"string"},"prompt_text":{"type":"string","example":"Tell me more about coverage","uniqueKey":"prompt_breakdown.items.[INDEX].prompt_text","typeLabel":"string"},"impressions":{"type":"integer","example":8200,"uniqueKey":"prompt_breakdown.items.[INDEX].impressions","typeLabel":"integer"},"queries":{"type":"integer","example":1900,"uniqueKey":"prompt_breakdown.items.[INDEX].queries","typeLabel":"integer"},"engagement_rate":{"type":"number","example":23.2,"uniqueKey":"prompt_breakdown.items.[INDEX].engagement_rate","typeLabel":"number"}},"uniqueKey":"prompt_breakdown.items.[INDEX]","typeLabel":"object"},"uniqueKey":"prompt_breakdown","typeLabel":"object[]"},"click_type_breakdown":{"type":"array","description":"One entry per click type present.","items":{"type":"object","properties":{"type":{"type":"string","example":"sponsored_cta_click","uniqueKey":"click_type_breakdown.items.[INDEX].type","typeLabel":"string"},"count":{"type":"integer","example":970,"uniqueKey":"click_type_breakdown.items.[INDEX].count","typeLabel":"integer"}},"uniqueKey":"click_type_breakdown.items.[INDEX]","typeLabel":"object"},"uniqueKey":"click_type_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":"BrandAgentsResponse · object"},"examples":{"Example":{"title":"Example","value":{"success":true,"filters":{"start_date":"2026-04-01","end_date":"2026-04-30","campaign_id":"cp_xxx","agent_id":"\u003cstring>","placement_id":"\u003cstring>","prompt_id":"\u003cstring>","creative_id":"\u003cstring>","line_item_id":"\u003cstring>","publisher_id":"\u003cstring>"},"summary":{"impressions":36470,"queries":7900,"sessions":2820,"engagement_rate":280.14,"avg_session_duration_seconds":182,"total_clicks":1282,"article_clicks":312,"cta_clicks":970,"conversion_rate":45.46,"avg_queries_per_session":2.8},"daily_breakdown":[{"date":"2026-04-29","queries":248,"engagement_rate":21.4,"total_clicks":31}],"campaign_breakdown":[{"campaign_id":"cp_xxx","campaign_name":"StateFarm Q2","creative_ids":["391487","391840"],"impressions":12000,"queries":2500,"total_clicks":320,"engagement_rate":20.8}],"prompt_breakdown":[{"prompt_id":"","prompt_text":"Tell me more about coverage","impressions":8200,"queries":1900,"engagement_rate":23.2}],"click_type_breakdown":[{"type":"sponsored_cta_click","count":970}],"meta":{"timezone":"UTC","generated_at":"2026-05-11T18:45:00Z"}}}},"exampleType":"generated"}},"exampleType":"generated"},"875eb48d-376e-4c8a-9313-ee61e8ea202c":{"description":"Missing or invalid dates, range greater than 365 days, or unknown `agent_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"},"1b1ca332-6b4f-4395-b6cd-75d87786d6c2":{"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"},"f795aef0-81dc-42ec-aab9-8ec34ce220b5":{"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"},"d60889b8-cc34-4b93-969e-f81d7e97042f":{"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"},"402a268b-c5a1-4bea-9b8c-88be053317ba":{"description":"Internal or BigQuery failure (empty body).","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}}},"security":{"e8408c03-8c2b-4a55-8a51-e0ae9e88778a":{"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":[],"schemeName":"ApiKeyBearer"}}},"servers":{"af957281-a0c3-4b93-95a7-52f24fbce262":{"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":[],"schemeName":"ApiKeyBearer"},"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":"Brand Agents Analytics - Dappier API Guide","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-10T08:55:06.650Z","originalFileLocation":"api-reference/endpoint/brand-agents-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=\"Advertiser-facing rollup for the campaigns the API key\u0026#x27;s tenant owns: summary KPIs, daily timeline, plus per-campaign, per-prompt, and click-type breakdowns. Numbers match the Dappier platform 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=\"Brand Agents Analytics - Dappier API Guide\">\u003cmeta data-mint-head property=\"og:description\" content=\"Advertiser-facing rollup for the campaigns the API key\u0026#x27;s tenant owns: summary KPIs, daily timeline, plus per-campaign, per-prompt, and click-type breakdowns. Numbers match the Dappier platform 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/brand-agents-analytics\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://dappier-20.mintlify.site/_mintlify/api/og/v2?division=Analytics+APIs\u0026amp;title=Brand+Agents+Analytics\u0026amp;description=Advertiser-facing+rollup+for+the+campaigns+the+API+key%27s+tenant+owns%3A+summary+KPIs%2C+daily+timeline%2C+plus+per-campaign%2C+per-prompt%2C+and+click-type+breakdowns.+Nu\u0026amp;theme=2876b51008eebc8ae2674856\u0026amp;signature=e0d65de082da99424434c6fbcd7e43075294fc8aa16fff383157180dc0904b0b\">\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=\"Brand Agents Analytics - Dappier API Guide\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Advertiser-facing rollup for the campaigns the API key\u0026#x27;s tenant owns: summary KPIs, daily timeline, plus per-campaign, per-prompt, and click-type breakdowns. Numbers match the Dappier platform dashboard for the same filters.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://dappier-20.mintlify.site/_mintlify/api/og/v2?division=Analytics+APIs\u0026amp;title=Brand+Agents+Analytics\u0026amp;description=Advertiser-facing+rollup+for+the+campaigns+the+API+key%27s+tenant+owns%3A+summary+KPIs%2C+daily+timeline%2C+plus+per-campaign%2C+per-prompt%2C+and+click-type+breakdowns.+Nu\u0026amp;theme=2876b51008eebc8ae2674856\u0026amp;signature=e0d65de082da99424434c6fbcd7e43075294fc8aa16fff383157180dc0904b0b\">\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/brand-agents-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/brand-agents-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/brand-agents-analytics#webpage\",\"url\":\"https://docs.dappier.com/api-reference/endpoint/brand-agents-analytics\",\"name\":\"Brand Agents Analytics\",\"description\":\"Advertiser-facing rollup for the campaigns the API key's tenant owns: summary KPIs, daily timeline, plus per-campaign, per-prompt, and click-type breakdowns. Numbers match the Dappier platform dashboard for the same filters.\",\"dateModified\":\"2026-11-10T08:55:06.650Z\",\"isPartOf\":{\"@id\":\"https://docs.dappier.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.dappier.com/api-reference/endpoint/brand-agents-analytics#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.dappier.com/api-reference/endpoint/brand-agents-analytics#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Analytics APIs\",\"item\":\"https://docs.dappier.com/api-reference/endpoint/ask-ai-analytics\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Brand Agents Analytics\",\"item\":\"https://docs.dappier.com/api-reference/endpoint/brand-agents-analytics\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.dappier.com/api-reference/endpoint/brand-agents-analytics#apireference\",\"headline\":\"Brand Agents Analytics\",\"name\":\"Brand Agents Analytics\",\"description\":\"Advertiser-facing rollup for the campaigns the API key's tenant owns: summary KPIs, daily timeline, plus per-campaign, per-prompt, and click-type breakdowns. Numbers match the Dappier platform dashboard for the same filters.\",\"url\":\"https://docs.dappier.com/api-reference/endpoint/brand-agents-analytics\",\"mainEntityOfPage\":{\"@id\":\"https://docs.dappier.com/api-reference/endpoint/brand-agents-analytics#webpage\"},\"dateModified\":\"2026-11-10T08:55:06.650Z\",\"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","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":"Brand Agents Analytics","openapi":"get /v1/analytics/brand-agents","href":"/api-reference/endpoint/brand-agents-analytics"},{"title":"Session Intelligence","openapi":"get /v1/analytics/session-intelligence","description":"Single aggregated payload describing how end users interact with a publisher's Ask AI widgets — summary KPIs, engagement time, intent breakdown, top queried topics, content-category mix, and session-engagement (query-depth) distribution. Powers the marketplace Session Intelligence dashboard in one request. Numbers match the Dappier platform dashboard for the same filters.","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"}]}]},"basePath":"","title":"Brand Agents Analytics - Dappier API Guide","buildId":"dpl_42LwxxU1kGN114H4XzwGYXa9ZDah","deploymentId":"dpl_42LwxxU1kGN114H4XzwGYXa9ZDah","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-C-hEh3I2.js","utils-CnF4QiUD.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-C7PVNbel.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-8ytevL2A.js","snippetPresets-BT1alx3v.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-BLXC0i_W.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-CyLIGI9_.js","shallow-DC0lGVIW.js","getApiPlaygroundDisplay-CgDQ85tN.js","CodeSnippet-6-I-Gpv9.js","CodeSnippets-BAk1kDdu.js","Page-C945cI-W.js","getPastedJson-B276RuWN.js","icon-BqP8etTm.js","MethodPill-DM6sbxG1.js","DuplicateIcon-PyJglOaE.js","createIcon-CMeOMAc_.js","DynamicMarkdown-BoyYAA8K.js","SectionHeading-DAYv3gvZ.js","axios-vUo_bRtp.js","Markdown-BhTTmazV.js","clsx-CR-RHrVC.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CBUH0-zX.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BmARFYNC.js"]}