List users

GET

/v1/convai/users

GET

/v1/convai/users

curl -G https://api.elevenlabs.io/v1/convai/users \
     -H "Content-Type: application/json" \
     -d agent_id=agent_id \
     -d branch_id=branch_id \
     -d call_start_after_unix=1 \
     -d call_start_before_unix=1 \
     -d cursor=cursor \
     -d page_size=1 \
     -d search=search \
     -d sort_by=last_contact_unix_secs \
     -d sort_direction=asc

{
  "users": [
    {
      "user_id": "user_9f8b7c6d5e4a3b2c1d0e",
      "last_contact_unix_secs": 1685404800,
      "first_contact_unix_secs": 1677628800,
      "conversation_count": 42,
      "last_contact_conversation_id": "conv_5a3f9b8c7d6e4f2a1b0c",
      "sentiment": {
        "scored_conversation_count": 40,
        "positive_count": 25,
        "neutral_count": 10,
        "negative_count": 5,
        "recent_scored_conversation_count": 10,
        "recent_positive_count": 6,
        "recent_neutral_count": 3,
        "recent_negative_count": 1,
        "average_sentiment_score": 0.75,
        "average_frustration_score": 0.2,
        "recent_average_sentiment_score": 0.8,
        "recent_average_frustration_score": 0.15
      },
      "last_contact_agent_id": "agent_3701k3ttaq12ewp8b7qv5rfyszkz",
      "last_contact_agent_name": "SupportBot Alpha",
      "most_frustrated_conversations": [
        {
          "conversation_id": "conv_7e4d3c2b1a0f9e8d7c6b",
          "agent_id": "agent_3701k3ttaq12ewp8b7qv5rfyszkz",
          "start_time_unix_secs": 1685318400,
          "overall_label": "negative",
          "overall_sentiment_score": -0.6,
          "overall_frustration_score": 0.9
        }
      ]
    }
  ],
  "has_more": true,
  "next_cursor": "cursor_eyJwYWdlIjoxfQ=="
}

Get distinct users from conversations with pagination.

Parâmetros de consulta

agent_idstringOpcional

Agent id (agent_…) or speech engine external id (seng_), resolved to the same underlying resource.

branch_idstringOpcional

Filter conversations by branch ID.

call_start_before_unixintegerOpcional

Unix timestamp (in seconds) to filter conversations up to this start date.

call_start_after_unixintegerOpcional

Unix timestamp (in seconds) to filter conversations after to this start date.

searchstringOpcional

Search/filter by user ID (exact match).

page_sizeintegerOpcional1-100Padrão é 30

How many users to return at maximum. Defaults to 30.

sort_byenumOpcional

The field to sort the results by. Defaults to last_contact_unix_secs.

Valores permitidos:

sort_directionenumOpcional

The direction to sort the results

Valores permitidos:

cursorstringOpcional

Used for fetching next page. Cursor is returned in the response.

Resposta

Successful Response

userslist of objects

has_moreboolean

next_cursorstringOpcional

Erros

422

Users List Request Unprocessable Entity Error

Cabeçalhos

Parâmetros de consulta

Resposta

Erros