Skip to content
WatchTower15Docs

public.databases.queries

GET
/databases/{database_uuid}/queries
curl --request GET \
  --url 'https://rest.watchtower15.com/v1/databases/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/queries?sort=total_time&order=asc' \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
database_uuid
required
string format: uuid

Query Parameters

Section titled “Query Parameters”
period
string | null

A relative window ending now: 1 to 9999 minutes, hours, days or weeks (3h, 2w). Not with from and to. The operation names its longest window and its default.

from
string | null

The start of a pinned window, epoch milliseconds or RFC 3339 with an offset. Needs to. A start before the oldest data kept is served from it.

to
string | null

The end of a pinned window, epoch milliseconds or RFC 3339 with an offset, after from. A window that ends before the oldest data kept, or in the future, is refused.

sort
string | null
Allowed values: total_time calls avg_time rows_examined no_index errors impact
order
string | null
Allowed values: asc desc

Responses

Section titled “Responses”

200

Section titled “200”

DatabasesQueriesResource

Media typeapplication/json
object
data
required
DatabasesQueriesResource
object
available
required

Whether the database keeps per-statement data: false for a counts-only database.

boolean
reason
required

counts_only while available is false; null otherwise.

string | null
window
required
object
from
required

Epoch milliseconds.

integer
to
required

Epoch milliseconds.

integer
statements
required

The window’s top 50 statements by the chosen sort.

Array<object>
object
digest_key
required
string
schema_key
required
string
schema_name
required
string | null
statement_text
required
string | null
text_truncated
required
boolean | null
first_seen_at
required
integer | null
last_seen_at
required
integer | null
calls
required
integer
total_wait_us
required
integer
lock_time_us
required
integer
rows_examined
required
integer
rows_sent
required
integer
rows_affected
required
integer
errors
required
integer
warnings
required
integer
tmp_disk_tables
required
integer
tmp_tables
required
integer
full_joins
required
integer
full_scans
required
integer
sort_merge_passes
required
integer
no_index_used
required
integer
no_good_index_used
required
integer
avg_wait_us
required
number | null
no_index_share
required
number | null
rows_examined_per_row_sent
required
number | null
impact_index
required
number | null
other
required

All the other statements: the window’s totals less the rows shown; null for a counts-only database.

object
calls
required
integer
total_wait_us
required
integer
lock_time_us
required
integer
rows_examined
required
integer
rows_sent
required
integer
rows_affected
required
integer
errors
required
integer
warnings
required
integer
tmp_disk_tables
required
integer
tmp_tables
required
integer
full_joins
required
integer
full_scans
required
integer
sort_merge_passes
required
integer
no_index_used
required
integer
no_good_index_used
required
integer
avg_wait_us
required
number | null
no_index_share
required
number | null
rows_examined_per_row_sent
required
number | null
totals
required

The window’s totals; null for a counts-only database.

object
calls
required
integer
total_wait_us
required
integer
lock_time_us
required
integer
rows_examined
required
integer
rows_sent
required
integer
rows_affected
required
integer
errors
required
integer
warnings
required
integer
tmp_disk_tables
required
integer
tmp_tables
required
integer
full_joins
required
integer
full_scans
required
integer
sort_merge_passes
required
integer
no_index_used
required
integer
no_good_index_used
required
integer
avg_wait_us
required
number | null
no_index_share
required
number | null
rows_examined_per_row_sent
required
number | null

Example generated

{
  "data": {
    "available": true,
    "reason": "example",
    "window": {
      "from": 1,
      "to": 1
    },
    "statements": [
      {
        "digest_key": "example",
        "schema_key": "example",
        "schema_name": "example",
        "statement_text": "example",
        "text_truncated": true,
        "first_seen_at": 1,
        "last_seen_at": 1,
        "calls": 1,
        "total_wait_us": 1,
        "lock_time_us": 1,
        "rows_examined": 1,
        "rows_sent": 1,
        "rows_affected": 1,
        "errors": 1,
        "warnings": 1,
        "tmp_disk_tables": 1,
        "tmp_tables": 1,
        "full_joins": 1,
        "full_scans": 1,
        "sort_merge_passes": 1,
        "no_index_used": 1,
        "no_good_index_used": 1,
        "avg_wait_us": 1,
        "no_index_share": 1,
        "rows_examined_per_row_sent": 1,
        "impact_index": 1
      }
    ],
    "other": {
      "calls": 1,
      "total_wait_us": 1,
      "lock_time_us": 1,
      "rows_examined": 1,
      "rows_sent": 1,
      "rows_affected": 1,
      "errors": 1,
      "warnings": 1,
      "tmp_disk_tables": 1,
      "tmp_tables": 1,
      "full_joins": 1,
      "full_scans": 1,
      "sort_merge_passes": 1,
      "no_index_used": 1,
      "no_good_index_used": 1,
      "avg_wait_us": 1,
      "no_index_share": 1,
      "rows_examined_per_row_sent": 1
    },
    "totals": {
      "calls": 1,
      "total_wait_us": 1,
      "lock_time_us": 1,
      "rows_examined": 1,
      "rows_sent": 1,
      "rows_affected": 1,
      "errors": 1,
      "warnings": 1,
      "tmp_disk_tables": 1,
      "tmp_tables": 1,
      "full_joins": 1,
      "full_scans": 1,
      "sort_merge_passes": 1,
      "no_index_used": 1,
      "no_good_index_used": 1,
      "avg_wait_us": 1,
      "no_index_share": 1,
      "rows_examined_per_row_sent": 1
    }
  }
}

