List queries

client.Workers.Observability.Queries.List(ctx, params) (*SinglePage[ObservabilityQueryListResponse], error)

GET/accounts/{account_id}/workers/observability/queries

List saved queries.

Security

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

API Token

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

Example:Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY

User Service Key

Used when interacting with the Origin CA certificates API. View/change your key.

Example:

X-Auth-User-Service-Key: v1.0-144c9defac04969c7bfad8ef-631a41d003a32d25fe878081ef365c49503f7fada600da935e2851a1c7326084b85cbf6429c4b859de8475731dc92a9c329631e6d59e6c73da7b198497172b4cefe071d90d0f5d2719

Accepted Permissions (at least one required)

Workers Observability WriteWorkers Observability Read

ParametersExpand Collapse

params ObservabilityQueryListParams

AccountID param.Field[string]

Path param: Your Cloudflare account ID.

Order param.Field[ObservabilityQueryListParamsOrder]Optional

Query param

const ObservabilityQueryListParamsOrderAsc ObservabilityQueryListParamsOrder = "asc"

const ObservabilityQueryListParamsOrderDesc ObservabilityQueryListParamsOrder = "desc"

OrderBy param.Field[ObservabilityQueryListParamsOrderBy]Optional

Query param

const ObservabilityQueryListParamsOrderByCreated ObservabilityQueryListParamsOrderBy = "created"

const ObservabilityQueryListParamsOrderByUpdated ObservabilityQueryListParamsOrderBy = "updated"

Page param.Field[float64]Optional

Query param

minimum1

PerPage param.Field[float64]Optional

Query param

maximum50

minimum5

ReturnsExpand Collapse

type ObservabilityQueryListResponse struct{…}

ID string

Adhoc bool

If the query wasn’t explcitly saved

Created string

CreatedBy string

Description string

maxLength1000

Name string

Query name

maxLength250

minLength1

Parameters ObservabilityQueryListResponseParameters

Calculations []ObservabilityQueryListResponseParametersCalculationOptional

Create Calculations to compute as part of the query.

Operator ObservabilityQueryListResponseParametersCalculationsOperator

One of the following:

const ObservabilityQueryListResponseParametersCalculationsOperatorUniq ObservabilityQueryListResponseParametersCalculationsOperator = "uniq"

const ObservabilityQueryListResponseParametersCalculationsOperatorCount ObservabilityQueryListResponseParametersCalculationsOperator = "count"

const ObservabilityQueryListResponseParametersCalculationsOperatorMax ObservabilityQueryListResponseParametersCalculationsOperator = "max"

const ObservabilityQueryListResponseParametersCalculationsOperatorMin ObservabilityQueryListResponseParametersCalculationsOperator = "min"

const ObservabilityQueryListResponseParametersCalculationsOperatorSum ObservabilityQueryListResponseParametersCalculationsOperator = "sum"

const ObservabilityQueryListResponseParametersCalculationsOperatorAvg ObservabilityQueryListResponseParametersCalculationsOperator = "avg"

const ObservabilityQueryListResponseParametersCalculationsOperatorMedian ObservabilityQueryListResponseParametersCalculationsOperator = "median"

const ObservabilityQueryListResponseParametersCalculationsOperatorP001 ObservabilityQueryListResponseParametersCalculationsOperator = "p001"

const ObservabilityQueryListResponseParametersCalculationsOperatorP01 ObservabilityQueryListResponseParametersCalculationsOperator = "p01"

const ObservabilityQueryListResponseParametersCalculationsOperatorP05 ObservabilityQueryListResponseParametersCalculationsOperator = "p05"

const ObservabilityQueryListResponseParametersCalculationsOperatorP10 ObservabilityQueryListResponseParametersCalculationsOperator = "p10"

const ObservabilityQueryListResponseParametersCalculationsOperatorP25 ObservabilityQueryListResponseParametersCalculationsOperator = "p25"

const ObservabilityQueryListResponseParametersCalculationsOperatorP75 ObservabilityQueryListResponseParametersCalculationsOperator = "p75"

const ObservabilityQueryListResponseParametersCalculationsOperatorP90 ObservabilityQueryListResponseParametersCalculationsOperator = "p90"

