Sign in
Videos

Video performance (date-filtered)

Top videos ranked by GMV or views earned within a specific date range. Unlike /videos/list (which shows lifetime totals), this endpoint uses daily performance data and matches the dashboard's 'Top Videos' section exactly. Defaults to the last 30 days. Use this for period-specific rankings, trend analysis, and correlating video performance with product sales.

post/videos/performance

Request body

pageinteger
page_sizeinteger
sort_by'video_gmv' | 'views' | 'like_count' | 'order_count' | 'posted_date' nullable
sort_dir'asc' | 'desc'
start_datestring date nullable
end_datestring date nullable
creator_handlestring nullable
min_gmvnumber nullable
min_viewsinteger nullable

Response

Successful Response

currencystring required
{"stackTrail":"components:schemas:VideoPerformanceResponse:properties:pagination","oasType":"schema","type":"unknown","title":"Pagination"}
shops_queriedstring[] nullable

Shop names included when querying multiple shops (x-shop-id: all or comma-separated).

Changes

No recorded changes to this endpoint across all 1 revision of this API.