Get document counts

Returns total document count and count of documents that have an active version.

GET /v0/documents/count

Get document counts

cURL

curl --request GET \
  --url https://api.avidoai.com/v0/documents/count \
  --header 'x-api-key: <api-key>' \
  --header 'x-application-id: <api-key>'

200

{
  "totalCount": 42,
  "activeVersionCount": 37
}

Authorizations

x-api-key · string · header · required

Your unique Avido API key

x-application-id · string · header · required

Your unique Avido Application ID

Query Parameters

type · enum<string>

Filter by document type. Defaults to KNOWLEDGE if not specified. Pass "ALL" to count across all document types.

Available options: KNOWLEDGE, POLICY, ALL

Example:

"KNOWLEDGE"

Response

200

application/json

Successfully retrieved document counts

Response containing total and active document counts

totalCount · integer · required

Total number of documents in the organization

Required range: 0 <= x <= 9007199254740991

Example:

42

activeVersionCount · integer · required

Number of documents that currently have an active version

Required range: 0 <= x <= 9007199254740991

Example:

37