Skip to main content
GET
List activity segments

Authorizations

Authorization
string
header
required

API key from your account settings

Path Parameters

agentId
string
required

The agent ID

Minimum string length: 1
Example:

"5QHA6VB-DIAbBhxwqxfdi"

Query Parameters

cursor
string

Opaque cursor from a previous response to fetch the next page

Example:

"eyJ0IjoiMjAyNC0wMS0xNVQxMDozMDowMC4wMDBaIiwiaWQiOiJhYmMxMjMifQ=="

limit
integer
default:100

Number of items per page (1 to 1000, default 100)

Required range: 1 <= x <= 1000
Example:

100

startDate
string<date>
required

First day to return (YYYY-MM-DD), as a calendar day in timezone. At most 396 days ago.

Example:

"2026-10-29"

endDate
string<date>
required

Last day to return (YYYY-MM-DD), inclusive. Not after today in timezone, and at most 31 days from startDate counting both.

Example:

"2026-10-30"

timezone
string
required

IANA time zone that decides where each day starts and ends, the same as the time zone picker on the dashboard.

Example:

"Africa/Cairo"

Response

Activity segments, by start, then segment ID

data
object[]
required
pagination
object
required