How to use the interface
Open an endpoint with interactive controls
Navigate to a Data API endpoint page and use the built-in request form:
Set authentication inputs
Add
apiKey and sig as query parameters, then include X-API-GATEWAY-KEY in headers. Remember: The sig must be re-generated every five minutes.Send an initial POST request
Provide required body fields such as
account_id, start_date, and end_date. Async endpoints return 202 with an executionId.Poll until execution completes
Resend a POST request with
executionId (and nextPageId when present) until you receive 200 with executionState: "COMPLETED".This workflow is ideal for developer handoff: Conductor users can validate inputs in the UI, and then engineers can productionize the exact request and response contract. If you are a non-developer, learn more in the API for Non-Developers article.
Endpoints
Each of these endpoints are documented here in the playground:- AI Search - Brands: /data-api/v1/async/ai_search_brands
- AI Search - Citations: /data-api/v1/async/ai_search_citations
- AI Search - Sentiments: /data-api/v1/async/ai_search_sentiments
- Keyword Rankings: /data-api/v1/async/keyword_rankings
- Highest Ranking URL per Keyword: /data-api/v1/async/highest_ranking_url_per_keyword
