curl --request POST \
--url https://analytics-api.voiceflow.com/v2/query/usage \
--header 'Content-Type: application/json' \
--header 'authorization: <api-key>' \
--data '
{
"data": {
"filter": {
"projectID": "<string>",
"startTime": "<string>",
"endTime": "<string>",
"projectEnvironmentIDOrAlias": "<string>",
"limit": 100,
"cursor": 123
}
}
}
'{
"result": {
"items": [
{
"period": "2023-11-07T05:31:56Z",
"projectID": "<string>",
"environmentID": "<string>",
"count": 0,
"type": "<string>"
}
],
"cursor": 0
}
}Query usage for a project
curl --request POST \
--url https://analytics-api.voiceflow.com/v2/query/usage \
--header 'Content-Type: application/json' \
--header 'authorization: <api-key>' \
--data '
{
"data": {
"filter": {
"projectID": "<string>",
"startTime": "<string>",
"endTime": "<string>",
"projectEnvironmentIDOrAlias": "<string>",
"limit": 100,
"cursor": 123
}
}
}
'{
"result": {
"items": [
{
"period": "2023-11-07T05:31:56Z",
"projectID": "<string>",
"environmentID": "<string>",
"count": 0,
"type": "<string>"
}
],
"cursor": 0
}
}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.
Voiceflow API key
Aggregate the number of interactions that match the provided filter.
Hide child attributes
interactions A base filter supported by all queries that return a list
Hide child attributes
1A timestamp in ISO-8601 format
A timestamp in ISO-8601 format
One or more Voiceflow project environment IDs or aliases
11 <= x <= 500The query succeed and the result was returned
Hide child attributes
Hide child attributes
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$-9007199254740991 <= x <= 9007199254740991-9007199254740991 <= x <= 9007199254740991Was this page helpful?