Preview transformer

logpush.transformers.preview() -> SyncSinglePage[TransformerPreviewResponse]

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

Executes a SQL transformer against a single input record and returns the transformed output. This is a stateless endpoint — nothing is persisted.

Security

API Token

The preferred authorization scheme for interacting with the Cloudflare API. Create a token.

Example:Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY

API Email + API Key

The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.

Example:X-Auth-Email: user@example.com

The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.

Example:X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194

Accepted Permissions (at least one required)

Logs Write

ParametersExpand Collapse

account_id: str

Identifier.

maxLength32

input: Dict[str, object]

A single log record to transform (JSON object).

sql: str

The SQL transformer query. Maximum 32 KB. The query must contain a FROM clause referencing a valid logpush dataset.

maxLength32768

ReturnsExpand Collapse

Dict[str, object]

Preview transformer

import os
from cloudflare import Cloudflare

client = Cloudflare(
    api_token=os.environ.get("CLOUDFLARE_API_TOKEN"),  # This is the default and can be omitted
)
page = client.logpush.transformers.preview(
    account_id="023e105f4ecef8ad9ca31a8372d0c353",
    input={
        "ClientIP": "bar",
        "ClientRequestHost": "bar",
        "EdgeStartTimestamp": "bar",
        "RayID": "bar",
    },
    sql="SELECT ClientIP, RayID FROM http_requests",
)
page = page.result[0]
print(page)

{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "success": true,
  "result": [
    {
      "ClientIP": "bar",
      "RayID": "bar"
    }
  ]
}

Returns Examples

{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "success": true,
  "result": [
    {
      "ClientIP": "bar",
      "RayID": "bar"
    }
  ]
}