Chat icon

Chat

Interact with the Chat API

Actions253

Report → Conversation Metrics

AI-generated

Summary

Fetch conversation metrics report for a selected account

Inputs

  • accountId (required) — Select the account whose conversation metrics are to be retrieved.
  • query — JSON object containing query parameters to customize the report.

Output shape

JSON object representing the conversation metrics report

The exact shape depends on the report definition; typically includes aggregated counts and statistics.

Examples

Example 1: Retrieve default metrics for a single account

accountId set to a selected account, query left empty

Example 2: Apply custom filters to the metrics query

accountId set to an account, query set to {"from":"2024-01-01","to":"2024-01-31"}

Example 3: Get metrics for multiple accounts in a single call

accountId left empty (optional list selection) and query includes additional parameters

Links

Discussion