401

Section titled “401”

The API key is missing, malformed, expired or revoked.

Media typeapplication/problem+json
Problem
object
type
required

https://docs.watchtower15.com/api/errors/<code>/

string format: uri
title
required
string
status
required
integer
code
required
string
detail
required
string
request_id
required
string
errors
object
key
additional properties
Array<string>
limit
integer
used
integer

Example generated

{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "code": "example",
  "detail": "example",
  "request_id": "example",
  "errors": {
    "additionalProperty": [
      "example"
    ]
  },
  "limit": 1,
  "used": 1
}

403

Section titled “403”

The key or its owner does not hold what the operation needs.

Media typeapplication/problem+json
Problem
object
type
required

https://docs.watchtower15.com/api/errors/<code>/

string format: uri
title
required
string
status
required
integer
code
required
string
detail
required
string
request_id
required
string
errors
object
key
additional properties
Array<string>
limit
integer
used
integer

Example generated

{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "code": "example",
  "detail": "example",
  "request_id": "example",
  "errors": {
    "additionalProperty": [
      "example"
    ]
  },
  "limit": 1,
  "used": 1
}

404

Section titled “404”

No such record in this organisation (an absent id and another organisation’s answer alike).

Media typeapplication/problem+json
Problem
object
type
required

https://docs.watchtower15.com/api/errors/<code>/

string format: uri
title
required
string
status
required
integer
code
required
string
detail
required
string
request_id
required
string
errors
object
key
additional properties
Array<string>
limit
integer
used
integer

Example generated

{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "code": "example",
  "detail": "example",
  "request_id": "example",
  "errors": {
    "additionalProperty": [
      "example"
    ]
  },
  "limit": 1,
  "used": 1
}

422

Section titled “422”

The request is invalid; errors names the parameters.

Media typeapplication/problem+json
Problem
object
type
required

https://docs.watchtower15.com/api/errors/<code>/

string format: uri
title
required
string
status
required
integer
code
required
string
detail
required
string
request_id
required
string
errors
object
key
additional properties
Array<string>
limit
integer
used
integer

Example generated

{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "code": "example",
  "detail": "example",
  "request_id": "example",
  "errors": {
    "additionalProperty": [
      "example"
    ]
  },
  "limit": 1,
  "used": 1
}

429

Section titled “429”

A rate limit or the organisation’s daily limit is reached; Retry-After says when to retry.

Media typeapplication/problem+json
Problem
object
type
required

https://docs.watchtower15.com/api/errors/<code>/

string format: uri
title
required
string
status
required
integer
code
required
string
detail
required
string
request_id
required
string
errors
object
key
additional properties
Array<string>
limit
integer
used
integer

Example generated

{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "code": "example",
  "detail": "example",
  "request_id": "example",
  "errors": {
    "additionalProperty": [
      "example"
    ]
  },
  "limit": 1,
  "used": 1
}

500

Section titled “500”

An unexpected error.

Media typeapplication/problem+json
Problem
object
type
required

https://docs.watchtower15.com/api/errors/<code>/

string format: uri
title
required
string
status
required
integer
code
required
string
detail
required
string
request_id
required
string
errors
object
key
additional properties
Array<string>
limit
integer
used
integer

Example generated

{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "code": "example",
  "detail": "example",
  "request_id": "example",
  "errors": {
    "additionalProperty": [
      "example"
    ]
  },
  "limit": 1,
  "used": 1
}

503

Section titled “503”

A data store did not answer within the request’s 10 seconds; try again shortly (store_unavailable).

Media typeapplication/problem+json
Problem
object
type
required

https://docs.watchtower15.com/api/errors/<code>/

string format: uri
title
required
string
status
required
integer
code
required
string
detail
required
string
request_id
required
string
errors
object
key
additional properties
Array<string>
limit
integer
used
integer

Example generated

{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "code": "example",
  "detail": "example",
  "request_id": "example",
  "errors": {
    "additionalProperty": [
      "example"
    ]
  },
  "limit": 1,
  "used": 1
}