Endpoint
POST
/v1/stable/analytics/query/call-count/project/{projectID}

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.

Request
Response

Authentication

Authorization
string
header
required

Voiceflow bearer token

Path parameters

projectID
string
required

The ID of the project to operate on.

Request body

endDate
object
required
startDate
object
required
timezone
string
interval
enum<string>
required
Available options: hour, day, week, month
version
enum<string>

Filters results to the draft or published version of the environment. Defaults to both.

Available options: draft, published
environmentAlias
string

The ID or alias of the environment to filter results by. Defaults to all environments.

Response

200 - application/json

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.

rows
object[]
required
Endpoint
POST
/v1/stable/analytics/query/call-duration/project/{projectID}

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.

Request
Response

Authentication

Authorization
string
header
required

Voiceflow bearer token

Path parameters

projectID
string
required

The ID of the project to operate on.

Request body

endDate
object
required
startDate
object
required
timezone
string
interval
enum<string>
required
Available options: hour, day, week, month
version
enum<string>

Filters results to the draft or published version of the environment. Defaults to both.

Available options: draft, published
environmentAlias
string

The ID or alias of the environment to filter results by. Defaults to all environments.

Response

200 - application/json

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.

rows
object[]
required
Endpoint
POST
/v1/stable/analytics/query/transcript-count/workspace/{workspaceID}

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.

Request
Response

Authentication

Authorization
string
header
required

Voiceflow bearer token

Path parameters

workspaceID
string
required

The ID of the workspace to operate on.

Request body

endDate
object
required
startDate
object
required
timezone
string
projectIDs
string[]

The IDs of the projects to filter results by. Defaults to all projects in the workspace.

Response

200 - application/json

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.

rows
object[]
required
Endpoint
POST
/v1/stable/analytics/query/transcript-count/project/{projectID}

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.

Request
Response

Authentication

Authorization
string
header
required

Voiceflow bearer token

Path parameters

projectID
string
required

The ID of the project to operate on.

Request body

endDate
object
required
startDate
object
required
timezone
string
interval
enum<string>
required
Available options: hour, day, week, month
version
enum<string>

Filters results to the draft or published version of the environment. Defaults to both.

Available options: draft, published
environmentAlias
string

The ID or alias of the environment to filter results by. Defaults to all environments.

Response

200 - application/json

Returns the project's transcript count as a time series, one row per interval holding the count and the timestamp that interval begins at.

rows
object[]
required
Endpoint
POST
/v1/stable/analytics/query/transcript-cost/project/{projectID}

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.

Request
Response

Authentication

Authorization
string
header
required

Voiceflow bearer token

Path parameters

projectID
string
required

The ID of the project to operate on.

Request body

endDate
object
required
startDate
object
required
timezone
string
interval
enum<string>
required
Available options: hour, day, week, month
usageClass
enum<string>
Available options: Host, Build, Test, Monitor
version
enum<string>

Filters results to the draft or published version of the environment. Defaults to both.

Available options: draft, published
environmentAlias
string

The ID or alias of the environment to filter results by. Defaults to all environments.

Response

200 - application/json

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.

rows
object[]
required
Endpoint
POST
/v1/stable/analytics/query/interaction-count/workspace/{workspaceID}

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.

Request
Response

Authentication

Authorization
string
header
required

Voiceflow bearer token

Path parameters

workspaceID
string
required

The ID of the workspace to operate on.

Request body

endDate
object
required
startDate
object
required
timezone
string
projectIDs
string[]

The IDs of the projects to filter results by. Defaults to all projects in the workspace.

Response

200 - application/json

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.

rows
object[]
required
Endpoint
POST
/v1/stable/analytics/query/interaction-count/project/{projectID}

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.

Request
Response

Authentication

Authorization
string
header
required

Voiceflow bearer token

Path parameters

projectID
string
required

The ID of the project to operate on.

Request body

endDate
object
required
startDate
object
required
timezone
string
interval
enum<string>
required
Available options: hour, day, week, month
version
enum<string>

Filters results to the draft or published version of the environment. Defaults to both.

Available options: draft, published
environmentAlias
string

The ID or alias of the environment to filter results by. Defaults to all environments.

Response

200 - application/json

Returns the project's interaction count per time interval, pairing each count with the average latency in milliseconds recorded over that interval.