const ObservabilityQueryListResponseParametersCalculationsOperatorP95 ObservabilityQueryListResponseParametersCalculationsOperator = "p95"

const ObservabilityQueryListResponseParametersCalculationsOperatorP99 ObservabilityQueryListResponseParametersCalculationsOperator = "p99"

const ObservabilityQueryListResponseParametersCalculationsOperatorP999 ObservabilityQueryListResponseParametersCalculationsOperator = "p999"

const ObservabilityQueryListResponseParametersCalculationsOperatorStddev ObservabilityQueryListResponseParametersCalculationsOperator = "stddev"

const ObservabilityQueryListResponseParametersCalculationsOperatorVariance ObservabilityQueryListResponseParametersCalculationsOperator = "variance"

const ObservabilityQueryListResponseParametersCalculationsOperatorCountDistinct ObservabilityQueryListResponseParametersCalculationsOperator = "COUNT_DISTINCT"

const ObservabilityQueryListResponseParametersCalculationsOperatorCountUppercase ObservabilityQueryListResponseParametersCalculationsOperator = "COUNT"

const ObservabilityQueryListResponseParametersCalculationsOperatorMaxUppercase ObservabilityQueryListResponseParametersCalculationsOperator = "MAX"

const ObservabilityQueryListResponseParametersCalculationsOperatorMinUppercase ObservabilityQueryListResponseParametersCalculationsOperator = "MIN"

const ObservabilityQueryListResponseParametersCalculationsOperatorSumUppercase ObservabilityQueryListResponseParametersCalculationsOperator = "SUM"

const ObservabilityQueryListResponseParametersCalculationsOperatorAvgUppercase ObservabilityQueryListResponseParametersCalculationsOperator = "AVG"

const ObservabilityQueryListResponseParametersCalculationsOperatorMedianUppercase ObservabilityQueryListResponseParametersCalculationsOperator = "MEDIAN"

const ObservabilityQueryListResponseParametersCalculationsOperatorP001Uppercase ObservabilityQueryListResponseParametersCalculationsOperator = "P001"

const ObservabilityQueryListResponseParametersCalculationsOperatorP01Uppercase ObservabilityQueryListResponseParametersCalculationsOperator = "P01"

const ObservabilityQueryListResponseParametersCalculationsOperatorP05Uppercase ObservabilityQueryListResponseParametersCalculationsOperator = "P05"

const ObservabilityQueryListResponseParametersCalculationsOperatorP10Uppercase ObservabilityQueryListResponseParametersCalculationsOperator = "P10"

const ObservabilityQueryListResponseParametersCalculationsOperatorP25Uppercase ObservabilityQueryListResponseParametersCalculationsOperator = "P25"

const ObservabilityQueryListResponseParametersCalculationsOperatorP75Uppercase ObservabilityQueryListResponseParametersCalculationsOperator = "P75"

const ObservabilityQueryListResponseParametersCalculationsOperatorP90Uppercase ObservabilityQueryListResponseParametersCalculationsOperator = "P90"

const ObservabilityQueryListResponseParametersCalculationsOperatorP95Uppercase ObservabilityQueryListResponseParametersCalculationsOperator = "P95"

const ObservabilityQueryListResponseParametersCalculationsOperatorP99Uppercase ObservabilityQueryListResponseParametersCalculationsOperator = "P99"

const ObservabilityQueryListResponseParametersCalculationsOperatorP999Uppercase ObservabilityQueryListResponseParametersCalculationsOperator = "P999"

const ObservabilityQueryListResponseParametersCalculationsOperatorStddevUppercase ObservabilityQueryListResponseParametersCalculationsOperator = "STDDEV"

const ObservabilityQueryListResponseParametersCalculationsOperatorVarianceUppercase ObservabilityQueryListResponseParametersCalculationsOperator = "VARIANCE"

Alias stringOptional

Key stringOptional

KeyType ObservabilityQueryListResponseParametersCalculationsKeyTypeOptional

One of the following:

const ObservabilityQueryListResponseParametersCalculationsKeyTypeString ObservabilityQueryListResponseParametersCalculationsKeyType = "string"

