Voiceflow bearer token
Analytics
Measure your agent’s usage and performance.
See Authentication for credentials and permissions.
Reports how many voice calls were placed, for one project over a date range. The request body takes startDate, endDate and an interval, the same shape the other analytics measures take.
Authentication
Path parameters
The ID of the project to operate on.
Request body
hour, day, week, monthFilters results to the draft or published version of the environment. Defaults to both.
draft, publishedThe ID or alias of the environment to filter results by. Defaults to all environments.
Response
Returns the project's call volume as a time series, one row per interval carrying the call count, an accompanying duration in milliseconds, and the timestamp the interval starts at.
Reports how much time was spent on voice calls, for one project over a date range. The request body takes startDate, endDate and an interval, the same shape the other analytics measures take.
Authentication
Voiceflow bearer token
Path parameters
The ID of the project to operate on.
Request body
hour, day, week, monthFilters results to the draft or published version of the environment. Defaults to both.
draft, publishedThe ID or alias of the environment to filter results by. Defaults to all environments.
Response
Returns real call duration, or talk time, as a millisecond figure for each interval. Each row holds only that duration and the interval's start timestamp, with no call count beside it.
Reports how many conversations were recorded, for one workspace over a date range. The request body takes startDate, endDate and an interval, the same shape the other analytics measures take.
Authentication
Voiceflow bearer token
Path parameters
The ID of the workspace to operate on.
Request body
The IDs of the projects to filter results by. Defaults to all projects in the workspace.
Response
Returns transcript totals across the workspace, split by project, by environment alias, and by whether the transcripts came from the environment's draft or published version. The rows carry no time dimension.
Reports how many conversations were recorded, for one project over a date range. The request body takes startDate, endDate and an interval, the same shape the other analytics measures take.
Authentication
Voiceflow bearer token
Path parameters
The ID of the project to operate on.
Request body
hour, day, week, monthFilters results to the draft or published version of the environment. Defaults to both.
draft, publishedThe ID or alias of the environment to filter results by. Defaults to all environments.
Response
Returns the project's transcript count as a time series, one row per interval holding the count and the timestamp that interval begins at.
Reports what those conversations cost in model spend, for one project over a date range. The request body takes startDate, endDate and an interval, the same shape the other analytics measures take.
Authentication
Voiceflow bearer token
Path parameters
The ID of the project to operate on.
Request body
hour, day, week, monthHost, Build, Test, MonitorFilters results to the draft or published version of the environment. Defaults to both.
draft, publishedThe ID or alias of the environment to filter results by. Defaults to all environments.
Response
Returns per-interval cost paired with the transcript count behind it, so a row shows both the total cost incurred by transcripts and how many transcripts produced it.
Reports how many interactions were exchanged, for one workspace over a date range. The request body takes startDate, endDate and an interval, the same shape the other analytics measures take.
Authentication
Voiceflow bearer token
Path parameters
The ID of the workspace to operate on.
Request body
The IDs of the projects to filter results by. Defaults to all projects in the workspace.
Response
Returns interaction totals for the workspace grouped by interaction type, one row per type. Each row is a type and a count only, with no time dimension.
Reports how many interactions were exchanged, for one project over a date range. The request body takes startDate, endDate and an interval, the same shape the other analytics measures take.
Authentication
Voiceflow bearer token
Path parameters
The ID of the project to operate on.
Request body
hour, day, week, monthFilters results to the draft or published version of the environment. Defaults to both.
draft, publishedThe ID or alias of the environment to filter results by. Defaults to all environments.
Response
Returns the project's interaction count per time interval, pairing each count with the average latency in milliseconds recorded over that interval.
Reports how many tokens were consumed, for one organization over a date range. The request body takes startDate, endDate and an interval, the same shape the other analytics measures take.
Authentication
Voiceflow bearer token
Path parameters
The ID of the organization to operate on.
Request body
The IDs of the projects to filter results by. Defaults to all projects in the workspace.
Response
Returns the organization's token consumption broken down by model, one row per model with the tokens attributed to it.
Reports how many tokens were consumed, for one workspace over a date range. The request body takes startDate, endDate and an interval, the same shape the other analytics measures take.
Authentication
Voiceflow bearer token
Path parameters
The ID of the workspace to operate on.
Request body
The IDs of the projects to filter results by. Defaults to all projects in the workspace.
Response
Returns token consumption scoped to a single workspace, one row per model, the same model and count pairing the organization query returns at a wider scope.
Reports how many tokens were consumed, for one project over a date range. The request body takes startDate, endDate and an interval, the same shape the other analytics measures take.
Authentication
Voiceflow bearer token
Path parameters
The ID of the project to operate on.
Request body
hour, day, week, monthFilters results to the draft or published version of the environment. Defaults to both.
draft, publishedThe ID or alias of the environment to filter results by. Defaults to all environments.
Response
Returns project token counts split by model and by time interval, where the workspace and organization queries give a model split with no interval. The model field is nullable, so some rows report a count without naming a model.
Reports how many tokens were consumed, bucketed by hour, for one organization over a date range. The request body takes startDate, endDate and an interval, the same shape the other analytics measures take.
Authentication
Voiceflow bearer token
Path parameters
The ID of the organization to operate on.
Request body
The IDs of the projects to filter results by. Defaults to all projects in the workspace.
Response
Returns two numbers rather than a row per hour: a total token count for the organization, and a filtered count reflecting the optional workspace and project filters sent with the query.
Reports how many tokens were consumed, bucketed by hour, for one project over a date range. The request body takes startDate, endDate and an interval, the same shape the other analytics measures take.
Authentication
Voiceflow bearer token
Path parameters
The ID of the project to operate on.
Request body
hour, day, week, monthHost, Build, Test, MonitorFilters results to the draft or published version of the environment. Defaults to both.
draft, publishedThe ID or alias of the environment to filter results by. Defaults to all environments.
Response
Returns hourly token counts for the project, each row keyed by the hour's start timestamp and split by model and by usage category. Both the model and the category are nullable.
Reports how many tokens were consumed, bucketed by day, for one organization over a date range. The request body takes startDate, endDate and an interval, the same shape the other analytics measures take.
Authentication
Voiceflow bearer token
Path parameters
The ID of the organization to operate on.
Request body
The IDs of the projects to filter results by. Defaults to all projects in the workspace.
Response
Returns a token count per day for the organization, each row split by usage class, usage category, and model, and flagged with a misclassified boolean.
Reports how many tokens each entity consumed, for one organization over a date range. The request body takes startDate, endDate and an interval, the same shape the other analytics measures take.
Authentication
Voiceflow bearer token
Path parameters
The ID of the organization to operate on.
Request body
Response
Returns two parallel breakdowns of the organization's tokens, one array of workspaces and one of projects, each row pairing an ID with the tokens it used. Neither is split by model or by time.
The token usage broken down by project.
Reports how many tokens each category consumed, for one project over a date range. The request body takes startDate, endDate and an interval, the same shape the other analytics measures take.
Authentication
Voiceflow bearer token
Path parameters
The ID of the project to operate on.
Request body
hour, day, week, monthHost, Build, Test, MonitorFilters results to the draft or published version of the environment. Defaults to both.
draft, publishedThe ID or alias of the environment to filter results by. Defaults to all environments.
Response
Returns hourly token counts for the project grouped by usage category alone, without the model split the hourly project query carries. The category is nullable.
Reports how often each playbook ran, for one project over a date range. The request body takes startDate, endDate and an interval, the same shape the other analytics measures take.
Authentication
Voiceflow bearer token
Path parameters
The ID of the project to operate on.
Request body
ASC, DESCcount, averageLatencyMSFilters results to the draft or published version of the environment. Defaults to both.
draft, publishedThe ID or alias of the environment to filter results by. Defaults to all environments.
Response
Returns one row per playbook, keyed by playbook ID, with its usage count, how many of those runs succeeded, and the average latency in milliseconds.
Reports how often each workflow ran, for one project over a date range. The request body takes startDate, endDate and an interval, the same shape the other analytics measures take.
Authentication
Voiceflow bearer token
Path parameters
The ID of the project to operate on.
Request body
ASC, DESCFilters results to the draft or published version of the environment. Defaults to both.
draft, publishedThe ID or alias of the environment to filter results by. Defaults to all environments.
Response
Returns a usage count for each workflow, keyed by workflow ID. Unlike the playbook and tool usage queries, the rows carry no success count and no latency figure.
Reports how often each prompt was used, for one project over a date range. The request body takes startDate, endDate and an interval, the same shape the other analytics measures take.
Authentication
Voiceflow bearer token
Path parameters
The ID of the project to operate on.
Request body
ASC, DESCcount, averageLatencyMSFilters results to the draft or published version of the environment. Defaults to both.
draft, publishedThe ID or alias of the environment to filter results by. Defaults to all environments.
Response
Returns per-prompt usage keyed by prompt ID, giving the number of uses, the successful subset of those, and the average latency in milliseconds.
Reports how often each intent matched, for one project over a date range. The request body takes startDate, endDate and an interval, the same shape the other analytics measures take.
Authentication
Voiceflow bearer token
Path parameters
The ID of the project to operate on.
Request body
ASC, DESCFilters results to the draft or published version of the environment. Defaults to both.
draft, publishedThe ID or alias of the environment to filter results by. Defaults to all environments.
Response
Returns a usage count for each intent, keyed by intent ID. That count is the whole row: no success count and no latency accompany it.
Reports how often each function ran, for one project over a date range. The request body takes startDate, endDate and an interval, the same shape the other analytics measures take.
Authentication
Voiceflow bearer token
Path parameters
The ID of the project to operate on.
Request body
ASC, DESCcount, averageLatencyMSFilters results to the draft or published version of the environment. Defaults to both.
draft, publishedThe ID or alias of the environment to filter results by. Defaults to all environments.
Response
Returns totals for each function keyed by function ID, separating overall uses from successful ones and adding the average latency in milliseconds.
Reports how often each API tool was called, for one project over a date range. The request body takes startDate, endDate and an interval, the same shape the other analytics measures take.
Authentication
Voiceflow bearer token
Path parameters
The ID of the project to operate on.
Request body
ASC, DESCcount, averageLatencyMSFilters results to the draft or published version of the environment. Defaults to both.
draft, publishedThe ID or alias of the environment to filter results by. Defaults to all environments.
Response
Returns usage for each saved API tool, keyed by API tool ID, with total and successful counts alongside the average latency in milliseconds.
Reports how often each MCP tool was called, for one project over a date range. The request body takes startDate, endDate and an interval, the same shape the other analytics measures take.
Authentication
Voiceflow bearer token
Path parameters
The ID of the project to operate on.
Request body
ASC, DESCcount, averageLatencyMSFilters results to the draft or published version of the environment. Defaults to both.
draft, publishedThe ID or alias of the environment to filter results by. Defaults to all environments.
Response
Returns usage for each MCP tool, keyed by the tool's name rather than an ID, with total and successful counts and the average latency in milliseconds.
Reports how often each knowledge base document was retrieved, for one project over a date range. The request body takes startDate, endDate and an interval, the same shape the other analytics measures take.
Authentication
Voiceflow bearer token
Path parameters
The ID of the project to operate on.
Request body
ASC, DESCFilters results to the draft or published version of the environment. Defaults to both.
draft, publishedThe ID or alias of the environment to filter results by. Defaults to all environments.
Response
Returns a usage count for each knowledge base document, keyed by document ID. The row is a document ID and a count, nothing more.
Reports how often each integration ran, for one project over a date range. The request body takes startDate, endDate and an interval, the same shape the other analytics measures take.
Authentication
Voiceflow bearer token
Path parameters
The ID of the project to operate on.
Request body
ASC, DESCcount, averageLatencyMSFilters results to the draft or published version of the environment. Defaults to both.
draft, publishedThe ID or alias of the environment to filter results by. Defaults to all environments.
Response
Returns usage for each integration, keyed by the integration tool's name, with total and successful counts and the average latency in milliseconds.
Reports how many distinct users held a conversation, for one project over a date range. The request body takes startDate, endDate and an interval, the same shape the other analytics measures take.
Authentication
Voiceflow bearer token
Path parameters
The ID of the project to operate on.
Request body
hour, day, week, monthFilters results to the draft or published version of the environment. Defaults to both.
draft, publishedThe ID or alias of the environment to filter results by. Defaults to all environments.
Response
Returns the number of unique users per time interval, one row for each interval with the timestamp it starts at.
Reports how sessions performed against the agent's configured objective, conversion or resolution, for one project over a date range. The request body takes startDate and endDate, with optional timezone, channel and environment filters.
Authentication
Voiceflow bearer token
Path parameters
The ID of the project to operate on.
Request body
The channels to filter results by. Defaults to all channels.
The ID or alias of the environment to filter results by. Defaults to all environments.
Response
Returns the objective's rate, its matched and evaluated session counts and a time series of buckets, under conversion or resolution depending on which objective the agent is configured with.
Returned only when the assistant's objective is conversion.
Returned only when the assistant's objective is resolution.