rows
object[]
required
Endpoint
POST
/v1/stable/analytics/query/token-usage/organization/{organizationID}

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.

Request
Response

Authentication

Authorization
string
header
required

Voiceflow bearer token

Path parameters

organizationID
string
required

The ID of the organization to operate on.

Request body

endDate
object
required
startDate
object
required
timezone
string
workspaceIDs
string[]
projectIDs
string[]

The IDs of the projects to filter results by. Defaults to all projects in the workspace.

Response

200 - application/json

Returns the organization's token consumption broken down by model, one row per model with the tokens attributed to it.

rows
object[]
required
Endpoint
POST
/v1/stable/analytics/query/token-usage/workspace/{workspaceID}

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.

Request
Response

Authentication

Authorization
string
header
required

Voiceflow bearer token

Path parameters

workspaceID
string
required

The ID of the workspace to operate on.

Request body

endDate
object
required
startDate
object
required
timezone
string
projectIDs
string[]

The IDs of the projects to filter results by. Defaults to all projects in the workspace.

Response

200 - application/json

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.

rows
object[]
required
Endpoint
POST
/v1/stable/analytics/query/token-usage/project/{projectID}

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.

Request
Response

Authentication

Authorization
string
header
required

Voiceflow bearer token

Path parameters

projectID
string
required

The ID of the project to operate on.

Request body

endDate
object
required
startDate
object
required
timezone
string
interval
enum<string>
required
Available options: hour, day, week, month
version
enum<string>

Filters results to the draft or published version of the environment. Defaults to both.

Available options: draft, published
environmentAlias
string

The ID or alias of the environment to filter results by. Defaults to all environments.

Response

200 - application/json

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.

rows
object[]
required
Endpoint
POST
/v1/stable/analytics/query/hourly-token-usage/organization/{organizationID}

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.

Request
Response

Authentication

Authorization
string
header
required

Voiceflow bearer token

Path parameters

organizationID
string
required

The ID of the organization to operate on.

Request body

endDate
object
required
startDate
object
required
timezone
string
workspaceIDs
string[]
projectIDs
string[]

The IDs of the projects to filter results by. Defaults to all projects in the workspace.

Response

200 - application/json

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.

usage
object
required
Endpoint
POST
/v1/stable/analytics/query/hourly-token-usage/project/{projectID}

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.

Request
Response

Authentication

Authorization
string
header
required

Voiceflow bearer token

Path parameters

projectID
string
required

The ID of the project to operate on.

Request body

endDate
object
required
startDate
object
required
timezone
string
interval
enum<string>
required
Available options: hour, day, week, month
usageClass
enum<string>
Available options: Host, Build, Test, Monitor
version
enum<string>

Filters results to the draft or published version of the environment. Defaults to both.

Available options: draft, published
environmentAlias
string

The ID or alias of the environment to filter results by. Defaults to all environments.

Response

200 - application/json

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.

rows
object[]
required
Endpoint
POST
/v1/stable/analytics/query/daily-token-usage/organization/{organizationID}

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.

Request
Response

Authentication

Authorization
string
header
required

Voiceflow bearer token

Path parameters

organizationID
string
required

The ID of the organization to operate on.

Request body

endDate
object
required
startDate
object
required
timezone
string
workspaceIDs
string[]
projectIDs
string[]

The IDs of the projects to filter results by. Defaults to all projects in the workspace.

Response

200 - application/json

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.

rows
object[]
required
Endpoint
POST
/v1/stable/analytics/query/entity-token-usage/organization/{organizationID}

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.

Request
Response

Authentication

Authorization
string
header
required

Voiceflow bearer token

Path parameters

organizationID
string
required

The ID of the organization to operate on.

Request body

endDate
object
required
startDate
object
required
timezone
string

Response

200 - application/json

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.

workspaces
object[]
required
projects
object[]
required

The token usage broken down by project.

Endpoint
POST
/v1/stable/analytics/query/category-token-usage/project/{projectID}

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.

Request
Response

Authentication

Authorization
string
header
required

Voiceflow bearer token

Path parameters

projectID
string
required

The ID of the project to operate on.

Request body

endDate
object
required
startDate
object
required
timezone
string
interval
enum<string>
required
Available options: hour, day, week, month
usageClass
enum<string>
Available options: Host, Build, Test, Monitor
version
enum<string>

Filters results to the draft or published version of the environment. Defaults to both.