const ObservabilityQueryListResponseParametersCalculationsKeyTypeNumber ObservabilityQueryListResponseParametersCalculationsKeyType = "number"

const ObservabilityQueryListResponseParametersCalculationsKeyTypeBoolean ObservabilityQueryListResponseParametersCalculationsKeyType = "boolean"

Datasets []stringOptional

Set the Datasets to query. Leave it empty to query all the datasets.

FilterCombination ObservabilityQueryListResponseParametersFilterCombinationOptional

Set a Flag to describe how to combine the filters on the query.

One of the following:

const ObservabilityQueryListResponseParametersFilterCombinationAnd ObservabilityQueryListResponseParametersFilterCombination = "and"

const ObservabilityQueryListResponseParametersFilterCombinationOr ObservabilityQueryListResponseParametersFilterCombination = "or"

const ObservabilityQueryListResponseParametersFilterCombinationAndUppercase ObservabilityQueryListResponseParametersFilterCombination = "AND"

const ObservabilityQueryListResponseParametersFilterCombinationOrUppercase ObservabilityQueryListResponseParametersFilterCombination = "OR"

Filters []ObservabilityQueryListResponseParametersFilterOptional

Configure the Filters to apply to the query. Supports nested groups via kind: ‘group’.

One of the following:

type ObservabilityQueryListResponseParametersFiltersObject struct{…}

FilterCombination ObservabilityQueryListResponseParametersFiltersObjectFilterCombination

One of the following:

const ObservabilityQueryListResponseParametersFiltersObjectFilterCombinationAnd ObservabilityQueryListResponseParametersFiltersObjectFilterCombination = "and"

const ObservabilityQueryListResponseParametersFiltersObjectFilterCombinationOr ObservabilityQueryListResponseParametersFiltersObjectFilterCombination = "or"

const ObservabilityQueryListResponseParametersFiltersObjectFilterCombinationAndUppercase ObservabilityQueryListResponseParametersFiltersObjectFilterCombination = "AND"

const ObservabilityQueryListResponseParametersFiltersObjectFilterCombinationOrUppercase ObservabilityQueryListResponseParametersFiltersObjectFilterCombination = "OR"

Filters []unknown

Kind ObservabilityQueryListResponseParametersFiltersObjectKind

type ObservabilityQueryListResponseParametersFiltersWorkersObservabilityFilterLeaf struct{…}

A filter condition applied to query results. Use the keys and values endpoints to discover available fields and their values before constructing filters.

Key string

Filter field name. Use verified keys from previous query results or the keys endpoint. Common keys include $metadata.service, $metadata.origin, $metadata.trigger, $metadata.message, and $metadata.error.

Operation ObservabilityQueryListResponseParametersFiltersWorkersObservabilityFilterLeafOperation

Comparison operator. String operators: includes, not_includes, starts_with, ends_with, regex. Existence: exists, is_null. Set membership: in, not_in (comma-separated values). Numeric: eq, neq, gt, gte, lt, lte.

One of the following:

const ObservabilityQueryListResponseParametersFiltersWorkersObservabilityFilterLeafOperationIncludes ObservabilityQueryListResponseParametersFiltersWorkersObservabilityFilterLeafOperation = "includes"

const ObservabilityQueryListResponseParametersFiltersWorkersObservabilityFilterLeafOperationNotIncludes ObservabilityQueryListResponseParametersFiltersWorkersObservabilityFilterLeafOperation = "not_includes"

const ObservabilityQueryListResponseParametersFiltersWorkersObservabilityFilterLeafOperationStartsWith ObservabilityQueryListResponseParametersFiltersWorkersObservabilityFilterLeafOperation = "starts_with"

const ObservabilityQueryListResponseParametersFiltersWorkersObservabilityFilterLeafOperationEndsWith ObservabilityQueryListResponseParametersFiltersWorkersObservabilityFilterLeafOperation = "ends_with"

const ObservabilityQueryListResponseParametersFiltersWorkersObservabilityFilterLeafOperationRegex ObservabilityQueryListResponseParametersFiltersWorkersObservabilityFilterLeafOperation = "regex"

const ObservabilityQueryListResponseParametersFiltersWorkersObservabilityFilterLeafOperationExists ObservabilityQueryListResponseParametersFiltersWorkersObservabilityFilterLeafOperation = "exists"

