Send a history, suggestion, validation or execution request.
receive
receiveSearchResponse
Receive the matching response, correlated by corrId.
Messages
heartbeat
Connection keep-alive / connection test.
Content-Type:
viewHistoryRequest
Retrieve previously typed queries matching a partial string.
Content-Type:
viewHistoryResponse
Content-Type:
viewSuggestionsRequest
Retrieve NLP token suggestions for a partial term against a Business View.
Content-Type:
viewSuggestionsResponse
Content-Type:
queryRequest
One message shape serves both validation and execution. With
enterKeyPress=false the query is validated and tokenized only; with
performQuery, enterKeyPress and createViz all true it is executed and a
Content-Type:
About AsyncAPI
The AsyncAPI specification describes event-driven APIs the way OpenAPI describes request/response APIs. A channel is the named pipe — a webhook URL, a Kafka topic, a WebSocket route, an MQTT subject — that producers and consumers publish or subscribe to. Each channel carries one or more messages with structured payloads, and an operation declares whether a given party sends or receives on that channel.
Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.