Observability
ObservabilityTelemetry
List keys
Run a query
List values
Prepare live tail
Live tail heartbeat
ModelsExpand Collapse
class TelemetryQueryResponse: …Complete results of a query run. The populated fields depend on the requested view type (events, calculations, invocations, traces, or agents).
Complete results of a query run. The populated fields depend on the requested view type (events, calculations, invocations, traces, or agents).
run: RunRepresents a single execution of a query against Workers Observability data, including the query definition, execution status, and performance statistics.
Represents a single execution of a query against Workers Observability data, including the query definition, execution status, and performance statistics.
Number of time-series buckets used for the query. Higher values produce more detailed series data.
query: RunQueryA saved query definition with its parameters, metadata, and ownership information.
A saved query definition with its parameters, metadata, and ownership information.
parameters: RunQueryParameters
calculations: Optional[List[RunQueryParametersCalculation]]Create Calculations to compute as part of the query.
Create Calculations to compute as part of the query.
filter_combination: Optional[Literal["and", "or", "AND", "OR"]]Set a Flag to describe how to combine the filters on the query.
Set a Flag to describe how to combine the filters on the query.
filters: Optional[List[RunQueryParametersFilter]]Configure the Filters to apply to the query. Supports nested groups via kind: ‘group’.
Configure the Filters to apply to the query. Supports nested groups via kind: ‘group’.
class RunQueryParametersFilterWorkersObservabilityFilterLeaf: …A filter condition applied to query results. Use the keys and values endpoints to discover available fields and their values before constructing filters.
A filter condition applied to query results. Use the keys and values endpoints to discover available fields and their values before constructing filters.
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: Literal["includes", "not_includes", "starts_with", 27 more]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.
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.
type: Literal["string", "number", "boolean"]Data type of the filter field. Must match the actual type of the key being filtered.
Data type of the filter field. Must match the actual type of the key being filtered.
Discriminator for leaf filter nodes. Always ‘filter’ when present; may be omitted.
havings: Optional[List[RunQueryParametersHaving]]Configure the Having clauses that filter on calculations in the query result.
Configure the Having clauses that filter on calculations in the query result.
Set a limit on the number of results / records returned by the query
timeframe: RunTimeframeTime range for the query execution. ‘from’ must be earlier than ‘to’. No fractional milliseconds.
Time range for the query execution. ‘from’ must be earlier than ‘to’. No fractional milliseconds.
statistics: StatisticsQuery performance statistics from the database. Includes execution time, rows scanned, and bytes read. Does not include network latency.
Query performance statistics from the database. Includes execution time, rows scanned, and bytes read. Does not include network latency.
agents: Optional[List[Agent]]Agent run summaries. Present when the query view is ‘agents’. Each entry represents one trace containing at least one agent invocation.
Agent run summaries. Present when the query view is ‘agents’. Each entry represents one trace containing at least one agent invocation.
calculations: Optional[List[Calculation]]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.
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: List[CalculationAggregate]
Estimated number of matching events: the sum of the sample intervals of the stored events. It equals the number of stored events when sampleInterval is 1.
Deprecated alias of sampleInterval. Always has the same value; use sampleInterval instead.
Average sample interval of the matched events. Each stored event has a sample interval of 1 / (the sampling rate applied when it was ingested): the Worker’s head_sampling_rate multiplied by any platform sampling applied to the account or script. A value of 1 means none of the matched events were sampled. A value above 1 means count and value are estimated from sampled data, not exact. This is independent of statistics.abr_level.
series: List[CalculationSeries]
data: List[CalculationSeriesData]
Estimated number of matching events: the sum of the sample intervals of the stored events. It equals the number of stored events when sampleInterval is 1.
Deprecated alias of sampleInterval. Always has the same value; use sampleInterval instead.
Average sample interval of the matched events. Each stored event has a sample interval of 1 / (the sampling rate applied when it was ingested): the Worker’s head_sampling_rate multiplied by any platform sampling applied to the account or script. A value of 1 means none of the matched events were sampled. A value above 1 means count and value are estimated from sampled data, not exact. This is independent of statistics.abr_level.
Result of the calculation. count, sum, avg, median, and percentiles are weighted by each event’s sample interval
compare: Optional[List[Compare]]Comparison calculation results from the previous time period. Present when the compare option is enabled. Same structure as calculations.
Comparison calculation results from the previous time period. Present when the compare option is enabled. Same structure as calculations.
aggregates: List[CompareAggregate]
Estimated number of matching events: the sum of the sample intervals of the stored events. It equals the number of stored events when sampleInterval is 1.
Deprecated alias of sampleInterval. Always has the same value; use sampleInterval instead.
Average sample interval of the matched events. Each stored event has a sample interval of 1 / (the sampling rate applied when it was ingested): the Worker’s head_sampling_rate multiplied by any platform sampling applied to the account or script. A value of 1 means none of the matched events were sampled. A value above 1 means count and value are estimated from sampled data, not exact. This is independent of statistics.abr_level.
series: List[CompareSeries]
data: List[CompareSeriesData]
Estimated number of matching events: the sum of the sample intervals of the stored events. It equals the number of stored events when sampleInterval is 1.
Deprecated alias of sampleInterval. Always has the same value; use sampleInterval instead.
Average sample interval of the matched events. Each stored event has a sample interval of 1 / (the sampling rate applied when it was ingested): the Worker’s head_sampling_rate multiplied by any platform sampling applied to the account or script. A value of 1 means none of the matched events were sampled. A value above 1 means count and value are estimated from sampled data, not exact. This is independent of statistics.abr_level.
Result of the calculation. count, sum, avg, median, and percentiles are weighted by each event’s sample interval
distribution: Optional[Distribution]Bucketed 2D histogram of a numeric field over time. Present when chartType is ‘distribution’.
Bucketed 2D histogram of a numeric field over time. Present when chartType is ‘distribution’.
Raw bucket edges in the value’s native unit, length buckets.length + 1. Used for the colour scale and percentile mapping.
events: Optional[Events]Individual event results. Present when the query view is ‘events’. Contains the matching log lines and their metadata.
Individual event results. Present when the query view is ‘events’. Contains the matching log lines and their metadata.
Total number of events matching the query (may exceed the number returned due to limits).
events: Optional[List[EventsEvent]]List of individual telemetry events matching the query.
List of individual telemetry events matching the query.
metadata: EventsEventMetadataStructured metadata extracted from the event. These fields are indexed and available for filtering and aggregation.
Structured metadata extracted from the event. These fields are indexed and available for filtering and aggregation.
Templatized version of the error message used for grouping similar errors.
Templatized version of the log message used for grouping similar messages.
Cloudflare Ray ID from the cf-ray header of the request that triggered the invocation.
Cloudflare request ID that ties all logs from a single invocation together.
source: Union[str, Dict[str, object]]Raw log payload. May be a string or a structured object depending on how the log was emitted.
Raw log payload. May be a string or a structured object depending on how the log was emitted.
Cloudflare Containers event information that enriches your logs for identifying and debugging issues.
workers: Optional[EventsEventWorkers]Cloudflare Workers event information that enriches your logs for identifying and debugging issues.
Cloudflare Workers event information that enriches your logs for identifying and debugging issues.
class EventsEventWorkersUnionMember0: …
class EventsEventWorkersUnionMember1: …
fields: Optional[List[EventsField]]List of fields discovered in the matched events. Useful for building dynamic UIs.
List of fields discovered in the matched events. Useful for building dynamic UIs.
series: Optional[List[EventsSeries]]Time-series data for the matched events, bucketed by the query granularity.
Time-series data for the matched events, bucketed by the query granularity.
data: List[EventsSeriesData]
Estimated number of matching events: the sum of the sample intervals of the stored events. It equals the number of stored events when sampleInterval is 1.
Deprecated alias of sampleInterval. Always has the same value; use sampleInterval instead.
Average sample interval of the matched events. Each stored event has a sample interval of 1 / (the sampling rate applied when it was ingested): the Worker’s head_sampling_rate multiplied by any platform sampling applied to the account or script. A value of 1 means none of the matched events were sampled. A value above 1 means count and value are estimated from sampled data, not exact. This is independent of statistics.abr_level.
invocations: Optional[Dict[str, List[Invocation]]]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.
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: InvocationMetadataStructured metadata extracted from the event. These fields are indexed and available for filtering and aggregation.
Structured metadata extracted from the event. These fields are indexed and available for filtering and aggregation.
Templatized version of the error message used for grouping similar errors.
Templatized version of the log message used for grouping similar messages.
Cloudflare Ray ID from the cf-ray header of the request that triggered the invocation.
Cloudflare request ID that ties all logs from a single invocation together.
source: Union[str, Dict[str, object]]Raw log payload. May be a string or a structured object depending on how the log was emitted.
Raw log payload. May be a string or a structured object depending on how the log was emitted.
Cloudflare Containers event information that enriches your logs for identifying and debugging issues.
workers: Optional[InvocationWorkers]Cloudflare Workers event information that enriches your logs for identifying and debugging issues.
Cloudflare Workers event information that enriches your logs for identifying and debugging issues.
class InvocationWorkersUnionMember0: …
class InvocationWorkersUnionMember1: …
ObservabilityDestinations
Get Destinations
Create Destination
Update Destination
Delete Destination
ModelsExpand Collapse
ObservabilityQueries
Save query
List queries
ModelsExpand Collapse
class QueryCreateResponse: …
parameters: Parameters
calculations: Optional[List[ParametersCalculation]]Create Calculations to compute as part of the query.
Create Calculations to compute as part of the query.
filter_combination: Optional[Literal["and", "or", "AND", "OR"]]Set a Flag to describe how to combine the filters on the query.
Set a Flag to describe how to combine the filters on the query.
filters: Optional[List[ParametersFilter]]Configure the Filters to apply to the query. Supports nested groups via kind: ‘group’.
Configure the Filters to apply to the query. Supports nested groups via kind: ‘group’.
class ParametersFilterWorkersObservabilityFilterLeaf: …A filter condition applied to query results. Use the keys and values endpoints to discover available fields and their values before constructing filters.
A filter condition applied to query results. Use the keys and values endpoints to discover available fields and their values before constructing filters.
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: Literal["includes", "not_includes", "starts_with", 27 more]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.
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.
type: Literal["string", "number", "boolean"]Data type of the filter field. Must match the actual type of the key being filtered.
Data type of the filter field. Must match the actual type of the key being filtered.
Discriminator for leaf filter nodes. Always ‘filter’ when present; may be omitted.
havings: Optional[List[ParametersHaving]]Configure the Having clauses that filter on calculations in the query result.
Configure the Having clauses that filter on calculations in the query result.
Set a limit on the number of results / records returned by the query
class QueryListResponse: …
parameters: Parameters
calculations: Optional[List[ParametersCalculation]]Create Calculations to compute as part of the query.
Create Calculations to compute as part of the query.
filter_combination: Optional[Literal["and", "or", "AND", "OR"]]Set a Flag to describe how to combine the filters on the query.
Set a Flag to describe how to combine the filters on the query.
filters: Optional[List[ParametersFilter]]Configure the Filters to apply to the query. Supports nested groups via kind: ‘group’.
Configure the Filters to apply to the query. Supports nested groups via kind: ‘group’.
class ParametersFilterWorkersObservabilityFilterLeaf: …A filter condition applied to query results. Use the keys and values endpoints to discover available fields and their values before constructing filters.
A filter condition applied to query results. Use the keys and values endpoints to discover available fields and their values before constructing filters.
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: Literal["includes", "not_includes", "starts_with", 27 more]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.
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.
type: Literal["string", "number", "boolean"]Data type of the filter field. Must match the actual type of the key being filtered.
Data type of the filter field. Must match the actual type of the key being filtered.
Discriminator for leaf filter nodes. Always ‘filter’ when present; may be omitted.
havings: Optional[List[ParametersHaving]]Configure the Having clauses that filter on calculations in the query result.
Configure the Having clauses that filter on calculations in the query result.
Set a limit on the number of results / records returned by the query
ObservabilityShared Queries
Create a sharable link to a query result
View a query that has been shared
ModelsExpand Collapse
class SharedQueryGetResponse: …Complete results of a query run. The populated fields depend on the requested view type (events, calculations, invocations, traces, or agents).
Complete results of a query run. The populated fields depend on the requested view type (events, calculations, invocations, traces, or agents).
run: RunRepresents a single execution of a query against Workers Observability data, including the query definition, execution status, and performance statistics.
Represents a single execution of a query against Workers Observability data, including the query definition, execution status, and performance statistics.
Number of time-series buckets used for the query. Higher values produce more detailed series data.
query: RunQueryA saved query definition with its parameters, metadata, and ownership information.
A saved query definition with its parameters, metadata, and ownership information.
parameters: RunQueryParameters
calculations: Optional[List[RunQueryParametersCalculation]]Create Calculations to compute as part of the query.
Create Calculations to compute as part of the query.
filter_combination: Optional[Literal["and", "or", "AND", "OR"]]Set a Flag to describe how to combine the filters on the query.
Set a Flag to describe how to combine the filters on the query.
filters: Optional[List[RunQueryParametersFilter]]Configure the Filters to apply to the query. Supports nested groups via kind: ‘group’.
Configure the Filters to apply to the query. Supports nested groups via kind: ‘group’.
class RunQueryParametersFilterWorkersObservabilityFilterLeaf: …A filter condition applied to query results. Use the keys and values endpoints to discover available fields and their values before constructing filters.
A filter condition applied to query results. Use the keys and values endpoints to discover available fields and their values before constructing filters.
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: Literal["includes", "not_includes", "starts_with", 27 more]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.
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.
type: Literal["string", "number", "boolean"]Data type of the filter field. Must match the actual type of the key being filtered.
Data type of the filter field. Must match the actual type of the key being filtered.
Discriminator for leaf filter nodes. Always ‘filter’ when present; may be omitted.
havings: Optional[List[RunQueryParametersHaving]]Configure the Having clauses that filter on calculations in the query result.
Configure the Having clauses that filter on calculations in the query result.
Set a limit on the number of results / records returned by the query
timeframe: RunTimeframeTime range for the query execution. ‘from’ must be earlier than ‘to’. No fractional milliseconds.
Time range for the query execution. ‘from’ must be earlier than ‘to’. No fractional milliseconds.
statistics: StatisticsQuery performance statistics from the database. Includes execution time, rows scanned, and bytes read. Does not include network latency.
Query performance statistics from the database. Includes execution time, rows scanned, and bytes read. Does not include network latency.
agents: Optional[List[Agent]]Agent run summaries. Present when the query view is ‘agents’. Each entry represents one trace containing at least one agent invocation.
Agent run summaries. Present when the query view is ‘agents’. Each entry represents one trace containing at least one agent invocation.
calculations: Optional[List[Calculation]]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.
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: List[CalculationAggregate]
Estimated number of matching events: the sum of the sample intervals of the stored events. It equals the number of stored events when sampleInterval is 1.
Deprecated alias of sampleInterval. Always has the same value; use sampleInterval instead.
Average sample interval of the matched events. Each stored event has a sample interval of 1 / (the sampling rate applied when it was ingested): the Worker’s head_sampling_rate multiplied by any platform sampling applied to the account or script. A value of 1 means none of the matched events were sampled. A value above 1 means count and value are estimated from sampled data, not exact. This is independent of statistics.abr_level.
series: List[CalculationSeries]
data: List[CalculationSeriesData]
Estimated number of matching events: the sum of the sample intervals of the stored events. It equals the number of stored events when sampleInterval is 1.
Deprecated alias of sampleInterval. Always has the same value; use sampleInterval instead.
Average sample interval of the matched events. Each stored event has a sample interval of 1 / (the sampling rate applied when it was ingested): the Worker’s head_sampling_rate multiplied by any platform sampling applied to the account or script. A value of 1 means none of the matched events were sampled. A value above 1 means count and value are estimated from sampled data, not exact. This is independent of statistics.abr_level.
Result of the calculation. count, sum, avg, median, and percentiles are weighted by each event’s sample interval
compare: Optional[List[Compare]]Comparison calculation results from the previous time period. Present when the compare option is enabled. Same structure as calculations.
Comparison calculation results from the previous time period. Present when the compare option is enabled. Same structure as calculations.
aggregates: List[CompareAggregate]
Estimated number of matching events: the sum of the sample intervals of the stored events. It equals the number of stored events when sampleInterval is 1.
Deprecated alias of sampleInterval. Always has the same value; use sampleInterval instead.
Average sample interval of the matched events. Each stored event has a sample interval of 1 / (the sampling rate applied when it was ingested): the Worker’s head_sampling_rate multiplied by any platform sampling applied to the account or script. A value of 1 means none of the matched events were sampled. A value above 1 means count and value are estimated from sampled data, not exact. This is independent of statistics.abr_level.
series: List[CompareSeries]
data: List[CompareSeriesData]
Estimated number of matching events: the sum of the sample intervals of the stored events. It equals the number of stored events when sampleInterval is 1.
Deprecated alias of sampleInterval. Always has the same value; use sampleInterval instead.
Average sample interval of the matched events. Each stored event has a sample interval of 1 / (the sampling rate applied when it was ingested): the Worker’s head_sampling_rate multiplied by any platform sampling applied to the account or script. A value of 1 means none of the matched events were sampled. A value above 1 means count and value are estimated from sampled data, not exact. This is independent of statistics.abr_level.
Result of the calculation. count, sum, avg, median, and percentiles are weighted by each event’s sample interval
distribution: Optional[Distribution]Bucketed 2D histogram of a numeric field over time. Present when chartType is ‘distribution’.
Bucketed 2D histogram of a numeric field over time. Present when chartType is ‘distribution’.
Raw bucket edges in the value’s native unit, length buckets.length + 1. Used for the colour scale and percentile mapping.
events: Optional[Events]Individual event results. Present when the query view is ‘events’. Contains the matching log lines and their metadata.
Individual event results. Present when the query view is ‘events’. Contains the matching log lines and their metadata.
Total number of events matching the query (may exceed the number returned due to limits).
events: Optional[List[EventsEvent]]List of individual telemetry events matching the query.
List of individual telemetry events matching the query.
metadata: EventsEventMetadataStructured metadata extracted from the event. These fields are indexed and available for filtering and aggregation.
Structured metadata extracted from the event. These fields are indexed and available for filtering and aggregation.
Templatized version of the error message used for grouping similar errors.
Templatized version of the log message used for grouping similar messages.
Cloudflare Ray ID from the cf-ray header of the request that triggered the invocation.
Cloudflare request ID that ties all logs from a single invocation together.
source: Union[str, Dict[str, object]]Raw log payload. May be a string or a structured object depending on how the log was emitted.
Raw log payload. May be a string or a structured object depending on how the log was emitted.
Cloudflare Containers event information that enriches your logs for identifying and debugging issues.
workers: Optional[EventsEventWorkers]Cloudflare Workers event information that enriches your logs for identifying and debugging issues.
Cloudflare Workers event information that enriches your logs for identifying and debugging issues.
class EventsEventWorkersUnionMember0: …
class EventsEventWorkersUnionMember1: …
fields: Optional[List[EventsField]]List of fields discovered in the matched events. Useful for building dynamic UIs.
List of fields discovered in the matched events. Useful for building dynamic UIs.
series: Optional[List[EventsSeries]]Time-series data for the matched events, bucketed by the query granularity.
Time-series data for the matched events, bucketed by the query granularity.
data: List[EventsSeriesData]
Estimated number of matching events: the sum of the sample intervals of the stored events. It equals the number of stored events when sampleInterval is 1.
Deprecated alias of sampleInterval. Always has the same value; use sampleInterval instead.
Average sample interval of the matched events. Each stored event has a sample interval of 1 / (the sampling rate applied when it was ingested): the Worker’s head_sampling_rate multiplied by any platform sampling applied to the account or script. A value of 1 means none of the matched events were sampled. A value above 1 means count and value are estimated from sampled data, not exact. This is independent of statistics.abr_level.
invocations: Optional[Dict[str, List[Invocation]]]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.
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: InvocationMetadataStructured metadata extracted from the event. These fields are indexed and available for filtering and aggregation.
Structured metadata extracted from the event. These fields are indexed and available for filtering and aggregation.
Templatized version of the error message used for grouping similar errors.
Templatized version of the log message used for grouping similar messages.
Cloudflare Ray ID from the cf-ray header of the request that triggered the invocation.
Cloudflare request ID that ties all logs from a single invocation together.
source: Union[str, Dict[str, object]]Raw log payload. May be a string or a structured object depending on how the log was emitted.
Raw log payload. May be a string or a structured object depending on how the log was emitted.
Cloudflare Containers event information that enriches your logs for identifying and debugging issues.
workers: Optional[InvocationWorkers]Cloudflare Workers event information that enriches your logs for identifying and debugging issues.
Cloudflare Workers event information that enriches your logs for identifying and debugging issues.