Weekly Report

Full weekly affiliate report for one shop

Changed on

The complete affiliate performance report for one shop over a date window — the same payload the Reacher portal renders and exports.

Includes affiliate GMV, units sold, GMV per video and GMV per sample (each with the previous equal-length period and its % change); recruitment counters (creators reached, sample requests, samples approved, DM / TC / email reply rates); performance counters (videos posted, video views, creators posting, creators converting); the creator-level distribution (L0-L7); six top-product leaderboards (GMV, units, sample requests, approvals, conversions, growth); top creators; top videos; and the rule-based recommendations.

Single-shop only — set x-shop-id to a specific shop ID. The window defaults to the last 7 settled days and is capped at 90 days; end_date must be at least 1 day in the past. An end_date past the shop's newest settled day is clamped to it, which can make the window shorter than requested (the 7-day default included) — the response's start_date/end_date always report the window actually used, and the period-over-period comparison follows that same length. Returns 404 when the shop has no activity in the settled part of the window, and when the requested window lies entirely past the settled day — that message names the newest day the shop is reportable through, so a caller can retry against a window that works.

post/weekly-report

Request

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

Request body

start_datestring date nullable

First day of the window (inclusive). Defaults to 7 days before end_date.

end_datestring date nullable

Last day of the window (inclusive). Must be at least 1 day in the past — today is never fully settled. Defaults to yesterday.

Response

Successful Response

idinteger nullable
shop_idinteger required
shop_namestring required
customer_idinteger required
start_datestring required
end_datestring required
currency_symbolstring
all_timeboolean
affiliate_gmvnumber required
affiliate_gmv_prev_weeknumber nullable
affiliate_gmv_pct_changenumber nullable
video_attributed_gmvnumber

SUM of video-cohort-attributed GMV (from shop_video_gmv). This is the numerator of gmv_per_video.

gmv_per_videonumber required

video_attributed_gmv / distinct videos with sales. Uses cohort-attributed video GMV, NOT total affiliate GMV.

gmv_per_video_prev_weeknumber nullable
gmv_per_video_pct_changenumber nullable
sample_attributed_gmvnumber

SUM of sample-cohort-attributed GMV (from product_sample_performance). This is the numerator of gmv_per_sample.

gmv_per_samplenumber required

sample_attributed_gmv / shipped samples. Uses cohort-attributed sample GMV, NOT total affiliate GMV.

gmv_per_sample_prev_weeknumber nullable
gmv_per_sample_pct_changenumber nullable
units_soldinteger required
units_sold_prev_weekinteger nullable
units_sold_pct_changenumber nullable
total_creators_reachedinteger required
total_sample_requestsinteger required
total_samples_approvedinteger required
creators_added_to_showcaseinteger
dm_reply_ratenumber nullable
tc_reply_ratenumber nullable
email_open_ratenumber nullable
email_reply_ratenumber nullable
videos_postedinteger required
videos_posted_prev_weekinteger nullable
videos_posted_pct_changenumber nullable
video_viewsinteger required
creators_posting_videosinteger required
creators_convertinginteger required
creators_converting_prev_weekinteger nullable
creators_converting_pct_changenumber nullable
videos_generating_salesinteger

Changes

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • breaking

      the response property became optional for the status

    • breaking

      the response property became optional for the status

    • breaking

      the response property became optional for the status

    • breaking

      the response property became optional for the status

    • breaking

      the response property became optional for the status

    • breaking

      the response property became optional for the status

    • breaking

      the response property became optional for the status

    • breaking

      the response property became optional for the status

    • breaking

      the response property became optional for the status

    • breaking

      the response property became optional for the status

    • breaking

      the response property became optional for the status

    • breaking

      the response property became optional for the status

    • breaking

      response property affiliate_gmv_pct_change list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property affiliate_gmv_prev_week list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property creators_converting_pct_change list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property creators_converting_prev_week list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property gmv_per_sample_pct_change list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property gmv_per_sample_prev_week list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property gmv_per_video_pct_change list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property gmv_per_video_prev_week list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property units_sold_pct_change list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property units_sold_prev_week list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property videos_posted_pct_change list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property videos_posted_prev_week list-of-types was widened by adding types null to media type application/json of response 200

    • info

      added the optional property to the response with the status