API Reference

Workers

Observability

Shared Queries

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

View a query that has been shared

client.Workers.Observability.SharedQueries.Get(ctx, id, params) (*ObservabilitySharedQueryGetResponse, error)

GET/accounts/{account_id}/workers/observability/shared/query/{id}

Shared queries store the results of a previously run query, allowing you to share the results with others.

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

id string

Specify the ID of the shared query.

params ObservabilitySharedQueryGetParams

AccountID param.Field[string]

Path param: Your Cloudflare account ID.

View param.Field[ObservabilitySharedQueryGetParamsView]Optional

Query param: Select the view of the query result to return, defaults to events.

const ObservabilitySharedQueryGetParamsViewEvents ObservabilitySharedQueryGetParamsView = "events"

const ObservabilitySharedQueryGetParamsViewInvocations ObservabilitySharedQueryGetParamsView = "invocations"

const ObservabilitySharedQueryGetParamsViewCalculations ObservabilitySharedQueryGetParamsView = "calculations"

ReturnsExpand Collapse

type ObservabilitySharedQueryGetResponse struct{…}

Complete results of a query run. The populated fields depend on the requested view type (events, calculations, invocations, traces, or agents).

Run ObservabilitySharedQueryGetResponseRun

Represents a single execution of a query against Workers Observability data, including the query definition, execution status, and performance statistics.

ID string

Unique identifier for this query run.

AccountID string

Cloudflare account ID that owns this query run.

Dry bool

Whether this was a dry run (results not persisted).

Granularity float64

Number of time-series buckets used for the query. Higher values produce more detailed series data.

Query ObservabilitySharedQueryGetResponseRunQuery

A saved query definition with its parameters, metadata, and ownership information.

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 ObservabilitySharedQueryGetResponseRunQueryParameters

Calculations []ObservabilitySharedQueryGetResponseRunQueryParametersCalculationOptional

Create Calculations to compute as part of the query.

Operator ObservabilitySharedQueryGetResponseRunQueryParametersCalculationsOperator

One of the following:

const ObservabilitySharedQueryGetResponseRunQueryParametersCalculationsOperatorUniq ObservabilitySharedQueryGetResponseRunQueryParametersCalculationsOperator = "uniq"

const ObservabilitySharedQueryGetResponseRunQueryParametersCalculationsOperatorCount ObservabilitySharedQueryGetResponseRunQueryParametersCalculationsOperator = "count"

const ObservabilitySharedQueryGetResponseRunQueryParametersCalculationsOperatorMax ObservabilitySharedQueryGetResponseRunQueryParametersCalculationsOperator = "max"

const ObservabilitySharedQueryGetResponseRunQueryParametersCalculationsOperatorMin ObservabilitySharedQueryGetResponseRunQueryParametersCalculationsOperator = "min"

const ObservabilitySharedQueryGetResponseRunQueryParametersCalculationsOperatorSum ObservabilitySharedQueryGetResponseRunQueryParametersCalculationsOperator = "sum"

const ObservabilitySharedQueryGetResponseRunQueryParametersCalculationsOperatorAvg ObservabilitySharedQueryGetResponseRunQueryParametersCalculationsOperator = "avg"

const ObservabilitySharedQueryGetResponseRunQueryParametersCalculationsOperatorMedian ObservabilitySharedQueryGetResponseRunQueryParametersCalculationsOperator = "median"

const ObservabilitySharedQueryGetResponseRunQueryParametersCalculationsOperatorP001 ObservabilitySharedQueryGetResponseRunQueryParametersCalculationsOperator = "p001"

const ObservabilitySharedQueryGetResponseRunQueryParametersCalculationsOperatorP01 ObservabilitySharedQueryGetResponseRunQueryParametersCalculationsOperator = "p01"

const ObservabilitySharedQueryGetResponseRunQueryParametersCalculationsOperatorP05 ObservabilitySharedQueryGetResponseRunQueryParametersCalculationsOperator = "p05"

const ObservabilitySharedQueryGetResponseRunQueryParametersCalculationsOperatorP10 ObservabilitySharedQueryGetResponseRunQueryParametersCalculationsOperator = "p10"

const ObservabilitySharedQueryGetResponseRunQueryParametersCalculationsOperatorP25 ObservabilitySharedQueryGetResponseRunQueryParametersCalculationsOperator = "p25"

const ObservabilitySharedQueryGetResponseRunQueryParametersCalculationsOperatorP75 ObservabilitySharedQueryGetResponseRunQueryParametersCalculationsOperator = "p75"

const ObservabilitySharedQueryGetResponseRunQueryParametersCalculationsOperatorP90 ObservabilitySharedQueryGetResponseRunQueryParametersCalculationsOperator = "p90"

const ObservabilitySharedQueryGetResponseRunQueryParametersCalculationsOperatorP95 ObservabilitySharedQueryGetResponseRunQueryParametersCalculationsOperator = "p95"

const ObservabilitySharedQueryGetResponseRunQueryParametersCalculationsOperatorP99 ObservabilitySharedQueryGetResponseRunQueryParametersCalculationsOperator = "p99"

const ObservabilitySharedQueryGetResponseRunQueryParametersCalculationsOperatorP999 ObservabilitySharedQueryGetResponseRunQueryParametersCalculationsOperator = "p999"

const ObservabilitySharedQueryGetResponseRunQueryParametersCalculationsOperatorStddev ObservabilitySharedQueryGetResponseRunQueryParametersCalculationsOperator = "stddev"

const ObservabilitySharedQueryGetResponseRunQueryParametersCalculationsOperatorVariance ObservabilitySharedQueryGetResponseRunQueryParametersCalculationsOperator = "variance"

const ObservabilitySharedQueryGetResponseRunQueryParametersCalculationsOperatorCountDistinct ObservabilitySharedQueryGetResponseRunQueryParametersCalculationsOperator = "COUNT_DISTINCT"

const ObservabilitySharedQueryGetResponseRunQueryParametersCalculationsOperatorCountUppercase ObservabilitySharedQueryGetResponseRunQueryParametersCalculationsOperator = "COUNT"

const ObservabilitySharedQueryGetResponseRunQueryParametersCalculationsOperatorMaxUppercase ObservabilitySharedQueryGetResponseRunQueryParametersCalculationsOperator = "MAX"

const ObservabilitySharedQueryGetResponseRunQueryParametersCalculationsOperatorMinUppercase ObservabilitySharedQueryGetResponseRunQueryParametersCalculationsOperator = "MIN"

const ObservabilitySharedQueryGetResponseRunQueryParametersCalculationsOperatorSumUppercase ObservabilitySharedQueryGetResponseRunQueryParametersCalculationsOperator = "SUM"

const ObservabilitySharedQueryGetResponseRunQueryParametersCalculationsOperatorAvgUppercase ObservabilitySharedQueryGetResponseRunQueryParametersCalculationsOperator = "AVG"

const ObservabilitySharedQueryGetResponseRunQueryParametersCalculationsOperatorMedianUppercase ObservabilitySharedQueryGetResponseRunQueryParametersCalculationsOperator = "MEDIAN"

const ObservabilitySharedQueryGetResponseRunQueryParametersCalculationsOperatorP001Uppercase ObservabilitySharedQueryGetResponseRunQueryParametersCalculationsOperator = "P001"

const ObservabilitySharedQueryGetResponseRunQueryParametersCalculationsOperatorP01Uppercase ObservabilitySharedQueryGetResponseRunQueryParametersCalculationsOperator = "P01"

const ObservabilitySharedQueryGetResponseRunQueryParametersCalculationsOperatorP05Uppercase ObservabilitySharedQueryGetResponseRunQueryParametersCalculationsOperator = "P05"

const ObservabilitySharedQueryGetResponseRunQueryParametersCalculationsOperatorP10Uppercase ObservabilitySharedQueryGetResponseRunQueryParametersCalculationsOperator = "P10"

const ObservabilitySharedQueryGetResponseRunQueryParametersCalculationsOperatorP25Uppercase ObservabilitySharedQueryGetResponseRunQueryParametersCalculationsOperator = "P25"

const ObservabilitySharedQueryGetResponseRunQueryParametersCalculationsOperatorP75Uppercase ObservabilitySharedQueryGetResponseRunQueryParametersCalculationsOperator = "P75"

const ObservabilitySharedQueryGetResponseRunQueryParametersCalculationsOperatorP90Uppercase ObservabilitySharedQueryGetResponseRunQueryParametersCalculationsOperator = "P90"

