Preview transformer

client.Logpush.Transformers.Preview(ctx, params) (*TransformerPreviewResponse, error)

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

params TransformerPreviewParams

AccountID param.Field[string]

Path param: Identifier.

maxLength32

Input param.Field[map[string, unknown]]

Body param: A single log record to transform (JSON object).

Sql param.Field[string]

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

maxLength32768

ReturnsExpand Collapse

type TransformerPreviewResponse map[string, unknown]

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

Preview transformer

package main

import (
  "context"
  "fmt"

  "github.com/cloudflare/cloudflare-go"
  "github.com/cloudflare/cloudflare-go/logpush"
  "github.com/cloudflare/cloudflare-go/option"
)

func main() {
  client := cloudflare.NewClient(
    option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"),
  )
  response, err := client.Logpush.Transformers.Preview(context.TODO(), logpush.TransformerPreviewParams{
    AccountID: cloudflare.F("023e105f4ecef8ad9ca31a8372d0c353"),
    Input: cloudflare.F(map[string]interface{}{
    "ClientIP": "bar",
    "ClientRequestHost": "bar",
    "EdgeStartTimestamp": "bar",
    "RayID": "bar",
    }),
    Sql: cloudflare.F("SELECT ClientIP, RayID FROM http_requests"),
  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", response)
}

{
  "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"
  }
}