const ObservabilityQueryListResponseParametersFiltersWorkersObservabilityFilterLeafOperationIsNull ObservabilityQueryListResponseParametersFiltersWorkersObservabilityFilterLeafOperation = "is_null"

const ObservabilityQueryListResponseParametersFiltersWorkersObservabilityFilterLeafOperationIn ObservabilityQueryListResponseParametersFiltersWorkersObservabilityFilterLeafOperation = "in"

const ObservabilityQueryListResponseParametersFiltersWorkersObservabilityFilterLeafOperationNotIn ObservabilityQueryListResponseParametersFiltersWorkersObservabilityFilterLeafOperation = "not_in"

const ObservabilityQueryListResponseParametersFiltersWorkersObservabilityFilterLeafOperationEq ObservabilityQueryListResponseParametersFiltersWorkersObservabilityFilterLeafOperation = "eq"

const ObservabilityQueryListResponseParametersFiltersWorkersObservabilityFilterLeafOperationNeq ObservabilityQueryListResponseParametersFiltersWorkersObservabilityFilterLeafOperation = "neq"

const ObservabilityQueryListResponseParametersFiltersWorkersObservabilityFilterLeafOperationGt ObservabilityQueryListResponseParametersFiltersWorkersObservabilityFilterLeafOperation = "gt"

const ObservabilityQueryListResponseParametersFiltersWorkersObservabilityFilterLeafOperationGte ObservabilityQueryListResponseParametersFiltersWorkersObservabilityFilterLeafOperation = "gte"

const ObservabilityQueryListResponseParametersFiltersWorkersObservabilityFilterLeafOperationLt ObservabilityQueryListResponseParametersFiltersWorkersObservabilityFilterLeafOperation = "lt"

const ObservabilityQueryListResponseParametersFiltersWorkersObservabilityFilterLeafOperationLte ObservabilityQueryListResponseParametersFiltersWorkersObservabilityFilterLeafOperation = "lte"

const ObservabilityQueryListResponseParametersFiltersWorkersObservabilityFilterLeafOperationEquals ObservabilityQueryListResponseParametersFiltersWorkersObservabilityFilterLeafOperation = "="

const ObservabilityQueryListResponseParametersFiltersWorkersObservabilityFilterLeafOperationNotEquals ObservabilityQueryListResponseParametersFiltersWorkersObservabilityFilterLeafOperation = "!="

const ObservabilityQueryListResponseParametersFiltersWorkersObservabilityFilterLeafOperationGreater ObservabilityQueryListResponseParametersFiltersWorkersObservabilityFilterLeafOperation = ">"

const ObservabilityQueryListResponseParametersFiltersWorkersObservabilityFilterLeafOperationGreaterOrEquals ObservabilityQueryListResponseParametersFiltersWorkersObservabilityFilterLeafOperation = ">="

const ObservabilityQueryListResponseParametersFiltersWorkersObservabilityFilterLeafOperationLess ObservabilityQueryListResponseParametersFiltersWorkersObservabilityFilterLeafOperation = "<"

const ObservabilityQueryListResponseParametersFiltersWorkersObservabilityFilterLeafOperationLessOrEquals ObservabilityQueryListResponseParametersFiltersWorkersObservabilityFilterLeafOperation = "<="

const ObservabilityQueryListResponseParametersFiltersWorkersObservabilityFilterLeafOperationIncludesUppercase ObservabilityQueryListResponseParametersFiltersWorkersObservabilityFilterLeafOperation = "INCLUDES"

const ObservabilityQueryListResponseParametersFiltersWorkersObservabilityFilterLeafOperationDoesNotInclude ObservabilityQueryListResponseParametersFiltersWorkersObservabilityFilterLeafOperation = "DOES_NOT_INCLUDE"

const ObservabilityQueryListResponseParametersFiltersWorkersObservabilityFilterLeafOperationMatchRegex ObservabilityQueryListResponseParametersFiltersWorkersObservabilityFilterLeafOperation = "MATCH_REGEX"

const ObservabilityQueryListResponseParametersFiltersWorkersObservabilityFilterLeafOperationExistsUppercase ObservabilityQueryListResponseParametersFiltersWorkersObservabilityFilterLeafOperation = "EXISTS"

