Samples

Sample request pipeline funnel counts

Changed on

How many sample requests sit at each stage of the fulfilment funnel: toReview → readyToShip → shipped → pendingContent → completed, plus cancelled. Also returns the shop's completionRate, its approvalTarget usage, the archivedCount, and expiringCount (requests about to lapse if no decision is made). approvalTarget is always shop-wide: it ignores product_ids and sku_ids.

Counts honour the same filters as the portal table, so a filtered funnel and a filtered list agree. They EXCLUDE requests hidden because the creator is archived (archivedCount.total is how many those are, and archivedCounts is unset here); for stage counts that include them, and so match TikTok's Affiliate Center, use GET /funnel/v2/counts. The portal's advanced numeric creator filters (GMV / views / post-rate bands) are not exposed here — use POST /samples/list and aggregate if you need those.

date_from/date_to must be given together. Single-shop only.

get/samples/pipeline-counts

Request

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

Query parameters

product_idsstring nullable

Comma-separated product IDs to filter by.

sku_idsstring nullable

Comma-separated SKU IDs. AND-ed with product_ids, so passing both narrows to those SKUs rather than widening.

date_fromstring date nullable

Start of the window (inclusive). Requires date_to.

date_tostring date nullable

End of the window (inclusive). Requires date_from.

exclude_rejectedboolean

Exclude creators previously rejected/cancelled by this shop.

include_archivedboolean

Include sample requests archived in the portal.

searchstring nullable

Free-text filter on creator handle / name.

tagsstring nullable

Comma-separated CRM tags to filter by.

show_expiringboolean

Count only requests that are close to expiring.

Response

Successful Response

completionRatenumber required
expiringCountinteger

Changes