Sign in
Reports

Shopping Item Visibility

post/v1/reports/shopping/item-visibility

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'
include_competitorsboolean
target_productstring nullable
competitor_limitinteger
include_position_frequencyboolean

Response

Successful Response

dataobject[] required

Changes

Changed in 1 of the 84 revisions of this API.1