Skip to main content
GET
List events

Authorizations

Authorization
string
header
required

Workspace-scoped token sent in the Authorization header as Bearer . Access depends on the credential's allowed operations, read or write scope, and workspace subscription. Use an API key issued in the tracker for Public API v1. MCP uses separate OAuth credentials.

Query Parameters

campaignId
string

Comma-separated campaign ids to filter by.

trafficSourceId
string

Comma-separated traffic source ids to filter by.

rotatorId
string

Comma-separated rotator ids to filter by.

rotatorPathId
string

Comma-separated rotator path ids to filter by.

requestIp
string

Comma-separated request sender IP addresses to filter by.

requestUa
string

Comma-separated request User-Agent values to filter by (exact match).

requestReferer
string

Comma-separated request referrer URLs to filter by (exact match).

from
string
required

Inclusive start as YYYY-MM-DD in timezone, or an ISO timestamp parsed directly. A date-only end includes the full calendar day.

to
string
required

Inclusive end as YYYY-MM-DD in timezone, or an ISO timestamp parsed directly. A date-only end includes the full calendar day.

timezone
string
default:UTC

IANA timezone with whole-hour UTC offsets, such as UTC or a timezone offered in the report interface. Defaults to UTC.

limit
integer
default:1000

Page size. Values outside 1 through 1000 or nonnumeric values fall back to 1000.

Required range: 1 <= x <= 1000
mode
enum<string>

Optional explicit value scroll for cursor pagination (default behavior).

Available options:
scroll
cursor
string

Continuation token from data.meta.nextCursor. Expired, malformed or query-mismatched cursors return 400.

idx
integer[]

Comma-separated event indices 1 through 10. Invalid entries are ignored if another valid index remains. A list without any valid indices returns 400. Visits and landing clicks have no event index and do not match this filter.

Required range: 1 <= x <= 10
type
enum<string>

Omit to include all record types. An unrecognized value also includes all types.

Available options:
visit,
lpclick,
event,
postback

Response

Event list

ok
enum<boolean>
required
Available options:
true
data
object
required