// BASE CODE TEMPLATE:
curl --location --request POST 'https://business-api.tiktok.com/open_api/v1.3/event/track/' --header 'Access-Token: ACCESS_TOKEN' --header 'Content-Type: application/json' --data-raw '{
"event_source": "web",
"event_source_id": "CP3NPFRC77U6AE4R4680",
"data": [
{
"event": "Search",
"event_id": "", // string. A hashed ID that can identify a unique event. Example: "1616318632825_357".
"event_time": "", // number. The time that the event took place. Use unix timestamp. Example: 1697783008.
"user": {
"ttclid": "", // string. TikTok Click ID (ttclid) or a tracking parameter added to a landing page URL whenever a user clicks on an ad on TikTok. It starts with "E.C.P.".
"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.
"phone": "", // string. The phone number of the customer if available. It must be hashed with SHA-256 on the client side.
"email": "", // string. The email of the customer if available. It must be hashed with SHA-256 on the client side.
"ttp": "<_ttp>", // string. Cookie ID saved in the _ttp cookie when you use Pixel SDK and enable cookies. Example: "2F7h37YkS1j57AYSKTI7IHhJPYH"
"ip": "", // string. Non-hashed public IP address of the browser.
"user_agent": "" // string. Non-hashed user agent from the user’s device. Example: "Chrome/91.0.4472.124".
},
"page": {
"url": "" // string. The page URL where the event took place. Example: "http://demo.mywebsite.com/purchase"
},
"properties": {
"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".
"query": "" // string. The word or phrase used to search. Example: "SAVE10COUPON".
}
}
]
}'
curl --location --request POST 'https://business-api.tiktok.com/open_api/v1.3/event/track/' --header 'Access-Token: ACCESS_TOKEN' --header 'Content-Type: application/json' --data-raw '{
"event_source": "web",
"event_source_id": "CP3NPFRC77U6AE4R4680",
"data": [
{
"event": "ViewContent",
"event_id": "", // string. A hashed ID that can identify a unique event. Example: "1616318632825_357".
"event_time": "", // number. The time that the event took place. Use unix timestamp. Example: 1697783008.
"user": {
"ttclid": "", // string. TikTok Click ID (ttclid) or a tracking parameter added to a landing page URL whenever a user clicks on an ad on TikTok. It starts with "E.C.P.".
"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.
"phone": "", // string. The phone number of the customer if available. It must be hashed with SHA-256 on the client side.
"email": "", // string. The email of the customer if available. It must be hashed with SHA-256 on the client side.
"ttp": "<_ttp>", // string. Cookie ID saved in the _ttp cookie when you use Pixel SDK and enable cookies. Example: "2F7h37YkS1j57AYSKTI7IHhJPYH"
"ip": "", // string. Non-hashed public IP address of the browser.
"user_agent": "" // string. Non-hashed user agent from the user’s device. Example: "Chrome/91.0.4472.124".
},
"page": {
"url": "" // string. The page URL where the event took place. Example: "http://demo.mywebsite.com/purchase"
},
"properties": {
"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".
}
}
]
}'
curl --location --request POST 'https://business-api.tiktok.com/open_api/v1.3/event/track/' --header 'Access-Token: ACCESS_TOKEN' --header 'Content-Type: application/json' --data-raw '{
"event_source": "web",
"event_source_id": "CP3NPFRC77U6AE4R4680",
"data": [
{
"event": "Subscribe",
"event_id": "", // string. A hashed ID that can identify a unique event. Example: "1616318632825_357".
"event_time": "", // number. The time that the event took place. Use unix timestamp. Example: 1697783008.
"user": {
"ttclid": "", // string. TikTok Click ID (ttclid) or a tracking parameter added to a landing page URL whenever a user clicks on an ad on TikTok. It starts with "E.C.P.".
"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.
"phone": "", // string. The phone number of the customer if available. It must be hashed with SHA-256 on the client side.
"email": "", // string. The email of the customer if available. It must be hashed with SHA-256 on the client side.
"ttp": "<_ttp>", // string. Cookie ID saved in the _ttp cookie when you use Pixel SDK and enable cookies. Example: "2F7h37YkS1j57AYSKTI7IHhJPYH"
"ip": "", // string. Non-hashed public IP address of the browser.
"user_agent": "" // string. Non-hashed user agent from the user’s device. Example: "Chrome/91.0.4472.124".
},
"page": {
"url": "" // string. The page URL where the event took place. Example: "http://demo.mywebsite.com/purchase"
},
"properties": {
"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".
}
}
]
}'
curl --location --request POST 'https://business-api.tiktok.com/open_api/v1.3/event/track/' --header 'Access-Token: ACCESS_TOKEN' --header 'Content-Type: application/json' --data-raw '{
"event_source": "web",
"event_source_id": "CP3NPFRC77U6AE4R4680",
"data": [
{
"event": "AddPaymentInfo",
"event_id": "", // string. A hashed ID that can identify a unique event. Example: "1616318632825_357".
"event_time": "", // number. The time that the event took place. Use unix timestamp. Example: 1697783008.
"user": {
"ttclid": "", // string. TikTok Click ID (ttclid) or a tracking parameter added to a landing page URL whenever a user clicks on an ad on TikTok. It starts with "E.C.P.".
"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.
"phone": "", // string. The phone number of the customer if available. It must be hashed with SHA-256 on the client side.
"email": "", // string. The email of the customer if available. It must be hashed with SHA-256 on the client side.
"ttp": "<_ttp>", // string. Cookie ID saved in the _ttp cookie when you use Pixel SDK and enable cookies. Example: "2F7h37YkS1j57AYSKTI7IHhJPYH"
"ip": "", // string. Non-hashed public IP address of the browser.
"user_agent": "" // string. Non-hashed user agent from the user’s device. Example: "Chrome/91.0.4472.124".
},
"page": {
"url": "" // string. The page URL where the event took place. Example: "http://demo.mywebsite.com/purchase"
},
"properties": {
"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".
}
}
]
}'
curl --location --request POST 'https://business-api.tiktok.com/open_api/v1.3/event/track/' --header 'Access-Token: ACCESS_TOKEN' --header 'Content-Type: application/json' --data-raw '{
"event_source": "web",
"event_source_id": "CP3NPFRC77U6AE4R4680",
"data": [
{
"event": "AddToCart",
"event_id": "", // string. A hashed ID that can identify a unique event. Example: "1616318632825_357".
"event_time": "", // number. The time that the event took place. Use unix timestamp. Example: 1697783008.
"user": {
"ttclid": "", // string. TikTok Click ID (ttclid) or a tracking parameter added to a landing page URL whenever a user clicks on an ad on TikTok. It starts with "E.C.P.".
"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.
"phone": "", // string. The phone number of the customer if available. It must be hashed with SHA-256 on the client side.
"email": "", // string. The email of the customer if available. It must be hashed with SHA-256 on the client side.
"ttp": "<_ttp>", // string. Cookie ID saved in the _ttp cookie when you use Pixel SDK and enable cookies. Example: "2F7h37YkS1j57AYSKTI7IHhJPYH"
"ip": "", // string. Non-hashed public IP address of the browser.
"user_agent": "" // string. Non-hashed user agent from the user’s device. Example: "Chrome/91.0.4472.124".
},
"page": {
"url": "" // string. The page URL where the event took place. Example: "http://demo.mywebsite.com/purchase"
},
"properties": {
"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".
}
}
]
}'
curl --location --request POST 'https://business-api.tiktok.com/open_api/v1.3/event/track/' --header 'Access-Token: ACCESS_TOKEN' --header 'Content-Type: application/json' --data-raw '{
"event_source": "web",
"event_source_id": "CP3NPFRC77U6AE4R4680",
"data": [
{
"event": "InitiateCheckout",
"event_id": "", // string. A hashed ID that can identify a unique event. Example: "1616318632825_357".
"event_time": "", // number. The time that the event took place. Use unix timestamp. Example: 1697783008.
"user": {
"ttclid": "", // string. TikTok Click ID (ttclid) or a tracking parameter added to a landing page URL whenever a user clicks on an ad on TikTok. It starts with "E.C.P.".
"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.
"phone": "", // string. The phone number of the customer if available. It must be hashed with SHA-256 on the client side.
"email": "", // string. The email of the customer if available. It must be hashed with SHA-256 on the client side.
"ttp": "<_ttp>", // string. Cookie ID saved in the _ttp cookie when you use Pixel SDK and enable cookies. Example: "2F7h37YkS1j57AYSKTI7IHhJPYH"
"ip": "", // string. Non-hashed public IP address of the browser.
"user_agent": "" // string. Non-hashed user agent from the user’s device. Example: "Chrome/91.0.4472.124".
},
"page": {
"url": "" // string. The page URL where the event took place. Example: "http://demo.mywebsite.com/purchase"
},
"properties": {
"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".
}
}
]
}'
curl --location --request POST 'https://business-api.tiktok.com/open_api/v1.3/event/track/' --header 'Access-Token: ACCESS_TOKEN' --header 'Content-Type: application/json' --data-raw '{
"event_source": "web",
"event_source_id": "CP3NPFRC77U6AE4R4680",
"data": [
{
"event": "CompletePayment",
"event_id": "", // string. A hashed ID that can identify a unique event. Example: "1616318632825_357".
"event_time": "", // number. The time that the event took place. Use unix timestamp. Example: 1697783008.
"user": {
"ttclid": "", // string. TikTok Click ID (ttclid) or a tracking parameter added to a landing page URL whenever a user clicks on an ad on TikTok. It starts with "E.C.P.".
"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.
"phone": "", // string. The phone number of the customer if available. It must be hashed with SHA-256 on the client side.
"email": "", // string. The email of the customer if available. It must be hashed with SHA-256 on the client side.
"ttp": "<_ttp>", // string. Cookie ID saved in the _ttp cookie when you use Pixel SDK and enable cookies. Example: "2F7h37YkS1j57AYSKTI7IHhJPYH"
"ip": "", // string. Non-hashed public IP address of the browser.
"user_agent": "" // string. Non-hashed user agent from the user’s device. Example: "Chrome/91.0.4472.124".
},
"page": {
"url": "" // string. The page URL where the event took place. Example: "http://demo.mywebsite.com/purchase"
},
"properties": {
"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('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".
"query": "" // string. The word or phrase used to search. Example: "SAVE10COUPON".
});
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('Subscribe', {
"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('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".
});
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".
}
],
"value": "", // number. Value of the order or items sold. Example: 100.
"currency": "" // string. The 4217 currency code. Example: "USD".
});
ttq.track('CompletePayment', {
"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".
});
