List

API Reference

Telemetry

Logs

List

client.telemetry.logs.list(LogListParamsquery, RequestOptionsoptions?): dataarraylinksPaginationLinksLogListResponse

get/v1/telemetry/logs

Get OpenTelemetry logs within a specified time window with flexible pagination options: Pass in only the end time to paginate backwards from there. Pass in a start time to paginate backwards from now until the start time. Pass in both to get resources within the time window. Filter additionally by branch_ids or file_id.

Parameters

querydirectionunionlimitnumberbranch_idsarrayendstringfile_idstringstartstringtrace_idsarrayLogListParams

Hide ParametersShow Parameters

directionunion

"asc" | "desc"

Sort direction for the traces. Defaults to descending order of timestamp.

Hide ParametersShow Parameters

"asc"

"desc"

limitnumber

Maximum items to return in each paginated response

minimum1

maximum100

branch_idsarray

optional

Array<string>

Branch IDs to filter by

endstring

optional

End date of the time window (latest time)

formatdate-time

file_idstring

optional

Include only resources from a given file identified by its ID

formatuuid

startstring

optional

Start date of the time window (earliest time)

formatdate-time

trace_idsarray

optional

Array<string>

Returns

LogListResponse

A paginated result set

Hide ParametersShow Parameters

dataarray

Array<Data>

Hide ParametersShow Parameters

attributesarray

Array<Attribute>

Hide ParametersShow Parameters

keystring

valuearrayValueunknownboolValuebooleanbytesValuestringdoubleValuenumberintValuestringkvlistValueunknownstringValuestringValue

Hide ParametersShow Parameters

arrayValueunknown

optional

boolValueboolean

optional

bytesValuestring

optional

doubleValuenumber

optional

intValuestring

optional

kvlistValueunknown

optional

stringValuestring

optional

bodyarrayValueunknownboolValuebooleanbytesValuestringdoubleValuenumberintValuestringkvlistValueunknownstringValuestringBody

Hide ParametersShow Parameters

arrayValueunknown

optional

boolValueboolean

optional

bytesValuestring

optional

doubleValuenumber

optional

intValuestring

optional

kvlistValueunknown

optional

stringValuestring

optional

severityTextstring

timeUnixNanostring

traceIdstring

linksselfstringnextstringprevstringPaginationLinks

Links to use for pagination

HTTPTypeScript

import ValTown from '@valtown/sdk';

const client = new ValTown();

const logs = await client.telemetry.logs.list({ direction: 'asc', limit: 1 });

console.log(logs.data);

200 Example

{
  "data": [
    {
      "attributes": [
        {
          "key": "key",
          "value": {
            "arrayValue": {},
            "boolValue": true,
            "bytesValue": "bytesValue",
            "doubleValue": 0,
            "intValue": "intValue",
            "kvlistValue": {},
            "stringValue": "stringValue"
          }
        }
      ],
      "body": {
        "arrayValue": {},
        "boolValue": true,
        "bytesValue": "bytesValue",
        "doubleValue": 0,
        "intValue": "intValue",
        "kvlistValue": {},
        "stringValue": "stringValue"
      },
      "severityText": "severityText",
      "timeUnixNano": "timeUnixNano",
      "traceId": "traceId"
    }
  ],
  "links": {
    "self": "https://example.com",
    "next": "https://example.com",
    "prev": "https://example.com"
  }
}