Get Agent Summary Statistics

GET

/api/v2/analytics/agents/summary

Analyticsv2

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')

Response Example

200 - Standard Response

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

Request

Query Params

agent_id

array[integer]

optional

List of agent IDs (can be specified multiple times as agent_id=1&agent_id=2)

bucket_type

enum<string>

optional

Type of time bucket for time series data. Determines how data is grouped when time_series=true.

Allowed values:

daymonthweek

Default:

day

Example:

day

days

integer

optional

Number of days to look back from current date (only used when type=fixed)

Example:

end_date

string

optional

End date in ISO format (only used when type=range). Can be date only or include time.

Example:

2024-03-31

limit

integer

optional

Number of top entities to return per date bucket

Default:

Example:

start_date

string

optional

Start date in ISO format (only used when type=range). Can be date only or include time.

Example:

2024-03-01

time_series

boolean

optional

Whether to return data in time series format. When true, data will be grouped by the specified bucket_type.

Default:

false

Example:

true

type

enum<string>

optional

Query type for date range filtering. Use 'fixed' for relative time periods or 'range' for specific date ranges.

Allowed values:

fixedrange

Example:

fixed

Responses

🟢200OK

application/json

Body

success

boolean

optional

Default:

true

message

string

required

data

object

optional

Default:

{"summary":[]}

Additional properties

array[object (Summary) {9}]

optional

🟠403Forbidden

🟠405405

🔴500Server Error

Get Recent Agent Data

Get Agent Token Data