const ObservabilitySharedQueryGetResponseRunQueryParametersCalculationsOperatorP95Uppercase ObservabilitySharedQueryGetResponseRunQueryParametersCalculationsOperator = "P95"

const ObservabilitySharedQueryGetResponseRunQueryParametersCalculationsOperatorP99Uppercase ObservabilitySharedQueryGetResponseRunQueryParametersCalculationsOperator = "P99"

const ObservabilitySharedQueryGetResponseRunQueryParametersCalculationsOperatorP999Uppercase ObservabilitySharedQueryGetResponseRunQueryParametersCalculationsOperator = "P999"

const ObservabilitySharedQueryGetResponseRunQueryParametersCalculationsOperatorStddevUppercase ObservabilitySharedQueryGetResponseRunQueryParametersCalculationsOperator = "STDDEV"

const ObservabilitySharedQueryGetResponseRunQueryParametersCalculationsOperatorVarianceUppercase ObservabilitySharedQueryGetResponseRunQueryParametersCalculationsOperator = "VARIANCE"

Alias stringOptional

Key stringOptional

KeyType ObservabilitySharedQueryGetResponseRunQueryParametersCalculationsKeyTypeOptional

One of the following:

const ObservabilitySharedQueryGetResponseRunQueryParametersCalculationsKeyTypeString ObservabilitySharedQueryGetResponseRunQueryParametersCalculationsKeyType = "string"

const ObservabilitySharedQueryGetResponseRunQueryParametersCalculationsKeyTypeNumber ObservabilitySharedQueryGetResponseRunQueryParametersCalculationsKeyType = "number"

const ObservabilitySharedQueryGetResponseRunQueryParametersCalculationsKeyTypeBoolean ObservabilitySharedQueryGetResponseRunQueryParametersCalculationsKeyType = "boolean"

Datasets []stringOptional

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

FilterCombination ObservabilitySharedQueryGetResponseRunQueryParametersFilterCombinationOptional

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

One of the following:

const ObservabilitySharedQueryGetResponseRunQueryParametersFilterCombinationAnd ObservabilitySharedQueryGetResponseRunQueryParametersFilterCombination = "and"

const ObservabilitySharedQueryGetResponseRunQueryParametersFilterCombinationOr ObservabilitySharedQueryGetResponseRunQueryParametersFilterCombination = "or"

const ObservabilitySharedQueryGetResponseRunQueryParametersFilterCombinationAndUppercase ObservabilitySharedQueryGetResponseRunQueryParametersFilterCombination = "AND"

const ObservabilitySharedQueryGetResponseRunQueryParametersFilterCombinationOrUppercase ObservabilitySharedQueryGetResponseRunQueryParametersFilterCombination = "OR"

Filters []ObservabilitySharedQueryGetResponseRunQueryParametersFilterOptional

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

One of the following:

type ObservabilitySharedQueryGetResponseRunQueryParametersFiltersObject struct{…}

FilterCombination ObservabilitySharedQueryGetResponseRunQueryParametersFiltersObjectFilterCombination

One of the following:

const ObservabilitySharedQueryGetResponseRunQueryParametersFiltersObjectFilterCombinationAnd ObservabilitySharedQueryGetResponseRunQueryParametersFiltersObjectFilterCombination = "and"

const ObservabilitySharedQueryGetResponseRunQueryParametersFiltersObjectFilterCombinationOr ObservabilitySharedQueryGetResponseRunQueryParametersFiltersObjectFilterCombination = "or"

const ObservabilitySharedQueryGetResponseRunQueryParametersFiltersObjectFilterCombinationAndUppercase ObservabilitySharedQueryGetResponseRunQueryParametersFiltersObjectFilterCombination = "AND"

const ObservabilitySharedQueryGetResponseRunQueryParametersFiltersObjectFilterCombinationOrUppercase ObservabilitySharedQueryGetResponseRunQueryParametersFiltersObjectFilterCombination = "OR"

Filters []unknown

Kind ObservabilitySharedQueryGetResponseRunQueryParametersFiltersObjectKind

type ObservabilitySharedQueryGetResponseRunQueryParametersFiltersWorkersObservabilityFilterLeaf 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 ObservabilitySharedQueryGetResponseRunQueryParametersFiltersWorkersObservabilityFilterLeafOperation

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 ObservabilitySharedQueryGetResponseRunQueryParametersFiltersWorkersObservabilityFilterLeafOperationIncludes ObservabilitySharedQueryGetResponseRunQueryParametersFiltersWorkersObservabilityFilterLeafOperation = "includes"

const ObservabilitySharedQueryGetResponseRunQueryParametersFiltersWorkersObservabilityFilterLeafOperationNotIncludes ObservabilitySharedQueryGetResponseRunQueryParametersFiltersWorkersObservabilityFilterLeafOperation = "not_includes"

const ObservabilitySharedQueryGetResponseRunQueryParametersFiltersWorkersObservabilityFilterLeafOperationStartsWith ObservabilitySharedQueryGetResponseRunQueryParametersFiltersWorkersObservabilityFilterLeafOperation = "starts_with"

const ObservabilitySharedQueryGetResponseRunQueryParametersFiltersWorkersObservabilityFilterLeafOperationEndsWith ObservabilitySharedQueryGetResponseRunQueryParametersFiltersWorkersObservabilityFilterLeafOperation = "ends_with"

const ObservabilitySharedQueryGetResponseRunQueryParametersFiltersWorkersObservabilityFilterLeafOperationRegex ObservabilitySharedQueryGetResponseRunQueryParametersFiltersWorkersObservabilityFilterLeafOperation = "regex"

const ObservabilitySharedQueryGetResponseRunQueryParametersFiltersWorkersObservabilityFilterLeafOperationExists ObservabilitySharedQueryGetResponseRunQueryParametersFiltersWorkersObservabilityFilterLeafOperation = "exists"

const ObservabilitySharedQueryGetResponseRunQueryParametersFiltersWorkersObservabilityFilterLeafOperationIsNull ObservabilitySharedQueryGetResponseRunQueryParametersFiltersWorkersObservabilityFilterLeafOperation = "is_null"

const ObservabilitySharedQueryGetResponseRunQueryParametersFiltersWorkersObservabilityFilterLeafOperationIn ObservabilitySharedQueryGetResponseRunQueryParametersFiltersWorkersObservabilityFilterLeafOperation = "in"

const ObservabilitySharedQueryGetResponseRunQueryParametersFiltersWorkersObservabilityFilterLeafOperationNotIn ObservabilitySharedQueryGetResponseRunQueryParametersFiltersWorkersObservabilityFilterLeafOperation = "not_in"

const ObservabilitySharedQueryGetResponseRunQueryParametersFiltersWorkersObservabilityFilterLeafOperationEq ObservabilitySharedQueryGetResponseRunQueryParametersFiltersWorkersObservabilityFilterLeafOperation = "eq"

const ObservabilitySharedQueryGetResponseRunQueryParametersFiltersWorkersObservabilityFilterLeafOperationNeq ObservabilitySharedQueryGetResponseRunQueryParametersFiltersWorkersObservabilityFilterLeafOperation = "neq"

const ObservabilitySharedQueryGetResponseRunQueryParametersFiltersWorkersObservabilityFilterLeafOperationGt ObservabilitySharedQueryGetResponseRunQueryParametersFiltersWorkersObservabilityFilterLeafOperation = "gt"

const ObservabilitySharedQueryGetResponseRunQueryParametersFiltersWorkersObservabilityFilterLeafOperationGte ObservabilitySharedQueryGetResponseRunQueryParametersFiltersWorkersObservabilityFilterLeafOperation = "gte"

const ObservabilitySharedQueryGetResponseRunQueryParametersFiltersWorkersObservabilityFilterLeafOperationLt ObservabilitySharedQueryGetResponseRunQueryParametersFiltersWorkersObservabilityFilterLeafOperation = "lt"

const ObservabilitySharedQueryGetResponseRunQueryParametersFiltersWorkersObservabilityFilterLeafOperationLte ObservabilitySharedQueryGetResponseRunQueryParametersFiltersWorkersObservabilityFilterLeafOperation = "lte"

const ObservabilitySharedQueryGetResponseRunQueryParametersFiltersWorkersObservabilityFilterLeafOperationEquals ObservabilitySharedQueryGetResponseRunQueryParametersFiltersWorkersObservabilityFilterLeafOperation = "="

