Conversaties weergeven

GET

/v1/convai/conversations

GET

/v1/convai/conversations

curl -G https://api.elevenlabs.io/v1/convai/conversations \
     -d agent_id=agent_3701k3ttaq12ewp8b7qv5rfyszkz \
     -d call_successful=success

{
  "conversations": [
    {
      "agent_id": "string",
      "conversation_id": "string",
      "start_time_unix_secs": 1,
      "call_duration_secs": 1,
      "message_count": 1,
      "status": "initiated",
      "call_successful": "success",
      "branch_id": "string",
      "version_id": "string",
      "agent_name": "string",
      "termination_reason": "",
      "call_success_score": 1.1,
      "transcript_summary": "string",
      "call_summary_title": "string",
      "main_language": "string",
      "conversation_initiation_source": "unknown",
      "tool_names": [
        "string"
      ],
      "direction": "inbound",
      "rating": 1.1,
      "sentiment_analysis": {
        "overall_label": "positive",
        "overall_sentiment_score": 0,
        "overall_frustration_score": 0.5,
        "min_user_sentiment_score": 0,
        "max_user_frustration_score": 0.5,
        "num_scored_user_turns": 1
      },
      "data_collection_results": {},
      "evaluation_criteria_results": {},
      "tag_ids": [
        "string"
      ]
    }
  ],
  "has_more": true,
  "next_cursor": "string"
}

Haal alle gesprekken op van agents waarvan de gebruiker eigenaar is. Met de optie om te beperken tot een specifieke agent.

Query parameters

cursorstring or nullOptional

Gebruikt om de volgende pagina op te halen. De cursor wordt teruggegeven in de response.

agent_idstring or nullOptional

Agent-ID (agent_…) of externe ID van de spraakengine (seng_), die naar dezelfde onderliggende resource verwijzen.

visited_agent_idslist of strings or nullOptional

Filter gesprekken waaraan een van deze agents heeft deelgenomen. Maximaal 50 waarden.

visited_agent_branch_idslist of strings or nullOptional

Filter gesprekken waaraan een van deze agentbranches heeft deelgenomen. Maximaal 50 waarden.

triggered_procedure_idslist of strings or nullOptional

Filter gesprekken waarin een van deze procedures is geactiveerd. Maximaal 50 waarden.

call_successfulenum or nullOptional

Het resultaat van de succesevaluatie

Allowed values:

call_start_before_unixinteger or nullOptional

Unix-timestamp (in seconden) om gesprekken tot deze startdatum te filteren.

call_start_after_unixinteger or nullOptional

Unix-timestamp (in seconden) om gesprekken vanaf deze startdatum te filteren.

call_duration_min_secsinteger or nullOptional

Minimale gespreksduur in seconden.

call_duration_max_secsinteger or nullOptional

Maximale gespreksduur in seconden.

rating_maxinteger or nullOptional1-5

Maximale algemene beoordeling (1-5).

rating_mininteger or nullOptional1-5

Minimale algemene beoordeling (1-5).

has_feedback_commentboolean or nullOptional

Filter gesprekken met feedbackreacties van gebruikers.

user_idstring or nullOptional

Filter gesprekken op de gebruikers-ID van degene die ze heeft gestart.

evaluation_paramslist of strings or nullOptional

Evaluatiefilters. Herhaalbare parameter. Indeling: criteria_id:result, waarbij result een van success|failure|unknown is. Voorbeeld: eval=value_framing:success

data_collection_paramslist of strings or nullOptional

Filters voor gegevensverzameling. Herhaalparameter. Indeling: id:op:value, waarbij op een van eq|neq|gt|gte|lt|lte|in is. Gebruik voor in een pipe als scheidingsteken tussen waarden. Een lege waarde komt overeen met gesprekken waarin het veld niet is verzameld (id:eq:), en neq met een lege waarde komt overeen met gesprekken waarin dat wel het geval was (id:neq:). eq is exacte gelijkheid. gt|gte|lt|lte vereisen een numerieke waarde.

dynamic_variable_paramslist of strings or nullOptional

