Performance overview

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

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.growi.io/api/public/v1/meta_ads/overview', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.growi.io/api/public/v1/meta_ads/overview",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.growi.io/api/public/v1/meta_ads/overview"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.growi.io/api/public/v1/meta_ads/overview")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "success": true,
  "date_range": {
    "start_date": "2023-12-25",
    "end_date": "2023-12-25"
  },
  "previous_range": {
    "start_date": "2023-12-25",
    "end_date": "2023-12-25"
  },
  "metrics": {},
  "availability": {
    "last_click_revenue": true,
    "creator_earnings": true
  }
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

Performance overview

Every Meta Ads metric for the range: its total, the previous period’s total, the change (a fraction: 0.25 is +25%) and a daily sparkline. Metrics: purchase value, last-click revenue, creator earnings, ROAS, spend, CPA, AOV, conversions, link clicks, CTR and thumbstop rate. Takes the same filters as /meta_ads/creators, so the totals describe exactly those rows. availability says whether last-click revenue and creator earnings can be tracked (they need orders tagged with an ad Growi has synced).

GET

meta_ads

overview

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

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.growi.io/api/public/v1/meta_ads/overview', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.growi.io/api/public/v1/meta_ads/overview",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.growi.io/api/public/v1/meta_ads/overview"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.growi.io/api/public/v1/meta_ads/overview")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "success": true,
  "date_range": {
    "start_date": "2023-12-25",
    "end_date": "2023-12-25"
  },
  "previous_range": {
    "start_date": "2023-12-25",
    "end_date": "2023-12-25"
  },
  "metrics": {},
  "availability": {
    "last_click_revenue": true,
    "creator_earnings": true
  }
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

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.

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

success

boolean

date_range

object

Show child attributes

previous_range

object

Show child attributes

metrics

object

Keyed by purchase_value, last_click_revenue, creator_earnings, roas, spend, cpa, aov, conversions, link_clicks, ctr, thumbstop

Show child attributes

availability

object

Show child attributes

Overview

Organization

Creators and campaigns

Content analytics

Sales and stores

Payouts

TikTok Shop

Meta ads

Deprecated

Performance overview

Authorizations

Query Parameters

Response