TOOL API

custom_conversion_get

Retrieves the details of a Custom Conversion associated with a Pixel or an App. The Custom Conversion must be identified by `custom_conversion_id`, and the request must also specify the matching event source context: `event_source_type=PIXEL` with a Pixel ID, or `event_source_type=APP` with the app platform ID of a Self Attribution Network (SAN) App. To obtain valid IDs, use `/custom_conversion/list/`, `/pixel/list/`, and `/app/list/` as applicable; for APP sources, confirm the app's `self_attribution_enabled` is `true` and use its `app_platform_id`.

ecommerceOAuth1 credits

Call information

Tool slug: tiktok-ads.custom_conversion_get
Provider: TikTok for Business
Average response: 0 ms
Calls in 7 days: 0

Input parameters

advertiser_idrequired

Advertiser ID.

custom_conversion_idrequired

ID of the Custom Conversion to retrieve. To obtain Custom Conversion IDs associated with a Pixel or an App, use `/custom_conversion/list/`.

event_source_idrequired

Event source ID. Required with a value that matches `event_source_type`. When `event_source_type` is `PIXEL`, specify a Pixel ID; obtain valid IDs from `/pixel/list/` and use the returned `pixel_id`. When `event_source_type` is `APP`, specify the app platform ID of a Self Attribution Network (SAN) App; obtain valid IDs from `/app/list/`, confirm the app's `self_attribution_enabled` is `true`, and use the returned `app_platform_id`.

event_source_typerequired

Event source type. This determines how to interpret `event_source_id`: `PIXEL` means `event_source_id` must be a Pixel ID; `APP` means `event_source_id` must be the app platform ID of a Self Attribution Network (SAN) App.