Create Tracking Event

cURL

curl --request POST \
  --url https://api.growi.io/api/public/v1/tracking_events \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "occurred_at": "2023-11-07T05:31:56Z",
  "visitor_uid": "<string>",
  "event_data": {},
  "subtotal": 123,
  "order_id": "<string>",
  "payment_id": "<string>",
  "external_user_id": "<string>",
  "quantity": 123,
  "campaign_affiliate_id": "<string>",
  "subscription_start_date": 123,
  "subscription_end_date": 123,
  "product_id": "<string>"
}
'

import requests

url = "https://api.growi.io/api/public/v1/tracking_events"

payload = {
    "occurred_at": "2023-11-07T05:31:56Z",
    "visitor_uid": "<string>",
    "event_data": {},
    "subtotal": 123,
    "order_id": "<string>",
    "payment_id": "<string>",
    "external_user_id": "<string>",
    "quantity": 123,
    "campaign_affiliate_id": "<string>",
    "subscription_start_date": 123,
    "subscription_end_date": 123,
    "product_id": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    occurred_at: '2023-11-07T05:31:56Z',
    visitor_uid: '<string>',
    event_data: {},
    subtotal: 123,
    order_id: '<string>',
    payment_id: '<string>',
    external_user_id: '<string>',
    quantity: 123,
    campaign_affiliate_id: '<string>',
    subscription_start_date: 123,
    subscription_end_date: 123,
    product_id: '<string>'
  })
};

fetch('https://api.growi.io/api/public/v1/tracking_events', 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/tracking_events",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'occurred_at' => '2023-11-07T05:31:56Z',
    'visitor_uid' => '<string>',
    'event_data' => [
        
    ],
    'subtotal' => 123,
    'order_id' => '<string>',
    'payment_id' => '<string>',
    'external_user_id' => '<string>',
    'quantity' => 123,
    'campaign_affiliate_id' => '<string>',
    'subscription_start_date' => 123,
    'subscription_end_date' => 123,
    'product_id' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.growi.io/api/public/v1/tracking_events"

	payload := strings.NewReader("{\n  \"occurred_at\": \"2023-11-07T05:31:56Z\",\n  \"visitor_uid\": \"<string>\",\n  \"event_data\": {},\n  \"subtotal\": 123,\n  \"order_id\": \"<string>\",\n  \"payment_id\": \"<string>\",\n  \"external_user_id\": \"<string>\",\n  \"quantity\": 123,\n  \"campaign_affiliate_id\": \"<string>\",\n  \"subscription_start_date\": 123,\n  \"subscription_end_date\": 123,\n  \"product_id\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.growi.io/api/public/v1/tracking_events")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"occurred_at\": \"2023-11-07T05:31:56Z\",\n  \"visitor_uid\": \"<string>\",\n  \"event_data\": {},\n  \"subtotal\": 123,\n  \"order_id\": \"<string>\",\n  \"payment_id\": \"<string>\",\n  \"external_user_id\": \"<string>\",\n  \"quantity\": 123,\n  \"campaign_affiliate_id\": \"<string>\",\n  \"subscription_start_date\": 123,\n  \"subscription_end_date\": 123,\n  \"product_id\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.growi.io/api/public/v1/tracking_events")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"occurred_at\": \"2023-11-07T05:31:56Z\",\n  \"visitor_uid\": \"<string>\",\n  \"event_data\": {},\n  \"subtotal\": 123,\n  \"order_id\": \"<string>\",\n  \"payment_id\": \"<string>\",\n  \"external_user_id\": \"<string>\",\n  \"quantity\": 123,\n  \"campaign_affiliate_id\": \"<string>\",\n  \"subscription_start_date\": 123,\n  \"subscription_end_date\": 123,\n  \"product_id\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "success": true
}

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

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

POST

tracking_events

cURL

curl --request POST \
  --url https://api.growi.io/api/public/v1/tracking_events \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "occurred_at": "2023-11-07T05:31:56Z",
  "visitor_uid": "<string>",
  "event_data": {},
  "subtotal": 123,
  "order_id": "<string>",
  "payment_id": "<string>",
  "external_user_id": "<string>",
  "quantity": 123,
  "campaign_affiliate_id": "<string>",
  "subscription_start_date": 123,
  "subscription_end_date": 123,
  "product_id": "<string>"
}
'

import requests

url = "https://api.growi.io/api/public/v1/tracking_events"

