The Analytics API gives you programmatic access to data about how your agent is performing. You can use it to query aggregate usage metrics, retrieve conversation transcripts, and run automated evaluations to assess conversation quality at scale.Documentation Index
Fetch the complete documentation index at: https://docs.voiceflow.com/llms.txt
Use this file to discover all available pages before exploring further.
Endpoints
| Endpoint | Description | |
|---|---|---|
| Usage | ||
| POST Query usage | Query aggregate usage metrics for a project. Supports interactions, sessions, unique users, top intents, credit consumption, function usage, API calls, knowledge base documents, integrations, transcripts, and per-agent activity. | |
| Transcript | ||
| POST Search transcripts | Search for transcripts matching a set of filters. Supports filtering by date range, environment, session ID, custom properties, and evaluation results. | |
| GET Get transcript | Fetch a single transcript with its full conversation logs, properties, and evaluation results. | |
| DELETE Delete transcript | Permanently remove a transcript along with its logs and all evaluation results. | |
| POST End transcript | Mark a transcript as complete. Triggers any enabled evaluations to run automatically. | |
| Transcript property | ||
| GET Get all transcript properties | List all custom property definitions for a project. | |
| GET Get transcript property | Fetch the definition of a single transcript property. | |
| POST Create transcript property | Define a new custom property for tagging transcripts in a project. | |
| PATCH Update transcript property | Update the name or type of an existing transcript property definition. | |
| DELETE Delete transcript property | Remove a property definition and its values from all transcripts in the project. | |
| Transcript property value | ||
| GET Get all transcript property values | Retrieve all property values set on a specific transcript. | |
| POST Set transcript property value | Attach a value to a property on a specific transcript. | |
| DELETE Delete transcript property value | Remove a single property value from a transcript without affecting the property definition. | |
| Transcript evaluation | ||
| GET Get all evaluations | List all evaluation definitions for a project, including result counts per evaluation. | |
| GET Get transcript evaluation | Fetch the definition of a single evaluation. | |
| POST Create transcript evaluation | Define a new LLM-based evaluation. Supports boolean, numeric rating, free-text, and option types. | |
| PATCH Update transcript evaluation | Update the definition of an existing evaluation, including its prompt, model settings, and type-specific fields. | |
| DELETE Delete transcript evaluation | Remove an evaluation definition along with all its results across every transcript. | |
| POST Run transcript evaluation | Run a single evaluation against a specific transcript and return the result immediately. | |
| POST Batch run transcript evaluations | Queue up to 10 evaluations across up to 100 transcripts in a single request. | |
| POST Estimate transcript evaluation | Calculate the expected cost of running evaluations against transcripts matching a set of filters before committing to a batch run. | ## Concepts |