get https://api.talkdeskapp.com/live-queries
Scope
live-queries:read
Body Response - Schema
200 (available queries)
Parameter | Type | Description | Required |
---|---|---|---|
total | integer | n/a | no |
per_page | integer | n/a | no |
page | integer | n/a | no |
count | integer | n/a | no |
_links | object | "_links" subdivides into: 1 - "self" (object) 1.1 - "href" (string) | no |
_embedded | object | "_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)
Parameter | Type | Description | Required |
---|---|---|---|
code | string | n/a | yes |
message | string | n/a | yes |
description | string | n/a | no |
fields | array[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.