TikTok Shop Videos

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

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

fetch('https://api.growi.io/api/public/v1/tik_tok_shop/videos', 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/videos",
  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/videos"

	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/videos")

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

{
  "data": [
    {
      "id": 123,
      "external_id": "<string>",
      "external_creator_id": "<string>",
      "title": "<string>",
      "truncated_title": "<string>",
      "share_url": "<string>",
      "product_name": "<string>",
      "create_time": "<string>",
      "pretty_create_time": "<string>",
      "connected_account_data": {},
      "affiliate_id": 123,
      "affiliate_name": "<string>",
      "affiliate_email": "<string>",
      "affiliate_avatar_url": "<string>",
      "total_gmv": 123,
      "total_gmv_formatted": "<string>",
      "total_commission": 123,
      "total_commission_formatted": "<string>",
      "total_refunded_amount": 123,
      "total_refunded_amount_formatted": "<string>",
      "total_units_sold": 123,
      "total_units_sold_formatted": "<string>",
      "total_sku_orders": 123,
      "total_sku_orders_formatted": "<string>",
      "total_items_refunded": 123,
      "total_items_refunded_formatted": "<string>",
      "total_views": 123,
      "total_views_formatted": "<string>"
    }
  ],
  "meta": {
    "row_count": 123,
    "total_pages": 123,
    "current_page": 123,
    "next_page": 123,
    "prev_page": 123
  },
  "additional_data": {
    "total_gmv": 123,
    "total_units_sold": 123,
    "total_sku_orders": 123,
    "total_commission": 123,
    "total_items_refunded": 123,
    "total_refunded_amount": 123,
    "currency_symbol": "<string>",
    "currency": "<string>"
  }
}

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

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

GET

tik_tok_shop

videos

TikTok Shop Videos

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

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

fetch('https://api.growi.io/api/public/v1/tik_tok_shop/videos', 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/videos",
  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/videos"

	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/videos")

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

{
  "data": [
    {
      "id": 123,
      "external_id": "<string>",
      "external_creator_id": "<string>",
      "title": "<string>",
      "truncated_title": "<string>",
      "share_url": "<string>",
      "product_name": "<string>",
      "create_time": "<string>",
      "pretty_create_time": "<string>",
      "connected_account_data": {},
      "affiliate_id": 123,
      "affiliate_name": "<string>",
      "affiliate_email": "<string>",
      "affiliate_avatar_url": "<string>",
      "total_gmv": 123,
      "total_gmv_formatted": "<string>",
      "total_commission": 123,
      "total_commission_formatted": "<string>",
      "total_refunded_amount": 123,
      "total_refunded_amount_formatted": "<string>",
      "total_units_sold": 123,
      "total_units_sold_formatted": "<string>",
      "total_sku_orders": 123,
      "total_sku_orders_formatted": "<string>",
      "total_items_refunded": 123,
      "total_items_refunded_formatted": "<string>",
      "total_views": 123,
      "total_views_formatted": "<string>"
    }
  ],
  "meta": {
    "row_count": 123,
    "total_pages": 123,
    "current_page": 123,
    "next_page": 123,
    "prev_page": 123
  },
  "additional_data": {
    "total_gmv": 123,
    "total_units_sold": 123,
    "total_sku_orders": 123,
    "total_commission": 123,
    "total_items_refunded": 123,
    "total_refunded_amount": 123,
    "currency_symbol": "<string>",
    "currency": "<string>"
  }
}

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

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

Lists shoppable videos for your TikTok Shop — one row per video with GMV, units sold, orders, views, and refund totals for the requested date range. This is the same data as the Videos tab of the TikTok Shop store page, with every filter the dashboard offers.

Response Fields

Each video row contains:

Field	Type	Description
`id`	Integer \| null	Internal snapshot id
`external_id`	String	TikTok video id
`external_creator_id`	String \| null	TikTok creator id (oecuid) of the poster
`title` / `truncated_title`	String	Video title (full / truncated to 30 chars)
`share_url`	String	Video share URL (`"#"` when unavailable)
`product_name`	String \| null	Featured product name
`create_time`	String	Video post time (ISO 8601)
`pretty_create_time`	String	Display string, e.g. `"July 10, 2026"`
`affiliate_id` / `affiliate_name` / `affiliate_email` / `affiliate_avatar_url`	Mixed	Growi creator info (`"N/A"` / null when the creator is not on Growi)
`connected_account_data`	Object	Linked TikTok account info
`total_gmv`	Number	GMV in display currency units
`total_units_sold`	Integer	Items sold
`total_sku_orders`	Integer	SKU orders
`total_commission`	Number	Estimated commission
`total_refunded_amount`	Number	Refunded amount
`total_items_refunded`	Integer	Items refunded
`total_views`	Integer	Video views
`*_formatted`	String	Display-string variant of every metric above

The response envelope is { data, meta, additional_data } (see the Creators endpoint for the envelope shape).

Request Parameters

Parameter	Type	Description	Required	Default
`start_date`	String	Start of the GMV date range (ISO 8601, `YYYY-MM-DD`)	Yes	—
`end_date`	String	End of the GMV date range (ISO 8601, `YYYY-MM-DD`)	Yes	—
`page`	Integer	Page number	No	1
`per_page`	Integer	Results per page (max 100)	No	20
`search`	String	Search by video URL, id, or title	No	—
`campaign_id`	Integer	Filter to a campaign or contract in your organization	No	—
`creator_id`	Integer	Filter to a single Growi creator (user id)	No	—
`external_creator_id`	String	Filter to a single TikTok creator (oecuid)	No	—
`connected_account_id`	Integer	Filter by connected social account id	No	—
`platform`	String	`growi`, `all`, or `non_growi`	No	`growi`
`gmv_min` / `gmv_max`	Number	GMV range bounds in display currency units	No	—
`post_start_date` / `post_end_date`	String	Filter by video post date (ISO 8601); must be provided together	No	—
`product_id`	String	Filter by TikTok Shop product id	No	—
`user_content_id`	String	Filter to a single tracked content item	No	—
`linked`	String	`all`, `linked`, or `unlinked`	No	`all`
`include_zero_gmv`	String	Include videos with zero GMV	No	`true`
`organization_id`	Integer	Narrow to a child organization	No	—

Request Example

curl -X GET "https://api.growi.io/api/public/v1/tik_tok_shop/videos?start_date=2026-07-01&end_date=2026-07-31&platform=all&include_zero_gmv=false" \
     -H "Authorization: Bearer YOUR_PUBLIC_API_KEY" \
     -H "Content-Type: application/json"

Response Example

{
  "data": [
    {
      "id": 998877,
      "external_id": "7523456789012345678",
      "external_creator_id": "7495033444...",
      "title": "My favorite peach vitamins!",
      "truncated_title": "My favorite peach vitamins!...",
      "share_url": "https://www.tiktok.com/@janecreates/video/7523456789012345678",
      "product_name": "Peach Perfect Multivitamin",
      "create_time": "2026-07-10T12:00:00Z",
      "pretty_create_time": "July 10, 2026",
      "affiliate_name": "Jane Creator",
      "total_gmv": 5432.1,
      "total_gmv_formatted": "$5,432.10",
      "total_units_sold": 180,
      "total_units_sold_formatted": "180",
      "total_views": 120000,
      "total_views_formatted": "120,000"
    }
  ],
  "meta": {
    "row_count": 1892,
    "total_pages": 95,
    "current_page": 1,
    "next_page": 2,
    "prev_page": null
  },
  "additional_data": {
    "total_gmv": 250000.5,
    "total_units_sold": 10400,
    "total_sku_orders": 9020,
    "total_commission": 37500.25,
    "total_items_refunded": 310,
    "total_refunded_amount": 6100.0,
    "currency_symbol": "$",
    "currency": "usd"
  }
}

Use Cases

Identifying top-converting videos by GMV and views
Attributing video performance to specific products (product_id) or campaigns (campaign_id)
Separating GMV attribution by post date vs. sale date with the post date range filters
Auditing linked vs. unlinked content with the linked filter

Notes

Results are always ordered by total GMV descending; there is no sort parameter.
include_zero_gmv=true (the default, matching the dashboard) includes videos that drove no sales in the range.
post_start_date / post_end_date filter on when the video was posted; start_date / end_date filter on when the GMV occurred.
Requests are rate limited (minimum 2 seconds between requests plus an hourly quota); see the X-RateLimit-* response headers.

Authorizations

Authorization

string

header

required

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

Query Parameters

start_date

string<date>

required

Start of the GMV date range (ISO 8601, YYYY-MM-DD)

end_date

string<date>

required

End of the GMV date range (ISO 8601, YYYY-MM-DD)

page

integer

default:1

Page number (default 1)

per_page

integer

default:20

Results per page: 1-100, default 20

Required range: x <= 100

string

Free-text search

campaign_id

integer

Filter to a campaign or contract belonging to your organization

creator_id

integer

Filter to a single Growi creator (user id)

platform

enum<string>

default:growi

Data scope: growi (only creators on Growi, default), all (all TikTok Shop data), non_growi (creators not on Growi)

Available options:

growi,

all,

non_growi

organization_id

integer

Narrow results to a child organization (id) of the API key organization

external_creator_id

string

Filter to a single TikTok creator by TikTok creator id (oecuid)

connected_account_id

integer

Filter by connected social account id (matches dashboard behavior; prefer external_creator_id)

gmv_min

number

Minimum GMV in display currency units (e.g. dollars)

gmv_max

number

Maximum GMV in display currency units (e.g. dollars)

post_start_date

string<date>

Filter by video post date, range start (ISO 8601). Must be paired with post_end_date.

post_end_date

string<date>

Filter by video post date, range end (ISO 8601). Must be paired with post_start_date.

product_id

string

Filter by TikTok Shop product id

user_content_id

string

Filter to a single tracked content item

linked

enum<string>

default:all

Filter by linked status

Available options:

all,

linked,

unlinked

include_zero_gmv

enum<string>

default:true

Include videos with zero GMV (default true)

Available options:

true,

false

Response

Videos listed

data

object[]

required

Show child attributes

Get Started

Essentials

API Documentation

Tracking Events

Stats API

TikTok Shop API

Organization API

Applications API

Conversions API

Webhooks

TikTok Shop Videos

Response Fields

Request Parameters

Request Example

Response Example

Use Cases

Notes

Authorizations

Query Parameters

Response

​Response Fields

​Request Parameters

​Request Example

​Response Example

​Use Cases

​Notes

Authorizations

Query Parameters

Response

Response Fields

Request Parameters

Request Example

Response Example

Use Cases

Notes