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

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
​
occurred_at
string

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:
AED,
AFN,
ALL,
AMD,
ANG,
AOA,
ARS,
AUD,
AWG,
AZN,
BAM,
BBD,
BDT,
BGN,
BHD,
BIF,
BMD,
BND,
BOB,
BRL,
BSD,
BTN,
BWP,
BYN,
BZD,
CAD,
CDF,
CHF,
CLP,
CNY,
COP,
CRC,
CVE,
CZK,
DJF,
DKK,
DOP,
DZD,
EGP,
ERN,
ETB,
EUR,
FJD,
FKP,
GBP,
GEL,
GHS,
GIP,
GMD,
GNF,
GTQ,
GYD,
HKD,
HNL,
HRK,
HTG,
HUF,
IDR,
ILS,
INR,
IQD,
IRR,
ISK,
JEP,
JMD,
JOD,
JPY,
KES,
KGS,
KHR,
KID,
KMF,
KRW,
KWD,
KYD,
KZT,
LAK,
LBP,
LKR,
LRD,
LSL,
LTL,
LVL,
LYD,
MAD,
MDL,
MGA,
MKD,
MMK,
MNT,
MOP,
MRU,
MUR,
MVR,
MWK,
MXN,
MYR,
MZN,
NAD,
NGN,
NIO,
NOK,
NPR,
NZD,
OMR,
PAB,
PEN,
PGK,
PHP,
PKR,
PLN,
PYG,
QAR,
RON,
RSD,
RUB,
RWF,
SAR,
SBD,
SCR,
SDG,
SEK,
SGD,
SHP,
SLL,
SOS,
SRD,
SSP,
STN,
SYP,
SZL,
THB,
TJS,
TMT,
TND,
TOP,
TRY,
TTD,
TWD,
TZS,
UAH,
UGX,
USD,
UYU,
UZS,
VED,
VES,
VND,
VUV,
WST,
XAF,
XCD,
XOF,
XPF,
XXX,
YER,
ZAR,
ZM
​
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.

Response

201
application/json
Tracking event created successfully
​
success
boolean