Get Templates

Gets the paginated list of all the query templates. The API can only return 100 tables at a time, starting from the offset number specified.

Parameters

offset: int, default 0 The offset position of where to select the templates from.
limit: int, default 100 The number of templates to retrieve. This value must range from 0 and 100.
search: str, default empty Substring to look for in query template names
order_by: str, default “recent” How the query template results should be ordered, there are three possible values:
- recent: based on the date of creation, from most recent to oldest
- name_asc: based on the name of the template, from A to Z
- name_desc: based on the name of the template, from Z to A

Returns

A QueryTemplates Pydantic object containing a List of QueryTemplate objects.

GET

api

query

template

curl --request GET \
  --url https://your-engine-url/api/v1/query/template \
  --header 'Authorization: <api-key>'

{
  "query_templates": [
    {
      "id": 123,
      "name": "<string>",
      "query": "<string>",
      "parameters": [],
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ]
}

Authorizations

Authorization

string

header

required

Enter: 'Bearer <JWT>', where JWT is the access token. Example: Bearer access_token_comes_here

Query Parameters

offset

integer

default:0

limit

integer

default:100

string

default:""

order_by

string

default:recent

Response

200

application/json

Successful Response

The response is of type object.

curl --request GET \
  --url https://your-engine-url/api/v1/query/template \
  --header 'Authorization: <api-key>'

{
  "query_templates": [
    {
      "id": 123,
      "name": "<string>",
      "query": "<string>",
      "parameters": [],
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ]
}

Get Templates

Gets the paginated list of all the query templates. The API can only return 100 tables at a time, starting from the offset number specified.

Parameters

offset: int, default 0 The offset position of where to select the templates from.
limit: int, default 100 The number of templates to retrieve. This value must range from 0 and 100.
search: str, default empty Substring to look for in query template names
order_by: str, default “recent” How the query template results should be ordered, there are three possible values:
- recent: based on the date of creation, from most recent to oldest
- name_asc: based on the name of the template, from A to Z
- name_desc: based on the name of the template, from Z to A

Returns

A QueryTemplates Pydantic object containing a List of QueryTemplate objects.

GET

api

query

template

curl --request GET \
  --url https://your-engine-url/api/v1/query/template \
  --header 'Authorization: <api-key>'

{
  "query_templates": [
    {
      "id": 123,
      "name": "<string>",
      "query": "<string>",
      "parameters": [],
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ]
}

Authorizations

Authorization

string

header

required

Enter: 'Bearer <JWT>', where JWT is the access token. Example: Bearer access_token_comes_here

Query Parameters

offset

integer

default:0

limit

integer

default:100

string

default:""

order_by

string

default:recent

Response

200

application/json

Successful Response

The response is of type object.

curl --request GET \
  --url https://your-engine-url/api/v1/query/template \
  --header 'Authorization: <api-key>'

{
  "query_templates": [
    {
      "id": 123,
      "name": "<string>",
      "query": "<string>",
      "parameters": [],
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ]
}

Authorizations

Query Parameters

Response

FAQs

Authorizations

Query Parameters

Response