Get Indexing Mode Data

GET

/api/v2/analytics/indexing-modes

Shows how the documents added during the date window are split across indexing modes. An indexing mode is how thoroughly a corpus's documents are processed for search: basic, moderate or exhaustive.

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

With time_series=false, data is the list itself rather than an object.

Bodyapplication/json

🟠400Forbidden

🟠401405

🟠403Server Error

🟠405

🔴500

🔴503

Request Example

Shell

JavaScript

Java

Swift

curl --location --globoff 'https:///api/v2/analytics/indexing-modes?bucket_type=&days=&end_date=&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": "Indexing mode statistics retrieved successfully",
    "data": [
        {
            "indexing_mode": "basic",
            "count": 60,
            "percentage": 75
        },
        {
            "indexing_mode": "exhaustive",
            "count": 20,
            "percentage": 25
        }
    ]
}

Get Document Count Data

Get Project Cost Data