> ## 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.

# Analytics API

> Query usage metrics, access transcripts, and evaluate conversation quality.

The Analytics API gives you programmatic access to data about how your agent is performing. You can use it to [query aggregate usage metrics](/api-reference/usage/query-usage), [retrieve conversation transcripts](/api-reference/transcript/search-transcripts), and [run automated evaluations](/api-reference/transcript-evaluation/run-transcript-evaluation) to assess conversation quality at scale.

## Endpoints

| Endpoint                                                                                                                                                         | Description                                                                                                                                                                                                                          |             |
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------- |
| **Usage**                                                                                                                                                        |                                                                                                                                                                                                                                      |             |
| <Badge color="blue" size="sm">POST</Badge> [**Query usage**](/api-reference/usage/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**                                                                                                                                                   |                                                                                                                                                                                                                                      |             |
| <Badge color="blue" size="sm">POST</Badge> [**Search transcripts**](/api-reference/transcript/search-transcripts)                                                | Search for transcripts matching a set of filters. Supports filtering by date range, environment, session ID, custom properties, and evaluation results.                                                                              |             |
| <Badge color="green" size="sm">GET</Badge> [**Get transcript**](/api-reference/transcript/get-transcript)                                                        | Fetch a single transcript with its full conversation logs, properties, and evaluation results.                                                                                                                                       |             |
| <Badge color="red" size="sm">DELETE</Badge> [**Delete transcript**](/api-reference/transcript/delete-transcript)                                                 | Permanently remove a transcript along with its logs and all evaluation results.                                                                                                                                                      |             |
| <Badge color="blue" size="sm">POST</Badge> [**End transcript**](/api-reference/transcript/end-transcript)                                                        | Mark a transcript as complete. Triggers any enabled evaluations to run automatically.                                                                                                                                                |             |
| **Transcript property**                                                                                                                                          |                                                                                                                                                                                                                                      |             |
| <Badge color="green" size="sm">GET</Badge> [**Get all transcript properties**](/api-reference/transcript-property/get-all-transcript-properties)                 | List all custom property definitions for a project.                                                                                                                                                                                  |             |
| <Badge color="green" size="sm">GET</Badge> [**Get transcript property**](/api-reference/transcript-property/get-transcript-property)                             | Fetch the definition of a single transcript property.                                                                                                                                                                                |             |
| <Badge color="blue" size="sm">POST</Badge> [**Create transcript property**](/api-reference/transcript-property/create-transcript-property)                       | Define a new custom property for tagging transcripts in a project.                                                                                                                                                                   |             |
| <Badge color="orange" size="sm">PATCH</Badge> [**Update transcript property**](/api-reference/transcript-property/update-transcript-property)                    | Update the name or type of an existing transcript property definition.                                                                                                                                                               |             |
| <Badge color="red" size="sm">DELETE</Badge> [**Delete transcript property**](/api-reference/transcript-property/delete-transcript-property)                      | Remove a property definition and its values from all transcripts in the project.                                                                                                                                                     |             |
| **Transcript property value**                                                                                                                                    |                                                                                                                                                                                                                                      |             |
| <Badge color="green" size="sm">GET</Badge> [**Get all transcript property values**](/api-reference/transcript-property-value/get-all-transcript-property-values) | Retrieve all property values set on a specific transcript.                                                                                                                                                                           |             |
| <Badge color="blue" size="sm">POST</Badge> [**Set transcript property value**](/api-reference/transcript-property-value/set-transcript-property-value)           | Attach a value to a property on a specific transcript.                                                                                                                                                                               |             |
| <Badge color="red" size="sm">DELETE</Badge> [**Delete transcript property value**](/api-reference/transcript-property-value/delete-transcript-property-value)    | Remove a single property value from a transcript without affecting the property definition.                                                                                                                                          |             |
| **Transcript evaluation**                                                                                                                                        |                                                                                                                                                                                                                                      |             |
| <Badge color="green" size="sm">GET</Badge> [**Get all evaluations**](/api-reference/transcript-evaluation/get-all-evaluations)                                   | List all evaluation definitions for a project, including result counts per evaluation.                                                                                                                                               |             |
| <Badge color="green" size="sm">GET</Badge> [**Get transcript evaluation**](/api-reference/transcript-evaluation/get-transcript-evaluation)                       | Fetch the definition of a single evaluation.                                                                                                                                                                                         |             |
| <Badge color="blue" size="sm">POST</Badge> [**Create transcript evaluation**](/api-reference/transcript-evaluation/create-transcript-evaluation)                 | Define a new LLM-based evaluation. Supports boolean, numeric rating, free-text, and option types.                                                                                                                                    |             |
| <Badge color="orange" size="sm">PATCH</Badge> [**Update transcript evaluation**](/api-reference/transcript-evaluation/update-transcript-evaluation)              | Update the definition of an existing evaluation, including its prompt, model settings, and type-specific fields.                                                                                                                     |             |
| <Badge color="red" size="sm">DELETE</Badge> [**Delete transcript evaluation**](/api-reference/transcript-evaluation/delete-transcript-evaluation)                | Remove an evaluation definition along with all its results across every transcript.                                                                                                                                                  |             |
| <Badge color="blue" size="sm">POST</Badge> [**Run transcript evaluation**](/api-reference/transcript-evaluation/run-transcript-evaluation)                       | Run a single evaluation against a specific transcript and return the result immediately.                                                                                                                                             |             |
| <Badge color="blue" size="sm">POST</Badge> [**Batch run transcript evaluations**](/api-reference/transcript-evaluation/batch-run-transcript-evaluations)         | Queue up to 10 evaluations across up to 100 transcripts in a single request.                                                                                                                                                         |             |
| <Badge color="blue" size="sm">POST</Badge> [**Estimate transcript evaluation**](/api-reference/transcript-evaluation/estimate-transcript-evaluation)             | Calculate the expected cost of running evaluations against transcripts matching a set of filters before committing to a batch run.                                                                                                   | ## Concepts |

### Transcripts

[Transcripts](/documentation/measure/transcripts) are full records of each conversation. You can [search](/api-reference/transcript/search-transcripts), [retrieve](/api-reference/transcript/get-transcript), and [delete](/api-reference/transcript/delete-transcript) them, or [mark them as ended](/api-reference/transcript/end-transcript). Ending a transcript signals that the conversation is complete and triggers any enabled evaluations to run automatically.

Transcript properties are custom metadata fields you define at the project level and attach to individual transcripts. They're useful for tagging conversations with context that isn't captured automatically, such as a support ticket ID or a user segment. Once defined, you can filter transcript searches by property values.

### Evaluations

[Evaluations](/documentation/measure/evaluations) are automated, LLM-based quality assessments that run against your transcripts. You define an evaluation with a prompt describing what you're measuring and an output type — a pass/fail boolean, a numeric rating, a free-text response, or a selection from a predefined set of options. Evaluations can run automatically whenever a transcript ends, or you can [trigger them manually against individual transcripts](/api-reference/transcript-evaluation/run-transcript-evaluation) or [in batches](/api-reference/transcript-evaluation/batch-run-transcript-evaluations).
