TOOL API

custom_conversion_list_get

Retrieves the Custom Conversions associated with an event source, which can be either a Pixel or an App, via `/open_api/v1.3/custom_conversion/list/`.

ecommerceOAuth1 credits

Call information

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

Input parameters

advertiser_idrequired

Advertiser ID.

event_source_idrequired

Event source ID. 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 returned `self_attribution_enabled` is `true`, and use the returned `app_platform_id`.

event_source_typerequired

Event source type. Enum values: `PIXEL` for Pixel, `APP` for App.

page

Current page number. Value range: greater than or equal to 1. Default value: 1.

page_size

Page size. Value range: 1-1,000. Default value: 10.

search_keyword

Keyword used to search Custom Conversions by name or Custom Conversion ID. Name searches support fuzzy matching; Custom Conversion ID searches support exact matching.

sort_field

Sorting field. Enum values: `CREATE_TIME` for the Custom Conversion creation time, `TOTAL_COUNT` for the total conversion count. Default value: `CREATE_TIME`.

sort_type

Sorting type. Enum values: `DESC` for descending, `ASC` for ascending. Default value: `DESC`.