REreacherapp
Samples

Sample metrics by product

Changed on

Sample performance breakdown by product. Shows requests, approvals, and GMV per product. Data can be up to three days stale, given the delay in affiliate center.

post/samples/by-product

Request

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

Request body

pageinteger
page_sizeinteger
sort_by'total_requests' | 'approved' | 'samples_shipped' | 'samples_approved' | 'sample_gmv' nullable
sort_dir'asc' | 'desc'
start_datestring date nullable
end_datestring date nullable

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

  • 30bc16d75a0aRevision changes
    • info

      added the new samples_approved enum value to the request property /

    • info

      added the new samples_shipped enum value to the request property /

    • info

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

    • info

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

    • info

      response property data/items/approved deprecated

  • 291230805105Revision changes
    • info

      api operation id samples_by_product_endpoint_samples_by_product_post removed and replaced with samples_by_product