Skip to main content
POST
/
v2
/
query
/
usage
Query usage
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
  }
}

Authorizations

​
authorization
string
header
required

Voiceflow API key

Body

application/json
​
data
object
required

Aggregate the number of interactions that match the provided filter.

Response

The query succeed and the result was returned

​
result
object
required