Stores overview
curl --request GET \
--url https://api.growi.io/api/public/v1/stores/overview \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.growi.io/api/public/v1/stores/overview"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.growi.io/api/public/v1/stores/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/stores/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/stores/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))
}HttpResponse<String> response = Unirest.get("https://api.growi.io/api/public/v1/stores/overview")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.growi.io/api/public/v1/stores/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,
"data": {
"currency_symbol": "<string>",
"organization_type": "<string>",
"range": {
"start": "2023-12-25",
"end": "2023-12-25",
"prior_start": "2023-12-25",
"prior_end": "2023-12-25"
},
"channels": [
{
"key": "shopify",
"name": "<string>",
"connected": true,
"status": "<string>",
"last_synced_at": "2023-11-07T05:31:56Z",
"last_data_date": "2023-12-25",
"available": true,
"totals": {
"gmv_cents": 123,
"commission_cents": 123,
"orders": 123,
"refund_cents": 123,
"active_creators": 123,
"aov_cents": 123,
"revenue_per_commission": 123
},
"deltas": {},
"series": [
{
"date": "2023-12-25",
"gmv_cents": 123,
"commission_cents": 123,
"orders": 123
}
],
"attribution": {
"spend_scope": "<string>",
"spend": {
"spend_cents": 123,
"series": [
{}
]
},
"last_click": {
"available": true,
"revenue_cents": 123,
"orders": 123,
"roas": 123,
"series": [
{}
]
},
"meta_reported": {
"available": true,
"revenue_cents": 123,
"orders": 123,
"roas": 123,
"series": [
{}
]
},
"triple_whale": {
"available": true,
"revenue_cents": 123,
"orders": 123,
"roas": 123,
"series": [
{}
]
}
}
}
],
"blended": {
"totals": {
"gmv_cents": 123,
"commission_cents": 123,
"orders": 123,
"refund_cents": 123,
"active_creators": 123,
"aov_cents": 123,
"revenue_per_commission": 123
},
"deltas": {},
"series": [
{}
],
"prior_series": [
{}
]
}
}
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}Stores overview
Sales per store for the range, the same numbers as the dashboard’s Stores overview: Shopify, TikTok Shop, Amazon, custom website, App Store, Google Play and Meta Ads (the stores your organization type uses; agencies and parent organizations get all of them, rolled up over their brands). Each store carries its connection status, totals (GMV, commission, orders, active creators, AOV), the change against the previous period of the same length and a daily series. Meta Ads also carries spend and three revenue views: last click, Meta reported and Triple Whale. Money is in cents. Refreshed every 15 minutes.
GET
/
stores
/
overview
Stores overview
curl --request GET \
--url https://api.growi.io/api/public/v1/stores/overview \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.growi.io/api/public/v1/stores/overview"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.growi.io/api/public/v1/stores/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/stores/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/stores/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))
}HttpResponse<String> response = Unirest.get("https://api.growi.io/api/public/v1/stores/overview")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.growi.io/api/public/v1/stores/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,
"data": {
"currency_symbol": "<string>",
"organization_type": "<string>",
"range": {
"start": "2023-12-25",
"end": "2023-12-25",
"prior_start": "2023-12-25",
"prior_end": "2023-12-25"
},
"channels": [
{
"key": "shopify",
"name": "<string>",
"connected": true,
"status": "<string>",
"last_synced_at": "2023-11-07T05:31:56Z",
"last_data_date": "2023-12-25",
"available": true,
"totals": {
"gmv_cents": 123,
"commission_cents": 123,
"orders": 123,
"refund_cents": 123,
"active_creators": 123,
"aov_cents": 123,
"revenue_per_commission": 123
},
"deltas": {},
"series": [
{
"date": "2023-12-25",
"gmv_cents": 123,
"commission_cents": 123,
"orders": 123
}
],
"attribution": {
"spend_scope": "<string>",
"spend": {
"spend_cents": 123,
"series": [
{}
]
},
"last_click": {
"available": true,
"revenue_cents": 123,
"orders": 123,
"roas": 123,
"series": [
{}
]
},
"meta_reported": {
"available": true,
"revenue_cents": 123,
"orders": 123,
"roas": 123,
"series": [
{}
]
},
"triple_whale": {
"available": true,
"revenue_cents": 123,
"orders": 123,
"roas": 123,
"series": [
{}
]
}
}
}
],
"blended": {
"totals": {
"gmv_cents": 123,
"commission_cents": 123,
"orders": 123,
"refund_cents": 123,
"active_creators": 123,
"aov_cents": 123,
"revenue_per_commission": 123
},
"deltas": {},
"series": [
{}
],
"prior_series": [
{}
]
}
}
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}Replaces
/stats/top_creators_by_gmv and /stats/top_earning_creators, which are deprecated.Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
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.
First day, YYYY-MM-DD. Default: 29 days before end_date.
Last day, YYYY-MM-DD. Default: today (UTC). At most 366 days in all.