Skip to main content
GET
Conversions

Authorizations

Authorization
string
header
required

A personal API key (adside_pat_…) or a token from adside login. Either carries the permissions of the person it belongs to.

Path Parameters

workspaceId
string
required
Minimum string length: 1

Query Parameters

from
string
required
Pattern: ^\d{4}-\d{2}-\d{2}$
to
string
required
Pattern: ^\d{4}-\d{2}-\d{2}$
granularity
enum<string>
default:day
Available options:
day,
week,
month
channels
enum<string>[]
Available options:
META,
TIKTOK,
LINKEDIN,
SNAPCHAT,
REDDIT,
GOOGLE_SEARCH,
GOOGLE_SHOPPING,
GOOGLE_DEMAND_GEN,
GOOGLE_VIDEO,
GOOGLE_DISPLAY,
GOOGLE_PERFORMANCE_MAX,
GOOGLE_OTHER
eventId
string
Required string length: 1 - 64

Response

200 - application/json

Success

status
string
required
Allowed value: "ok"
mapping
object | null
required
events
object[]
required
data
object | null
required