const ObservabilitySharedQueryGetResponseRunQueryParametersFiltersWorkersObservabilityFilterLeafOperationNotEquals ObservabilitySharedQueryGetResponseRunQueryParametersFiltersWorkersObservabilityFilterLeafOperation = "!="

const ObservabilitySharedQueryGetResponseRunQueryParametersFiltersWorkersObservabilityFilterLeafOperationGreater ObservabilitySharedQueryGetResponseRunQueryParametersFiltersWorkersObservabilityFilterLeafOperation = ">"

const ObservabilitySharedQueryGetResponseRunQueryParametersFiltersWorkersObservabilityFilterLeafOperationGreaterOrEquals ObservabilitySharedQueryGetResponseRunQueryParametersFiltersWorkersObservabilityFilterLeafOperation = ">="

const ObservabilitySharedQueryGetResponseRunQueryParametersFiltersWorkersObservabilityFilterLeafOperationLess ObservabilitySharedQueryGetResponseRunQueryParametersFiltersWorkersObservabilityFilterLeafOperation = "<"

const ObservabilitySharedQueryGetResponseRunQueryParametersFiltersWorkersObservabilityFilterLeafOperationLessOrEquals ObservabilitySharedQueryGetResponseRunQueryParametersFiltersWorkersObservabilityFilterLeafOperation = "<="

const ObservabilitySharedQueryGetResponseRunQueryParametersFiltersWorkersObservabilityFilterLeafOperationIncludesUppercase ObservabilitySharedQueryGetResponseRunQueryParametersFiltersWorkersObservabilityFilterLeafOperation = "INCLUDES"

const ObservabilitySharedQueryGetResponseRunQueryParametersFiltersWorkersObservabilityFilterLeafOperationDoesNotInclude ObservabilitySharedQueryGetResponseRunQueryParametersFiltersWorkersObservabilityFilterLeafOperation = "DOES_NOT_INCLUDE"

const ObservabilitySharedQueryGetResponseRunQueryParametersFiltersWorkersObservabilityFilterLeafOperationMatchRegex ObservabilitySharedQueryGetResponseRunQueryParametersFiltersWorkersObservabilityFilterLeafOperation = "MATCH_REGEX"

const ObservabilitySharedQueryGetResponseRunQueryParametersFiltersWorkersObservabilityFilterLeafOperationExistsUppercase ObservabilitySharedQueryGetResponseRunQueryParametersFiltersWorkersObservabilityFilterLeafOperation = "EXISTS"

const ObservabilitySharedQueryGetResponseRunQueryParametersFiltersWorkersObservabilityFilterLeafOperationDoesNotExist ObservabilitySharedQueryGetResponseRunQueryParametersFiltersWorkersObservabilityFilterLeafOperation = "DOES_NOT_EXIST"

const ObservabilitySharedQueryGetResponseRunQueryParametersFiltersWorkersObservabilityFilterLeafOperationInUppercase ObservabilitySharedQueryGetResponseRunQueryParametersFiltersWorkersObservabilityFilterLeafOperation = "IN"

const ObservabilitySharedQueryGetResponseRunQueryParametersFiltersWorkersObservabilityFilterLeafOperationNotInUppercase ObservabilitySharedQueryGetResponseRunQueryParametersFiltersWorkersObservabilityFilterLeafOperation = "NOT_IN"

const ObservabilitySharedQueryGetResponseRunQueryParametersFiltersWorkersObservabilityFilterLeafOperationStartsWithUppercase ObservabilitySharedQueryGetResponseRunQueryParametersFiltersWorkersObservabilityFilterLeafOperation = "STARTS_WITH"

const ObservabilitySharedQueryGetResponseRunQueryParametersFiltersWorkersObservabilityFilterLeafOperationEndsWithUppercase ObservabilitySharedQueryGetResponseRunQueryParametersFiltersWorkersObservabilityFilterLeafOperation = "ENDS_WITH"

Type ObservabilitySharedQueryGetResponseRunQueryParametersFiltersWorkersObservabilityFilterLeafType

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

One of the following:

const ObservabilitySharedQueryGetResponseRunQueryParametersFiltersWorkersObservabilityFilterLeafTypeString ObservabilitySharedQueryGetResponseRunQueryParametersFiltersWorkersObservabilityFilterLeafType = "string"

const ObservabilitySharedQueryGetResponseRunQueryParametersFiltersWorkersObservabilityFilterLeafTypeNumber ObservabilitySharedQueryGetResponseRunQueryParametersFiltersWorkersObservabilityFilterLeafType = "number"

const ObservabilitySharedQueryGetResponseRunQueryParametersFiltersWorkersObservabilityFilterLeafTypeBoolean ObservabilitySharedQueryGetResponseRunQueryParametersFiltersWorkersObservabilityFilterLeafType = "boolean"

Kind ObservabilitySharedQueryGetResponseRunQueryParametersFiltersWorkersObservabilityFilterLeafKindOptional

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

Value ObservabilitySharedQueryGetResponseRunQueryParametersFiltersWorkersObservabilityFilterLeafValueUnionOptional

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 []ObservabilitySharedQueryGetResponseRunQueryParametersGroupByOptional

Define how to group the results of the query.

Type ObservabilitySharedQueryGetResponseRunQueryParametersGroupBysType

One of the following:

const ObservabilitySharedQueryGetResponseRunQueryParametersGroupBysTypeString ObservabilitySharedQueryGetResponseRunQueryParametersGroupBysType = "string"

const ObservabilitySharedQueryGetResponseRunQueryParametersGroupBysTypeNumber ObservabilitySharedQueryGetResponseRunQueryParametersGroupBysType = "number"

const ObservabilitySharedQueryGetResponseRunQueryParametersGroupBysTypeBoolean ObservabilitySharedQueryGetResponseRunQueryParametersGroupBysType = "boolean"

Value string

Havings []ObservabilitySharedQueryGetResponseRunQueryParametersHavingOptional

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

Key string

Operation ObservabilitySharedQueryGetResponseRunQueryParametersHavingsOperation

One of the following:

const ObservabilitySharedQueryGetResponseRunQueryParametersHavingsOperationEq ObservabilitySharedQueryGetResponseRunQueryParametersHavingsOperation = "eq"

const ObservabilitySharedQueryGetResponseRunQueryParametersHavingsOperationNeq ObservabilitySharedQueryGetResponseRunQueryParametersHavingsOperation = "neq"

const ObservabilitySharedQueryGetResponseRunQueryParametersHavingsOperationGt ObservabilitySharedQueryGetResponseRunQueryParametersHavingsOperation = "gt"

const ObservabilitySharedQueryGetResponseRunQueryParametersHavingsOperationGte ObservabilitySharedQueryGetResponseRunQueryParametersHavingsOperation = "gte"

const ObservabilitySharedQueryGetResponseRunQueryParametersHavingsOperationLt ObservabilitySharedQueryGetResponseRunQueryParametersHavingsOperation = "lt"

const ObservabilitySharedQueryGetResponseRunQueryParametersHavingsOperationLte ObservabilitySharedQueryGetResponseRunQueryParametersHavingsOperation = "lte"

Value float64

Limit int64Optional

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

maximum100

minimum0

Needle ObservabilitySharedQueryGetResponseRunQueryParametersNeedleOptional

Define an expression to search using full-text search.

Value ObservabilitySharedQueryGetResponseRunQueryParametersNeedleValue

IsRegex boolOptional

MatchCase boolOptional

OrderBy ObservabilitySharedQueryGetResponseRunQueryParametersOrderByOptional

Configure the order of the results returned by the query.

Value string

Configure which Calculation to order the results by.

Order ObservabilitySharedQueryGetResponseRunQueryParametersOrderByOrderOptional

Set the order of the results

One of the following:

const ObservabilitySharedQueryGetResponseRunQueryParametersOrderByOrderAsc ObservabilitySharedQueryGetResponseRunQueryParametersOrderByOrder = "asc"

const ObservabilitySharedQueryGetResponseRunQueryParametersOrderByOrderDesc ObservabilitySharedQueryGetResponseRunQueryParametersOrderByOrder = "desc"

Updated string

UpdatedBy string

Status ObservabilitySharedQueryGetResponseRunStatus

Current execution status of the query run.

One of the following:

const ObservabilitySharedQueryGetResponseRunStatusStarted ObservabilitySharedQueryGetResponseRunStatus = "STARTED"

