Reports

get_query_fanouts_report

Retrieve a report on query fan-outs in AI search.

Operation: Read-only. The authenticated hosted connection determines the workspace.

Parameters

ParameterTypeRequiredDescription
scopestringNoReport scope type. project / brand / topic / prompt
scope_idstringNoReport scope ID.
metricsstring[]NoMetric names to retrieve.
dimensionsstring[]NoDimension names.
date_rangeobjectNoRelative period or explicit start and end dates.
date_range.periodstringNoRelative period, such as 7d, 30d, or 90d.
date_range.startstringNoInclusive start timestamp or date.
date_range.endstringNoInclusive end timestamp or date.
granularitystringNoTime-series granularity. day / week / month
filtersobjectNoFilters supported by the selected report.
cursorstringNoNext-page cursor from the previous response.
limitintegerNoMaximum number of results. Minimum: 1; Maximum: 500

Metrics, dimensions, and filters depend on the report. Check the report reference before choosing values. Results include columns, rows, and rowCount when report rows are available.

If the response includes a next-page cursor, pass it in the next request to continue.

Sample prompt

Summarize query fan-outs related to the selected brand and include the reporting period.