v1

latestOpenAPI 3.0.0Proprietary2026-07-244990150.4 KB
Sessions

Get Session Timeseries

Returns timeseries data for sessions, optionally grouped by a field. Useful for visualizing session volume over time and identifying trends.

get/v3/sessions/timeseries

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

querystring

Lucene query string to filter sessions.

fieldstring

Field to group timeseries by.

sizeinteger

Number of groups to return when field is provided.

interval'auto' | '1s' | '1m' | '1h' | '1d'

Time interval for bucketing.

Response

OK - request successful.

totalinteger

Total number of sessions in the time range.

Example response

{
  "timeseries": [
    {
      "timestamp": "2025-01-01T00:00:00Z",
      "count": 42
    }
  ],
  "items": [
    {
      "label": "192.168.1.1",
      "count": 150,
      "timeseries": [
        {
          "timestamp": "2025-01-01T00:00:00Z",
          "count": 42
        }
      ]
    }
  ],
  "total": 1000
}