Skip to main content
POST
Analytics get

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
pivot
enum<string>
required

Dimension to group results by

Available options:
ACCOUNT,
CAMPAIGN_GROUP,
CAMPAIGN,
CREATIVE
date_range_start
object
required

Start date (inclusive)

account_id
string

LinkedIn Ad Account ID. Omit it: it defaults to the account this workspace is connected to, and any other account is refused.

time_granularity
enum<string>
default:ALL

Time granularity for results

Available options:
DAILY,
MONTHLY,
ALL
date_range_end
object

End date (inclusive). If omitted, returns data up to now.

campaign_ids
string[]

Filter by campaign IDs

campaign_group_ids
string[]

Filter by campaign group IDs

creative_ids
string[]

Filter by creative URNs

fields
string[]

Specific metrics to return (max 20). Default: impressions, clicks. Examples: costInLocalCurrency, landingPageClicks, likes, shares, externalWebsiteConversions

Response

200 - application/json

Success