Skip to main content
POST
Performance query

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

Body

application/json
from
string
required

Inclusive start date, yyyy-MM-dd.

Pattern: ^\d{4}-\d{2}-\d{2}$
to
string
required

Inclusive end date, yyyy-MM-dd.

Pattern: ^\d{4}-\d{2}-\d{2}$
level
enum<string>
default:campaign

What each result row represents. Defaults to campaign.

Available options:
channel,
campaign,
ad
metrics
enum<string>[]

Metrics to show per row. Defaults to spend, impressions, clicks, ctr, cpc, cpm. reach, conversions and costPerConversion need level ad.

Minimum array length: 1
Available options:
spend,
impressions,
clicks,
ctr,
cpc,
cpm,
reach,
conversions,
costPerConversion
orderBy
enum<string>
default:spend

Metric to rank rows by. Defaults to spend.

Available options:
spend,
impressions,
clicks,
ctr,
cpc,
cpm,
reach,
conversions,
costPerConversion
orderDirection
enum<string>
default:desc

Sort direction. Defaults to desc (highest first).

Available options:
asc,
desc
limit
integer
default:10

Maximum rows to return (1-50). Defaults to 10.

Required range: 1 <= x <= 50
channels
enum<string>[]

Channel filter for level channel or campaign, e.g. ["META", "GOOGLE_SEARCH"]. Omit for every channel.

Available options:
META,
TIKTOK,
LINKEDIN,
SNAPCHAT,
REDDIT,
GOOGLE_SEARCH,
GOOGLE_SHOPPING,
GOOGLE_DEMAND_GEN,
GOOGLE_VIDEO,
GOOGLE_DISPLAY,
GOOGLE_PERFORMANCE_MAX,
GOOGLE_OTHER
source
enum<string>
default:META

Level ad only: the ad platform to read ads from. Defaults to META.

Available options:
META,
TIKTOK,
GOOGLE,
LINKEDIN,
SNAPCHAT,
REDDIT
campaignName
string

Level ad only: keep ads whose campaign name contains this.

Required string length: 1 - 200
adSetName
string

Level ad only: keep ads whose ad set name contains this (Meta).

Required string length: 1 - 200
conversionEvent
string

Level ad only: the platform conversion event to count (e.g. a Meta action_type). Defaults to the workspace's primary mapped conversion for that platform.

Required string length: 1 - 256
timeSeries
boolean
default:false

Level channel or campaign: also return totals per time bucket.

granularity
enum<string>
default:day

Bucket width for the time series: day, week or month.

Available options:
day,
week,
month
compareWithPreviousPeriod
boolean
default:false

Level channel or campaign: compare with the equally long period just before from.

Response

200 - application/json

Success

text
string
required