Sales channel mix

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

import requests

url = "https://api.growi.io/api/public/v1/tik_tok_shop/analytics/channel_mix"

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/tik_tok_shop/analytics/channel_mix', 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/tik_tok_shop/analytics/channel_mix",
  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/tik_tok_shop/analytics/channel_mix"

	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/tik_tok_shop/analytics/channel_mix")

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

{
  "shopId": "7494000000000000123",
  "startDate": "2026-09-01",
  "endDate": "2026-09-08",
  "currency": "USD",
  "total": {
    "gmv": "1000.00",
    "skuOrders": 40,
    "itemsSold": 44,
    "impressions": 52000,
    "clicks": 1900
  },
  "channels": [
    {
      "channel": "seller_video",
      "source": "seller",
      "contentType": "video",
      "gmv": "100.00",
      "gmvShare": 0.1,
      "skuOrders": 4,
      "itemsSold": 4,
      "impressions": 6000,
      "clicks": 210
    },
    {
      "channel": "seller_live",
      "source": "seller",
      "contentType": "live",
      "gmv": "50.00",
      "gmvShare": 0.05,
      "skuOrders": 2,
      "itemsSold": 2,
      "impressions": 1500,
      "clicks": 60
    },
    {
      "channel": "seller_product_card",
      "source": "seller",
      "contentType": "product_card",
      "gmv": "350.00",
      "gmvShare": 0.35,
      "skuOrders": 14,
      "itemsSold": 16,
      "impressions": 20000,
      "clicks": 800
    },
    {
      "channel": "affiliate_video",
      "source": "affiliate",
      "contentType": "video",
      "gmv": "300.00",
      "gmvShare": 0.3,
      "skuOrders": null,
      "itemsSold": null,
      "impressions": 18000,
      "clicks": 600
    },
    {
      "channel": "affiliate_live",
      "source": "affiliate",
      "contentType": "live",
      "gmv": "100.00",
      "gmvShare": 0.1,
      "skuOrders": null,
      "itemsSold": null,
      "impressions": 6500,
      "clicks": 230
    },
    {
      "channel": "affiliate_product_card",
      "source": "affiliate",
      "contentType": "product_card",
      "gmv": "100.00",
      "gmvShare": 0.1,
      "skuOrders": null,
      "itemsSold": null,
      "impressions": null,
      "clicks": null
    }
  ],
  "bySource": {
    "seller": {
      "gmv": "500.00",
      "gmvShare": 0.5,
      "skuOrders": 20,
      "itemsSold": 22
    },
    "affiliate": {
      "gmv": "500.00",
      "gmvShare": 0.5,
      "skuOrders": 20,
      "itemsSold": 22
    }
  },
  "shopTab": {
    "gmv": "120.00",
    "gmvShare": 0.12,
    "itemsSold": 5,
    "impressions": 4000,
    "clicks": 150,
    "estimatedCustomers": 5
  },
  "products": {
    "counted": 42,
    "totalCount": 42,
    "pages": 1,
    "maxPages": 5,
    "truncated": false
  },
  "latestAvailableDate": "2026-09-27",
  "productCard": null,
  "productCardReason": "no_seller_session"
}

{
  "error": "<string>",
  "code": "<string>"
}

{
  "error": "<string>",
  "code": "<string>"
}

{
  "error": "<string>",
  "code": "<string>"
}

{
  "error": "<string>",
  "code": "<string>"
}

{
  "error": "<string>",
  "code": "<string>"
}

{
  "error": "<string>",
  "code": "<string>"
}

Sales channel mix

Breaks the shop’s GMV down by sales channel for a date window: seller video, seller LIVE, seller product card, affiliate video, affiliate LIVE and affiliate product card. The six channels don’t overlap and add up to total.gmv. Each has gmv, gmvShare (0 to 1), impressions and clicks; SKU orders and items sold exist for seller channels only. bySource sums seller and affiliate. shopTab is reported alongside because it overlaps the channels.

start_date is inclusive and end_date is exclusive (YYYY-MM-DD, shop timezone). Data lags 1 to 2 days (latestAvailableDate). Totals are summed over the shop’s products, 100 per page in GMV order, and max_pages (1 to 10, default 5) caps how many pages are read. When products.truncated is true, the numbers cover only the top products. currency is USD or LOCAL (TikTok’s default).

US shops with an active Seller Center login also get productCard: product card GMV split into shop tab, search and other. When it can’t be served it’s null and productCardReason says why.

GET

tik_tok_shop

analytics

channel_mix

Sales channel mix

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

import requests

url = "https://api.growi.io/api/public/v1/tik_tok_shop/analytics/channel_mix"

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/tik_tok_shop/analytics/channel_mix', 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/tik_tok_shop/analytics/channel_mix",
  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/tik_tok_shop/analytics/channel_mix"

	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/tik_tok_shop/analytics/channel_mix")

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

