Get User Indexing Mode Data

GET

/api/v2/analytics/users/indexing-modes

API endpoint for retrieving indexing mode statistics for specified users.

Version:

2.1.0

Changelog:

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

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

GET Parameters:

user_id (str): List of user IDs to filter by (can be specified multiple times as user_id=1&user_id=2)
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 indexing mode statistics for the specified users

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request GET 'https:///api/v2/analytics/users/indexing-modes' \
--header 'Ocp-Apim-Subscription-Key: ' \
--header 'Authorization: Bearer '

Response Example

200 - Standard Response

{
    "success": true,
    "message": "User indexing mode stats data retrieved successfully",
    "data": {
        "indexing_mode_stats": [
            {
                "user_name": "Example User",
                "stats": [
                    {
                        "indexing_mode": "Basic",
                        "count": 75,
                        "percentage": 50
                    },
                    {
                        "indexing_mode": "Moderate",
                        "count": 45,
                        "percentage": 30
                    },
                    {
                        "indexing_mode": "Exhaustive",
                        "count": 30,
                        "percentage": 20
                    }
                ]
            }
        ]
    }
}

Request

Query Params

Header Params

Responses

🟢200OK

application/json

Body

🟠403Forbidden

🟠405405

🔴500Server Error

Get User Document Count Data

Get User Most Active Data