Query knowledge base document usage

curl --request POST \
  --url https://realtime-api.voiceflow.com/v1/stable/analytics/query/knowledge-base-document-usage/project/<projectID> \
  --header 'Authorization: Bearer <token>'
  --header 'Content-Type: application/json' \
  --data '{
  "endDate": "<string>",
  "startDate": "<string>",
  "timezone": "<string>",
  "excludeID": [
    "<string>"
  ],
  "limit": 10,
  "orderDirection": "ASC",
  "version": "draft",
  "environmentAlias": "<string>"
}'

const response = await fetch('https://realtime-api.voiceflow.com/v1/stable/analytics/query/knowledge-base-document-usage/project/<projectID>', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "endDate": "<string>",
    "startDate": "<string>",
    "timezone": "<string>",
    "excludeID": [
      "<string>"
    ],
    "limit": 10,
    "orderDirection": "ASC",
    "version": "draft",
    "environmentAlias": "<string>"
  }),
});
const data = await response.json();

import requests

response = requests.post(
    'https://realtime-api.voiceflow.com/v1/stable/analytics/query/knowledge-base-document-usage/project/<projectID>',
    headers={'Authorization': 'Bearer <token>'},
    json={
      "endDate": "<string>",
      "startDate": "<string>",
      "timezone": "<string>",
      "excludeID": [
        "<string>"
      ],
      "limit": 10,
      "orderDirection": "ASC",
      "version": "draft",
      "environmentAlias": "<string>"
    },
)
data = response.json()

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

Query knowledge base document usage

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.

POST

/v1/stable/analytics/query/knowledge-base-document-usage/project/{projectID}

curl --request POST \
  --url https://realtime-api.voiceflow.com/v1/stable/analytics/query/knowledge-base-document-usage/project/<projectID> \
  --header 'Authorization: Bearer <token>'
  --header 'Content-Type: application/json' \
  --data '{
  "endDate": "<string>",
  "startDate": "<string>",
  "timezone": "<string>",
  "excludeID": [
    "<string>"
  ],
  "limit": 10,
  "orderDirection": "ASC",
  "version": "draft",
  "environmentAlias": "<string>"
}'

const response = await fetch('https://realtime-api.voiceflow.com/v1/stable/analytics/query/knowledge-base-document-usage/project/<projectID>', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "endDate": "<string>",
    "startDate": "<string>",
    "timezone": "<string>",
    "excludeID": [
      "<string>"
    ],
    "limit": 10,
    "orderDirection": "ASC",
    "version": "draft",
    "environmentAlias": "<string>"
  }),
});
const data = await response.json();

import requests

response = requests.post(
    'https://realtime-api.voiceflow.com/v1/stable/analytics/query/knowledge-base-document-usage/project/<projectID>',
    headers={'Authorization': 'Bearer <token>'},
    json={
      "endDate": "<string>",
      "startDate": "<string>",
      "timezone": "<string>",
      "excludeID": [
        "<string>"
      ],
      "limit": 10,
      "orderDirection": "ASC",
      "version": "draft",
      "environmentAlias": "<string>"
    },
)
data = response.json()

{
  "rows": [
    {
      "count": 0,
      "documentID": "<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

excludeID

string[]

limit

number

default:10

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

Show child attributes

count

number

required

documentID

string

required

Getting started

Running agents

Build

Manage

Publishing

Observe

Insights

QA

Analytics

Webhooks

Query knowledge base document usage

Authorizations

Path Parameters

Body

Response

Getting started

Running agents

Build

Manage

Publishing

Observe

Insights

QA

Analytics

Webhooks