const ObservabilitySharedQueryGetResponseRunStatusCompleted ObservabilitySharedQueryGetResponseRunStatus = "COMPLETED"

Timeframe ObservabilitySharedQueryGetResponseRunTimeframe

Time range for the query execution

From float64

Start timestamp for the query timeframe (Unix timestamp in milliseconds)

To float64

End timestamp for the query timeframe (Unix timestamp in milliseconds)

UserID string

ID of the user who initiated the query run.

Created stringOptional

ISO-8601 timestamp when the query run was created.

Statistics ObservabilitySharedQueryGetResponseRunStatisticsOptional

Query performance statistics from the database (does not include network latency).

BytesRead float64

Number of uncompressed bytes read from the table.

Elapsed float64

Time in seconds for the query to run.

RowsRead float64

Number of rows scanned from the table.

AbrLevel float64Optional

The level of Adaptive Bit Rate (ABR) sampling used for the query. If empty the ABR level is 1

Updated stringOptional

ISO-8601 timestamp when the query run was last updated.

Statistics ObservabilitySharedQueryGetResponseStatistics

Query performance statistics from the database. Includes execution time, rows scanned, and bytes read. Does not include network latency.

BytesRead float64

Number of uncompressed bytes read from the table.

Elapsed float64

Time in seconds for the query to run.

RowsRead float64

Number of rows scanned from the table.

AbrLevel float64Optional

The level of Adaptive Bit Rate (ABR) sampling used for the query. If empty the ABR level is 1

Agents []ObservabilitySharedQueryGetResponseAgentOptional

Durable Object agent summaries. Present when the query view is ‘agents’. Each entry represents an agent with its event counts and status.

AgentClass string

Class name of the Durable Object agent.

EventTypeCounts map[string, float64]

Breakdown of event counts by event type.

FirstEventMs float64

Timestamp of the earliest event from this agent in the queried window (Unix epoch ms).

HasErrors bool

Whether the agent emitted any error events in the queried window.

LastEventMs float64

Timestamp of the most recent event from this agent (Unix epoch ms).

Namespace string

Durable Object namespace the agent belongs to.

Service string

Worker service name that hosts this agent.

TotalEvents float64

Total number of events emitted by this agent in the queried window.

Calculations []ObservabilitySharedQueryGetResponseCalculationOptional

Aggregated calculation results. Present when the query view is ‘calculations’. Contains computed metrics (count, avg, p99, etc.) with optional group-by breakdowns and time-series data.

Aggregates []ObservabilitySharedQueryGetResponseCalculationsAggregate

Count float64

Interval float64

SampleInterval float64

Value float64

Groups []ObservabilitySharedQueryGetResponseCalculationsAggregatesGroupOptional

Key string

Value ObservabilitySharedQueryGetResponseCalculationsAggregatesGroupsValueUnion

One of the following:

UnionString

UnionFloat

UnionBool

Calculation string

Series []ObservabilitySharedQueryGetResponseCalculationsSeries

Data []ObservabilitySharedQueryGetResponseCalculationsSeriesData

Count float64

Interval float64

SampleInterval float64

Value float64

FirstSeen stringOptional

Groups []ObservabilitySharedQueryGetResponseCalculationsSeriesDataGroupOptional

Key string

Value ObservabilitySharedQueryGetResponseCalculationsSeriesDataGroupsValueUnion

One of the following:

UnionString

UnionFloat

UnionBool

LastSeen stringOptional

Time string

Alias stringOptional

Compare []ObservabilitySharedQueryGetResponseCompareOptional

Comparison calculation results from the previous time period. Present when the compare option is enabled. Same structure as calculations.

Aggregates []ObservabilitySharedQueryGetResponseCompareAggregate

Count float64

Interval float64

SampleInterval float64

Value float64

Groups []ObservabilitySharedQueryGetResponseCompareAggregatesGroupOptional

Key string

Value ObservabilitySharedQueryGetResponseCompareAggregatesGroupsValueUnion

One of the following:

UnionString

UnionFloat

UnionBool

Calculation string

Series []ObservabilitySharedQueryGetResponseCompareSeries

Data []ObservabilitySharedQueryGetResponseCompareSeriesData

Count float64

Interval float64

SampleInterval float64

Value float64

FirstSeen stringOptional

Groups []ObservabilitySharedQueryGetResponseCompareSeriesDataGroupOptional

Key string

Value ObservabilitySharedQueryGetResponseCompareSeriesDataGroupsValueUnion

One of the following:

UnionString

UnionFloat

UnionBool

LastSeen stringOptional

Time string

Alias stringOptional

Events ObservabilitySharedQueryGetResponseEventsOptional

Individual event results. Present when the query view is ‘events’. Contains the matching log lines and their metadata.

Count float64Optional

Total number of events matching the query (may exceed the number returned due to limits).

Events []ObservabilitySharedQueryGetResponseEventsEventOptional

List of individual telemetry events matching the query.

Metadata ObservabilitySharedQueryGetResponseEventsEventsMetadata

Structured metadata extracted from the event. These fields are indexed and available for filtering and aggregation.

ID string

Unique event ID. Use as the cursor value for offset-based pagination.

Account stringOptional

Cloudflare account identifier.

CloudService stringOptional

Cloudflare product that generated this event (e.g. workers, pages).

ColdStart int64Optional

exclusiveMinimum

minimum0

Cost int64Optional

Estimated cost units for this invocation.

exclusiveMinimum

minimum0

Duration int64Optional

Span duration in milliseconds.

exclusiveMinimum

minimum0

EndTime int64Optional

Span end time as a Unix epoch in milliseconds.

minimum0

Error stringOptional

Error message, present when the log represents an error.

ErrorTemplate stringOptional

Templatized version of the error message used for grouping similar errors.

Fingerprint stringOptional

Content-based fingerprint used to group similar events.

Level stringOptional

Log level (e.g. log, debug, info, warn, error).

Message stringOptional

Log message text.

MessageTemplate stringOptional

Templatized version of the log message used for grouping similar messages.

MetricName stringOptional

Metric name when the event represents a metric data point.

Origin stringOptional

Origin of the event (e.g. fetch, scheduled, queue).

ParentSpanID stringOptional

Span ID of the parent span in the trace hierarchy.

Provider stringOptional

Infrastructure provider identifier.

Region stringOptional

Cloudflare data center / region that handled the request.

RequestID stringOptional

Cloudflare request ID that ties all logs from a single invocation together.

Service stringOptional

Worker script name that produced this event.

SpanID stringOptional

Span ID for this individual unit of work within a trace.

SpanName stringOptional

Human-readable name for this span.

StackID stringOptional

Stack / deployment identifier.

StartTime int64Optional

Span start time as a Unix epoch in milliseconds.

minimum0

StatusCode int64Optional

HTTP response status code returned by the Worker.

exclusiveMinimum

minimum0

TraceDuration int64Optional

Total duration of the entire trace in milliseconds.

exclusiveMinimum

minimum0

TraceID stringOptional

Distributed trace ID linking spans across services.

TransactionName stringOptional

Logical transaction name for this request.

Trigger stringOptional

What triggered the invocation (e.g. GET /users, POST /orders, queue message).

Type stringOptional

Event type classifier (e.g. cf-worker-event, cf-worker-log).

URL stringOptional

Request URL that triggered the Worker invocation.

Dataset string

The dataset this event belongs to (e.g. cloudflare-workers).

Source ObservabilitySharedQueryGetResponseEventsEventsSourceUnion

Raw log payload. May be a string or a structured object depending on how the log was emitted.

One of the following:

UnionString

type ObservabilitySharedQueryGetResponseEventsEventsSourceMap map[string, unknown]

Timestamp int64

Event timestamp as a Unix epoch in milliseconds.

minimum0

Containers map[string, unknown]Optional

Cloudflare Containers event information that enriches your logs for identifying and debugging issues.

Workers ObservabilitySharedQueryGetResponseEventsEventsWorkersOptional

Cloudflare Workers event information that enriches your logs for identifying and debugging issues.

One of the following:

type ObservabilitySharedQueryGetResponseEventsEventsWorkersObject struct{…}

EventType ObservabilitySharedQueryGetResponseEventsEventsWorkersObjectEventType

One of the following:

const ObservabilitySharedQueryGetResponseEventsEventsWorkersObjectEventTypeFetch ObservabilitySharedQueryGetResponseEventsEventsWorkersObjectEventType = "fetch"