payload = {
    "occurred_at": "2023-11-07T05:31:56Z",
    "visitor_uid": "<string>",
    "event_data": {},
    "subtotal": 123,
    "order_id": "<string>",
    "payment_id": "<string>",
    "external_user_id": "<string>",
    "quantity": 123,
    "campaign_affiliate_id": "<string>",
    "subscription_start_date": 123,
    "subscription_end_date": 123,
    "product_id": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    occurred_at: '2023-11-07T05:31:56Z',
    visitor_uid: '<string>',
    event_data: {},
    subtotal: 123,
    order_id: '<string>',
    payment_id: '<string>',
    external_user_id: '<string>',
    quantity: 123,
    campaign_affiliate_id: '<string>',
    subscription_start_date: 123,
    subscription_end_date: 123,
    product_id: '<string>'
  })
};

fetch('https://api.growi.io/api/public/v1/tracking_events', 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/tracking_events",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'occurred_at' => '2023-11-07T05:31:56Z',
    'visitor_uid' => '<string>',
    'event_data' => [
        
    ],
    'subtotal' => 123,
    'order_id' => '<string>',
    'payment_id' => '<string>',
    'external_user_id' => '<string>',
    'quantity' => 123,
    'campaign_affiliate_id' => '<string>',
    'subscription_start_date' => 123,
    'subscription_end_date' => 123,
    'product_id' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.growi.io/api/public/v1/tracking_events"

	payload := strings.NewReader("{\n  \"occurred_at\": \"2023-11-07T05:31:56Z\",\n  \"visitor_uid\": \"<string>\",\n  \"event_data\": {},\n  \"subtotal\": 123,\n  \"order_id\": \"<string>\",\n  \"payment_id\": \"<string>\",\n  \"external_user_id\": \"<string>\",\n  \"quantity\": 123,\n  \"campaign_affiliate_id\": \"<string>\",\n  \"subscription_start_date\": 123,\n  \"subscription_end_date\": 123,\n  \"product_id\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.growi.io/api/public/v1/tracking_events")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"occurred_at\": \"2023-11-07T05:31:56Z\",\n  \"visitor_uid\": \"<string>\",\n  \"event_data\": {},\n  \"subtotal\": 123,\n  \"order_id\": \"<string>\",\n  \"payment_id\": \"<string>\",\n  \"external_user_id\": \"<string>\",\n  \"quantity\": 123,\n  \"campaign_affiliate_id\": \"<string>\",\n  \"subscription_start_date\": 123,\n  \"subscription_end_date\": 123,\n  \"product_id\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.growi.io/api/public/v1/tracking_events")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"occurred_at\": \"2023-11-07T05:31:56Z\",\n  \"visitor_uid\": \"<string>\",\n  \"event_data\": {},\n  \"subtotal\": 123,\n  \"order_id\": \"<string>\",\n  \"payment_id\": \"<string>\",\n  \"external_user_id\": \"<string>\",\n  \"quantity\": 123,\n  \"campaign_affiliate_id\": \"<string>\",\n  \"subscription_start_date\": 123,\n  \"subscription_end_date\": 123,\n  \"product_id\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "success": true
}

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

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

Authorizations

Authorization

string

header

required

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

Body

application/json

Tracking event to be added

event_name

enum<string>

required

Name of the event

Available options:

cart_viewed,

checkout_address_info_submitted,

checkout_completed,

checkout_contact_info_submitted,

checkout_shipping_info_submitted,

checkout_started,

collection_viewed,

page_viewed,

payment_info_submitted,

product_added_to_cart,

product_removed_from_cart,

product_viewed,

search_submitted,

payment_completed,

app_installed,

app_uninstalled

occurred_at

string<date-time>

Timestamp of when the event occurred

visitor_uid

string

Unique identifier for the visitor

event_data

object

Additional data related to the event

subtotal

integer | null

Subtotal amount of the transaction in cents. For example, for $40, input 4000.

currency

enum<string> | null

Currency of the transaction

Available options:

usd,

eur,

gbp

conversion_platform

enum<string>

Which platform the conversion happened on

Available options:

shopify,

tik_tok_shop,

ios,

stripe,

whop

order_id

string | null

ID of the order

order_type

enum<string> | null

Type of the order

Available options:

one_time,

subscription

payment_id

string | null

ID of the payment

external_user_id

string | null

External user ID associated with the event

quantity

integer

Quantity involved in the event

campaign_affiliate_id

string

Tag of the campaign affiliate associated with the event. Not required when order_id is present and the order is a recurring subscription.

subscription_start_date

integer

UTC integer timestamp for the start of the subscription. Required only for subscription events.

subscription_end_date

integer

UTC integer timestamp for the end of the subscription. Required only for subscription events.

product_id

string

The product or plan ID associated with the purchase. Required only for payment events.

Response

Tracking event created successfully

success

boolean

Get Started

Essentials

API Documentation

Tracking Events

Stats API

TikTok Shop API

Organization API

Conversions API

Authorizations

Body

Response