const ObservabilityQueryListResponseParametersFiltersWorkersObservabilityFilterLeafOperationDoesNotExist ObservabilityQueryListResponseParametersFiltersWorkersObservabilityFilterLeafOperation = "DOES_NOT_EXIST"

const ObservabilityQueryListResponseParametersFiltersWorkersObservabilityFilterLeafOperationInUppercase ObservabilityQueryListResponseParametersFiltersWorkersObservabilityFilterLeafOperation = "IN"

const ObservabilityQueryListResponseParametersFiltersWorkersObservabilityFilterLeafOperationNotInUppercase ObservabilityQueryListResponseParametersFiltersWorkersObservabilityFilterLeafOperation = "NOT_IN"

const ObservabilityQueryListResponseParametersFiltersWorkersObservabilityFilterLeafOperationStartsWithUppercase ObservabilityQueryListResponseParametersFiltersWorkersObservabilityFilterLeafOperation = "STARTS_WITH"

const ObservabilityQueryListResponseParametersFiltersWorkersObservabilityFilterLeafOperationEndsWithUppercase ObservabilityQueryListResponseParametersFiltersWorkersObservabilityFilterLeafOperation = "ENDS_WITH"

Type ObservabilityQueryListResponseParametersFiltersWorkersObservabilityFilterLeafType

Data type of the filter field. Must match the actual type of the key being filtered.

One of the following:

const ObservabilityQueryListResponseParametersFiltersWorkersObservabilityFilterLeafTypeString ObservabilityQueryListResponseParametersFiltersWorkersObservabilityFilterLeafType = "string"

const ObservabilityQueryListResponseParametersFiltersWorkersObservabilityFilterLeafTypeNumber ObservabilityQueryListResponseParametersFiltersWorkersObservabilityFilterLeafType = "number"

const ObservabilityQueryListResponseParametersFiltersWorkersObservabilityFilterLeafTypeBoolean ObservabilityQueryListResponseParametersFiltersWorkersObservabilityFilterLeafType = "boolean"

Kind ObservabilityQueryListResponseParametersFiltersWorkersObservabilityFilterLeafKindOptional

Discriminator for leaf filter nodes. Always ‘filter’ when present; may be omitted.

Value ObservabilityQueryListResponseParametersFiltersWorkersObservabilityFilterLeafValueUnionOptional

Comparison value. Must match actual values in your data — verify with the values endpoint. Ensure the value type (string/number/boolean) matches the field type. String comparisons are case-sensitive. Regex uses RE2 syntax (no lookaheads/lookbehinds).

One of the following:

UnionString

UnionFloat

UnionBool

GroupBys []ObservabilityQueryListResponseParametersGroupByOptional

Define how to group the results of the query.

Type ObservabilityQueryListResponseParametersGroupBysType

One of the following:

const ObservabilityQueryListResponseParametersGroupBysTypeString ObservabilityQueryListResponseParametersGroupBysType = "string"

const ObservabilityQueryListResponseParametersGroupBysTypeNumber ObservabilityQueryListResponseParametersGroupBysType = "number"

const ObservabilityQueryListResponseParametersGroupBysTypeBoolean ObservabilityQueryListResponseParametersGroupBysType = "boolean"

Value string

Havings []ObservabilityQueryListResponseParametersHavingOptional

Configure the Having clauses that filter on calculations in the query result.

Key string

Operation ObservabilityQueryListResponseParametersHavingsOperation

One of the following:

const ObservabilityQueryListResponseParametersHavingsOperationEq ObservabilityQueryListResponseParametersHavingsOperation = "eq"

const ObservabilityQueryListResponseParametersHavingsOperationNeq ObservabilityQueryListResponseParametersHavingsOperation = "neq"

const ObservabilityQueryListResponseParametersHavingsOperationGt ObservabilityQueryListResponseParametersHavingsOperation = "gt"

const ObservabilityQueryListResponseParametersHavingsOperationGte ObservabilityQueryListResponseParametersHavingsOperation = "gte"

const ObservabilityQueryListResponseParametersHavingsOperationLt ObservabilityQueryListResponseParametersHavingsOperation = "lt"

