TOOL API
pixel_ instant_ page_ event_ get
Returns the supported Instant Page events for the specified objective type and optimization goal. Use this endpoint to determine which Instant Page events are available for your setup. By using Events API endpoints, you agree to the TikTok Business Products (Data) Terms at https://ads.tiktok.com/i18n/official/policy/business-products-terms and must not share sensitive data with TikTok. Compared with v1.2, this v1.3 endpoint uses /v1.3/pixel/instant_page/event/, changes `advertiser_id` from number to string, renames request parameter `optimize_goal` to `optimization_goal`, renames response fields `optimize_goals` to `optimization_goals` and `external_actions` to `optimization_events`, and changes `business_type` enum from `CUSTOM_INSTANT_PAGE` to `TIKTOK_INSTANT_PAGE`.
Call information
- Tool slug
- tiktok-ads.pixel_instant_page_event_get
- Provider
- TikTok for Business
- Average response
- 0 ms
- Calls in 7 days
- 0
Input parameters
advertiser_idrequiredAdvertiser ID.
is_retargetingWhether the request is for retargeting.
objective_typerequiredObjective type. Must be either `CONVERSIONS` or `APP_PROMOTION`.
optimization_goalrequiredOptimization goal for the specified `objective_type`.