Available options: draft, published
environmentAlias
string

The ID or alias of the environment to filter results by. Defaults to all environments.

Response

200 - application/json

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.

rows
object[]
required
Endpoint
POST
/v1/stable/analytics/query/playbook-usage/project/{projectID}

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.

Request
Response

Authentication

Authorization
string
header
required

Voiceflow bearer token

Path parameters

projectID
string
required

The ID of the project to operate on.

Request body

endDate
object
required
startDate
object
required
timezone
string
excludeID
string[]
limit
number
default:10
Maximum: 20
orderDirection
enum<string>
Available options: ASC, DESC
orderBy
enum<string>
Available options: count, averageLatencyMS
version
enum<string>

Filters results to the draft or published version of the environment. Defaults to both.

Available options: draft, published
environmentAlias
string

The ID or alias of the environment to filter results by. Defaults to all environments.

Response

200 - application/json

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.

rows
object[]
required
Endpoint
POST
/v1/stable/analytics/query/workflow-usage/project/{projectID}

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.

Request
Response

Authentication

Authorization
string
header
required

Voiceflow bearer token

Path parameters

projectID
string
required

The ID of the project to operate on.

Request body

endDate
object
required
startDate
object
required
timezone
string
excludeID
string[]
limit
number
default:10
Maximum: 20
orderDirection
enum<string>
Available options: ASC, DESC
version
enum<string>

Filters results to the draft or published version of the environment. Defaults to both.

Available options: draft, published
environmentAlias
string

The ID or alias of the environment to filter results by. Defaults to all environments.

Response

200 - application/json

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.

rows
object[]
required
Endpoint
POST
/v1/stable/analytics/query/prompt-usage/project/{projectID}

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.

Request
Response

Authentication

Authorization
string
header
required

Voiceflow bearer token

Path parameters

projectID
string
required

The ID of the project to operate on.

Request body

endDate
object
required
startDate
object
required
timezone
string
excludeID
string[]
limit
number
default:10
Maximum: 20
orderDirection
enum<string>
Available options: ASC, DESC
orderBy
enum<string>
Available options: count, averageLatencyMS
version
enum<string>

Filters results to the draft or published version of the environment. Defaults to both.

Available options: draft, published
environmentAlias
string

The ID or alias of the environment to filter results by. Defaults to all environments.

Response

200 - application/json

Returns per-prompt usage keyed by prompt ID, giving the number of uses, the successful subset of those, and the average latency in milliseconds.

rows
object[]
required
Endpoint
POST
/v1/stable/analytics/query/intent-usage/project/{projectID}

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.

Request
Response

Authentication

Authorization
string
header
required

Voiceflow bearer token

Path parameters

projectID
string
required

The ID of the project to operate on.

Request body

endDate
object
required
startDate
object
required
timezone
string
excludeID
string[]
limit
number
default:10
Maximum: 20
orderDirection
enum<string>
Available options: ASC, DESC
version
enum<string>

Filters results to the draft or published version of the environment. Defaults to both.

Available options: draft, published
environmentAlias
string

The ID or alias of the environment to filter results by. Defaults to all environments.

Response

200 - application/json

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.

rows
object[]
required
Endpoint
POST
/v1/stable/analytics/query/function-usage/project/{projectID}

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.

Request
Response

Authentication

Authorization
string
header
required

Voiceflow bearer token

Path parameters

projectID
string
required

The ID of the project to operate on.

Request body

endDate
object
required
startDate
object
required
timezone
string
excludeID
string[]
limit
number
default:10
Maximum: 20
orderDirection
enum<string>
Available options: ASC, DESC
orderBy
enum<string>
Available options: count, averageLatencyMS
version
enum<string>

Filters results to the draft or published version of the environment. Defaults to both.

Available options: draft, published
environmentAlias
string

The ID or alias of the environment to filter results by. Defaults to all environments.

Response

200 - application/json

Returns totals for each function keyed by function ID, separating overall uses from successful ones and adding the average latency in milliseconds.

rows
object[]
required
Endpoint
POST
/v1/stable/analytics/query/api-tool-usage/project/{projectID}

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.

Request
Response

Authentication

Authorization
string
header
required

Voiceflow bearer token

Path parameters

projectID
string
required

The ID of the project to operate on.

Request body