const ObservabilityQueryListResponseParametersHavingsOperationLte ObservabilityQueryListResponseParametersHavingsOperation = "lte"

Value float64

Limit int64Optional

Set a limit on the number of results / records returned by the query

maximum100

minimum0

Needle ObservabilityQueryListResponseParametersNeedleOptional

Define an expression to search using full-text search.

Value ObservabilityQueryListResponseParametersNeedleValueUnion

maxLength1000

One of the following:

UnionString

UnionFloat

UnionBool

IsRegex boolOptional

MatchCase boolOptional

OrderBy ObservabilityQueryListResponseParametersOrderByOptional

Configure the order of the results returned by the query.

Value string

Configure which Calculation to order the results by.

Order ObservabilityQueryListResponseParametersOrderByOrderOptional

Set the order of the results

One of the following:

const ObservabilityQueryListResponseParametersOrderByOrderAsc ObservabilityQueryListResponseParametersOrderByOrder = "asc"

const ObservabilityQueryListResponseParametersOrderByOrderDesc ObservabilityQueryListResponseParametersOrderByOrder = "desc"

Updated string

UpdatedBy string

List queries

package main

import (
  "context"
  "fmt"

  "github.com/stainless-sdks/cloudflare-go"
  "github.com/stainless-sdks/cloudflare-go/option"
  "github.com/stainless-sdks/cloudflare-go/workers"
)

func main() {
  client := cloudflare.NewClient(
    option.WithAPIKey("144c9defac04969c7bfad8efaa8ea194"),
    option.WithAPIEmail("user@example.com"),
  )
  page, err := client.Workers.Observability.Queries.List(context.TODO(), workers.ObservabilityQueryListParams{
    AccountID: cloudflare.F("account_id"),
  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", page)
}

{
  "errors": [
    {
      "message": "message"
    }
  ],
  "messages": [
    {
      "message": "Successful request"
    }
  ],
  "result": [
    {
      "id": "id",
      "adhoc": true,
      "created": "created",
      "createdBy": "createdBy",
      "description": "Query description",
      "name": "x",
      "parameters": {
        "calculations": [
          {
            "operator": "uniq",
            "alias": "alias",
            "key": "key",
            "keyType": "string"
          }
        ],
        "datasets": [
          "string"
        ],
        "filterCombination": "and",
        "filters": [
          {
            "filterCombination": "and",
            "filters": [
              {}
            ],
            "kind": "group"
          }
        ],
        "groupBys": [
          {
            "type": "string",
            "value": "value"
          }
        ],
        "havings": [
          {
            "key": "key",
            "operation": "eq",
            "value": 0
          }
        ],
        "limit": 0,
        "needle": {
          "value": "string",
          "isRegex": true,
          "matchCase": true
        },
        "orderBy": {
          "value": "value",
          "order": "asc"
        }
      },
      "updated": "updated",
      "updatedBy": "updatedBy"
    }
  ],
  "success": true
}

Returns Examples

{
  "errors": [
    {
      "message": "message"
    }
  ],
  "messages": [
    {
      "message": "Successful request"
    }
  ],
  "result": [
    {
      "id": "id",
      "adhoc": true,
      "created": "created",
      "createdBy": "createdBy",
      "description": "Query description",
      "name": "x",
      "parameters": {
        "calculations": [
          {
            "operator": "uniq",
            "alias": "alias",
            "key": "key",
            "keyType": "string"
          }
        ],
        "datasets": [
          "string"
        ],
        "filterCombination": "and",
        "filters": [
          {
            "filterCombination": "and",
            "filters": [
              {}
            ],
            "kind": "group"
          }
        ],
        "groupBys": [
          {
            "type": "string",
            "value": "value"
          }
        ],
        "havings": [
          {
            "key": "key",
            "operation": "eq",
            "value": 0
          }
        ],
        "limit": 0,
        "needle": {
          "value": "string",
          "isRegex": true,
          "matchCase": true
        },
        "orderBy": {
          "value": "value",
          "order": "asc"
        }
      },
      "updated": "updated",
      "updatedBy": "updatedBy"
    }
  ],
  "success": true
}