const ObservabilitySharedQueryGetResponseEventsEventsWorkersObjectEventTypeScheduled ObservabilitySharedQueryGetResponseEventsEventsWorkersObjectEventType = "scheduled"

const ObservabilitySharedQueryGetResponseEventsEventsWorkersObjectEventTypeAlarm ObservabilitySharedQueryGetResponseEventsEventsWorkersObjectEventType = "alarm"

const ObservabilitySharedQueryGetResponseEventsEventsWorkersObjectEventTypeCron ObservabilitySharedQueryGetResponseEventsEventsWorkersObjectEventType = "cron"

const ObservabilitySharedQueryGetResponseEventsEventsWorkersObjectEventTypeQueue ObservabilitySharedQueryGetResponseEventsEventsWorkersObjectEventType = "queue"

const ObservabilitySharedQueryGetResponseEventsEventsWorkersObjectEventTypeEmail ObservabilitySharedQueryGetResponseEventsEventsWorkersObjectEventType = "email"

const ObservabilitySharedQueryGetResponseEventsEventsWorkersObjectEventTypeTail ObservabilitySharedQueryGetResponseEventsEventsWorkersObjectEventType = "tail"

const ObservabilitySharedQueryGetResponseEventsEventsWorkersObjectEventTypeRpc ObservabilitySharedQueryGetResponseEventsEventsWorkersObjectEventType = "rpc"

const ObservabilitySharedQueryGetResponseEventsEventsWorkersObjectEventTypeWebsocket ObservabilitySharedQueryGetResponseEventsEventsWorkersObjectEventType = "websocket"

const ObservabilitySharedQueryGetResponseEventsEventsWorkersObjectEventTypeWorkflow ObservabilitySharedQueryGetResponseEventsEventsWorkersObjectEventType = "workflow"

const ObservabilitySharedQueryGetResponseEventsEventsWorkersObjectEventTypeUnknown ObservabilitySharedQueryGetResponseEventsEventsWorkersObjectEventType = "unknown"

RequestID string

ScriptName string

DurableObjectID stringOptional

Entrypoint stringOptional

Event map[string, unknown]Optional

ExecutionModel ObservabilitySharedQueryGetResponseEventsEventsWorkersObjectExecutionModelOptional

One of the following:

const ObservabilitySharedQueryGetResponseEventsEventsWorkersObjectExecutionModelDurableObject ObservabilitySharedQueryGetResponseEventsEventsWorkersObjectExecutionModel = "durableObject"

const ObservabilitySharedQueryGetResponseEventsEventsWorkersObjectExecutionModelStateless ObservabilitySharedQueryGetResponseEventsEventsWorkersObjectExecutionModel = "stateless"

Outcome stringOptional

Preview ObservabilitySharedQueryGetResponseEventsEventsWorkersObjectPreviewOptional

ID stringOptional

Name stringOptional

Slug stringOptional

ScriptVersion ObservabilitySharedQueryGetResponseEventsEventsWorkersObjectScriptVersionOptional

ID stringOptional

Message stringOptional

Tag stringOptional

SpanID stringOptional

TraceID stringOptional

Truncated boolOptional

type ObservabilitySharedQueryGetResponseEventsEventsWorkersObject struct{…}

CPUTimeMs float64

EventType ObservabilitySharedQueryGetResponseEventsEventsWorkersObjectEventType

One of the following:

const ObservabilitySharedQueryGetResponseEventsEventsWorkersObjectEventTypeFetch ObservabilitySharedQueryGetResponseEventsEventsWorkersObjectEventType = "fetch"

const ObservabilitySharedQueryGetResponseEventsEventsWorkersObjectEventTypeScheduled ObservabilitySharedQueryGetResponseEventsEventsWorkersObjectEventType = "scheduled"

const ObservabilitySharedQueryGetResponseEventsEventsWorkersObjectEventTypeAlarm ObservabilitySharedQueryGetResponseEventsEventsWorkersObjectEventType = "alarm"

const ObservabilitySharedQueryGetResponseEventsEventsWorkersObjectEventTypeCron ObservabilitySharedQueryGetResponseEventsEventsWorkersObjectEventType = "cron"

const ObservabilitySharedQueryGetResponseEventsEventsWorkersObjectEventTypeQueue ObservabilitySharedQueryGetResponseEventsEventsWorkersObjectEventType = "queue"

const ObservabilitySharedQueryGetResponseEventsEventsWorkersObjectEventTypeEmail ObservabilitySharedQueryGetResponseEventsEventsWorkersObjectEventType = "email"

const ObservabilitySharedQueryGetResponseEventsEventsWorkersObjectEventTypeTail ObservabilitySharedQueryGetResponseEventsEventsWorkersObjectEventType = "tail"

const ObservabilitySharedQueryGetResponseEventsEventsWorkersObjectEventTypeRpc ObservabilitySharedQueryGetResponseEventsEventsWorkersObjectEventType = "rpc"

const ObservabilitySharedQueryGetResponseEventsEventsWorkersObjectEventTypeWebsocket ObservabilitySharedQueryGetResponseEventsEventsWorkersObjectEventType = "websocket"

const ObservabilitySharedQueryGetResponseEventsEventsWorkersObjectEventTypeWorkflow ObservabilitySharedQueryGetResponseEventsEventsWorkersObjectEventType = "workflow"

const ObservabilitySharedQueryGetResponseEventsEventsWorkersObjectEventTypeUnknown ObservabilitySharedQueryGetResponseEventsEventsWorkersObjectEventType = "unknown"

Outcome string

RequestID string

ScriptName string

WallTimeMs float64

DiagnosticsChannelEvents []ObservabilitySharedQueryGetResponseEventsEventsWorkersObjectDiagnosticsChannelEventOptional

Channel string

Message string

Timestamp float64

DispatchNamespace stringOptional

DurableObjectID stringOptional

Entrypoint stringOptional

Event map[string, unknown]Optional

ExecutionModel ObservabilitySharedQueryGetResponseEventsEventsWorkersObjectExecutionModelOptional

One of the following:

const ObservabilitySharedQueryGetResponseEventsEventsWorkersObjectExecutionModelDurableObject ObservabilitySharedQueryGetResponseEventsEventsWorkersObjectExecutionModel = "durableObject"

const ObservabilitySharedQueryGetResponseEventsEventsWorkersObjectExecutionModelStateless ObservabilitySharedQueryGetResponseEventsEventsWorkersObjectExecutionModel = "stateless"

Preview ObservabilitySharedQueryGetResponseEventsEventsWorkersObjectPreviewOptional

ID stringOptional

Name stringOptional

Slug stringOptional

ScriptVersion ObservabilitySharedQueryGetResponseEventsEventsWorkersObjectScriptVersionOptional

ID stringOptional

Message stringOptional

Tag stringOptional

SpanID stringOptional

TraceID stringOptional

Truncated boolOptional

Fields []ObservabilitySharedQueryGetResponseEventsFieldOptional

List of fields discovered in the matched events. Useful for building dynamic UIs.

Key string

Field name present in the matched events.

Type string

Data type of the field (string, number, or boolean).

Series []ObservabilitySharedQueryGetResponseEventsSeriesOptional

Time-series data for the matched events, bucketed by the query granularity.

Data []ObservabilitySharedQueryGetResponseEventsSeriesData

Aggregates ObservabilitySharedQueryGetResponseEventsSeriesDataAggregates

DeprecatedCount int64

exclusiveMinimum

minimum0

DeprecatedInterval float64

exclusiveMinimum

minimum0

DeprecatedFirstSeen stringOptional

DeprecatedLastSeen stringOptional

DeprecatedBin unknownOptional

Count float64

Interval float64

SampleInterval float64

Errors float64Optional

Groups map[string, ObservabilitySharedQueryGetResponseEventsSeriesDataGroupsUnion]Optional

Groups in the query results.

One of the following:

UnionString

UnionFloat

UnionBool

Time string

Invocations map[string, []ObservabilitySharedQueryGetResponseInvocation]Optional

Events grouped by invocation (request ID). Present when the query view is ‘invocations’. Each key is a request ID mapping to all events from that invocation.

Metadata ObservabilitySharedQueryGetResponseInvocationsMetadata

Structured metadata extracted from the event. These fields are indexed and available for filtering and aggregation.

ID string

Unique event ID. Use as the cursor value for offset-based pagination.

