Get Total Entity Counts

GET

/api/v2/analytics/total-counts

API endpoint for retrieving total counts of users, agents, teams, projects, queries, and documents.

Version:

2.0.0

Changelog:

v2.0.0: New API version for total entity counts.

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)

Returns:

JSON response containing counts and growth percentages for all entity types

Request

Query Params

Header Params

Responses

🟢200OK

application/json

Body

🟠403Forbidden

🟠405405

🔴500Server Error

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request GET 'https:///api/v2/analytics/total-counts?bucket_type=day&days=30&end_date=2024-03-31&limit=10&start_date=2024-03-01&time_series=true&type=fixed' \
--header 'Ocp-Apim-Subscription-Key: ' \
--header 'Authorization: Bearer '

Response Example

200 - Standard Response

{
    "success": true,
    "message": "Overall count  data retrieved successfully",
    "data": {
        "count_data": [
            {
                "userCount": 25,
                "userPercentage": 15,
                "agentCount": 150,
                "agentPercentage": 12,
                "teamCount": 8,
                "teamPercentage": 25,
                "projectCount": 45,
                "projectPercentage": 18,
                "queryCount": 3250,
                "queryPercentage": 22,
                "documentCount": 1850,
                "documentPercentage": 30
            }
        ]
    }
}

Get Team Vote Data

Get User Cost Data