Skip to main content
POST
TypeScript (SDK)

Authorizations

tql_api_key
string
header
required

Headers

Connect-Protocol-Version
enum<number>
required

Define the version of the Connect protocol

Available options:
1
Connect-Timeout-Ms
number

Define the timeout, in ms

Body

application/json
pathPrefix
string | null
order
enum<string> | null
Available options:
ORDER_BY_UNKNOWN,
ORDER_BY_MOST_RECENTLY_USED,
ORDER_BY_LEAST_RECENTLY_USED,
ORDER_BY_MOST_FREQUENTLY_USED,
ORDER_BY_LEAST_FREQUENTLY_USED
observationPeriod
string<duration> | null

A Duration represents a signed, fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". It is related to Timestamp in that the difference between two Timestamp values is a Duration and it can be added or subtracted from a Timestamp. Range is approximately +-10,000 years.

Examples

Example 1: Compute Duration from two Timestamps in pseudo code.

Example 2: Compute Timestamp from Timestamp + Duration in pseudo code.

Example 3: Compute Duration from datetime.timedelta in Python.

JSON Mapping

In JSON format, the Duration type is encoded as a string rather than an object, where the string ends in the suffix "s" (indicating seconds) and is preceded by the number of seconds, with nanoseconds expressed as fractional seconds. For example, 3 seconds with 0 nanoseconds should be encoded in JSON format as "3s", while 3 seconds and 1 nanosecond should be expressed in JSON format as "3.000000001s", and 3 seconds and 1 microsecond should be expressed in JSON format as "3.000001s".

pageCursor
string | null
pageSize
integer<int32> | null

Response

Success

files
FileUsage · object[]
nextPageCursor
string | null