endDate
object
required
startDate
object
required
timezone
string
excludeID
string[]
limit
number
default:10
Maximum: 20
orderDirection
enum<string>
Available options: ASC, DESC
orderBy
enum<string>
Available options: count, averageLatencyMS
version
enum<string>

Filters results to the draft or published version of the environment. Defaults to both.

Available options: draft, published
environmentAlias
string

The ID or alias of the environment to filter results by. Defaults to all environments.

Response

200 - application/json

Returns usage for each saved API tool, keyed by API tool ID, with total and successful counts alongside the average latency in milliseconds.

rows
object[]
required
Endpoint
POST
/v1/stable/analytics/query/mcp-tool-usage/project/{projectID}

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.

Request
Response

Authentication

Authorization
string
header
required

Voiceflow bearer token

Path parameters

projectID
string
required

The ID of the project to operate on.

Request body

endDate
object
required
startDate
object
required
timezone
string
excludeID
string[]
limit
number
default:10
Maximum: 20
orderDirection
enum<string>
Available options: ASC, DESC
orderBy
enum<string>
Available options: count, averageLatencyMS
version
enum<string>

Filters results to the draft or published version of the environment. Defaults to both.

Available options: draft, published
environmentAlias
string

The ID or alias of the environment to filter results by. Defaults to all environments.

Response

200 - application/json

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.

rows
object[]
required
Endpoint
POST
/v1/stable/analytics/query/knowledge-base-document-usage/project/{projectID}

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.

Request
Response

Authentication

Authorization
string
header
required

Voiceflow bearer token

Path parameters

projectID
string
required

The ID of the project to operate on.

Request body

endDate
object
required
startDate
object
required
timezone
string
excludeID
string[]
limit
number
default:10
Maximum: 20
orderDirection
enum<string>
Available options: ASC, DESC
version
enum<string>

Filters results to the draft or published version of the environment. Defaults to both.

Available options: draft, published
environmentAlias
string

The ID or alias of the environment to filter results by. Defaults to all environments.

Response

200 - application/json

Returns a usage count for each knowledge base document, keyed by document ID. The row is a document ID and a count, nothing more.

rows
object[]
required
Endpoint
POST
/v1/stable/analytics/query/integration-usage/project/{projectID}

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.

Request
Response

Authentication

Authorization
string
header
required

Voiceflow bearer token

Path parameters

projectID
string
required

The ID of the project to operate on.

Request body

endDate
object
required
startDate
object
required
timezone
string
excludeID
string[]
limit
number
default:10
Maximum: 20
orderDirection
enum<string>
Available options: ASC, DESC
orderBy
enum<string>
Available options: count, averageLatencyMS
version
enum<string>

Filters results to the draft or published version of the environment. Defaults to both.

Available options: draft, published
environmentAlias
string

The ID or alias of the environment to filter results by. Defaults to all environments.

Response

200 - application/json

Returns usage for each integration, keyed by the integration tool's name, with total and successful counts and the average latency in milliseconds.

rows
object[]
required
Endpoint
POST
/v1/stable/analytics/query/unique-user-count/project/{projectID}

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.

Request
Response

Authentication

Authorization
string
header
required

Voiceflow bearer token

Path parameters

projectID
string
required

The ID of the project to operate on.

Request body

endDate
object
required
startDate
object
required
timezone
string
interval
enum<string>
required
Available options: hour, day, week, month
version
enum<string>

Filters results to the draft or published version of the environment. Defaults to both.

Available options: draft, published
environmentAlias
string

The ID or alias of the environment to filter results by. Defaults to all environments.

Response

200 - application/json

Returns the number of unique users per time interval, one row for each interval with the timestamp it starts at.

rows
object[]
required
Endpoint
POST
/v1/stable/analytics/query/objective-metrics/project/{projectID}

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.

Request
Response

Authentication

Authorization
string
header
required

Voiceflow bearer token

Path parameters

projectID
string
required

The ID of the project to operate on.

Request body

endDate
object
required
startDate
object
required
timezone
string
interfaces
enum<string>[]

The channels to filter results by. Defaults to all channels.

Minimum items: 1
environmentAlias
string

The ID or alias of the environment to filter results by. Defaults to all environments.

Response

200 - application/json

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.

conversion
object

Returned only when the assistant's objective is conversion.

resolution
object

Returned only when the assistant's objective is resolution.

Schemas

Use the up and down arrow keys to select a result, Enter to open it, and Escape to close the search.