Skip to main content

DashQ Assistant

DashQ Assistant is a conversational analytics experience with text or voice, follow-up context, inline charts, and tables. It supports questions about funnel performance, sources, representatives, portfolios, and time comparisons.

Access is enabled per customer environment. Your backend requests a short-lived URL from POST /v1/embed/url; the browser renders the URL as-is.

Embed contract

FieldPurpose
accountIdAuthorized tenant scope.
buildingIdsAuthorized property subset.
externalUserId, userId, or userEmailStable user identity for conversation ownership.
userName, userRoleTrusted display and role context.
dashboardIdSeeds questions relevant to a dashboard surface.
starterQuestionsUp to three de-duplicated opening questions.
startDate, endDateOptional paired reporting window.

Numeric DashQ user IDs can be enriched from the DashQ user directory. Analytics Assistant rejects account-only identity: it requires a stable user ID or email. Your backend must derive identity and entitlements; never create Assistant scope from browser-supplied user or account IDs.

Host behavior

  • Request a new URL when the short-lived URL expires; do not persist or reconstruct it.
  • Use allow="microphone; fullscreen" only when voice is enabled.
  • Permit microphone access for the assigned DashQ origin in the host Permissions-Policy.
  • Do not include credentials, hidden instructions, or private context in starter questions.
  • Treat generated answers as analysis support and keep the active account, property, and date scope visible.

Use Embedded experiences for implementation details and Security for the AI and secret-handling requirements.

Preview