Sign in
Weekly Report

Cross-shop agency roll-up

One row per shop for the window — affiliate GMV, videos posted, video views, videos converted, video conversion rate, active creators, GMV per video and GMV per sample, each with its % change against the previous equal-length period. This is the portal's Agency View table.

Covers every shop this API key can access, so it works with x-shop-id: all, a comma-separated list, or a single shop ID — a key scoped to a subset of shops only ever sees that subset. Sortable by any of: affiliate_gmv, videos_posted, video_views, active_creators, gmv_per_video, gmv_per_sample, video_conversion_rate, shop_name; search filters on shop name; results are paginated (page / page_size, max 100) and total_pagination is the number of shops you can see after filtering.

The window defaults to the last 7 settled days.

post/weekly-report/agency-view

Request body

start_datestring date nullable

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

end_datestring date nullable

Last day of the window (inclusive). Defaults to yesterday.

pageinteger

1-based page number.

page_sizeinteger

Rows per page (max 100).

sort_fieldstring

Column to sort by. One of: affiliate_gmv, videos_posted, video_views, active_creators, gmv_per_video, gmv_per_sample, video_conversion_rate, shop_name.

sort_orderstring

'asc' or 'desc'.

searchstring nullable

Case-insensitive shop-name filter.

Response

Successful Response

total_paginationinteger required
pageinteger required
page_sizeinteger required

Changes

No recorded changes to this endpoint across all 6 revisions of this API.