Discovery filters

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

import requests

url = "https://api.growi.io/api/public/v1/tik_tok_shop/creators/discover/filters"

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/creators/discover/filters', 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/creators/discover/filters",
  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/creators/discover/filters"

	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/creators/discover/filters")

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

{
  "options": [
    {
      "optionType": "OPTION_LANGUAGE",
      "options": [
        {
          "id": "1",
          "name": "English",
          "children": []
        }
      ]
    }
  ],
  "sorters": [
    {
      "algorithmId": "1",
      "name": "Recommended"
    }
  ],
  "semantics": {
    "pageSizes": [
      12,
      20
    ],
    "gmvRanges": [
      {
        "value": "GMV_RANGE_0_100",
        "label": "0-100"
      },
      {
        "value": "GMV_RANGE_100_1000",
        "label": "100-1000"
      },
      {
        "value": "GMV_RANGE_1000_10000",
        "label": "1000-10000"
      },
      {
        "value": "GMV_RANGE_10000_AND_ABOVE",
        "label": "10000+"
      }
    ],
    "notes": [
      "GMV and units sold are TikTok's four fixed buckets, not continuous ranges."
    ]
  }
}

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

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

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

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

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

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

Discovery filters

Returns the filters and sort orders you can use with Discover creators. options and sorters come live from TikTok and vary by region. Pass an option’s optionType and chosen ids back as advanced.options, and a sorter’s algorithmId as advanced.sorterAlgorithmId. semantics lists Growi’s fixed values: page sizes, the GMV and units-sold buckets with readable labels, and notes on how the ranges read. This call doesn’t count against the creator discovery quota.

GET

tik_tok_shop

creators

discover

filters

Discovery filters

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

import requests

url = "https://api.growi.io/api/public/v1/tik_tok_shop/creators/discover/filters"

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/creators/discover/filters', 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/creators/discover/filters",
  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/creators/discover/filters"

	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/creators/discover/filters")

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

{
  "options": [
    {
      "optionType": "OPTION_LANGUAGE",
      "options": [
        {
          "id": "1",
          "name": "English",
          "children": []
        }
      ]
    }
  ],
  "sorters": [
    {
      "algorithmId": "1",
      "name": "Recommended"
    }
  ],
  "semantics": {
    "pageSizes": [
      12,
      20
    ],
    "gmvRanges": [
      {
        "value": "GMV_RANGE_0_100",
        "label": "0-100"
      },
      {
        "value": "GMV_RANGE_100_1000",
        "label": "100-1000"
      },
      {
        "value": "GMV_RANGE_1000_10000",
        "label": "1000-10000"
      },
      {
        "value": "GMV_RANGE_10000_AND_ABOVE",
        "label": "10000+"
      }
    ],
    "notes": [
      "GMV and units sold are TikTok's four fixed buckets, not continuous ranges."
    ]
  }
}

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

organization_id

integer

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

Response

TikTok's per-region options and sort orders, plus the fixed rules Growi applies.

options

object[]

required

Show child attributes

sorters

object[]

required

Show child attributes

semantics

object

required

Fixed enums, labels and notes.

Overview

Conversions

Tracking events

Campaign affiliates

Organization

Applications

Stats

TikTok Shop

Discovery filters

Authorizations

Query Parameters

Response