Query AI Search Response Data (Async)
Execute a query to retrieve response-focused data from AI search responses. This endpoint follows the asynchronous query flow.
Usage Patterns:
- Submit: Create a query (Initial request). Returns
executionId. - Poll: Use
executionIdto check status. Returns 200 with results whenCOMPLETED. - Paginate: Use
executionIdandnextPageIdfrom the previous response.
Rate Limits:
- Submit: 40 req/min (Hard), 5 req/min (Recommended).
- Poll/Paginate: 5000 req/min (Hard), 1000 req/min (Recommended).
Sequential Pagination:
- Pagination must be performed sequentially. Each request for the next page must use the
nextPageIdreturned in the previous response. Parallel pagination is not supported.
Authorizations
API Key as a query parameter
Request signature computed using API key and secret. Valid for 5 minutes after creation.
Body
- Submit
- Poll
- Paginate
Submit a new query with filters and parameters. Returns an executionId to track the query.
Start date of the time period; if collection_frequency is WEEKLY, this field must be Sunday
"2025-11-02"
End date of the time period; if collection_frequency is WEEKLY, this field must be Saturday
"2025-11-08"
Data collection frequency
DAILY, WEEKLY Required account ID to filter results
x >= 1101
Maximum number of results to return
0 <= x <= 1000100
(Optional) comma-separated list of web property IDs to filter results. If not provided, results are not filtered by web property
x >= 1[122556, 987654](Optional) comma-separated list of AI engines to filter
["chatgptsearch", "perplexity"](Optional) comma-separated list of locodes to filter (case-insensitive; values will be uppercased). Supports locales like country codes "DE" or city locodes "US NYC" or state codes "PL-02"
2 - 12["US", "CA", "US NYC", "US-TX"](Optional) comma-separated list of search engine language codes to filter (case-insensitive; values will be uppercased).
2 - 7["en_US", "hant_TW"](Optional) comma-separated list of topics to filter
[
"marketing automation",
"website optimization"
](Optional) comma-separated list of prompts to filter
[
"best marketing automation tools",
"website optimization tools"
](Optional) comma-separated list of intents to filter
["Education", "Purchase"](Optional) comma-separated list of personas to filter
["young adults", "developers"]Response
Query completed successfully
List of query results. Each item is a positional tuple row.
Available only when executionState is COMPLETED.
Positional tuple row for AI Search Response results. Column order matches the schema metadata. All values are returned as strings.
19Current execution state of the query:
IN_PROGRESS: The query is still running. Poll again later.COMPLETED: The query finished successfully. Results are available.FAILED: The query failed. Check the error message if available.
IN_PROGRESS, COMPLETED, FAILED Unique identifier for the query execution. Valid for 7 days. Use this for polling and pagination.
Unique identifier for the HTTP request, useful for support and debugging.
Token for retrieving the next page of results. Available as long as the executionId is valid (7 days).
If null, there are no more pages available.
Total number of rows across all pages (if available).
Column metadata providing the name and type for each position in the results tuple.
