Synthetic Monitoring Template Variables

Overview

Template variables allow you to insert dynamic values from your test results and configuration into Synthetic Monitoring notification messages. Access these variables using the synthetics.attributes prefix. For example:

Test failed at step {{synthetics.failed_step.name}} with error: {{synthetics.failed_step.failure.message}}.

Common variable shortcuts

{{synthetics.failed_step.name}}
The name of the failing step (for example, Test div #title content).
{{synthetics.failed_step.failure.message}}
The error message (for example, Element's content should match the given regex).
{{synthetics.failed_step.url}}
The URL of the failed step (for example, https://www.datadoghq.com/blog/).
{{synthetics.attributes.result.response.statusCode}}
The HTTP status code (for example, 403).
{{synthetics.result.step_count}}
Number of steps (for example, 4).
{{synthetics.result.duration}}
Duration of the test run (in milliseconds) (for example, 9096).
{{tags.env}}
The environment tag value (for example, prod).

Note: Not all variables are available for every test type. You may need to test different outputs to verify the data returned.

Result attributes

    .test
    Info about the test
    .test.id
    Public ID (for example, abc-def-ghi)
    .test.type
    Test type (for example, api)
    .test.subType
    Subtype for API tests (for example, http)
    .location.id
    Location ID (for example, aws:eu-central-1)
    .location.privateLocation
    true for Private Locations

    Applies to browser and mobile tests.

    .device.id
    Device identifier
    .device.name
    Human-readable device name
    .device.type
    Device type classification
    .device.resolution.width, .device.resolution.height
    Screen resolution dimensions
    .device.browser.type
    Browser type (browser tests only)
    .device.platform.name, .device.platform.version
    Platform information (mobile tests only)

    Example values:

    {
  "device": {
    "id": "chrome.laptop_large",
    "name": "Laptop Large",
    "type": "laptop",
    "resolution": {"width": 1440, "height": 1100},
    "browser": {"type": "Chrome"},
    "platform": {"name": "Android", "version": "14"}
  }
}
    .result.id
    Unique result ID
    .result.status
    Test execution status
    .result.duration
    Test duration in milliseconds
    .result.testStartedAt, .result.testFinishedAt, .result.testTriggeredAt
    Epoch timestamps in milliseconds
    .result.failure.message
    Description of failure
    .result.failure.code
    Error code

    Example values:

    {
  "result": {
    "id": "3015485096247415772",
    "status": "failed",
    "duration": 9096,
    "testStartedAt": 1743760758904,
    "testFinishedAt": 1743760772025,
    "testTriggeredAt": 1743760758593,
    "failure": {
      "message": "Error: Element's content should match the given regex",
      "code": "ASSERTION_FAILURE"
    }
  }
}

    Variables

      These are local variables configured for API tests or defined outside individual steps in step-based tests. This also includes variables created by JavaScript code execution.

      Located at {{synthetics.attributes.result.variables.config}}:

      .name
      Variable name
      .type
      Variable type
      .secure
      Whether the variable value is obfuscated
      .value
      Variable value (non-obfuscated only)

      Examples:

      {
  "name": "RANDOM_NUMBER",
  "type": "text",
  "secure": false,
  "value": "133245995"
}

      These are extracted variables whose value updates a global variable value.

      Available only for successful test results and recovery notifications.

      Located at result.variables.extracted:

      .id
      Global variable ID
      .name
      Variable name
      .secure
      Whether the variable value is obfuscated
      .val
      Variable value (note: uses .val, not .value)

      Examples:

      {
  "id": "ec734823-536e-4aba-8b5f-55733189d936",
  "name": "EXTRACTED_NUMBER",
  "secure": false,
  "val": "250661"
}

      For tests with steps, step data is contained in .steps.

      .extractedValue.name
      Variable name
      .extractedValue.secure
      Whether the variable value is obfuscated
      .extractedValue.value
      Variable value (if step was successful)

      Examples:

      {
  "extractedValue": {
    "name": "EXTRACTED_COUNT",
    "secure": false,
    "value": "12"
  }
}

      Variables extracted by steps

      Similar to standard API tests, the variables are listed in the variables.extracted property, but inside steps themselves. These values are available as long as the step is successful.

        For multistep/browser/mobile tests:

        .steps.allowFailure
        Whether the step is allowed to fail without failing the entire test
        .steps.duration
        Step execution duration in milliseconds
        .steps.failure
        Failure information object containing .code and .message
        .steps.id
        Unique step identifier
        .steps.isCritical
        Whether the step is critical to the test
        .steps.status
        Step execution status
        .steps.type
        Type of step being executed

        Subtest information:

        .steps.subTest.id
        Subtest identifier
        .steps.subStep.parentStep.id
        Parent step identifier
        .steps.subStep.parentTest.id
        Parent test identifier
        .steps.subStep.level
        Nesting level (1 for subtests, 2 for subtests of subtests)

        Examples:

        {
  "steps": [
    {
      "allowFailure": false,
      "duration": 10955,
      "failure": {
        "code": "ASSERTION_FAILURE",
        "message": "Element's content should not equal given value."
      },
      "id": "g8e-q4a-fix",
      "isCritical": true,
      "status": "failed",
      "type": "assertElementContent",
      "subTest": {
        "id": "m2i-fcy-eva"
      },
      "subStep": {
        "parentStep": {"id": "ikj-juk-z2u"},
        "parentTest": {"id": "th5-wic-5mj"},
        "level": 1
      }
    }
  ]
}

        General:

        .startUrl
        URL from test configuration

        Steps:

        .apiTest.request
        API test request configuration (only for “Run API Test” steps where type is runApiTest)
        .apiTest.result
        API test result data (similar to attributes.result for API tests)
        .assertionResult.expected
        Expected value for assertions
        .assertionResults.checkType
        Type of assertion check
        .assertionResults.actual
        Actual value found during assertion
        .browserErrors
        List of browser errors encountered
        .timings.firstByte
        Time to first byte
        .timings.tcp
        TCP connection timing
        .description
        Step description

        Examples:

        {
  "startUrl": "https://datadoghq.com",
  "apiTest": {
    "request": {
      "subType": "http",
      "method": "GET",
      "url": "https://datadoghq.com"
    },
    "result": {
      "statusCode": 200
    }
  },
  "assertionResults": {
    "expected": "100",
    "checkType": "equals",
    "actual": "200"
  },
  "timings": {
    "firstByte": 7.1,
    "tcp": 5.2
  }
}

        Examples for .browserErrors:

        {
    "name": "Console error",
    "description": "Failed to load resource: the server responded with a status of 403 ()",
    "type": "js"
},
{
    "name": "[GET] 403 - https://accounts.google.com/v3/signin/identifier?dsh=S688774280%3A1687962864348747&conti",
    "description": "https://accounts.google.com/v3/signin/identifier?dsh=S688774280%3A1687962864348747&continue=https%3A%2F%2Fwww.youtube.com%2Fsignin%3Faction_handle_signin%3Dtrue%26app%3Ddesktop%26hl%3Den%26next%3D%252Fsignin_passive%26feature%3Dpassive&hl=en&ifkv=AeDOFXjMKzxp0wt-b9IzWKz6RS9Kk-VmW5z_fzLP_cjbSWd4hWeP5g53fvdrhX6b2cDVQrNtJ5B7vA&passive=true&service=youtube&uilel=3&flowName=GlifWebSignIn&flowEntry=ServiceLogin\n<html lang=en><meta charset=utf-8><meta name=viewport content=\"initial-scale=1, minimum-sca",
    "type": "network",
    "status": 403
},
{
    "method": "POST",
    "name": "https://8b61d74c.datadoghq.com/api/v2/rum?batch_time=1752830394872&dd-request-id=8c0e7b8c-3d52-4b96-",
    "description": "Request was pending when step timed out: POST - https://8b61d74c.datadoghq.com/api/v2/rum?batch_time=1752830394872&dd-request-id=8c0e7b8c-3d52-4b96-b1a0-627e7070b863&dd-evp-origin=browser&dd-evp-origin-version=5.27.0&dd-api-key=pub0b466265cd4de08394d4e1979fb79787&ddtags=sdk_version%3A5.27.0%2Capi%3Abeacon%2Cenv%3Alive%2Cservice%3Acorp%2Cversion%3Ae0fdd625&ddsource=browser",
    "type": "network",
    "url": {
        "protocol": "https:",
        "search": "?batch_time=1752830394872&dd-request-id=8c0e7b8c-3d52-4b96-b1a0-627e7070b863&dd-evp-origin=browser&dd-evp-origin-version=5.27.0&dd-api-key=pub0b466265cd4de08394d4e1979fb79787&ddtags=sdk_version%3A5.27.0%2Capi%3Abeacon%2Cenv%3Alive%2Cservice%3Acorp%2Cversion%3Ae0fdd625&ddsource=browser",
        "domain": "datadoghq.com",
        "origin": "https://8b61d74c.datadoghq.com",
        "full": "https://8b61d74c.datadoghq.com/api/v2/rum?batch_time=1752830394872&dd-request-id=8c0e7b8c-3d52-4b96-b1a0-627e7070b863&dd-evp-origin=browser&dd-evp-origin-version=5.27.0&dd-api-key=pub0b466265cd4de08394d4e1979fb79787&ddtags=sdk_version%3A5.27.0%2Capi%3Abeacon%2Cenv%3Alive%2Cservice%3Acorp%2Cversion%3Ae0fdd625&ddsource=browser",
      "pathname": "/api/v2/rum"
    }
},
        .application.versionId
        Mobile application version identifier
        .apiTest
        API test data (for API test steps within mobile tests)
        .description
        Step description

        Examples:

        {
  "application": {
    "versionId": "4408df2e-9b7a-4665-9510-b9041b2ae1e8"
  },
  "description": "Tap on Button Sign In"
}

        Multistep:

        .name
        Step name
        .type
        Step type

        Note: Follow regular API fields per subType

        Non-Multistep:

        .assertions.actual
        Actual value from assertion
        .assertions.expected
        Expected value for assertion
        .assertions.operator
        Assertion operator
        .assertions.type
        Assertion type
        .dnsResolution.resolvedIp
        Resolved IP address
        .dnsResolution.server
        DNS server used
        .timings.dns
        DNS resolution time
        .timings.tcp
        TCP connection time
        .request.url
        Request URL
        .request.host
        Request host
        .response.body
        Response body content
        .response.statusCode
        HTTP status code
        .response.headers
        Response headers
        .response.httpVersion
        HTTP version
        .response.redirects
        Redirect information

        Examples:

        {
  "name": "Check API endpoint",
  "type": "http",
  "assertions": {
    "actual": 1.5145,
    "expected": 1000,
    "operator": "moreThan",
    "type": "latency"
  },
  "dnsResolution": {
    "resolvedIp": "18.245.199.78",
    "server": "8.8.4.4"
  },
  "timings": { //Dependent on the sub-type
    "tcp": 6.9,
      "download": 33.5,
      "total": 75,
      "dns": 7.5,
      "firstByte": 17.2,
      "ssl": 9.9
    },
  },
  "request": {
    "url": "https://www.datadogh.com",
    "host": "datadoghq.com",
    "method": "GET"
  },
  "response": {
    "body": "Example Page Content", // Raw text (even if it's JSON, its contents can't be accessed individually), and it's truncated if too big (only the start is available)
    "statusCode": 200,
    "headers": { // Object/dictionary of headers, the key is the header name and the value its value
      "content-type": "text/html; charset=utf-8",
      "content-length": "250661"
    },
    "httpVersion": "1.1",
    "redirects": [ // List of redirect items
      {
        "location": "https://datadoghq.com",
        "statusCode": 302
      }
    ]
  }
        .timings.open
        Time to open connection (in milliseconds)
        .timings.receive
        Time to receive response
        .handshake.request
        Handshake request data
        .handshake.response
        Handshake response data
        .request.message
        WebSocket request message
        .response.message
        WebSocket response message
        .close.reason
        Connection close reason
        .close.statusCode
        Connection close status code

        Examples:

        {
  "timings": {
    "tcp": 96,
    "receive": 97,
    "download": 0,
    "total": 201.9,
    "dns": 7.7,
    "firstByte": 0,
    "ssl": 1,
    "open": 0.2
  },
  "handshake": {
    "response": {
      "statusCode": 101
    }
  },
  "request": {
    "message": "Ping"
  },
  "response": {
    "message": "Pong"
  },
  "close": {
    "reason": "message_received",
    "statusCode": 1000
  }
}
        .callType
        Call type (unary or healthcheck)
        .timings.rpc
        RPC call timing
        .response.healthcheck.status
        Health check status
        .request.message
        gRPC request message
        .response.message
        gRPC response message

        Examples:

        {
  "callType": "healthcheck",
  "timings": {
    "total": 55.3,
    "rpc": 9.2,
    "dns": 46.1
  },
  "response": {
    "healthcheck": {
      "status": 1
    }
  },
  "request": {
    "message": "Ping"
  },
  "response": {
    "message": "Pong" // Responses can be truncated if too big (only the start is available)
  }
}
        .request.message
        UDP request message
        .response.message
        UDP response message
        .timings.message
        Message timing

        Examples:

        {
  "timings": {
    "total": 135.3,
    "dns": 14.4,
    "message": 120.9
  },
  "request": {
    "message": "Ping"
  },
  "response": {
    "message": "Pong"
  }
}
        .connectionOutcome
        Connection result
        .netpath.routers.ip
        Router IP addresses
        .traceroute.latency.min
        Minimum latency
        .traceroute.latency.max
        Maximum latency
        .traceroute.latency.avg
        Average latency
        .traceroute.latency.stddev
        Standard deviation
        .traceroute.latency.values
        Latency values array

        Examples:

        [
      {
        "packetLossPercentage": 1,
        "packetsReceived": 0,
        "packetsSent": 2,
        "routers": [
          {
            "ip": "???"
          }
        ]
      },
      {
        "packetLossPercentage": 0,
        "packetsReceived": 2,
        "latency": {
          "avg": 0.2375,
          "min": 0.189,
          "max": 0.286,
          "values": [
            0.189,
            0.286
          ],
          "stddev": 0.04849999999999999
        },
        "packetsSent": 2,
        "routers": [
          {
            "ip": "10.241.134.75"
          }
        ]
      }
]
        .traceroute
        Same structure as TCP traceroute
        .request.host
        Target host
        .ping
        Ping results
        .latency.min, .latency.max, .latency.avg, .latency.stddev, .latency.values
        Latency measurements (same as TCP)

        Examples:

        {
  "ping": {
    "packetLossPercentage": 0,
    "packetsReceived": 4,
    "latency": {
      "avg": 1.47375,
      "min": 1.442,
      "max": 1.516,
      "values": [
        1.467,
        1.442,
        1.47,
        1.516
      ],
      "stddev": 0.02670557057993708
    },
    "resolvedIp": "18.245.199.70",
    "packetsSent": 4,
    "packetSize": 56
  }
}
        .cert
        SSL certificate information
        .cipher
        Cipher suite used
        .issuer
        Certificate issuer
        .subject
        Certificate subject
        .valid.from
        Certificate valid from date
        .valid.to
        Certificate valid to date
        .ocsp
        OCSP (Online Certificate Status Protocol) information
        .timings.handshake
        SSL handshake timing

        Examples:

              "cipher": TLS_AES_128_GCM_SHA256,
      "issuer": {
        "C": "US",
        "CN": "DigiCert Global G2 TLS RSA SHA256 2020 CA1",
        "O": "DigiCert Inc"
      },

        {
  "issuer": {
    "C": "US",
    "CN": "DigiCert Global G2 TLS RSA SHA256 2020 CA1",
    "O": "DigiCert Inc"
  },
  "valid.from": 1751414400000, //milliseconds
  "valid.to": 1783036799000 //milliseconds
}
        .response.records.type
        DNS record type
        .response.records.values
        DNS record values

        Examples:

        {
  "dns": {
    "response": {
      "records": {
        "type": "A",
        "values": ["192.0.2.1", "192.0.2.2"]
      }
    }
  }
}

        Step Summary:

        • .result.steps.<step_id>
          • .id, .status, .type, .duration, .description, .failure.message, .code, .url

        The step summary contains the same data as described in steps, but you can access it in several ways:

        By step index (0-based):

        • .steps.0 - first step
        • .steps.1 - second step
        • .steps.-1 - last step
        • .steps.-2 - step before last

        By step name:

        • .steps[Click button]

        By step id:

        • .steps.abc-def-ghi

        Then you access the data as usual, for example:

        • .steps.-1.status
        • .steps[Click button].status
        • .steps.abc-def-ghi.status

        Summary Data:

        • .count.steps.{total,completed}, .count.errors, .count.hops (for example, 4)

        Service Tag: If service tag is set:

        • {{service.name}}
        • {{service.team}}
        • {{service.docs}}, {{service.links}}

        Examples:

        {
  "service.name": "API Server",
  "service.team": "Backend team",
  "service.docs": "https://docs.datadoghq.com/api/"
}

        Further Reading

        Additional helpful documentation, links, and articles:

        Learn how to manage monitorsDOCUMENTATION more more Learn more about monitor templatesDOCUMENTATION more more