TOOL API

diagnostic_catalog_eventsource_metric_get

Retrieves app-event or pixel-event trend metrics for a catalog, including the number of events available for retargeting and the catalog match rate. Before using this endpoint, bind an event source to the catalog in a Business Center with /catalog/eventsource/bind/ or in TikTok Ads Manager. To verify whether an event source is already bound to a catalog, use /catalog/eventsource_bind/get/.

ecommerceOAuth1 credits

Call information

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

Input parameters

app_id

Required when `event_source_type` is `APP`. App ID bound to the specified `catalog_id`.

bc_idrequired

Business Center ID.

catalog_idrequired

Catalog ID.

event_source_typerequired

Event source type. If set to `APP`, you must also pass `app_id`. If set to `PIXEL`, you must also pass `pixel_code`.

event_type

Event type to retrieve metrics for. Defaults to `VIEW_CONTENT` if omitted.

pixel_code

Required when `event_source_type` is `PIXEL`. Pixel code bound to the specified `catalog_id`.

time_range

Time range for the metrics. Defaults to `LAST_7_DAYS` if omitted.