Product performance

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

import requests

url = "https://api.growi.io/api/public/v1/tik_tok_shop/analytics/products/{productId}/performance"

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/products/{productId}/performance', 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/products/{productId}/performance",
  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/products/{productId}/performance"

	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/products/{productId}/performance")

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

{
  "productId": "1729000000000000100",
  "title": "Example Serum 30ml",
  "imageUrl": "https://media.example.com/products/1729000000000000100.jpg",
  "latestAvailableDate": "2026-09-27",
  "intervals": [
    {
      "startDate": "2026-09-01",
      "endDate": "2026-09-02",
      "gmv": {
        "amount": "149.94",
        "currency": "USD"
      },
      "orders": 6,
      "itemsSold": 6,
      "salesByChannel": [
        {
          "contentType": "VIDEO",
          "gmv": {
            "amount": "99.96",
            "currency": "USD"
          },
          "itemsSold": 4,
          "avgCustomers": 4
        },
        {
          "contentType": "PRODUCT_CARD",
          "gmv": {
            "amount": "49.98",
            "currency": "USD"
          },
          "itemsSold": 2,
          "avgCustomers": 2
        }
      ],
      "trafficByChannel": [
        {
          "contentType": "VIDEO",
          "impressions": 21000,
          "pageViews": 640,
          "avgUniquePageViews": 600,
          "ctr": "0.0305",
          "avgConversionRate": "0.0067"
        }
      ],
      "cancelAndRefunds": null
    }
  ],
  "ratings": [
    {
      "stars": "5",
      "count": 120,
      "percentage": "0.80"
    }
  ]
}

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

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

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

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

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

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

Product performance

Returns one product’s performance over time from TikTok’s analytics: all-channel GMV, orders and items sold per day or as one total, with sales and traffic split by channel (VIDEO, LIVE, PRODUCT_CARD), cancelled, returned and refunded units, and the star-rating breakdown. title and imageUrl come from the shop’s catalog.

start_date is inclusive and end_date is exclusive, both YYYY-MM-DD in the shop’s timezone, so pass the day after the last day you want. TikTok rejects windows starting more than about 180 days back. granularity is 1D (default, one interval per day) or ALL (one total). TikTok fills the cancel and refund counts only on ALL. currency is USD or LOCAL (TikTok’s default). latestAvailableDate shows the newest day TikTok has data for.

GET

tik_tok_shop

analytics

products

{productId}

performance

Product performance

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

import requests

url = "https://api.growi.io/api/public/v1/tik_tok_shop/analytics/products/{productId}/performance"

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/products/{productId}/performance', 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/products/{productId}/performance",
  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/products/{productId}/performance"

	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/products/{productId}/performance")

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

{
  "productId": "1729000000000000100",
  "title": "Example Serum 30ml",
  "imageUrl": "https://media.example.com/products/1729000000000000100.jpg",
  "latestAvailableDate": "2026-09-27",
  "intervals": [
    {
      "startDate": "2026-09-01",
      "endDate": "2026-09-02",
      "gmv": {
        "amount": "149.94",
        "currency": "USD"
      },
      "orders": 6,
      "itemsSold": 6,
      "salesByChannel": [
        {
          "contentType": "VIDEO",
          "gmv": {
            "amount": "99.96",
            "currency": "USD"
          },
          "itemsSold": 4,
          "avgCustomers": 4
        },
        {
          "contentType": "PRODUCT_CARD",
          "gmv": {
            "amount": "49.98",
            "currency": "USD"
          },
          "itemsSold": 2,
          "avgCustomers": 2
        }
      ],
      "trafficByChannel": [
        {
          "contentType": "VIDEO",
          "impressions": 21000,
          "pageViews": 640,
          "avgUniquePageViews": 600,
          "ctr": "0.0305",
          "avgConversionRate": "0.0067"
        }
      ],
      "cancelAndRefunds": null
    }
  ],
  "ratings": [
    {
      "stars": "5",
      "count": 120,
      "percentage": "0.80"
    }
  ]
}

{
  "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.

Path Parameters

productId

string

required

TikTok product id.

Pattern: ^[0-9]{1,32}$

Query Parameters

start_date

string<date>

required

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

end_date

string<date>

required

Window end, YYYY-MM-DD EXCLUSIVE (TikTok's end_date_lt semantics). TikTok rejects windows starting more than ~180 days back.

granularity

enum<string>

default:1D

1D = one interval per day, ALL = one aggregate interval.

Available options:

1D,

ALL

currency

enum<string>

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

The product's intervals.

productId

string

title

string | null

imageUrl

string | null

latestAvailableDate

string | null

intervals

object[]

Show child attributes

ratings

object[]

Show child attributes

Overview

Conversions

Tracking events

Campaign affiliates

Organization

Applications

Stats

TikTok Shop

Product performance

Authorizations

Path Parameters

Query Parameters

Response