Manage Attribute Pattern Rules (Private BETA)

List Attribute Pattern Rules

get/api/attribute-pattern-rules

Returns Attribute Pattern Rules in the given dataset. Omitting serviceNamespace and serviceName returns every rule in the dataset across all services; supplying both scopes the response to that single service.

Parameters 9

datasetqueryrequired

The dataset to list Pattern Rules from.

References Dataset

Optional dataset to query across. Defaults to whatever is configured to be the default dataset for the organization.

stringpattern "^[a-zA-Z0-9_-]{3,26}$"

serviceNamespacequery

Filter to rules scoped to this OpenTelemetry service.namespace. Requires serviceName to also be set.

string

serviceNamequery

Filter to rules scoped to this OpenTelemetry service.name.

string

ownershipquery

Filter to rules with this ownership.

References AttributePatternRuleOwnership

user_defined: created, or promoted from auto_derived, by a human through this API.
auto_derived: inferred by the Operation Miner.

string

Allowed values"user_defined""auto_derived"

statusquery

Filter to rules with this status.

References AttributePatternRuleStatus

active: applied by the collector's Operation Processor.
inactive: stored but not applied.

string

Allowed values"active""inactive"

priorityquery

Filter to rules at any of these priorities, comma-separated. Priorities 1-5 are the user-facing priority levels; 0 matches auto-derived rows, which always carry the reserved priority 0 regardless of the ownership filter.

arrayminItems 1maxItems 6

Array items

integerminimum 0maximum 5

searchQueryquery

Optional search term to filter rules whose spec.details.canonicalOperation or stored canonical pattern contains it, case-insensitively. The canonical pattern anonymizes placeholders to <>, and spec.details.canonicalOperation renders them as :name rather than the <name> form shown in spec.pattern -- so a placeholder's bare name (e.g. orderId) matches via spec.details.canonicalOperation, but the bracketed form as displayed (<orderId>) matches neither field.

stringmaxLength 200

limitquery

Maximum number of rules to return.

integerdefault 50minimum 1maximum 200

offsetquery

Number of rules to skip.

integerdefault 0minimum 0

bash

Sample request12
curl --request GET 'https://api.eu-west-1.aws.dash0.com/api/attribute-pattern-rules?dataset=default' \
  --header "Authorization: Bearer ${DASH0_AUTH_TOKEN}"

Server

Responses

List of Attribute Pattern Rules

References AttributePatternRuleListResponse

object

AttributePatternRuleDefinition[]required

boolean

Whether there are more rules beyond the current page.

object

Rule counts per priority ("0" for auto-derived, "1"-"5" for the user-facing levels), matching the request's serviceNamespace/serviceName/ownership/status/searchQuery filters but ignoring the priority filter itself and pagination -- so a caller can show an accurate count for a collapsed/unselected priority category without fetching its rows. Present only when offset is 0 or omitted (computed once per fresh query, not on every page); absent rather than zero-filled when unavailable -- a consumer must not read a missing priorityCounts as "no rules".