Performance by creative

The Meta Ads performance table grouped by ad (default), ad set or product, with the same totals, quick view counts and histograms as /meta_ads/creators.

GET /meta_ads/creatives

Performance by creative

cURL

curl --request GET \
  --url https://api.growi.io/api/public/v1/meta_ads/creatives \
  --header 'Authorization: Bearer <token>'

200

{
  "success": true,
  "group_by": "<string>",
  "metric": "<string>",
  "sort": "<string>",
  "direction": "<string>",
  "date_range": {
    "start_date": "2023-12-25",
    "end_date": "2023-12-25"
  },
  "tw_metric_columns": [
    {
      "key": "<string>",
      "label": "<string>",
      "value_type": "<string>"
    }
  ],
  "total": 123,
  "creator_count": 123,
  "ad_count": 123,
  "pagination": {
    "page": 123,
    "per_page": 123,
    "total_pages": 123,
    "total": 123
  },
  "totals": {
    "purchase_value": 123,
    "last_click_revenue": 123,
    "last_click_commission": 123,
    "cpa": 123,
    "roas": 123,
    "spend": 123,
    "aov": 123,
    "conversions": 123,
    "link_clicks": 123,
    "ctr": 123,
    "thumbstop": 123,
    "tw_metrics": {}
  },
  "quick_view_counts": {},
  "histograms": {},
  "items": [
    {
      "id": "<string>",
      "ad_name": "<string>",
      "creative_name": "<string>",
      "meta_ads_count": 123,
      "thumbnail_url": "<string>",
      "thumbnail_color": "<string>",
      "status": "active",
      "product_tag": "<string>",
      "creator": {
        "id": 123,
        "name": "<string>",
        "handle": "<string>",
        "avatar_url": "<string>",
        "color": "<string>"
      },
      "ad_set_id": "<string>",
      "ad_set_name": "<string>",
      "metrics": {
        "purchase_value": 123,
        "last_click_revenue": 123,
        "last_click_commission": 123,
        "cpa": 123,
        "roas": 123,
        "spend": 123,
        "aov": 123,
        "conversions": 123,
        "link_clicks": 123,
        "ctr": 123,
        "thumbstop": 123,
        "tw_metrics": {}
      },
      "launched_at": "2023-11-07T05:31:56Z",
      "is_new": true,
      "fatiguing": true,
      "sparkline": [
        123
      ]
    }
  ]
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

organization_id · integer

Read one of your child brands instead of the organization that owns the key. Any id that is not one of your brands answers 404.

start_date · string<date>

First day, YYYY-MM-DD. Default: 7 days ago. At most 366 days before end_date.

end_date · string<date>

Last day, YYYY-MM-DD. Default: today.

group_by · enum<string>

ad (default), ad_set or product.

Available options: ad, ad_set, product

sort · enum<string>

Sort rows by a metric, name or launched_at. Default: metric.

Available options: purchase_value, last_click_revenue, creator_earnings, roas, spend, cpa, aov, conversions, link_clicks, ctr, thumbstop, name, launched_at

metric · enum<string>

The metric of each row's sparkline and the default sort. Default spend.

Available options: purchase_value, last_click_revenue, creator_earnings, roas, spend, cpa, aov, conversions, link_clicks, ctr, thumbstop

direction · enum<string>

desc (default) or asc.

Available options: asc, desc

page · integer

Page number, from 1.

per_page · integer

Rows per page, 1-200. Default 50.

q · string

Search ad, creator, ad set or product names.

ads · enum<string>

all (default), only creatives with an active ad, or only creatives with purchases.

Available options: all, active, with_gmv

creator_ids · string

Comma separated Growi user ids.

campaign_ids · string

Comma separated Growi campaign ids.

ad_set_ids · string

Comma separated Growi ad set ids, or unassigned.

product_tags · string

Comma separated product names, or Unattributed.

launched · enum<string>

Only ads launched in the last N days.

Available options: 7, 14, 30

quick_view · enum<string>

scaling (ROAS >= 1.5), burning (ROAS < 0.5), fatiguing (CTR down 30%+ week over week) or new (launched in the last 7 days).

Available options: scaling, burning, fatiguing, new

purchase_value_min · number

Rows with purchase_value at least this.

purchase_value_max · number

Rows with purchase_value at most this.

cpa_min · number

Rows with cpa at least this.

cpa_max · number

Rows with cpa at most this.

spend_min · number

Rows with spend at least this.

spend_max · number

Rows with spend at most this.

roas_min · number

Rows with roas at least this.

roas_max · number

Rows with roas at most this.

ctr_min · number

Rows with ctr at least this.

ctr_max · number

Rows with ctr at most this.

thumbstop_min · number

Rows with thumbstop at least this.

thumbstop_max · number

Rows with thumbstop at most this.

Response

200

application/json

OK

success · boolean

group_by · string

metric · string

sort · string

direction · string

date_range · object

Show child attributes

tw_metric_columns · object[]

Show child attributes

total · integer

Rows across all pages

creator_count · integer

ad_count · integer

pagination · object

Show child attributes

totals · object

Money in your currency (not cents).

Show child attributes

quick_view_counts · object

Show child attributes

histograms · object

Per range metric: min, max, edges, counts, total

Show child attributes

items · object[]

Show child attributes