About this endpoint
What it does
Returns an AI search overview for a given engine, source, and target as a JSON object with summary metrics and time-series data. The request is made with query parameters only.
Query Parameter(s)
| Attribute | Type | Description |
|---|---|---|
| brand | String | Brand identifier or name. |
| scope | ENUM | Scope for the comparison. Allowed values: domain, base_domain, url. Default: base_domain. |
| engine | String | AI search engine to query. |
| source | String | Source to compare from. |
| target | String | Target to compare against. |
Response
Returns a JSON object with two top-level object fields: summary and time_series. summary contains four metric objects, each with current, previous, change_percent, and change_absolute number fields. time_series contains arrays of { date, value } objects for AI and traffic metrics.
| Parameter | Type | Description |
|---|---|---|
| summary | Object | Summary metrics object. |
| summary.link_presence | Object | Link presence metrics with current, previous, change_percent, and change_absolute number fields. |
| summary.brand_presence | Object | Brand presence metrics with current, previous, change_percent, and change_absolute number fields. |
| summary.average_position | Object | Average position metrics with current, previous, change_percent, and change_absolute number fields. |
| summary.ai_opportunity_traffic | Object | AI opportunity traffic metrics with current, previous, change_percent, and change_absolute number fields. |
| time_series | Object | Time-series data object. |
| time_series.ai_traffic | Object Array | Array of { date, value } objects. date is a string in YYYY-MM format and value is a float. |
| time_series.link_presence | Object Array | Array of { date, value } objects. date is a string in YYYY-MM format and value is a float. |
| time_series.organic_traffic | Object Array | Array of { date, value } objects. date is a string in YYYY-MM format and value is a float. |
| time_series.overall_traffic | Object Array | Array of { date, value } objects. date is a string in YYYY-MM format and value is a float. |
| time_series.average_position | Object Array | Array of { date, value } objects. date is a string in YYYY-MM format and value is a float. |


