curl --location --request POST 'https://business-api.tiktok.com/open_api/v1.3/event/track/' --header 'Access-Token: <>' --header 'Content-Type: application/json' --data-raw '{
"event_source": "web",
"event_source_id": "D9OKMP3C77U1NSLT2B1G ",
"data": [
{
"event": "ClickButton",
"event_time": 1785891514,
"user": {
"email": null,
"phone": null,
"external_id": null
},
"properties": {
"currency": null,
"content_type": null
},
"page": {
"url": null,
"referrer": null
}
}
]
}'
// add this before event code to all pages where PII data postback is expected and appropriate
ttq.identify({
"email": "", // string. The email of the customer if available. It must be hashed with SHA-256 on the client side.
"phone_number": "", // string. The phone number of the customer if available. It must be hashed with SHA-256 on the client side.
"external_id": "" // string. Any unique identifier, such as loyalty membership IDs, user IDs, and external cookie IDs.It must be hashed with SHA-256 on the client side.
});
ttq.track('ViewContent', {
"contents": [
{
"content_id": "", // string. ID of the product. Example: "1077218".
"content_type": "", // string. Either product or product_group.
"content_name": "" // string. The name of the page or product. Example: "shirt".
}
],
"value": "", // number. Value of the order or items sold. Example: 100.
"currency": "" // string. The 4217 currency code. Example: "USD".
});
ttq.track('AddToWishlist', {
"contents": [
{
"content_id": "", // string. ID of the product. Example: "1077218".
"content_type": "", // string. Either product or product_group.
"content_name": "" // string. The name of the page or product. Example: "shirt".
}
],
"value": "", // number. Value of the order or items sold. Example: 100.
"currency": "" // string. The 4217 currency code. Example: "USD".
});
ttq.track('Search', {
"contents": [
{
"content_id": "", // string. ID of the product. Example: "1077218".
"content_type": "", // string. Either product or product_group.
"content_name": "" // string. The name of the page or product. Example: "shirt".
}
],
"value": "", // number. Value of the order or items sold. Example: 100.
"currency": "", // string. The 4217 currency code. Example: "USD".
"search_string": "" // string. The word or phrase used to search. Example: "SAVE10COUPON".
});
ttq.track('AddPaymentInfo', {
"contents": [
{
"content_id": "", // string. ID of the product. Example: "1077218".
"content_type": "", // string. Either product or product_group.
"content_name": "" // string. The name of the page or product. Example: "shirt".
}
],
"value": "", // number. Value of the order or items sold. Example: 100.
"currency": "" // string. The 4217 currency code. Example: "USD".
});
ttq.track('AddToCart', {
"contents": [
{
"content_id": "", // string. ID of the product. Example: "1077218".
"content_type": "", // string. Either product or product_group.
"content_name": "" // string. The name of the page or product. Example: "shirt".
}
],
"value": "", // number. Value of the order or items sold. Example: 100.
"currency": "", // string. The 4217 currency code. Example: "USD".
"search_string": "" // string. The word or phrase used to search. Example: "SAVE10COUPON".
});
ttq.track('InitiateCheckout', {
"contents": [
{
"content_id": "", // string. ID of the product. Example: "1077218".
"content_type": "", // string. Either product or product_group.
"content_name": "", // string. The name of the page or product. Example: "shirt".
"content_category": "", // string. The category of the page or product. Example: "apparel".
"price": "", // number. The price of a single item. Example: 25.
"num_items": "", // number. The number of items. Example: 4.
"brand": "" // string. The brand name of the page or product. Example: "Nike".
}
],
"value": "", // number. Value of the order or items sold. Example: 100.
"currency": "", // string. The 4217 currency code. Example: "USD".
"search_string": "", // string. The word or phrase used to search. Example: "SAVE10COUPON".
"description": "", // string. Non-hashed public IP address of the browser.
"status": "" // string. The status of an order, item, or service. Example: "submitted".
});
ttq.track('PlaceAnOrder', {
"contents": [
{
"content_id": "", // string. ID of the product. Example: "1077218".
"content_type": "", // string. Either product or product_group.
"content_name": "", // string. The name of the page or product. Example: "shirt".
"content_category": "", // string. The category of the page or product. Example: "apparel".
"price": "", // number. The price of a single item. Example: 25.
"num_items": "", // number. The number of items. Example: 4.
"brand": "" // string. The brand name of the page or product. Example: "Nike".
}
],
"value": "", // number. Value of the order or items sold. Example: 100.
"currency": "", // string. The 4217 currency code. Example: "USD".
"search_string": "", // string. The word or phrase used to search. Example: "SAVE10COUPON".
"description": "", // string. Non-hashed public IP address of the browser.
"status": "" // string. The status of an order, item, or service. Example: "submitted".
});
ttq.track('CompleteRegistration', {
"contents": [
{
"content_id": "", // string. ID of the product. Example: "1077218".
"content_type": "", // string. Either product or product_group.
"content_name": "" // string. The name of the page or product. Example: "shirt".
}
],
"value": "", // number. Value of the order or items sold. Example: 100.
"currency": "" // string. The 4217 currency code. Example: "USD".
});
ttq.track('Purchase', {
"contents": [
{
"content_id": "", // string. ID of the product. Example: "1077218".
"content_type": "", // string. Either product or product_group.
"content_name": "" // string. The name of the page or product. Example: "shirt".
}
],
"value": "", // number. Value of the order or items sold. Example: 100.
"currency": "" // string. The 4217 currency code. Example: "USD".
});
// add this before event code to all pages where PII data postback is expected and appropriate
ttq.identify({
"email": "", // string. The email of the customer if available. It must be hashed with SHA-256 on the client side.
"phone_number": "", // string. The phone number of the customer if available. It must be hashed with SHA-256 on the client side.
"external_id": "" // string. Any unique identifier, such as loyalty membership IDs, user IDs, and external cookie IDs.It must be hashed with SHA-256 on the client side.
});
ttq.track('ViewContent', {
"contents": [
{
"content_id": "", // string. ID of the product. Example: "1077218".
"content_type": "", // string. Either product or product_group.
"content_name": "" // string. The name of the page or product. Example: "shirt".
}
],
"value": "", // number. Value of the order or items sold. Example: 100.
"currency": "" // string. The 4217 currency code. Example: "USD".
});
ttq.track('Search', {
"contents": [
{
"content_id": "", // string. ID of the product. Example: "1077218".
"content_type": "", // string. Either product or product_group.
"content_name": "" // string. The name of the page or product. Example: "shirt".
}
],
"value": "", // number. Value of the order or items sold. Example: 100.
"currency": "", // string. The 4217 currency code. Example: "USD".
"search_string": "" // string. The word or phrase used to search. Example: "SAVE10COUPON".
});
ttq.track('ClickButton', {
"contents": [
{
"content_id": "", // string. ID of the product. Example: "1077218".
"content_type": "", // string. Either product or product_group.
"content_name": "", // string. The name of the page or product. Example: "shirt".
"content_category": "", // string. The category of the page or product. Example: "apparel".
"price": "", // number. The price of a single item. Example: 25.
"num_items": "", // number. The number of items. Example: 4.
"brand": "" // string. The brand name of the page or product. Example: "Nike".
}
],
"value": "", // number. Value of the order or items sold. Example: 100.
"currency": "", // string. The 4217 currency code. Example: "USD".
"description": "", // string. Non-hashed public IP address of the browser.
"status": "" // string. The status of an order, item, or service. Example: "submitted".
});
ttq.track('Lead', {
"contents": [
{
"content_id": "", // string. ID of the product. Example: "1077218".
"content_type": "", // string. Either product or product_group.
"content_name": "" // string. The name of the page or product. Example: "shirt".
}
],
"value": "", // number. Value of the order or items sold. Example: 100.
"currency": "" // string. The 4217 currency code. Example: "USD".
});