Account stringOptional

Cloudflare account identifier.

CloudService stringOptional

Cloudflare product that generated this event (e.g. workers, pages).

ColdStart int64Optional

exclusiveMinimum

minimum0

Cost int64Optional

Estimated cost units for this invocation.

exclusiveMinimum

minimum0

Duration int64Optional

Span duration in milliseconds.

exclusiveMinimum

minimum0

EndTime int64Optional

Span end time as a Unix epoch in milliseconds.

minimum0

Error stringOptional

Error message, present when the log represents an error.

ErrorTemplate stringOptional

Templatized version of the error message used for grouping similar errors.

Fingerprint stringOptional

Content-based fingerprint used to group similar events.

Level stringOptional

Log level (e.g. log, debug, info, warn, error).

Message stringOptional

Log message text.

MessageTemplate stringOptional

Templatized version of the log message used for grouping similar messages.

MetricName stringOptional

Metric name when the event represents a metric data point.

Origin stringOptional

Origin of the event (e.g. fetch, scheduled, queue).

ParentSpanID stringOptional

Span ID of the parent span in the trace hierarchy.

Provider stringOptional

Infrastructure provider identifier.

Region stringOptional

Cloudflare data center / region that handled the request.

RequestID stringOptional

Cloudflare request ID that ties all logs from a single invocation together.

Service stringOptional

Worker script name that produced this event.

SpanID stringOptional

Span ID for this individual unit of work within a trace.

SpanName stringOptional

Human-readable name for this span.

StackID stringOptional

Stack / deployment identifier.

StartTime int64Optional

Span start time as a Unix epoch in milliseconds.

minimum0

StatusCode int64Optional

HTTP response status code returned by the Worker.

exclusiveMinimum

minimum0

TraceDuration int64Optional

Total duration of the entire trace in milliseconds.

exclusiveMinimum

minimum0

TraceID stringOptional

Distributed trace ID linking spans across services.

TransactionName stringOptional

Logical transaction name for this request.

Trigger stringOptional

What triggered the invocation (e.g. GET /users, POST /orders, queue message).

Type stringOptional

Event type classifier (e.g. cf-worker-event, cf-worker-log).

URL stringOptional

Request URL that triggered the Worker invocation.

Dataset string

The dataset this event belongs to (e.g. cloudflare-workers).

Source ObservabilitySharedQueryGetResponseInvocationsSourceUnion

Raw log payload. May be a string or a structured object depending on how the log was emitted.

One of the following:

UnionString

type ObservabilitySharedQueryGetResponseInvocationsSourceMap map[string, unknown]

Timestamp int64

Event timestamp as a Unix epoch in milliseconds.

minimum0

Containers map[string, unknown]Optional

Cloudflare Containers event information that enriches your logs for identifying and debugging issues.

Workers ObservabilitySharedQueryGetResponseInvocationsWorkersOptional

Cloudflare Workers event information that enriches your logs for identifying and debugging issues.

One of the following:

type ObservabilitySharedQueryGetResponseInvocationsWorkersObject struct{…}

EventType ObservabilitySharedQueryGetResponseInvocationsWorkersObjectEventType

One of the following:

const ObservabilitySharedQueryGetResponseInvocationsWorkersObjectEventTypeFetch ObservabilitySharedQueryGetResponseInvocationsWorkersObjectEventType = "fetch"

const ObservabilitySharedQueryGetResponseInvocationsWorkersObjectEventTypeScheduled ObservabilitySharedQueryGetResponseInvocationsWorkersObjectEventType = "scheduled"

const ObservabilitySharedQueryGetResponseInvocationsWorkersObjectEventTypeAlarm ObservabilitySharedQueryGetResponseInvocationsWorkersObjectEventType = "alarm"

const ObservabilitySharedQueryGetResponseInvocationsWorkersObjectEventTypeCron ObservabilitySharedQueryGetResponseInvocationsWorkersObjectEventType = "cron"

const ObservabilitySharedQueryGetResponseInvocationsWorkersObjectEventTypeQueue ObservabilitySharedQueryGetResponseInvocationsWorkersObjectEventType = "queue"

const ObservabilitySharedQueryGetResponseInvocationsWorkersObjectEventTypeEmail ObservabilitySharedQueryGetResponseInvocationsWorkersObjectEventType = "email"

const ObservabilitySharedQueryGetResponseInvocationsWorkersObjectEventTypeTail ObservabilitySharedQueryGetResponseInvocationsWorkersObjectEventType = "tail"

const ObservabilitySharedQueryGetResponseInvocationsWorkersObjectEventTypeRpc ObservabilitySharedQueryGetResponseInvocationsWorkersObjectEventType = "rpc"

const ObservabilitySharedQueryGetResponseInvocationsWorkersObjectEventTypeWebsocket ObservabilitySharedQueryGetResponseInvocationsWorkersObjectEventType = "websocket"

const ObservabilitySharedQueryGetResponseInvocationsWorkersObjectEventTypeWorkflow ObservabilitySharedQueryGetResponseInvocationsWorkersObjectEventType = "workflow"

const ObservabilitySharedQueryGetResponseInvocationsWorkersObjectEventTypeUnknown ObservabilitySharedQueryGetResponseInvocationsWorkersObjectEventType = "unknown"

RequestID string

ScriptName string

DurableObjectID stringOptional

Entrypoint stringOptional

Event map[string, unknown]Optional

ExecutionModel ObservabilitySharedQueryGetResponseInvocationsWorkersObjectExecutionModelOptional

One of the following:

const ObservabilitySharedQueryGetResponseInvocationsWorkersObjectExecutionModelDurableObject ObservabilitySharedQueryGetResponseInvocationsWorkersObjectExecutionModel = "durableObject"

const ObservabilitySharedQueryGetResponseInvocationsWorkersObjectExecutionModelStateless ObservabilitySharedQueryGetResponseInvocationsWorkersObjectExecutionModel = "stateless"

Outcome stringOptional

Preview ObservabilitySharedQueryGetResponseInvocationsWorkersObjectPreviewOptional

ID stringOptional

Name stringOptional

Slug stringOptional

ScriptVersion ObservabilitySharedQueryGetResponseInvocationsWorkersObjectScriptVersionOptional

ID stringOptional

Message stringOptional

Tag stringOptional

SpanID stringOptional

TraceID stringOptional

Truncated boolOptional

type ObservabilitySharedQueryGetResponseInvocationsWorkersObject struct{…}

CPUTimeMs float64

EventType ObservabilitySharedQueryGetResponseInvocationsWorkersObjectEventType

One of the following:

const ObservabilitySharedQueryGetResponseInvocationsWorkersObjectEventTypeFetch ObservabilitySharedQueryGetResponseInvocationsWorkersObjectEventType = "fetch"

const ObservabilitySharedQueryGetResponseInvocationsWorkersObjectEventTypeScheduled ObservabilitySharedQueryGetResponseInvocationsWorkersObjectEventType = "scheduled"

const ObservabilitySharedQueryGetResponseInvocationsWorkersObjectEventTypeAlarm ObservabilitySharedQueryGetResponseInvocationsWorkersObjectEventType = "alarm"

const ObservabilitySharedQueryGetResponseInvocationsWorkersObjectEventTypeCron ObservabilitySharedQueryGetResponseInvocationsWorkersObjectEventType = "cron"

const ObservabilitySharedQueryGetResponseInvocationsWorkersObjectEventTypeQueue ObservabilitySharedQueryGetResponseInvocationsWorkersObjectEventType = "queue"

const ObservabilitySharedQueryGetResponseInvocationsWorkersObjectEventTypeEmail ObservabilitySharedQueryGetResponseInvocationsWorkersObjectEventType = "email"

const ObservabilitySharedQueryGetResponseInvocationsWorkersObjectEventTypeTail ObservabilitySharedQueryGetResponseInvocationsWorkersObjectEventType = "tail"

const ObservabilitySharedQueryGetResponseInvocationsWorkersObjectEventTypeRpc ObservabilitySharedQueryGetResponseInvocationsWorkersObjectEventType = "rpc"

const ObservabilitySharedQueryGetResponseInvocationsWorkersObjectEventTypeWebsocket ObservabilitySharedQueryGetResponseInvocationsWorkersObjectEventType = "websocket"

const ObservabilitySharedQueryGetResponseInvocationsWorkersObjectEventTypeWorkflow ObservabilitySharedQueryGetResponseInvocationsWorkersObjectEventType = "workflow"

