POpoll-the-people
Reports & Analytics

Get conversation analytics.

Changed on

Returns conversation metrics, including total conversations, average duration, messages per conversation, and completion rates. Use this to understand how users engage with your agent.

get/api/v1/projects/{projectId}/reports/conversations

Request

Path parameters

projectIdinteger required
Example:1

The ID of the agent to get conversations for

Query parameters

filtersstring[] required

Filters to return conversations metrics for.

Response

Get the conversation metrics data for an agent

status'error' | 'success'

The status of the response

Example response

{
  "status": "success",
  "data": {
    "total": 10
  }
}

Changes

  • 77aab4354382Revision changes
    • warning

      added the new 422.00 enum value to the / response property for the response status

    • warning

      added the new 422.00 enum value to the / response property for the response status

    • warning

      added the new 422.00 enum value to the / response property for the response status

    • warning

      added the new 422.00 enum value to the / response property for the response status

    • info

      added the non-success response with the status

  • b80e6dfcf78dRevision changes
    • info

      endpoint added