{ "openapi": "3.0.1", "info": { "title": "TikTok Events API - Server-Side Conversions", "description": "Send offline events and server-side conversions to TikTok Events API. Track purchases, signups, and custom events with automatic PII hashing for campaign attribution.", "version": "1.0", "x-build-id": "T7jcMMYbCOYBjiBdT" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/alizarin_refrigerator-owner~tiktok-events-api---server-side-conversions/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-alizarin_refrigerator-owner-tiktok-events-api---server-side-conversions", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } }, "/acts/alizarin_refrigerator-owner~tiktok-events-api---server-side-conversions/runs": { "post": { "operationId": "runs-sync-alizarin_refrigerator-owner-tiktok-events-api---server-side-conversions", "x-openai-isConsequential": false, "summary": "Executes an Actor and returns information about the initiated run in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runsResponseSchema" } } } } } } }, "/acts/alizarin_refrigerator-owner~tiktok-events-api---server-side-conversions/run-sync": { "post": { "operationId": "run-sync-alizarin_refrigerator-owner-tiktok-events-api---server-side-conversions", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "inputSchema": { "type": "object", "required": [ "task" ], "properties": { "task": { "title": "Task", "enum": [ "send_event", "send_batch_events", "test_event", "list_pixels", "get_pixel_info" ], "type": "string", "description": "The operation to perform", "default": "send_event" }, "accessToken": { "title": "TikTok Access Token", "type": "string", "description": "TikTok Marketing API access token" }, "pixelCode": { "title": "Pixel Code", "type": "string", "description": "TikTok Pixel code to send events to" }, "advertiserId": { "title": "Advertiser ID", "type": "string", "description": "TikTok Ads advertiser account ID" }, "testEventCode": { "title": "Test Event Code", "type": "string", "description": "Test event code from Events Manager" }, "eventName": { "title": "Event Name", "enum": [ "CompletePayment", "PlaceAnOrder", "InitiateCheckout", "AddToCart", "ViewContent", "AddToWishlist", "Search", "Contact", "Subscribe", "SubmitForm", "CompleteRegistration", "Download", "CustomEvent" ], "type": "string", "description": "Standard or custom event name", "default": "CompletePayment" }, "customEventName": { "title": "Custom Event Name", "type": "string", "description": "Name for custom event (if eventName is CustomEvent)" }, "events": { "title": "Events (JSON Array)", "type": "string", "description": "JSON array of event objects for batch sending" }, "email": { "title": "Email", "type": "string", "description": "Customer email (will be hashed)" }, "phone": { "title": "Phone", "type": "string", "description": "Customer phone (will be hashed)" }, "externalId": { "title": "External ID", "type": "string", "description": "Your unique customer identifier (will be hashed)" }, "ttclid": { "title": "TikTok Click ID (ttclid)", "type": "string", "description": "TikTok click ID from URL parameter" }, "ttp": { "title": "TikTok Cookie ID (ttp)", "type": "string", "description": "TikTok cookie value (_ttp)" }, "ipAddress": { "title": "IP Address", "type": "string", "description": "Customer IP address" }, "userAgent": { "title": "User Agent", "type": "string", "description": "Browser user agent string" }, "eventTime": { "title": "Event Time", "type": "string", "description": "Event timestamp (Unix timestamp in seconds)" }, "eventSourceUrl": { "title": "Event Source URL", "type": "string", "description": "URL where the conversion occurred" }, "value": { "title": "Conversion Value", "type": "number", "description": "Monetary value of the conversion" }, "currency": { "title": "Currency", "type": "string", "description": "ISO 4217 currency code", "default": "USD" }, "orderId": { "title": "Order ID", "type": "string", "description": "Unique order/transaction identifier" }, "contentId": { "title": "Content ID", "type": "string", "description": "Product/content identifier" }, "contentType": { "title": "Content Type", "enum": [ "product", "product_group" ], "type": "string", "description": "Type of content", "default": "product" }, "quantity": { "title": "Quantity", "minimum": 1, "type": "integer", "description": "Number of items", "default": 1 }, "isAlreadyHashed": { "title": "Data Already Hashed", "type": "boolean", "description": "Set to true if PII data is already SHA256 hashed", "default": false }, "webhookUrl": { "title": "Result Webhook URL", "type": "string", "description": "URL to receive results via webhook" }, "demoMode": { "title": "Demo Mode", "type": "boolean", "description": "Run with sample data for testing (no external API calls)", "default": true } } }, "runsResponseSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "actId": { "type": "string" }, "userId": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "finishedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "status": { "type": "string", "example": "READY" }, "meta": { "type": "object", "properties": { "origin": { "type": "string", "example": "API" }, "userAgent": { "type": "string" } } }, "stats": { "type": "object", "properties": { "inputBodyLen": { "type": "integer", "example": 2000 }, "rebootCount": { "type": "integer", "example": 0 }, "restartCount": { "type": "integer", "example": 0 }, "resurrectCount": { "type": "integer", "example": 0 }, "computeUnits": { "type": "integer", "example": 0 } } }, "options": { "type": "object", "properties": { "build": { "type": "string", "example": "latest" }, "timeoutSecs": { "type": "integer", "example": 300 }, "memoryMbytes": { "type": "integer", "example": 1024 }, "diskMbytes": { "type": "integer", "example": 2048 } } }, "buildId": { "type": "string" }, "defaultKeyValueStoreId": { "type": "string" }, "defaultDatasetId": { "type": "string" }, "defaultRequestQueueId": { "type": "string" }, "buildNumber": { "type": "string", "example": "1.0.0" }, "containerUrl": { "type": "string" }, "usage": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "integer", "example": 1 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } }, "usageTotalUsd": { "type": "number", "example": 0.00005 }, "usageUsd": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "number", "example": 0.00005 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } } } } } } } } }