Sign in

v84

latestOpenAPI 3.1.0raw.githubusercontent.com2026-07-0985248447.1 KB
Reports

Shopping All Items With Merchants

post/v1/reports/shopping/all-items-with-merchants

Request body

category_idstring uuid required
start_datestring date-time required

Start date. Accepts YYYY-MM-DD, YYYY-MM-DD HH:MM, or ISO timestamp.

end_datestring date-time required

End date. Accepts YYYY-MM-DD, YYYY-MM-DD HH:MM, or ISO timestamp.

comparison_start_datestring date-time nullable
comparison_end_datestring date-time nullable
date_interval'hour' | 'day' | 'week' | 'month' | 'quarter' | 'year' | 'relative_week'
order_byobject
include_countboolean
tag_filter_type'any' | 'all'
include_no_tagboolean
exclude_topic_idsboolean
dimensionsstring[]
metricsstring[]
owned_asset_namesstring[]
include_itemsstring[]
search_itemstring nullable
merchant_filter_type'any' | 'all'
rank_by'visibility' | 'average_position' | 'name'
sort_order'asc' | 'desc'

Response

Successful Response

dataobject[] required