const ObservabilitySharedQueryGetResponseInvocationsWorkersObjectEventTypeUnknown ObservabilitySharedQueryGetResponseInvocationsWorkersObjectEventType = "unknown"

Outcome string

RequestID string

ScriptName string

WallTimeMs float64

DiagnosticsChannelEvents []ObservabilitySharedQueryGetResponseInvocationsWorkersObjectDiagnosticsChannelEventOptional

Channel string

Message string

Timestamp float64

DispatchNamespace stringOptional

DurableObjectID stringOptional

Entrypoint stringOptional

Event map[string, unknown]Optional

ExecutionModel ObservabilitySharedQueryGetResponseInvocationsWorkersObjectExecutionModelOptional

One of the following:

const ObservabilitySharedQueryGetResponseInvocationsWorkersObjectExecutionModelDurableObject ObservabilitySharedQueryGetResponseInvocationsWorkersObjectExecutionModel = "durableObject"

const ObservabilitySharedQueryGetResponseInvocationsWorkersObjectExecutionModelStateless ObservabilitySharedQueryGetResponseInvocationsWorkersObjectExecutionModel = "stateless"

Preview ObservabilitySharedQueryGetResponseInvocationsWorkersObjectPreviewOptional

ID stringOptional

Name stringOptional

Slug stringOptional

ScriptVersion ObservabilitySharedQueryGetResponseInvocationsWorkersObjectScriptVersionOptional

ID stringOptional

Message stringOptional

Tag stringOptional

SpanID stringOptional

TraceID stringOptional

Truncated boolOptional

Traces []ObservabilitySharedQueryGetResponseTraceOptional

Trace summaries matching the query. Present when the query view is ‘traces’. Each entry represents a distributed trace with its spans, duration, and services involved.

RootSpanName string

Name of the root span that initiated the trace.

RootTransactionName string

Logical transaction name for the root span.

Service []string

List of Worker services involved in the trace.

Spans float64

Total number of spans in the trace.

TraceDurationMs float64

Total duration of the trace in milliseconds.

TraceEndMs float64

Trace end time as a Unix epoch in milliseconds.

TraceID string

Unique identifier for the distributed trace.

TraceStartMs float64

Trace start time as a Unix epoch in milliseconds.

Errors []stringOptional

Error messages encountered during the trace, if any.

View a query that has been shared

Go

HTTP

TypeScript

Python

Go

Terraform

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"),
  )
  sharedQuery, err := client.Workers.Observability.SharedQueries.Get(
    context.TODO(),
    "id",
    workers.ObservabilitySharedQueryGetParams{
      AccountID: cloudflare.F("account_id"),
    },
  )
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", sharedQuery.Run)
}

200 example

{
  "errors": [
    {
      "message": "message"
    }
  ],
  "messages": [
    {
      "message": "Successful request"
    }
  ],
  "result": {
    "run": {
      "id": "id",
      "accountId": "accountId",
      "dry": true,
      "granularity": 0,
      "query": {
        "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": {
              "0": "s",
              "1": "t",
              "2": "r",
              "3": "i",
              "4": "n",
              "5": "g"
            },
            "isRegex": true,
            "matchCase": true
          },
          "orderBy": {
            "value": "value",
            "order": "asc"
          }
        },
        "updated": "updated",
        "updatedBy": "updatedBy"
      },
      "status": "STARTED",
      "timeframe": {
        "from": 0,
        "to": 0
      },
      "userId": "userId",
      "created": "created",
      "statistics": {
        "bytes_read": 0,
        "elapsed": 0,
        "rows_read": 0,
        "abr_level": 0
      },
      "updated": "updated"
    },
    "statistics": {
      "bytes_read": 0,
      "elapsed": 0,
      "rows_read": 0,
      "abr_level": 0
    },
    "agents": [
      {
        "agentClass": "agentClass",
        "eventTypeCounts": {
          "foo": 0
        },
        "firstEventMs": 0,
        "hasErrors": true,
        "lastEventMs": 0,
        "namespace": "namespace",
        "service": "service",
        "totalEvents": 0
      }
    ],
    "calculations": [
      {
        "aggregates": [
          {
            "count": 0,
            "interval": 0,
            "sampleInterval": 0,
            "value": 0,
            "groups": [
              {
                "key": "key",
                "value": "string"
              }
            ]
          }
        ],
        "calculation": "calculation",
        "series": [
          {
            "data": [
              {
                "count": 0,
                "interval": 0,
                "sampleInterval": 0,
                "value": 0,
                "firstSeen": "firstSeen",
                "groups": [
                  {
                    "key": "key",
                    "value": "string"
                  }
                ],
                "lastSeen": "lastSeen"
              }
            ],
            "time": "time"
          }
        ],
        "alias": "alias"
      }
    ],
    "compare": [
      {
        "aggregates": [
          {
            "count": 0,
            "interval": 0,
            "sampleInterval": 0,
            "value": 0,
            "groups": [
              {
                "key": "key",
                "value": "string"
              }
            ]
          }
        ],
        "calculation": "calculation",
        "series": [
          {
            "data": [
              {
                "count": 0,
                "interval": 0,
                "sampleInterval": 0,
                "value": 0,
                "firstSeen": "firstSeen",
                "groups": [
                  {
                    "key": "key",
                    "value": "string"
                  }
                ],
                "lastSeen": "lastSeen"
              }
            ],
            "time": "time"
          }
        ],
        "alias": "alias"
      }
    ],
    "events": {
      "count": 0,
      "events": [
        {
          "$metadata": {
            "id": "id",
            "account": "account",
            "cloudService": "cloudService",
            "coldStart": 1,
            "cost": 1,
            "duration": 1,
            "endTime": 0,
            "error": "error",
            "errorTemplate": "errorTemplate",
            "fingerprint": "fingerprint",
            "level": "level",
            "message": "message",
            "messageTemplate": "messageTemplate",
            "metricName": "metricName",
            "origin": "origin",
            "parentSpanId": "parentSpanId",
            "provider": "provider",
            "region": "region",
            "requestId": "requestId",
            "service": "service",
            "spanId": "spanId",
            "spanName": "spanName",
            "stackId": "stackId",
            "startTime": 0,
            "statusCode": 1,
            "traceDuration": 1,
            "traceId": "traceId",
            "transactionName": "transactionName",
            "trigger": "trigger",
            "type": "type",
            "url": "url"
          },
          "dataset": "dataset",
          "source": "string",
          "timestamp": 0,
          "$containers": {
            "foo": "bar"
          },
          "$workers": {
            "eventType": "fetch",
            "requestId": "requestId",
            "scriptName": "scriptName",
            "durableObjectId": "durableObjectId",
            "entrypoint": "entrypoint",
            "event": {
              "foo": "bar"
            },
            "executionModel": "durableObject",
            "outcome": "outcome",
            "preview": {
              "id": "id",
              "name": "name",
              "slug": "slug"
            },
            "scriptVersion": {
              "id": "id",
              "message": "message",
              "tag": "tag"
            },
            "spanId": "spanId",
            "traceId": "traceId",
            "truncated": true
          }
        }
      ],
      "fields": [
        {
          "key": "key",
          "type": "type"
        }
      ],
      "series": [
        {
          "data": [
            {
              "aggregates": {
                "_count": 1,
                "_interval": 1,
                "_firstSeen": "_firstSeen",
                "_lastSeen": "_lastSeen",
                "bin": {}
              },
              "count": 0,
              "interval": 0,
              "sampleInterval": 0,
              "errors": 0,
              "groups": {
                "foo": "string"
              }
            }
          ],
          "time": "time"
        }
      ]
    },
    "invocations": {
      "foo": [
        {
          "$metadata": {
            "id": "id",
            "account": "account",
            "cloudService": "cloudService",
            "coldStart": 1,
            "cost": 1,
            "duration": 1,
            "endTime": 0,
            "error": "error",
            "errorTemplate": "errorTemplate",
            "fingerprint": "fingerprint",
            "level": "level",
            "message": "message",
            "messageTemplate": "messageTemplate",
            "metricName": "metricName",
            "origin": "origin",
            "parentSpanId": "parentSpanId",
            "provider": "provider",
            "region": "region",
            "requestId": "requestId",
            "service": "service",
            "spanId": "spanId",
            "spanName": "spanName",
            "stackId": "stackId",
            "startTime": 0,
            "statusCode": 1,
            "traceDuration": 1,
            "traceId": "traceId",
            "transactionName": "transactionName",
            "trigger": "trigger",
            "type": "type",
            "url": "url"
          },
          "dataset": "dataset",
          "source": "string",
          "timestamp": 0,
          "$containers": {
            "foo": "bar"
          },
          "$workers": {
            "eventType": "fetch",
            "requestId": "requestId",
            "scriptName": "scriptName",
            "durableObjectId": "durableObjectId",
            "entrypoint": "entrypoint",
            "event": {
              "foo": "bar"
            },
            "executionModel": "durableObject",
            "outcome": "outcome",
            "preview": {
              "id": "id",
              "name": "name",
              "slug": "slug"
            },
            "scriptVersion": {
              "id": "id",
              "message": "message",
              "tag": "tag"
            },
            "spanId": "spanId",
            "traceId": "traceId",
            "truncated": true
          }
        }
      ]
    },
    "traces": [
      {
        "rootSpanName": "rootSpanName",
        "rootTransactionName": "rootTransactionName",
        "service": [
          "string"
        ],
        "spans": 0,
        "traceDurationMs": 0,
        "traceEndMs": 0,
        "traceId": "traceId",
        "traceStartMs": 0,
        "errors": [
          "string"
        ]
      }
    ]
  },
  "success": true
}

