Skip to main content
POST
Stats-job-result fetch

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
job_id
string
required

A job whose status is SUCCESS (adside x stats-job get).

Pattern: ^\d{1,20}$
account_id
string

X ads account id (e.g. 18ce55xcrlv). Omit it: it defaults to the ads account this workspace is connected to, and any other account is refused.

metrics
string[]

Friendly metric names: spend, impressions, engagements, clicks, url_clicks, likes, follows, video_total_views, conversion_purchases, … plus derived ones (cpm, cpe, cplc, ctr, engagement_rate, cpv, cpa, roas) computed here. Default: the ENGAGEMENT + BILLING groups. See adside x metrics list.

format
enum<string>
default:markdown
Available options:
markdown,
json

Response

200 - application/json

Success