JavaScript
Reports
Query Visibility
Query visibility report.
POST
JavaScript
Authorizations
Body
application/json
Available options:
share_of_voice, mentions_count, visibility_score, executions, average_position Start date for the report. Accepts formats: YYYY-MM-DD, YYYY-MM-DD HH:MM, or full ISO timestamp.
End date for the report. Accepts formats: YYYY-MM-DD, YYYY-MM-DD HH:MM, or full ISO timestamp.
Date interval for the report. (only used with date dimension)
Available options:
hour, day, week, month, quarter, year, relative_week Dimensions to group the report by.
Available options:
date, region, topic, topic_id, model, asset_id, asset_name, prompt, prompt_id, tag, persona Custom ordering of the report results.
The order is a record of key-value pairs where:
- key is the field to order by, which can be a metric or dimension
- value is the direction of the order, either 'asc' for ascending or 'desc' for descending.
When not specified, the default order is the first metric in the query descending.
Example:
{ "date": "asc" }Pagination settings for the report results.
filters
(RegionIdFilter · object | RegionNameFilter · object | ModelIdFilter · object | TopicIdFilter · object | TopicNameFilter · object | AssetNameFilter · object | TagIdFilter · object | TagNameFilter · object | PromptIdFilter · object | PromptFilter · object | PersonaIdFilter · object)[]
List of filters to apply to the visibility report.
Filter by region UUID.
- RegionIdFilter
- RegionNameFilter
- ModelIdFilter
- TopicIdFilter
- TopicNameFilter
- AssetNameFilter
- TagIdFilter
- TagNameFilter
- PromptIdFilter
- PromptFilter
- PersonaIdFilter