Returns Examples

200 example

{
  "errors": [
    {
      "message": "message"
    }
  ],
  "messages": [
    {
      "message": "Successful request"
    }
  ],
  "result": {
    "run": {
      "id": "id",
      "accountId": "accountId",
      "dry": true,
      "granularity": 0,
      "query": {
        "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": {
              "0": "s",
              "1": "t",
              "2": "r",
              "3": "i",
              "4": "n",
              "5": "g"
            },
            "isRegex": true,
            "matchCase": true
          },
          "orderBy": {
            "value": "value",
            "order": "asc"
          }
        },
        "updated": "updated",
        "updatedBy": "updatedBy"
      },
      "status": "STARTED",
      "timeframe": {
        "from": 0,
        "to": 0
      },
      "userId": "userId",
      "created": "created",
      "statistics": {
        "bytes_read": 0,
        "elapsed": 0,
        "rows_read": 0,
        "abr_level": 0
      },
      "updated": "updated"
    },
    "statistics": {
      "bytes_read": 0,
      "elapsed": 0,
      "rows_read": 0,
      "abr_level": 0
    },
    "agents": [
      {
        "agentClass": "agentClass",
        "eventTypeCounts": {
          "foo": 0
        },
        "firstEventMs": 0,
        "hasErrors": true,
        "lastEventMs": 0,
        "namespace": "namespace",
        "service": "service",
        "totalEvents": 0
      }
    ],
    "calculations": [
      {
        "aggregates": [
          {
            "count": 0,
            "interval": 0,
            "sampleInterval": 0,
            "value": 0,
            "groups": [
              {
                "key": "key",
                "value": "string"
              }
            ]
          }
        ],
        "calculation": "calculation",
        "series": [
          {
            "data": [
              {
                "count": 0,
                "interval": 0,
                "sampleInterval": 0,
                "value": 0,
                "firstSeen": "firstSeen",
                "groups": [
                  {
                    "key": "key",
                    "value": "string"
                  }
                ],
                "lastSeen": "lastSeen"
              }
            ],
            "time": "time"
          }
        ],
        "alias": "alias"
      }
    ],
    "compare": [
      {
        "aggregates": [
          {
            "count": 0,
            "interval": 0,
            "sampleInterval": 0,
            "value": 0,
            "groups": [
              {
                "key": "key",
                "value": "string"
              }
            ]
          }
        ],
        "calculation": "calculation",
        "series": [
          {
            "data": [
              {
                "count": 0,
                "interval": 0,
                "sampleInterval": 0,
                "value": 0,
                "firstSeen": "firstSeen",
                "groups": [
                  {
                    "key": "key",
                    "value": "string"
                  }
                ],
                "lastSeen": "lastSeen"
              }
            ],
            "time": "time"
          }
        ],
        "alias": "alias"
      }
    ],
    "events": {
      "count": 0,
      "events": [
        {
          "$metadata": {
            "id": "id",
            "account": "account",
            "cloudService": "cloudService",
            "coldStart": 1,
            "cost": 1,
            "duration": 1,
            "endTime": 0,
            "error": "error",
            "errorTemplate": "errorTemplate",
            "fingerprint": "fingerprint",
            "level": "level",
            "message": "message",
            "messageTemplate": "messageTemplate",
            "metricName": "metricName",
            "origin": "origin",
            "parentSpanId": "parentSpanId",
            "provider": "provider",
            "region": "region",
            "requestId": "requestId",
            "service": "service",
            "spanId": "spanId",
            "spanName": "spanName",
            "stackId": "stackId",
            "startTime": 0,
            "statusCode": 1,
            "traceDuration": 1,
            "traceId": "traceId",
            "transactionName": "transactionName",
            "trigger": "trigger",
            "type": "type",
            "url": "url"
          },
          "dataset": "dataset",
          "source": "string",
          "timestamp": 0,
          "$containers": {
            "foo": "bar"
          },
          "$workers": {
            "eventType": "fetch",
            "requestId": "requestId",
            "scriptName": "scriptName",
            "durableObjectId": "durableObjectId",
            "entrypoint": "entrypoint",
            "event": {
              "foo": "bar"
            },
            "executionModel": "durableObject",
            "outcome": "outcome",
            "preview": {
              "id": "id",
              "name": "name",
              "slug": "slug"
            },
            "scriptVersion": {
              "id": "id",
              "message": "message",
              "tag": "tag"
            },
            "spanId": "spanId",
            "traceId": "traceId",
            "truncated": true
          }
        }
      ],
      "fields": [
        {
          "key": "key",
          "type": "type"
        }
      ],
      "series": [
        {
          "data": [
            {
              "aggregates": {
                "_count": 1,
                "_interval": 1,
                "_firstSeen": "_firstSeen",
                "_lastSeen": "_lastSeen",
                "bin": {}
              },
              "count": 0,
              "interval": 0,
              "sampleInterval": 0,
              "errors": 0,
              "groups": {
                "foo": "string"
              }
            }
          ],
          "time": "time"
        }
      ]
    },
    "invocations": {
      "foo": [
        {
          "$metadata": {
            "id": "id",
            "account": "account",
            "cloudService": "cloudService",
            "coldStart": 1,
            "cost": 1,
            "duration": 1,
            "endTime": 0,
            "error": "error",
            "errorTemplate": "errorTemplate",
            "fingerprint": "fingerprint",
            "level": "level",
            "message": "message",
            "messageTemplate": "messageTemplate",
            "metricName": "metricName",
            "origin": "origin",
            "parentSpanId": "parentSpanId",
            "provider": "provider",
            "region": "region",
            "requestId": "requestId",
            "service": "service",
            "spanId": "spanId",
            "spanName": "spanName",
            "stackId": "stackId",
            "startTime": 0,
            "statusCode": 1,
            "traceDuration": 1,
            "traceId": "traceId",
            "transactionName": "transactionName",
            "trigger": "trigger",
            "type": "type",
            "url": "url"
          },
          "dataset": "dataset",
          "source": "string",
          "timestamp": 0,
          "$containers": {
            "foo": "bar"
          },
          "$workers": {
            "eventType": "fetch",
            "requestId": "requestId",
            "scriptName": "scriptName",
            "durableObjectId": "durableObjectId",
            "entrypoint": "entrypoint",
            "event": {
              "foo": "bar"
            },
            "executionModel": "durableObject",
            "outcome": "outcome",
            "preview": {
              "id": "id",
              "name": "name",
              "slug": "slug"
            },
            "scriptVersion": {
              "id": "id",
              "message": "message",
              "tag": "tag"
            },
            "spanId": "spanId",
            "traceId": "traceId",
            "truncated": true
          }
        }
      ]
    },
    "traces": [
      {
        "rootSpanName": "rootSpanName",
        "rootTransactionName": "rootTransactionName",
        "service": [
          "string"
        ],
        "spans": 0,
        "traceDurationMs": 0,
        "traceEndMs": 0,
        "traceId": "traceId",
        "traceStartMs": 0,
        "errors": [
          "string"
        ]
      }
    ]
  },
  "success": true
}