Get Indexing Mode Data

GET

/api/v2/analytics/indexing-modes

API endpoint for retrieving overall indexing mode statistics.

Version:

2.0.0

Changelog:

v2.1.0: Added time series data support with bucket_type parameter

v2.0.0: New API version for indexing mode statistics.

GET Parameters:

type (str): Query type ('fixed' or 'range')
days (int): Number of days to look back (for 'fixed' type)
start_date (str): Start date in ISO format (for 'range' type)
end_date (str): End date in ISO format (for 'range' type)
time_series (bool): Whether to return data in time series format
bucket_type (str): Type of time bucket ('day', 'week', 'month')
limit (int): Number of top entities to return per date bucket (default: 10)

Returns:

JSON response containing overall indexing mode statistics aggregated across all documents

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET '/api/v2/analytics/indexing-modes' \
--header 'Ocp-Apim-Subscription-Key;'

Response Example

200 - Standard Response

{
    "success": true,
    "message": "Overall indexing mode stats data retrieved successfully",
    "data": {
        "indexing_mode_stats": [
            [
                {
                    "indexing_mode": "Basic",
                    "count": 2150,
                    "percentage": 60.5
                },
                {
                    "indexing_mode": "Moderate",
                    "count": 950,
                    "percentage": 26.8
                },
                {
                    "indexing_mode": "Exhaustive",
                    "count": 450,
                    "percentage": 12.7
                }
            ]
        ]
    }
}

Request

Authorization

API Key

Add parameter in header

Ocp-Apim-Subscription-Key

Example:

Ocp-Apim-Subscription-Key: ********************

Query Params

Responses

🟢200OK

application/json

Body

🟠403Forbidden

🟠405405

🔴500Server Error

Get Document Count Data

Get Project Cost Data