Queries built using the Query Editor can be exposed for consumption by external applications or users via endpoints.
To create an endpoint, build a query in
Query Editor and go to
Create Endpoint in the upper right corner.
To view created endpoints, click on
Endpoints in the left-hand navigation.
The list of endpoints shows:
Type (based on query type)
Schema (with the schema id)
To see the overview of information about an endpoint, navigate to
Endpoints > right-click on the
[Endpoint] Actions menu >
Overview is split into:
The Details section contains:
ID (endpoint ID)
Name (endpoint name)
Description (endpoint description)
Execution URL (used to ping your endpoint with an access token)
To edit the above information, click on Details >
The Query section contains:
Type (query type)
Schema (schema ID)
Query Definition (elements of the query you defined)
The Danger Zone section contains an endpoint deletion function.
To test an endpoint, go to
Test Endpoint >
You can modify the request body with custom parameters and query settings. The response is displayed in the bottom of the window under Results.
Under Endpoint Information, find an execution URL can be used to send a request to an endpoint.
In the Playground section, under Parameters, enter values for custom filtering parameters. Define custom parameters by parameterizing filters when building your query in the query editor.
The Request Body section generates the request body within a
curl or Node.JS request, and also displays the JSON and schema for the query settings.
Under Query Settings you can modify:
_page (page number from which the display in the Response body starts)
_pageSize (number of lines of a single page in the Response body)
_queryId (optional uuid you can use to identify your query)
_customReference (to group queries together, e.g., "my app")
To delete an endpoint, navigate to
Overview, scroll to the bottom and click on
Please note that deletions are irreversible.