Reports
Shopping Visibility
post/v1/reports/shopping/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[]
search_assetstring nullable
include_assetstring nullable
include_asset_onlyboolean
include_assets_onlystring[]
rank_by'visibility_score' | 'average_position'
include_position_frequencyboolean
Response
Successful Response
dataobject[] required