Skip to main content

Get Effectiveness Report

GET 

/v1/apps/:app_key/effectiveness/:dimension

Returns entity-level VTO effectiveness metrics for either products or variants, including ready, exploration, add-to-cart, and go-to-product activity. exploration_events counts actual rendered try-ons (onTryOn); use GET /v1/events for documented mappings. This route is limited to 31 days. Rows are ordered by add-to-cart, go-to-product, and try-on counts descending, then entity key ascending. Traverse using meta.pagination.next_offset until has_next is false, keeping app, dimension, and dates unchanged. total counts matching analytics entities, not catalog shades or events. Late events and backfills can change rankings between requests; generated_at is not a snapshot identifier. Empty pages may have data_state: empty even when total is positive.

Request​

Responses​

Effectiveness analytics payload