Manage Signal To Metrics

Test a signal-to-metrics config

Validates a signal-to-metrics definition and simulates its match filter against real signals in the selected dataset over a recent time window. Returns the number of matching signals on success. A 4xx error is returned when the definition fails validation or the request is otherwise invalid. Nothing is persisted.

post/api/signal-to-metrics/test

Request

  • Base URL: https://api.eu-west-1.aws.dash0.com
  • URL: https://api.eu-west-1.aws.dash0.com/api/signal-to-metrics/test
  • Auth: none declared

Query parameters

datasetstring

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

Request body

Example request

{
  "definition": {
    "spec": {
      "match": {
        "filters": [
          {
            "key": "service.name",
            "operator": "is",
            "value": "foo"
          }
        ]
      }
    }
  },
  "timeRange": {
    "from": "now-30m",
    "to": "now"
  }
}

Response

The test result.

executionTimestring date-time required

A fixed point in time represented as an RFC 3339 date-time string.

Format: YYYY-MM-DDTHH:MM:SSZ (UTC) or YYYY-MM-DDTHH:MM:SS±HH:MM (with timezone offset)

Examples:

  • 2024-01-15T14:30:00Z
  • 2024-01-15T14:30:00+08:00
matchedCountinteger required

Number of signals (spans or logs) matching spec.match.filters over the evaluated time window.

Changes

No recorded changes to this operation across all 1 revision of this API.