Endpoints

Endpoints

Queries built using the Query Editor can be exposed for consumption by external applications or users via endpoints.

Creating Endpoints

To create an endpoint, build a query in Schemas > Query Editor and go to Create Endpoint in the upper right corner.

Managing Endpoints

To view created endpoints, click on Endpoints in the left-hand navigation.

The list of endpoints shows:

  • Type (based on query type)

  • Name

  • Schema (with the schema id)

  • Description

Overview

To see the overview of information about an endpoint, navigate to Endpoints > [Endpoint] > Overview, or Endpoints > right-click on the [Endpoint] Actions menu > Details.

Overview is split into:

  • Details

  • Query

  • Danger Zone

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 > Edit.

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.

Testing Endpoints

To test an endpoint, go to Endpoints > [Endpoint] > Test Endpoint > Send Request.

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")

Deleting Endpoints

To delete an endpoint, navigate to Endpoints > [Endpoint] > Overview, scroll to the bottom and click on Delete Endpoint.

Please note that deletions are irreversible.