Query call count

curl --request POST \
  --url https://realtime-api.voiceflow.com/v1/stable/analytics/query/call-count/project/<projectID> \
  --header 'Authorization: Bearer <token>'
  --header 'Content-Type: application/json' \
  --data '{
  "endDate": "<string>",
  "startDate": "<string>",
  "timezone": "<string>",
  "interval": "hour",
  "version": "draft",
  "environmentAlias": "<string>"
}'

const response = await fetch('https://realtime-api.voiceflow.com/v1/stable/analytics/query/call-count/project/<projectID>', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "endDate": "<string>",
    "startDate": "<string>",
    "timezone": "<string>",
    "interval": "hour",
    "version": "draft",
    "environmentAlias": "<string>"
  }),
});
const data = await response.json();

import requests

response = requests.post(
    'https://realtime-api.voiceflow.com/v1/stable/analytics/query/call-count/project/<projectID>',
    headers={'Authorization': 'Bearer <token>'},
    json={
      "endDate": "<string>",
      "startDate": "<string>",
      "timezone": "<string>",
      "interval": "hour",
      "version": "draft",
      "environmentAlias": "<string>"
    },
)
data = response.json()

{
  "rows": [
    {
      "count": 0,
      "durationMS": 0,
      "intervalStartDate": "<string>"
    }
  ]
}

Query call count

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.

POST

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

Query call count

curl --request POST \
  --url https://realtime-api.voiceflow.com/v1/stable/analytics/query/call-count/project/<projectID> \
  --header 'Authorization: Bearer <token>'
  --header 'Content-Type: application/json' \
  --data '{
  "endDate": "<string>",
  "startDate": "<string>",
  "timezone": "<string>",
  "interval": "hour",
  "version": "draft",
  "environmentAlias": "<string>"
}'

const response = await fetch('https://realtime-api.voiceflow.com/v1/stable/analytics/query/call-count/project/<projectID>', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "endDate": "<string>",
    "startDate": "<string>",
    "timezone": "<string>",
    "interval": "hour",
    "version": "draft",
    "environmentAlias": "<string>"
  }),
});
const data = await response.json();

import requests

response = requests.post(
    'https://realtime-api.voiceflow.com/v1/stable/analytics/query/call-count/project/<projectID>',
    headers={'Authorization': 'Bearer <token>'},
    json={
      "endDate": "<string>",
      "startDate": "<string>",
      "timezone": "<string>",
      "interval": "hour",
      "version": "draft",
      "environmentAlias": "<string>"
    },
)
data = response.json()

{
  "rows": [
    {
      "count": 0,
      "durationMS": 0,
      "intervalStartDate": "<string>"
    }
  ]
}

Authorizations

Authorization

string

header

required

Voiceflow bearer token

Path Parameters

projectID

string

required

Body

endDate

object

required

Show child attributes

startDate

object

required

Show child attributes

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

Show child attributes

count

number

required

durationMS

number

required

intervalStartDate

object

required

Show child attributes

Getting started

Running agents

Build

Manage

Publishing

Observe

Insights

QA

Analytics

Webhooks

Query call count

Authorizations

Path Parameters

Body

Response

Getting started

Running agents

Build

Manage

Publishing

Observe

Insights

QA

Analytics

Webhooks