Skip to main content
GET
Get Custom Events

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

account
string
required

User account identifier

platform
string
required

Platform identifier where the user account exists

pid
string
required

Campaign ID associated with this event

name
string
required

Event name identifier for filtering

category
string
required

Event category for filtering/grouping

Response

Events retrieved successfully

success
boolean
Example:

true

events
object[]

Array of matching events