REreacherapp
Videos

List videos

Changed on

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.

A creator can tag several products on one post. products lists all of them (primary first); product_id/product_name are the primary one only. The product filters default to matching that primary product — set product_match: "any" to match a product tagged anywhere on the post.

post/videos/list

Request

  • Base URL
    https://api.reacherapp.com/public/v1
  • URL
    https://api.reacherapp.com/public/v1/videos/list
  • Auth
    API key in header x-api-key and API key in header x-shop-id

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
product_match'primary' | 'any'

How the product filter matches. 'primary' (default) tests only the video's primary product_id. 'any' matches a product tagged anywhere on the post, so multi-product videos are no longer missed — note a video tagging two products is then returned for BOTH, each time carrying its full video_gmv, so do not sum GMV across per-product queries under 'any'.

Response

Successful Response

currencystring required
paginationunknown required
shops_queriedstring[] nullable

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

Changes

  • 2a7ed9f8c407Revision changes
    • info

      added the new optional request property

    • info

      added the optional property // to the response with the status

  • 291230805105Revision changes
    • info

      api operation id videos_list_videos_list_post removed and replaced with videos_list