List Available Queries

📘

Supported Regions and Base URLs

👍

Access and Registration

Authentication

Scope

live-queries:read

Body Response - Schema

200 (available queries)

ParameterTypeDescriptionRequired
totalintegern/ano
per_pageintegern/ano
pageintegern/ano
countintegern/ano
_linksobject"_links" subdivides into:

1 - "self" (object)

1.1 - "href" (string)
no
_embeddedobject"_embedded" subdivides into:

1 - "queries" (object)

1.1 - "params" (array) - list of query parameters. Each one may have a default value and, if applicable, a hard limit. If a parameter does not have a default, then it is mandatory. Required.

1.2 - "name" (string). Required.

1.3 - "id" (string) - query unique identifier. Required.

1.4 - "filters" (array[object]) - set of filters for the query.
1.4.1 - "name" (string)
1.4.2 - "json_map" (boolean)
1.4.3 - "type" (string)
1.4.4 - "default" (string)

1.5 - "_links" (object)
1.5.1 - "self" (object)
1.5.1.1 - "href" (string)
no

400 (bad request), 401 (unauthorized access), 403 (forbidden access)

ParameterTypeDescriptionRequired
codestringn/ayes
messagestringn/ayes
descriptionstringn/ano
fieldsarray[object]"fields" subdivides into:

"name" (string)

"description" (string)
yes (name and description)

🚧

Troubleshooting

If you have any questions regarding the usage of this API, or if you’re having any technical issues, please open a ticket using this form.

Language
Authorization
Header
Click Try It! to start a request and see the response here!