Filters voor dynamische variabelen. Herhaalbare parameter. Indeling: name:op:value, waarbij op een van eq|neq|gt|gte|lt|lte|in is. Scheid waarden voor in met een verticale streep. Een lege waarde komt overeen met gesprekken waarin de variabele niet was ingesteld (name:eq:), en neq met een lege waarde komt overeen met gesprekken waarin deze wel was ingesteld (name:neq:). eq is exacte gelijkheid. gt|gte|lt|lte vereisen een numerieke waarde. Namen die ’:’ bevatten, kunnen niet worden uitgedrukt.

data_collection_idslist of strings or nullOptional

ID’s van gegevensverzamelingsvelden die in elke gesprekssamenvatting moeten worden opgenomen. Herhaalparameter. Als deze wordt weggelaten, wordt data_collection_results niet geretourneerd.

evaluation_criteria_idslist of strings or nullOptional

ID’s van evaluatiecriteria die in elke gesprekssamenvatting moeten worden opgenomen. Herhaalbare parameter. Indien weggelaten, wordt evaluation_criteria_results niet teruggestuurd.

tool_nameslist of strings or nullOptional

Filter gesprekken op toolnamen die tijdens de call zijn gebruikt.

tool_names_successfullist of strings or nullOptional

Filter gesprekken op toolnamen met geslaagde calls.

tool_names_erroredlist of strings or nullOptional

Filter gesprekken op toolnamen met mislukte calls.

include_invalid_tool_callsbooleanOptionalDefaults to false

Komt ook overeen met toolaanroepen die nooit zijn uitgevoerd.

main_languageslist of strings or nullOptional

Filter gesprekken op gedetecteerde hoofdtaal (taalcode).

page_sizeintegerOptional1-100Defaults to 30

Het maximale aantal gesprekken dat moet worden geretourneerd. Mag niet meer zijn dan 100; standaard is dit 30.

summary_modeenumOptionalDefaults to exclude

Of transcript-samenvattingen in de response moeten worden opgenomen.

Allowed values:

searchstring or nullOptionalDeprecated

Volledige-tekst- of fuzzyzoekopdracht in transcriptberichten

conversation_initiation_sourceenum or nullOptionalDefaults to unknown

Enum die de mogelijke bronnen voor het starten van een gesprek weergeeft.

text_onlyboolean or nullOptional

conversation_product_typeenum or nullOptional

Beperk de resultaten tot één productinterface voor gesprekken.

Allowed values:

branch_idstring or nullOptional

Filter gesprekken op branch-ID.

version_idstring or nullOptional

Filter gesprekken op versie-ID.

parent_conversation_idstring or nullOptional

Filter gesprekken op bovenliggende gespreks-ID voor subagentgesprekken.

topic_idslist of strings or nullOptional

Filter gesprekken op topic-ID’s die tijdens topic discovery zijn toegewezen.

exclude_statuseslist of enums or nullOptional

Sluit gesprekken met de opgegeven statussen uit. Handig om gesprekken die nog bezig zijn / worden verwerkt te verbergen in lijstweergaven.

Allowed values:

tag_idslist of strings or nullOptional

Filter gesprekken op gespreks-tag-ID’s die zijn toegewezen via de conversation-tags-endpoints.

workflow_node_entered_idstring or nullOptional

Filter alleen op gesprekken die het opgegeven knooppunt hebben bereikt.

termination_reasonslist of strings or nullOptional

Filter gesprekken op hun opgeslagen termination_reason (metadata.termination_reason). Herhaal de parameter om een van meerdere waarden te matchen.

guardrail_typeslist of enums or nullOptional

Filter op gesprekken waarin een guardrail van een van deze typen is geactiveerd (metadata.triggered_guardrails.guardrail_type). Herhaal de parameter om een van meerdere waarden te matchen.

custom_guardrail_nameslist of strings or nullOptional

Filter op gesprekken waarin een aangepaste guardrail met een van deze namen is geactiveerd (metadata.triggered_guardrails.guardrail_name). Alleen aangepaste guardrails hebben een naam. Herhaal de parameter om een van meerdere waarden te matchen.

sort_directionenumOptional

De richting om gesprekken te sorteren op starttijd van het gesprek. Standaard aflopend (nieuwste eerst).

Allowed values:

Response

Geslaagde response

conversationslist of objects

has_moreboolean

next_cursorstring or nullOptional

Errors

422

Unprocessable Entity Error

Headers

Query parameters

Response

Errors