API Reference

Logpush

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Transformers

List transformers

logpush.transformers.list(TransformerListParams**kwargs) -> SyncSinglePage[TransformerListResponse]

GET/accounts/{account_id}/logpush/transformers

Get transformer

logpush.transformers.get(inttransformer_id, TransformerGetParams**kwargs) -> TransformerGetResponse

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

Create transformer

logpush.transformers.create(TransformerCreateParams**kwargs) -> TransformerCreateResponse

POST/accounts/{account_id}/logpush/transformers

Update transformer

logpush.transformers.update(inttransformer_id, TransformerUpdateParams**kwargs) -> TransformerUpdateResponse

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

Delete transformer

logpush.transformers.delete(inttransformer_id, TransformerDeleteParams**kwargs) -> TransformerDeleteResponse

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

Preview transformer

logpush.transformers.preview(TransformerPreviewParams**kwargs) -> TransformerPreviewResponse

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

ModelsExpand Collapse

class TransformerListResponse: …

id: Optional[int]

The transformer ID.

minimum1

associated_jobs: Optional[List[AssociatedJob]]

Logpush jobs that reference this transformer.

id: Optional[int]

The logpush job ID.

name: Optional[str]

The logpush job destination name.

object_tag: Optional[str]

The zone or account tag.

object_type: Optional[Literal["zone", "account"]]

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

One of the following:

"zone"

"account"

created_at: Optional[datetime]

When the transformer was created (RFC 3339).

formatdate-time

dataset: Optional[str]

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: Optional[str]

Optional customer-provided description.

maxLength4096

name: Optional[str]

Customer-provided name for identification.

maxLength255

updated_at: Optional[datetime]

When the transformer was last modified (RFC 3339).

formatdate-time

class TransformerGetResponse: …

id: Optional[int]

The transformer ID.

minimum1

associated_jobs: Optional[List[AssociatedJob]]

Logpush jobs that reference this transformer.

id: Optional[int]

The logpush job ID.

name: Optional[str]

The logpush job destination name.

object_tag: Optional[str]

The zone or account tag.

object_type: Optional[Literal["zone", "account"]]

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

One of the following:

"zone"

"account"

created_at: Optional[datetime]

When the transformer was created (RFC 3339).

formatdate-time

dataset: Optional[str]

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: Optional[str]

Optional customer-provided description.

maxLength4096

name: Optional[str]

Customer-provided name for identification.

maxLength255

updated_at: Optional[datetime]

When the transformer was last modified (RFC 3339).

formatdate-time

class TransformerCreateResponse: …

id: Optional[int]

The transformer ID.

minimum1

associated_jobs: Optional[List[AssociatedJob]]

Logpush jobs that reference this transformer.

id: Optional[int]

The logpush job ID.

name: Optional[str]

The logpush job destination name.

object_tag: Optional[str]

The zone or account tag.

object_type: Optional[Literal["zone", "account"]]

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

One of the following:

"zone"

"account"

created_at: Optional[datetime]

When the transformer was created (RFC 3339).

formatdate-time

dataset: Optional[str]

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: Optional[str]

Optional customer-provided description.

maxLength4096

name: Optional[str]

Customer-provided name for identification.

maxLength255

updated_at: Optional[datetime]

When the transformer was last modified (RFC 3339).

formatdate-time

class TransformerUpdateResponse: …

id: Optional[int]

The transformer ID.

minimum1

associated_jobs: Optional[List[AssociatedJob]]

Logpush jobs that reference this transformer.

id: Optional[int]

The logpush job ID.

name: Optional[str]

The logpush job destination name.

object_tag: Optional[str]

The zone or account tag.

object_type: Optional[Literal["zone", "account"]]

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

One of the following:

"zone"

"account"

created_at: Optional[datetime]

When the transformer was created (RFC 3339).

formatdate-time

dataset: Optional[str]

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: Optional[str]

Optional customer-provided description.

maxLength4096

name: Optional[str]

Customer-provided name for identification.

maxLength255

updated_at: Optional[datetime]

When the transformer was last modified (RFC 3339).

formatdate-time

class TransformerDeleteResponse: …

id: Optional[int]

The deleted transformer’s ID.

Optional[Dict[str, object]]

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

TransformersContent

Get transformer content

logpush.transformers.content.get(inttransformer_id, ContentGetParams**kwargs) -> ContentGetResponse

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

ModelsExpand Collapse

class ContentGetResponse: …

content: Optional[str]

The SQL query content.

TransformersVersions

List transformer versions

logpush.transformers.versions.list(inttransformer_id, VersionListParams**kwargs) -> SyncSinglePage[VersionListResponse]

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

ModelsExpand Collapse

class VersionListResponse: …

id: Optional[int]

Unique identifier for this version.

formatint64

minimum1

created_at: Optional[datetime]

When this version was created (RFC 3339).

formatdate-time

version: Optional[int]

Sequential version number.

minimum1