Get Agent Summary Statistics

GET

/api/v2/analytics/agents/summary

API endpoint for retrieving agent summary statistics.

Version:
2.1.0

Changelog:

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

v2.0.0: Initial version

GET Parameters:
agent_id (str): List of agent IDs to filter by (can be specified multiple times)
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')

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request GET 'https:///api/v2/analytics/agents/summary' \
--header 'Ocp-Apim-Subscription-Key;'

Response Example

200 - Standard Response

{
    "success": true,
    "message": "Agent summary data retrieved successfully",
    "data": {
        "summary": [
            {}
        ]
    }
}

Request

Query Params

Header Params

Responses

🟢200OK

application/json

Body

🟠403Forbidden

🟠405405

🔴500Server Error

Get Recent Agent Data

Get Agent Token Data