Skip to main content
POST
JavaScript

Authorizations

X-API-Key
string
header
required

Body

application/json
metrics
enum<string>[]
required
Available options:
fanouts_per_execution,
total_fanouts,
share,
query_variations
category_id
string<uuid>
required
start_date
string<date-time>
required

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

end_date
string<date-time>
required

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

date_interval
enum<string>
default:day

Date interval for the report. (only used with date dimension)

Available options:
hour,
day,
week,
month,
quarter,
year,
relative_week
dimensions
enum<string>[]

Dimensions to group the report by.

Available options:
prompt,
query,
model,
region,
date
order_by
Order By · object

Custom ordering. Keys must be a requested metric or the date dimension. Values are asc or desc. Defaults to first metric descending.

Example:
pagination
Pagination · object

Pagination settings for the report results.

filters
(RegionIdFilter · object | RegionNameFilter · object | ModelIdFilter · object | TopicIdFilter · object | TagIdFilter · object | PromptIdFilter · object | PersonaIdFilter · object | AnalysisTypeFilter · object | PromptTypeFilter · object)[]

Filters to apply to the query fanout report.

Filter by region UUID.

Response

Successful Response

Base response model for reports.

info
Info · object
required

Base model for report information.

data
Result · object[]
required