Creative Metrics

GET/api/v1/analytics/creatives

Authorization

AuthorizationBearer token · headerrequired

AuthorizationOAuth2 access token · headerrequired

Query parameters

date_fromstring<date> | any

date_tostring<date> | any

productstring[] | any

platformstring[] | any

media_sourcestring[] | any

countrystring[] | any

ad_typestring[] | any

reelsstring[] | any

assigneestring[] | any

task_ownerstring[] | any

subjectstring[] | any

topicstring[] | any

subtopicstring[] | any

geostring[] | any

languagestring[] | any

created_fromstring<date> | any

created_tostring<date> | any

creo_namestring | any

Exact creative name

searchstring | any

Substring match on creative/campaign/ad set names

group_bystring[] | any

Dimensions that define a row

sort_bystring

default: "spend_usd"

sort_dirstring

default: "desc"

Allowed:ascdesc

limitinteger

min 1 · max 500 · default: 50

offsetinteger

min 0 · default: 0

Responses

200Successful Response

successboolean

default: true

dataCreativeAnalyticsResult | any

Show properties

Any of:

CreativeAnalyticsResult

rowsCreativeMetricsRow[]required

Show properties

Array of CreativeMetricsRow

keystringrequired

dimensionsobjectrequired

impressionsintegerrequired

clicksintegerrequired

installsintegerrequired

purchasesintegerrequired

base_purchintegerrequired

spend_usdnumberrequired

ltvnumberrequired

spend_pctnumber | any

Show properties

Any of:

number

number

any

any

roasnumber | any

Show properties

Any of:

number

number

any

any

romi_pctnumber | any

Show properties

Any of:

number

number

any

any

cr_pctnumber | any

Show properties

Any of:

number

number

any

any

ctr_pctnumber | any

Show properties

Any of:

number

number

any

any

c2i_pctnumber | any

Show properties

Any of:

number

number

any

any

i2l_pctnumber | any

Show properties

Any of:

number

number

any

any

hook_rate_pctnumber | any

Show properties

Any of:

number

number

any

any

hold_rate_pctnumber | any

Show properties

Any of:

number

number

any

any

ipmnumber | any

Show properties

Any of:

number

number

any

any

cpmnumber | any

Show properties

Any of:

number

number

any

any

cpcnumber | any

Show properties

Any of:

number

number

any

any

cpinumber | any

Show properties

Any of:

number

number

any

any

cpanumber | any

Show properties

Any of:

number

number

any

any

duration_msinteger | any

Show properties

Any of:

integer

integer

any

any

totalsPortfolioTotalsrequired

Totals across the whole filtered window (denominators / benchmark row).

Show properties

impressionsintegerrequired

clicksintegerrequired

installsintegerrequired

purchasesintegerrequired

spend_usdnumberrequired

ltvnumberrequired

roasnumber | any

Show properties

Any of:

number

number

any

any

romi_pctnumber | any

Show properties

Any of:

number

number

any

any

creativesintegerrequired

metaCreativeAnalyticsMetarequired

Show properties

totalintegerrequired

limitintegerrequired

offsetintegerrequired

group_bystring[]required

date_fromstring<date>required

date_tostring<date>required

any

any

messagestring | any

Show properties

Any of:

string

string

any

any

errorsstring[] | any

Show properties

Any of:

string[]

Array of string

string

any

any

422Validation Error

detailValidationError[]

Show properties

Array of ValidationError

locstring | integer[]required

Show properties

Array of string | integer

Any of:

string

string

integer

integer

msgstringrequired

typestringrequired

inputany

ctxobject

Request

curl -X GET "/api/v1/analytics/creatives" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("/api/v1/analytics/creatives", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

import requests

response = requests.get(
    "/api/v1/analytics/creatives",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    },
)

Response

{
  "success": true,
  "data": {
    "rows": [
      {
        "key": "string",
        "dimensions": {
          "property1": "string",
          "property2": "string"
        },
        "impressions": 0,
        "clicks": 0,
        "installs": 0,
        "purchases": 0,
        "base_purch": 0,
        "spend_usd": 0,
        "ltv": 0,
        "spend_pct": 0,
        "roas": 0,
        "romi_pct": 0,
        "cr_pct": 0,
        "ctr_pct": 0,
        "c2i_pct": 0,
        "i2l_pct": 0,
        "hook_rate_pct": 0,
        "hold_rate_pct": 0,
        "ipm": 0,
        "cpm": 0,
        "cpc": 0,
        "cpi": 0,
        "cpa": 0,
        "duration_ms": 0
      }
    ],
    "totals": {
      "impressions": 0,
      "clicks": 0,
      "installs": 0,
      "purchases": 0,
      "spend_usd": 0,
      "ltv": 0,
      "roas": 0,
      "romi_pct": 0,
      "creatives": 0
    },
    "meta": {
      "total": 0,
      "limit": 0,
      "offset": 0,
      "group_by": [
        "string"
      ],
      "date_from": "2019-08-24",
      "date_to": "2019-08-24"
    }
  },
  "message": "string",
  "errors": [
    "string"
  ]
}