Get User Summary Statistics

GET

/api/v2/analytics/users/summary

Summarizes activity over the date window for the selected users: queries, tokens, cost, votes, documents added and their indexing modes.

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

Figures cover the selected users. With time_series=true, summary is a list with one entry per bucket that had queries.

Bodyapplication/json

🟠400Forbidden

🟠401405

🟠403Server Error

🟠405

🔴500

🔴503

Request Example

Shell

JavaScript

Java

Swift

curl --location --globoff 'https:///api/v2/analytics/users/summary?bucket_type=&days=&end_date=&start_date=&time_series=&type=&user_id=' \
--header 'Organization-Id;' \
--header 'Ocp-Apim-Subscription-Key: ' \
--header 'Authorization: Bearer '

Response Example

200 - Totals for the window

{
    "success": true,
    "message": "User summary statistics retrieved successfully",
    "data": {
        "summary": {
            "query_count": 150,
            "token_count": 50210,
            "document_count": 75,
            "indexing_mode": {
                "basic": 45,
                "moderate": 20,
                "exhaustive": 10
            },
            "cost": "0.84210",
            "vote_count": 30,
            "upvote_count": 25,
            "downvote_count": 5
        }
    }
}

Get Recent User Data

Get User Token Data