Videos

List videos

Affiliate videos and their performance metrics. Values represent lifetime totals per video (total views, total GMV, etc.). Data can be up to three days stale, given the delay in affiliate center.

post/videos/list

Request body

pageinteger
page_sizeinteger
sort_by'video_gmv' | 'views' | 'units_sold' | 'posted_date' | 'like_count' nullable
sort_dir'asc' | 'desc'
start_datestring date nullable
end_datestring date nullable
creator_idstring nullable
creator_handlestring nullable
product_idstring nullable
product_idsstring[] nullable

Restrict to these product ids (IN filter). Max 50. The single product_id filter still works and is ANDed if both are supplied.

min_gmvnumber nullable
min_viewsinteger nullable

Response

Successful Response

currencystring required
{"stackTrail":"components:schemas:VideosListPaginatedResponse: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.