Halo Effect Tracker

Branded-search detail and its TikTok correlation

Changed on

Amazon branded search is the cleanest halo signal there is: nobody searches a brand by name unless something put it in their head, and on TikTok-driven brands that something is usually a video. This returns the daily branded-search volume and click share for the window, the window totals, the peak day, and the Pearson correlation against TikTok views at the requested lag_days — the same regression the analysis endpoint runs.

top_search_terms is always null: Amazon reports branded-search volume per ASIN per day, not the query strings, so there is no term list to return. The field exists so it can be filled later without a breaking change.

Pass asins to scope to specific products; omit for every tracked ASIN. An empty series means branded search isn't tracked for this shop (check branded_search on GET /halo/channels). Single-shop only.

post/halo/branded-search

Request

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

Request body

start_datestring date nullable

Inclusive window start (YYYY-MM-DD).

end_datestring date nullable

Inclusive window end (YYYY-MM-DD).

asinsstring[] nullable

Restrict to these ASINs. Omit for every tracked ASIN.

lag_daysinteger

Shift TikTok views forward N days before correlating.

Response

Successful Response

shop_idinteger required
start_datestring required
end_datestring required
lag_daysinteger required
asinsstring[] nullable

The ASIN filter applied, echoed back.

total_search_termsinteger nullable

Sum of daily branded-search volume.

average_click_sharenumber nullable

Mean of the daily click-share values.

peak_datestring nullable

Date of the highest branded-search volume.

peak_search_termsinteger nullable
top_search_termsstring[] nullable

Always null. Amazon's report gives us branded-search VOLUME per ASIN per day, not the query strings, so no term list exists to return. Reserved so the field can be populated without a breaking change if term-level data is ever ingested.

Changes

    • info

      api operation id halo_branded_search_halo_branded_search_post removed and replaced with halo_branded_search