Skip to content
Start here

Available

List available account or zone datasets
client.logs.logExplorer.datasets.available.list(AvailableListParams { account_id, zone_id } params?, RequestOptionsoptions?): SinglePage<AvailableDataset { dataset, object_type, schema, timestamp_field } >
GET/{accounts_or_zones}/{account_or_zone_id}/logs/explorer/datasets/available
ModelsExpand Collapse
AvailableDataset { dataset, object_type, schema, timestamp_field }

A dataset type that the account or zone can create.

dataset: string

Dataset type name (e.g. http_requests).

object_type: "account" | "zone"

Whether this dataset type is account-scoped or zone-scoped.

One of the following:
"account"
"zone"
schema: Schema { properties, required, type }

JSON Schema that describes the fields this dataset exposes.

properties?: Record<string, unknown>
required?: Array<string>
type?: "object"
timestamp_field: string

The primary timestamp field name for this dataset.

AvailableList { errors, messages, success, result }
errors: Array<ResponseInfo { code, message, documentation_url, source } >
code: number
minimum1000
message: string
documentation_url?: string
source?: Source { pointer }
pointer?: string
messages: Array<string>
success: boolean
result?: Array<AvailableDataset { dataset, object_type, schema, timestamp_field } > | null
dataset: string

Dataset type name (e.g. http_requests).

object_type: "account" | "zone"

Whether this dataset type is account-scoped or zone-scoped.

One of the following:
"account"
"zone"
schema: Schema { properties, required, type }

JSON Schema that describes the fields this dataset exposes.

properties?: Record<string, unknown>
required?: Array<string>
type?: "object"
timestamp_field: string

The primary timestamp field name for this dataset.