API Reference

Logpush

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Transformers

List transformers

client.logpush.transformers.list(TransformerListParams { account_id } params, RequestOptionsoptions?): SinglePage<TransformerListResponse { id, associated_jobs, created_at, 4 more } >

GET/accounts/{account_id}/logpush/transformers

Get transformer

client.logpush.transformers.get(numbertransformerID, TransformerGetParams { account_id } params, RequestOptionsoptions?): TransformerGetResponse { id, associated_jobs, created_at, 4 more }

GET/accounts/{account_id}/logpush/transformers/{transformer_id}

Create transformer

client.logpush.transformers.create(TransformerCreateParams { account_id, code, name, description } params, RequestOptionsoptions?): TransformerCreateResponse { id, associated_jobs, created_at, 4 more }

POST/accounts/{account_id}/logpush/transformers

Update transformer

client.logpush.transformers.update(numbertransformerID, TransformerUpdateParams { account_id, name, code, description } params, RequestOptionsoptions?): TransformerUpdateResponse { id, associated_jobs, created_at, 4 more }

PUT/accounts/{account_id}/logpush/transformers/{transformer_id}

Delete transformer

client.logpush.transformers.delete(numbertransformerID, TransformerDeleteParams { account_id } params, RequestOptionsoptions?): TransformerDeleteResponse { id }

DELETE/accounts/{account_id}/logpush/transformers/{transformer_id}

Preview transformer

client.logpush.transformers.preview(TransformerPreviewParams { account_id, input, sql } params, RequestOptionsoptions?): TransformerPreviewResponse | null

POST/accounts/{account_id}/logpush/transformers/preview

ModelsExpand Collapse

TransformerListResponse { id, associated_jobs, created_at, 4 more }

id?: number

The transformer ID.

minimum1

associated_jobs?: Array<AssociatedJob>

Logpush jobs that reference this transformer.

id?: number

The logpush job ID.

name?: string

The logpush job destination name.

object_tag?: string

The zone or account tag.

object_type?: "zone" | "account"

Whether the job is zone-scoped or account-scoped.

One of the following:

"zone"

"account"

created_at?: string

When the transformer was created (RFC 3339).

formatdate-time

dataset?: string | null

The dataset this transformer operates on, derived from the SQL query’s FROM clause. Informational only. May be absent if the dataset cannot be determined from the query.

description?: string

Optional customer-provided description.

maxLength4096

name?: string

Customer-provided name for identification.

maxLength255

updated_at?: string

When the transformer was last modified (RFC 3339).

formatdate-time

TransformerGetResponse { id, associated_jobs, created_at, 4 more }

id?: number

The transformer ID.

minimum1

associated_jobs?: Array<AssociatedJob>

Logpush jobs that reference this transformer.

id?: number

The logpush job ID.

name?: string

The logpush job destination name.

object_tag?: string

The zone or account tag.

object_type?: "zone" | "account"

Whether the job is zone-scoped or account-scoped.

One of the following:

"zone"

"account"

created_at?: string

When the transformer was created (RFC 3339).

formatdate-time

dataset?: string | null

The dataset this transformer operates on, derived from the SQL query’s FROM clause. Informational only. May be absent if the dataset cannot be determined from the query.

description?: string

Optional customer-provided description.

maxLength4096

name?: string

Customer-provided name for identification.

maxLength255

updated_at?: string

When the transformer was last modified (RFC 3339).

formatdate-time

TransformerCreateResponse { id, associated_jobs, created_at, 4 more }

id?: number

The transformer ID.

minimum1

associated_jobs?: Array<AssociatedJob>

Logpush jobs that reference this transformer.

id?: number

The logpush job ID.

name?: string

The logpush job destination name.

object_tag?: string

The zone or account tag.

object_type?: "zone" | "account"

Whether the job is zone-scoped or account-scoped.

One of the following:

"zone"

"account"

created_at?: string

When the transformer was created (RFC 3339).

formatdate-time

dataset?: string | null

The dataset this transformer operates on, derived from the SQL query’s FROM clause. Informational only. May be absent if the dataset cannot be determined from the query.

description?: string

Optional customer-provided description.

maxLength4096

name?: string

Customer-provided name for identification.

maxLength255

updated_at?: string

When the transformer was last modified (RFC 3339).

formatdate-time

TransformerUpdateResponse { id, associated_jobs, created_at, 4 more }

id?: number

The transformer ID.

minimum1

associated_jobs?: Array<AssociatedJob>

Logpush jobs that reference this transformer.

id?: number

The logpush job ID.

name?: string

The logpush job destination name.

object_tag?: string

The zone or account tag.

object_type?: "zone" | "account"

Whether the job is zone-scoped or account-scoped.

One of the following:

"zone"

"account"

created_at?: string

When the transformer was created (RFC 3339).

formatdate-time

dataset?: string | null

The dataset this transformer operates on, derived from the SQL query’s FROM clause. Informational only. May be absent if the dataset cannot be determined from the query.

description?: string

Optional customer-provided description.

maxLength4096

name?: string

Customer-provided name for identification.

maxLength255

updated_at?: string

When the transformer was last modified (RFC 3339).

formatdate-time

TransformerDeleteResponse { id }

id?: number

The deleted transformer’s ID.

TransformerPreviewResponse = Record<string, unknown> | null

The transformed log record, or null if the query filtered it out.

TransformersContent

Get transformer content

client.logpush.transformers.content.get(numbertransformerID, ContentGetParams { account_id, version_id } params, RequestOptionsoptions?): ContentGetResponse { content }

GET/accounts/{account_id}/logpush/transformers/{transformer_id}/content

ModelsExpand Collapse

ContentGetResponse { content }

content?: string

The SQL query content.

TransformersVersions

List transformer versions

client.logpush.transformers.versions.list(numbertransformerID, VersionListParams { account_id, limit } params, RequestOptionsoptions?): SinglePage<VersionListResponse { id, created_at, version } >

GET/accounts/{account_id}/logpush/transformers/{transformer_id}/versions

ModelsExpand Collapse

VersionListResponse { id, created_at, version }

id?: number

Unique identifier for this version.

formatint64

minimum1

created_at?: string

When this version was created (RFC 3339).

formatdate-time

version?: number

Sequential version number.

minimum1