v1

latestOpenAPI 3.0.0Proprietary2026-07-244990150.4 KB
Sessions

Get Session Counts

Returns aggregated counts of sessions grouped by the specified fields. Useful for building dashboards and understanding traffic distribution.

get/v3/sessions/counts

Query parameters

scope'workspace' | 'demo'

Controls the data scope for the query.

  • workspace: Query data from the current workspace (default). Requires the Sensors entitlement.
  • demo: Query demo/sample data. Requires the Swarm entitlement. Not available on export endpoints.
start_timestring date-time required

Start time for the query range (ISO 8601 format).

end_timestring date-time required

End time for the query range (ISO 8601 format).

fieldsstring required

Comma-separated list of fields to aggregate on.

querystring

Lucene query string to filter sessions.

sizeinteger

Number of buckets per aggregation level.

Response

OK - request successful.

totalinteger

Total number of sessions matching the query.