{
  "shopId": "7494000000000000123",
  "startDate": "2026-09-01",
  "endDate": "2026-09-08",
  "currency": "USD",
  "total": {
    "gmv": "1000.00",
    "skuOrders": 40,
    "itemsSold": 44,
    "impressions": 52000,
    "clicks": 1900
  },
  "channels": [
    {
      "channel": "seller_video",
      "source": "seller",
      "contentType": "video",
      "gmv": "100.00",
      "gmvShare": 0.1,
      "skuOrders": 4,
      "itemsSold": 4,
      "impressions": 6000,
      "clicks": 210
    },
    {
      "channel": "seller_live",
      "source": "seller",
      "contentType": "live",
      "gmv": "50.00",
      "gmvShare": 0.05,
      "skuOrders": 2,
      "itemsSold": 2,
      "impressions": 1500,
      "clicks": 60
    },
    {
      "channel": "seller_product_card",
      "source": "seller",
      "contentType": "product_card",
      "gmv": "350.00",
      "gmvShare": 0.35,
      "skuOrders": 14,
      "itemsSold": 16,
      "impressions": 20000,
      "clicks": 800
    },
    {
      "channel": "affiliate_video",
      "source": "affiliate",
      "contentType": "video",
      "gmv": "300.00",
      "gmvShare": 0.3,
      "skuOrders": null,
      "itemsSold": null,
      "impressions": 18000,
      "clicks": 600
    },
    {
      "channel": "affiliate_live",
      "source": "affiliate",
      "contentType": "live",
      "gmv": "100.00",
      "gmvShare": 0.1,
      "skuOrders": null,
      "itemsSold": null,
      "impressions": 6500,
      "clicks": 230
    },
    {
      "channel": "affiliate_product_card",
      "source": "affiliate",
      "contentType": "product_card",
      "gmv": "100.00",
      "gmvShare": 0.1,
      "skuOrders": null,
      "itemsSold": null,
      "impressions": null,
      "clicks": null
    }
  ],
  "bySource": {
    "seller": {
      "gmv": "500.00",
      "gmvShare": 0.5,
      "skuOrders": 20,
      "itemsSold": 22
    },
    "affiliate": {
      "gmv": "500.00",
      "gmvShare": 0.5,
      "skuOrders": 20,
      "itemsSold": 22
    }
  },
  "shopTab": {
    "gmv": "120.00",
    "gmvShare": 0.12,
    "itemsSold": 5,
    "impressions": 4000,
    "clicks": 150,
    "estimatedCustomers": 5
  },
  "products": {
    "counted": 42,
    "totalCount": 42,
    "pages": 1,
    "maxPages": 5,
    "truncated": false
  },
  "latestAvailableDate": "2026-09-27",
  "productCard": null,
  "productCardReason": "no_seller_session"
}

{
  "error": "<string>",
  "code": "<string>"
}

{
  "error": "<string>",
  "code": "<string>"
}

{
  "error": "<string>",
  "code": "<string>"
}

{
  "error": "<string>",
  "code": "<string>"
}

{
  "error": "<string>",
  "code": "<string>"
}

{
  "error": "<string>",
  "code": "<string>"
}

Authorizations

Authorization

string

header

required

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

Query Parameters

start_date

string

required

Window start, YYYY-MM-DD inclusive (shop timezone).

end_date

string

required

Window end, YYYY-MM-DD EXCLUSIVE (TikTok's end_date_lt semantics). Must be after start_date.

max_pages

integer

default:5

Cap on product pages walked (100 products each, one TikTok call each, a few seconds each).

Required range: 1 <= x <= 10

currency

enum<string>

USD for US dollars or LOCAL for the shop's own currency. TikTok defaults to LOCAL.

Available options:

USD,

LOCAL

organization_id

integer

Use the TikTok Shop of this child brand (organization id) of your API key's organization

Response

Channel totals and shares for the window.

shopId

string

required

startDate

string

required

endDate

string

required

Exclusive, as requested.

currency

string | null

required

null when products came back in more than one currency, or when there were no products. Every amount and share is then null too.

total

object

required

Show child attributes

channels

object[]

required

Always the six channels, in a fixed order. They do not overlap and their gmv adds up to total.gmv.

Show child attributes

bySource

object

required

Show child attributes

shopTab

object

required

Shop tab sales and traffic. Overlaps the channels, so its share is not part of their sum.

Show child attributes

products

object

required

Show child attributes

latestAvailableDate

string | null

required

Freshness marker. TikTok's analytics lag is typically T+1 to T+2.

productCard

object | null

required

Product card GMV by entry point, from TikTok Seller Center (TikTok's official API has no search channel). US shops only, and only while the shop's Seller Center session is active. Same window as the rest of the response, in US Pacific days. Seller Center has intraday values for today and yesterday, so a window past latestAvailableDate can show product card GMV the channels don't. Cached per shop and window for about 5 minutes. null when it can't be served (productCardReason says why); the rest of the response is unaffected.

Show child attributes

productCardReason

enum<string> | null

required

Why productCard is null; null when it is present. no_seller_session: no seller web cookie on file, or no official token (the block needs both). region_not_supported: not a US shop (not called). session_expired: TikTok answered 98001002, the seller must log in again. captcha: TikTok challenged the call and one retry did not clear it. unexpected_response: the answer did not carry the expected metrics. upstream_error: any other failure, including an HTML or block page. timeout: Seller Center did not answer within about 8 seconds; the response went out without the block, and the late result is cached for the next request. A failure is remembered for about 2 minutes, so retrying sooner gets the same reason.

Available options:

no_seller_session,

region_not_supported,

session_expired,

captcha,

unexpected_response,

upstream_error,

timeout,

null

Overview

Conversions

Tracking events

Campaign affiliates

Organization

Applications

Stats

TikTok Shop

Sales channel mix

Authorizations

Query Parameters

Response