Get Corpus Document Count Data

GET

/api/v2/analytics/corpora/document-counts

Breaks the documents added during the date window down by corpus, with an optional breakdown by document type.

Current Version:

2.1.0

Changelog:

2.1.0: Added the time_series and bucket_type parameters.

2.0.0: Initial version.

Request

Query Params

Header Params

Responses

🟢200OK

application/json

Corpora with the most documents first. Counts cover documents added during the window that have not been deleted.

Bodyapplication/json

🟠400Forbidden

🟠401405

🟠403Server Error

🟠405

🔴500

🔴503

Request Example

Shell

JavaScript

Java

Swift

curl --location --globoff 'https:///api/v2/analytics/corpora/document-counts?bucket_type=&corpus_id=&days=&end_date=&include_types=&limit=&start_date=&time_series=&type=' \
--header 'Organization-Id;' \
--header 'Ocp-Apim-Subscription-Key: ' \
--header 'Authorization: Bearer '

Response Example

200 - Totals for the window

{
    "success": true,
    "message": "Corpus document data retrieved successfully",
    "data": {
        "document_counts": [
            {
                "corpus_name": "Help Center",
                "total_documents": 42,
                "document_types": [
                    {
                        "type": "file",
                        "type_count": 30
                    },
                    {
                        "type": "weblink",
                        "type_count": 12
                    }
                ]
            }
        ]
    }
}

Get Agent Vote Data

Get Corpus Indexing Mode Data