--- title: Get an API test result description: Get a specific full result from a given Synthetic API test. breadcrumbs: Docs > API > Get an API test result --- > For the complete documentation index, see [llms.txt](https://dnd37xeb23o8n.cloudfront.net/jen.gilbert/astro-base/llms.txt). # Get an API test result ## v1 (latest) | Datadog site | API endpoint | | ----------------- | ----------------------------------------------------------------------------------------- | | app.datadoghq.com | GET https://api.datadoghq.com/api/v1/synthetics/tests/{public_id}/results/{result_id} | | us3.datadoghq.com | GET https://api.us3.datadoghq.com/api/v1/synthetics/tests/{public_id}/results/{result_id} | | us5.datadoghq.com | GET https://api.us5.datadoghq.com/api/v1/synthetics/tests/{public_id}/results/{result_id} | | app.datadoghq.eu | GET https://api.datadoghq.eu/api/v1/synthetics/tests/{public_id}/results/{result_id} | | ap1.datadoghq.com | GET https://api.ap1.datadoghq.com/api/v1/synthetics/tests/{public_id}/results/{result_id} | | ap2.datadoghq.com | GET https://api.ap2.datadoghq.com/api/v1/synthetics/tests/{public_id}/results/{result_id} | | uk1.datadoghq.com | GET https://api.uk1.datadoghq.com/api/v1/synthetics/tests/{public_id}/results/{result_id} | | app.ddog-gov.com | GET https://api.ddog-gov.com/api/v1/synthetics/tests/{public_id}/results/{result_id} | | us2.ddog-gov.com | GET https://api.us2.ddog-gov.com/api/v1/synthetics/tests/{public_id}/results/{result_id} | ### Overview Get a specific full result from a given Synthetic API test. This endpoint requires the `synthetics_read` permission. OAuth apps require the `synthetics_read` authorization [scope](https://dnd37xeb23o8n.cloudfront.net/jen.gilbert/astro-base/api/latest/scopes.md#synthetics) to access this endpoint. ### Arguments #### Path Parameters | Field | Type | Description | | ---------------------- | ------ | ----------------------------------------------------------------- | | public_id [*required*] | string | The public ID of the API test to which the target result belongs. | | result_id [*required*] | string | The ID of the result to get. | ### Response {% tabs %} {% tab label="200" %} OK {% tabs %} {% tab label="Model" %} Object returned describing a API test result. | Parent field | Field | Type | Description | | -------------------- | ----------------------------------- | --------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | | check | object | Object describing the API test configuration. | | check | config [*required*] | object | Configuration object for a Synthetic test. | | config | assertions | [] | Array of assertions used for the test. Required for single API tests. | | assertions | Object 1 | object | An assertion which uses a simple target. | | Object 1 | operator [*required*] | enum | Assertion operator to apply. Allowed enum values: `contains`, `doesNotContain`, `is`, `isNot`, `lessThan`, `lessThanOrEqual`, `moreThan`, `moreThanOrEqual`, `matches`, `doesNotMatch`, `validates`, `isInMoreThan`, `isInLessThan`, `doesNotExist`, `isUndefined`. | | Object 1 | property | string | The associated assertion property. | | Object 1 | target [*required*] | | Value used by the operator. | | target | Object 1 | double | Numeric value used by the operator in assertions. | | target | Object 2 | string | String value used by the operator in assertions. Supports templated variables. | | Object 1 | timingsScope | enum | Timings scope for response time assertions. Allowed enum values: `all`, `withoutDNS`. | | Object 1 | type [*required*] | enum | Type of the assertion. Allowed enum values: `body`, `header`, `statusCode`, `certificate`, `responseTime`, `property`, `recordEvery`, `recordSome`, `tlsVersion`, `minTlsVersion`, `latency`, `packetLossPercentage`, `packetsReceived`, `networkHop`, `receivedMessage`, `grpcHealthcheckStatus`, `grpcMetadata`, `grpcProto`, `connection`, `multiNetworkHop`, `jitter`, `mcpToolNameLength`, `mcpToolCount`. | | assertions | Object 2 | object | An assertion which targets body hash. | | Object 2 | operator [*required*] | enum | Assertion operator to apply. Allowed enum values: `md5`, `sha1`, `sha256`. | | Object 2 | target [*required*] | | Value used by the operator. | | target | Object 1 | double | Numeric value used by the operator in assertions. | | target | Object 2 | string | String value used by the operator in assertions. Supports templated variables. | | Object 2 | type [*required*] | enum | Type of the assertion. Allowed enum values: `bodyHash`. | | assertions | Object 3 | object | An assertion for the `validatesJSONPath` operator. | | Object 3 | operator [*required*] | enum | Assertion operator to apply. Allowed enum values: `validatesJSONPath`. | | Object 3 | property | string | The associated assertion property. | | Object 3 | target | object | Composed target for `validatesJSONPath` operator. | | target | elementsOperator | string | The element from the list of results to assert on. To choose from the first element in the list `firstElementMatches`, every element in the list `everyElementMatches`, at least one element in the list `atLeastOneElementMatches` or the serialized value of the list `serializationMatches`. | | target | jsonPath | string | The JSON path to assert. | | target | operator | string | The specific operator to use on the path. | | target | targetValue | | The path target value to compare to. | | targetValue | Object 1 | double | Numeric value used by the operator in assertions. | | targetValue | Object 2 | string | String value used by the operator in assertions. Supports templated variables. | | Object 3 | type [*required*] | enum | Type of the assertion. Allowed enum values: `body`, `header`, `statusCode`, `certificate`, `responseTime`, `property`, `recordEvery`, `recordSome`, `tlsVersion`, `minTlsVersion`, `latency`, `packetLossPercentage`, `packetsReceived`, `networkHop`, `receivedMessage`, `grpcHealthcheckStatus`, `grpcMetadata`, `grpcProto`, `connection`, `multiNetworkHop`, `jitter`, `mcpToolNameLength`, `mcpToolCount`. | | assertions | Object 4 | object | An assertion for the `validatesJSONSchema` operator. | | Object 4 | operator [*required*] | enum | Assertion operator to apply. Allowed enum values: `validatesJSONSchema`. | | Object 4 | target | object | Composed target for `validatesJSONSchema` operator. | | target | jsonSchema | string | The JSON Schema to assert. | | target | metaSchema | enum | The JSON Schema meta-schema version used in the assertion. Allowed enum values: `draft-07`, `draft-06`. | | Object 4 | type [*required*] | enum | Type of the assertion. Allowed enum values: `body`, `header`, `statusCode`, `certificate`, `responseTime`, `property`, `recordEvery`, `recordSome`, `tlsVersion`, `minTlsVersion`, `latency`, `packetLossPercentage`, `packetsReceived`, `networkHop`, `receivedMessage`, `grpcHealthcheckStatus`, `grpcMetadata`, `grpcProto`, `connection`, `multiNetworkHop`, `jitter`, `mcpToolNameLength`, `mcpToolCount`. | | assertions | Object 5 | object | An assertion for the `validatesXPath` operator. | | Object 5 | operator [*required*] | enum | Assertion operator to apply. Allowed enum values: `validatesXPath`. | | Object 5 | property | string | The associated assertion property. | | Object 5 | target | object | Composed target for `validatesXPath` operator. | | target | operator | string | The specific operator to use on the path. | | target | targetValue | | The path target value to compare to. | | targetValue | Object 1 | double | Numeric value used by the operator in assertions. | | targetValue | Object 2 | string | String value used by the operator in assertions. Supports templated variables. | | target | xPath | string | The X path to assert. | | Object 5 | type [*required*] | enum | Type of the assertion. Allowed enum values: `body`, `header`, `statusCode`, `certificate`, `responseTime`, `property`, `recordEvery`, `recordSome`, `tlsVersion`, `minTlsVersion`, `latency`, `packetLossPercentage`, `packetsReceived`, `networkHop`, `receivedMessage`, `grpcHealthcheckStatus`, `grpcMetadata`, `grpcProto`, `connection`, `multiNetworkHop`, `jitter`, `mcpToolNameLength`, `mcpToolCount`. | | assertions | Object 6 | object | A JavaScript assertion. | | Object 6 | code [*required*] | string | The JavaScript code that performs the assertions. | | Object 6 | type [*required*] | enum | Type of the assertion. Allowed enum values: `javascript`. | | assertions | Object 7 | object | An assertion that checks that an MCP server advertises the expected capabilities. | | Object 7 | operator [*required*] | enum | Assertion operator to apply. Allowed enum values: `contains`, `doesNotContain`, `is`, `isNot`, `lessThan`, `lessThanOrEqual`, `moreThan`, `moreThanOrEqual`, `matches`, `doesNotMatch`, `validates`, `isInMoreThan`, `isInLessThan`, `doesNotExist`, `isUndefined`. | | Object 7 | target [*required*] | [string] | List of MCP server capabilities to assert against. | | Object 7 | type [*required*] | enum | Type of the assertion. Allowed enum values: `mcpServerCapabilities`. | | assertions | Object 8 | object | An assertion that verifies the MCP server response respects the MCP specification. | | Object 8 | type [*required*] | enum | Type of the assertion. Allowed enum values: `mcpRespectsSpecification`. | | config | configVariables | [object] | Array of variables used for the test. | | configVariables | example | string | Example for the variable. | | configVariables | id | string | ID of the variable for global variables. | | configVariables | name [*required*] | string | Name of the variable. | | configVariables | pattern | string | Pattern of the variable. | | configVariables | secure | boolean | Whether the value of this variable will be obfuscated in test results. Only for config variables of type `text`. | | configVariables | type [*required*] | enum | Type of the configuration variable. Allowed enum values: `global`, `text`, `email`. | | config | request | object | Object describing the Synthetic test request. | | request | allow_insecure | boolean | Allows loading insecure content for an HTTP request in a multistep test step. | | request | basicAuth | | Object to handle basic authentication when performing the test. | | basicAuth | | object | Object to handle basic authentication when performing the test. | | | password | string | Password to use for the basic authentication. | | | type | enum | The type of basic authentication to use when performing the test. Allowed enum values: `web`. Default: `web`. | | | username | string | Username to use for the basic authentication. | | basicAuth | | object | Object to handle `SIGV4` authentication when performing the test. | | | accessKey [*required*] | string | Access key for the `SIGV4` authentication. | | | region | string | Region for the `SIGV4` authentication. | | | secretKey [*required*] | string | Secret key for the `SIGV4` authentication. | | | serviceName | string | Service name for the `SIGV4` authentication. | | | sessionToken | string | Session token for the `SIGV4` authentication. | | | type [*required*] | enum | The type of authentication to use when performing the test. Allowed enum values: `sigv4`. Default: `sigv4`. | | basicAuth | | object | Object to handle `NTLM` authentication when performing the test. | | | domain | string | Domain for the authentication to use when performing the test. | | | password | string | Password for the authentication to use when performing the test. | | | type [*required*] | enum | The type of authentication to use when performing the test. Allowed enum values: `ntlm`. Default: `ntlm`. | | | username | string | Username for the authentication to use when performing the test. | | | workstation | string | Workstation for the authentication to use when performing the test. | | basicAuth | | object | Object to handle digest authentication when performing the test. | | | password [*required*] | string | Password to use for the digest authentication. | | | type [*required*] | enum | The type of basic authentication to use when performing the test. Allowed enum values: `digest`. Default: `digest`. | | | username [*required*] | string | Username to use for the digest authentication. | | basicAuth | | object | Object to handle `oauth client` authentication when performing the test. | | | accessTokenUrl [*required*] | string | Access token URL to use when performing the authentication. | | | audience | string | Audience to use when performing the authentication. | | | clientId [*required*] | string | Client ID to use when performing the authentication. | | | clientSecret [*required*] | string | Client secret to use when performing the authentication. | | | resource | string | Resource to use when performing the authentication. | | | scope | string | Scope to use when performing the authentication. | | | tokenApiAuthentication [*required*] | enum | Type of token to use when performing the authentication. Allowed enum values: `header`, `body`. | | | type [*required*] | enum | The type of basic authentication to use when performing the test. Allowed enum values: `oauth-client`. Default: `oauth-client`. | | basicAuth | | object | Object to handle `oauth rop` authentication when performing the test. | | | accessTokenUrl [*required*] | string | Access token URL to use when performing the authentication. | | | audience | string | Audience to use when performing the authentication. | | | clientId | string | Client ID to use when performing the authentication. | | | clientSecret | string | Client secret to use when performing the authentication. | | | password [*required*] | string | Password to use when performing the authentication. | | | resource | string | Resource to use when performing the authentication. | | | scope | string | Scope to use when performing the authentication. | | | tokenApiAuthentication [*required*] | enum | Type of token to use when performing the authentication. Allowed enum values: `header`, `body`. | | | type [*required*] | enum | The type of basic authentication to use when performing the test. Allowed enum values: `oauth-rop`. Default: `oauth-rop`. | | | username [*required*] | string | Username to use when performing the authentication. | | basicAuth | | object | Object to handle JWT authentication when performing the test. | | | addClaims | object | Standard JWT claims to automatically inject. | | addClaims | exp | boolean | Whether to inject the `exp` (expiration) claim. | | addClaims | iat | boolean | Whether to inject the `iat` (issued at) claim. | | | algorithm [*required*] | enum | Algorithm to use for the JWT authentication. Allowed enum values: `HS256`, `RS256`, `ES256`. | | | expiresIn | int64 | Token time-to-live in seconds. | | | header | string | Custom JWT header as a JSON string. | | | payload [*required*] | string | JWT claims as a JSON string. | | | secret [*required*] | string | Signing key for the JWT authentication. Use the shared secret for `HS256` or the private key (PEM format) for `RS256` and `ES256`. | | | tokenPrefix | string | Prefix added before the token in the `Authorization` header. Defaults to `Bearer`. | | | type [*required*] | enum | The type of authentication to use when performing the test. Allowed enum values: `jwt`. Default: `jwt`. | | request | body | string | Body to include in the test. | | request | bodyType | enum | Type of the request body. Allowed enum values: `text/plain`, `application/json`, `text/xml`, `text/html`, `application/x-www-form-urlencoded`, `graphql`, `application/octet-stream`, `multipart/form-data`. | | request | callType | enum | The type of call to perform. Used by gRPC steps (`healthcheck`, `unary`) and MCP steps (`init`, `tool_list`, `tool_call`). Valid values depend on the parent step's `subtype`. Allowed enum values: `healthcheck`, `unary`, `init`, `tool_list`, `tool_call`. | | request | certificate | object | Client certificate to use when performing the test request. | | certificate | cert | object | Define a request certificate. | | cert | content | string | Content of the certificate or key. | | cert | filename | string | File name for the certificate or key. | | cert | updatedAt | string | Date of update of the certificate or key, ISO format. | | certificate | key | object | Define a request certificate. | | key | content | string | Content of the certificate or key. | | key | filename | string | File name for the certificate or key. | | key | updatedAt | string | Date of update of the certificate or key, ISO format. | | request | certificateDomains | [string] | By default, the client certificate is applied on the domain of the starting URL for browser tests. If you want your client certificate to be applied on other domains instead, add them in `certificateDomains`. | | request | checkCertificateRevocation | boolean | Check for certificate revocation. | | request | compressedJsonDescriptor | string | A protobuf JSON descriptor that needs to be gzipped first then base64 encoded. | | request | compressedProtoFile | string | A protobuf file that needs to be gzipped first then base64 encoded. | | request | disableAiaIntermediateFetching | boolean | Disable fetching intermediate certificates from AIA. | | request | dnsServer | string | DNS server to use for DNS tests. | | request | dnsServerPort | | DNS server port to use for DNS tests. | | dnsServerPort | Object 1 | int64 | Integer DNS server port number to use when performing the test. | | dnsServerPort | Object 2 | string | String DNS server port number to use when performing the test. Supports templated variables. | | request | files | [object] | Files to be used as part of the request in the test. Only valid if `bodyType` is `multipart/form-data`. | | files | bucketKey | string | Bucket key of the file. | | files | content | string | Content of the file. | | files | encoding | string | Encoding of the file content. The only supported value is `base64`, indicating the `content` field contains base64-encoded data. | | files | name | string | Name of the file. | | files | originalFileName | string | Original name of the file. | | files | size | int64 | Size of the file. | | files | type | string | Type of the file. | | request | follow_redirects | boolean | Specifies whether or not the request follows redirects. | | request | form | object | Form to be used as part of the request in the test. Only valid if `bodyType` is `multipart/form-data`. | | additionalProperties | | string | A single form entry. | | request | headers | object | Headers to include when performing the test. | | additionalProperties | | string | A single Header. | | request | host | string | Host name to perform the test with. | | request | httpVersion | enum | HTTP version to use for a Synthetic test. Allowed enum values: `http1`, `http2`, `any`. | | request | ignore_certificate_validation | boolean | For SSL tests, whether the test should ignore certificate validation. | | request | isMessageBase64Encoded | boolean | Whether the message is base64 encoded. | | request | mcpProtocolVersion | enum | The MCP protocol version used by the step. See . Allowed enum values: `2025-06-18`. | | request | message | string | Message to send for UDP or WebSocket tests. | | request | metadata | object | Metadata to include when performing the gRPC test. | | additionalProperties | | string | A single metadatum. | | request | method | string | Either the HTTP method/verb to use or a gRPC method available on the service set in the `service` field. Required if `subtype` is `HTTP` or if `subtype` is `grpc` and `callType` is `unary`. | | request | noSavingResponseBody | boolean | Determines whether or not to save the response body. | | request | numberOfPackets | int32 | Number of pings to use per test. | | request | persistCookies | boolean | Persist cookies across redirects. | | request | port | | Port to use when performing the test. | | port | Object 1 | int64 | Integer Port number to use when performing the test. | | port | Object 2 | string | String Port number to use when performing the test. Supports templated variables. | | request | proxy | object | The proxy to perform the test. | | proxy | headers | object | Headers to include when performing the test. | | additionalProperties | | string | A single Header. | | proxy | url [*required*] | string | URL of the proxy to perform the test. | | request | query | object | Query to use for the test. | | request | servername | string | For SSL tests, it specifies on which server you want to initiate the TLS handshake, allowing the server to present one of multiple possible certificates on the same IP address and TCP port number. | | request | service | string | The gRPC service on which you want to perform the gRPC call. | | request | shouldTrackHops | boolean | Turns on a traceroute probe to discover all gateways along the path to the host destination. | | request | timeout | double | Timeout in seconds for the test. | | request | toolArgs | object | Arguments to pass to the MCP tool. Free-form object whose shape depends on the tool. Used when `callType` is `tool_call`. | | request | toolName | string | The name of the MCP tool to call. Required when `callType` is `tool_call`. | | request | url | string | URL to perform the test with. | | config | variables | [object] | Browser tests only - array of variables used for the test steps. | | variables | example | string | Example for the variable. | | variables | id | string | ID for the variable. Global variables require an ID. | | variables | name [*required*] | string | Name of the variable. | | variables | pattern | string | Pattern of the variable. | | variables | secure | boolean | Determines whether or not the browser test variable is obfuscated. Can only be used with browser variables of type `text`. | | variables | type [*required*] | enum | Type of browser test variable. Allowed enum values: `element`, `email`, `global`, `text`. | | | check_time | double | When the API test was conducted. | | | check_version | int64 | Version of the API test used. | | | probe_dc | string | Locations for which to query the API test results. | | | result | object | Object containing results for your Synthetic API test. | | result | cert | object | Object describing the SSL certificate used for a Synthetic test. | | cert | cipher | string | Cipher used for the connection. | | cert | exponent | double | Exponent associated to the certificate. | | cert | extKeyUsage | [string] | Array of extensions and details used for the certificate. | | cert | fingerprint | string | MD5 digest of the DER-encoded Certificate information. | | cert | fingerprint256 | string | SHA-1 digest of the DER-encoded Certificate information. | | cert | issuer | object | Object describing the issuer of a SSL certificate. | | issuer | C | string | Country Name that issued the certificate. | | issuer | CN | string | Common Name that issued certificate. | | issuer | L | string | Locality that issued the certificate. | | issuer | O | string | Organization that issued the certificate. | | issuer | OU | string | Organizational Unit that issued the certificate. | | issuer | ST | string | State Or Province Name that issued the certificate. | | cert | modulus | string | Modulus associated to the SSL certificate private key. | | cert | protocol | string | TLS protocol used for the test. | | cert | serialNumber | string | Serial Number assigned by Symantec to the SSL certificate. | | cert | subject | object | Object describing the SSL certificate used for the test. | | subject | C | string | Country Name associated with the certificate. | | subject | CN | string | Common Name that associated with the certificate. | | subject | L | string | Locality associated with the certificate. | | subject | O | string | Organization associated with the certificate. | | subject | OU | string | Organizational Unit associated with the certificate. | | subject | ST | string | State Or Province Name associated with the certificate. | | subject | altName | string | Subject Alternative Name associated with the certificate. | | cert | validFrom | date-time | Date from which the SSL certificate is valid. | | cert | validTo | date-time | Date until which the SSL certificate is valid. | | result | eventType | enum | Status of a Synthetic test. Allowed enum values: `not_scheduled`, `scheduled`, `finished`, `finished_with_error`. | | result | failure | object | The API test failure details. | | failure | code | enum | Error code that can be returned by a Synthetic test. Allowed enum values: `BODY_TOO_LARGE`, `DENIED`, `TOO_MANY_REDIRECTS`, `AUTHENTICATION_ERROR`, `DECRYPTION`, `INVALID_CHAR_IN_HEADER`, `HEADER_TOO_LARGE`, `HEADERS_INCOMPATIBLE_CONTENT_LENGTH`, `INVALID_REQUEST`, `REQUIRES_UPDATE`, `UNESCAPED_CHARACTERS_IN_REQUEST_PATH`, `MALFORMED_RESPONSE`, `INCORRECT_ASSERTION`, `CONNREFUSED`, `CONNRESET`, `DNS`, `HOSTUNREACH`, `NETUNREACH`, `TIMEOUT`, `SSL`, `OCSP`, `INVALID_TEST`, `TUNNEL`, `WEBSOCKET`, `UNKNOWN`, `INTERNAL_ERROR`. | | failure | message | string | The API test error message. | | result | httpStatusCode | int64 | The API test HTTP status code. | | result | requestHeaders | object | Request header object used for the API test. | | additionalProperties | | object | Requested request header. | | result | responseBody | string | Response body returned for the API test. | | result | responseHeaders | object | Response headers returned for the API test. | | additionalProperties | | any | Returned request header. | | result | responseSize | int64 | Global size in byte of the API test response. | | result | timings | object | Object containing all metrics and their values collected for a Synthetic API test. See the [Synthetic Monitoring Metrics documentation](https://docs.datadoghq.com/synthetics/metrics.md). | | timings | dns | double | The duration in millisecond of the DNS lookup. | | timings | download | double | The time in millisecond to download the response. | | timings | firstByte | double | The time in millisecond to first byte. | | timings | handshake | double | The duration in millisecond of the TLS handshake. | | timings | redirect | double | The time in millisecond spent during redirections. | | timings | ssl | double | The duration in millisecond of the TLS handshake. | | timings | tcp | double | Time in millisecond to establish the TCP connection. | | timings | total | double | The overall time in millisecond the request took to be processed. | | timings | wait | double | Time spent in millisecond waiting for a response. | | | result_id | string | ID of the API test result. | | | status | enum | The status of your Synthetic monitor. * `O` for not triggered * `1` for triggered * `2` for no data Allowed enum values: `0`, `1`, `2`. | {% /tab %} {% tab label="Example" %} ```json { "check": { "config": { "assertions": [ { "operator": "contains", "property": "string", "target": 0, "timingsScope": "string", "type": "statusCode" } ], "configVariables": [ { "example": "string", "id": "string", "name": "VARIABLE_NAME", "pattern": "string", "secure": false, "type": "text" } ], "request": { "allow_insecure": false, "basicAuth": { "password": "PaSSw0RD!", "type": "web", "username": "my_username" }, "body": "string", "bodyType": "text/plain", "callType": "unary", "certificate": { "cert": { "content": "string", "filename": "string", "updatedAt": "string" }, "key": { "content": "string", "filename": "string", "updatedAt": "string" } }, "certificateDomains": [], "checkCertificateRevocation": false, "compressedJsonDescriptor": "string", "compressedProtoFile": "string", "disableAiaIntermediateFetching": false, "dnsServer": "string", "dnsServerPort": { "description": "undefined", "format": "undefined", "type": "undefined" }, "files": [ { "bucketKey": "string", "content": "string", "encoding": "string", "name": "string", "originalFileName": "string", "size": "integer", "type": "string" } ], "follow_redirects": false, "form": { "": "string" }, "headers": { "": "string" }, "host": "string", "httpVersion": "string", "ignore_certificate_validation": false, "isMessageBase64Encoded": false, "mcpProtocolVersion": "2025-06-18", "message": "string", "metadata": { "": "string" }, "method": "string", "noSavingResponseBody": false, "numberOfPackets": "integer", "persistCookies": false, "port": { "description": "undefined", "format": "undefined", "type": "undefined" }, "proxy": { "headers": { "": "string" }, "url": "https://example.com" }, "query": {}, "servername": "string", "service": "Greeter", "shouldTrackHops": false, "timeout": "number", "toolArgs": {}, "toolName": "search", "url": "https://example.com" }, "variables": [ { "example": "string", "id": "string", "name": "VARIABLE_NAME", "pattern": "string", "secure": false, "type": "text" } ] } }, "check_time": "number", "check_version": "integer", "probe_dc": "string", "result": { "cert": { "cipher": "string", "exponent": "number", "extKeyUsage": [], "fingerprint": "string", "fingerprint256": "string", "issuer": { "C": "string", "CN": "string", "L": "string", "O": "string", "OU": "string", "ST": "string" }, "modulus": "string", "protocol": "string", "serialNumber": "string", "subject": { "C": "string", "CN": "string", "L": "string", "O": "string", "OU": "string", "ST": "string", "altName": "string" }, "validFrom": "2019-09-19T10:00:00.000Z", "validTo": "2019-09-19T10:00:00.000Z" }, "eventType": "string", "failure": { "code": "string", "message": "Error during DNS resolution (ENOTFOUND)." }, "httpStatusCode": "integer", "requestHeaders": { "": {} }, "responseBody": "string", "responseHeaders": { "": "undefined" }, "responseSize": "integer", "timings": { "dns": "number", "download": "number", "firstByte": "number", "handshake": "number", "redirect": "number", "ssl": "number", "tcp": "number", "total": "number", "wait": "number" } }, "result_id": "string", "status": "integer" } ``` {% /tab %} {% /tabs %} {% /tab %} {% tab label="403" %} Forbidden {% tabs %} {% tab label="Model" %} Error response object. | Field | Type | Description | | ------------------- | -------- | ------------------------------------ | | errors [*required*] | [string] | Array of errors returned by the API. | {% /tab %} {% tab label="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tabs %} {% /tab %} {% tab label="404" %} - Synthetic Monitoring is not activated for the user - Test or result is not owned by the user {% tabs %} {% tab label="Model" %} Error response object. | Field | Type | Description | | ------------------- | -------- | ------------------------------------ | | errors [*required*] | [string] | Array of errors returned by the API. | {% /tab %} {% tab label="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tabs %} {% /tab %} {% tab label="429" %} Too many requests {% tabs %} {% tab label="Model" %} Error response object. | Field | Type | Description | | ------------------- | -------- | ------------------------------------ | | errors [*required*] | [string] | Array of errors returned by the API. | {% /tab %} {% tab label="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tabs %} {% /tab %} {% /tabs %} ### Code Example {% tabs %} {% tab label="Curl" %} ```bash # Path parameters export public_id="CHANGE_ME" export result_id="CHANGE_ME" # Set your Datadog site and credentials export DD_SITE="datadoghq.com" # Or us3.datadoghq.com, us5.datadoghq.com, datadoghq.eu, ap1.datadoghq.com, ap2.datadoghq.com, uk1.datadoghq.com, ddog-gov.com, us2.ddog-gov.com # Use a Personal Access Token or Service Access Token export DD_BEARER_TOKEN="" curl -X GET "https://api.${DD_SITE}/api/v1/synthetics/tests/${public_id}/results/${result_id}" \ -H "Accept: application/json" \ -H "Authorization: Bearer ${DD_BEARER_TOKEN}" ``` {% /tab %} {% tab label="Go" %} ```go // Get an API test result returns "OK" response package main import ( "context" "encoding/json" "fmt" "os" "github.com/DataDog/datadog-api-client-go/v2/api/datadog" "github.com/DataDog/datadog-api-client-go/v2/api/datadogV1" ) func main() { ctx := datadog.NewDefaultContext(context.Background()) ctx = context.WithValue(ctx, datadog.ContextAccessToken, os.Getenv("DD_BEARER_TOKEN")) configuration := datadog.NewConfiguration() apiClient := datadog.NewAPIClient(configuration) api := datadogV1.NewSyntheticsApi(apiClient) resp, r, err := api.GetAPITestResult(ctx, "hwb-332-3xe", "3420446318379485707") if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `SyntheticsApi.GetAPITestResult`: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } responseContent, _ := json.MarshalIndent(resp, "", " ") fmt.Fprintf(os.Stdout, "Response from `SyntheticsApi.GetAPITestResult`:\n%s\n", responseContent) } ``` #### Instructions First [install the library and its dependencies](https://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=go) and then save the example to `main.go` and run following commands: ```bash DD_SITE="datadoghq.com" DD_BEARER_TOKEN="" go run "main.go" ``` {% /tab %} {% tab label="Java" %} ```java // Get an API test result returns "OK" response import com.datadog.api.client.ApiClient; import com.datadog.api.client.ApiException; import com.datadog.api.client.v1.api.SyntheticsApi; import com.datadog.api.client.v1.model.SyntheticsAPITestResultFull; public class Example { public static void main(String[] args) { ApiClient defaultClient = ApiClient.getDefaultApiClient(); defaultClient.setAccessToken(System.getenv("DD_BEARER_TOKEN")); SyntheticsApi apiInstance = new SyntheticsApi(defaultClient); try { SyntheticsAPITestResultFull result = apiInstance.getAPITestResult("hwb-332-3xe", "3420446318379485707"); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling SyntheticsApi#getAPITestResult"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` #### Instructions First [install the library and its dependencies](https://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=java) and then save the example to `Example.java` and run following commands: ```bash DD_SITE="datadoghq.com" DD_BEARER_TOKEN="" java "Example.java" ``` {% /tab %} {% tab label="Python" %} ```python """ Get an API test result returns "OK" response """ from os import environ from datadog_api_client import ApiClient, Configuration from datadog_api_client.v1.api.synthetics_api import SyntheticsApi configuration = Configuration() configuration.access_token = environ["DD_BEARER_TOKEN"] with ApiClient(configuration) as api_client: api_instance = SyntheticsApi(api_client) response = api_instance.get_api_test_result( public_id="hwb-332-3xe", result_id="3420446318379485707", ) print(response) ``` #### Instructions First [install the library and its dependencies](https://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=python) and then save the example to `example.py` and run following commands: ```bash DD_SITE="datadoghq.com" DD_BEARER_TOKEN="" python3 "example.py" ``` {% /tab %} {% tab label="Ruby" %} ```ruby # Get an API test result returns "OK" response require "datadog_api_client" DatadogAPIClient.configure do |config| config.access_token = ENV["DD_BEARER_TOKEN"] end api_instance = DatadogAPIClient::V1::SyntheticsAPI.new p api_instance.get_api_test_result("hwb-332-3xe", "3420446318379485707") ``` #### Instructions First [install the library and its dependencies](https://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=ruby) and then save the example to `example.rb` and run following commands: ```bash DD_SITE="datadoghq.com" DD_BEARER_TOKEN="" rb "example.rb" ``` {% /tab %} {% tab label="Rust" %} ```rust // Get an API test result returns "OK" response use datadog_api_client::datadog; use datadog_api_client::datadogV1::api_synthetics::SyntheticsAPI; #[tokio::main] async fn main() { let configuration = datadog::Configuration::new(); let api = SyntheticsAPI::with_config(configuration); let resp = api .get_api_test_result("hwb-332-3xe".to_string(), "3420446318379485707".to_string()) .await; if let Ok(value) = resp { println!("{:#?}", value); } else { println!("{:#?}", resp.unwrap_err()); } } ``` #### Instructions First [install the library and its dependencies](https://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=rust) and then save the example to `src/main.rs` and run following commands: ```bash DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" cargo run ``` {% /tab %} {% tab label="TypeScript" %} ```typescript /** * Get an API test result returns "OK" response */ import { client, v1 } from "@datadog/datadog-api-client"; const configuration = client.createConfiguration({ authMethods: { AuthZ: { accessToken: process.env.DD_BEARER_TOKEN as string, }, }, }); const apiInstance = new v1.SyntheticsApi(configuration); const params: v1.SyntheticsApiGetAPITestResultRequest = { publicId: "hwb-332-3xe", resultId: "3420446318379485707", }; apiInstance .getAPITestResult(params) .then((data: v1.SyntheticsAPITestResultFull) => { console.log( "API called successfully. Returned data: " + JSON.stringify(data) ); }) .catch((error: any) => console.error(error)); ``` #### Instructions First [install the library and its dependencies](https://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=typescript) and then save the example to `example.ts` and run following commands: ```bash DD_SITE="datadoghq.com" DD_BEARER_TOKEN="" tsc "example.ts" ``` {% /tab %} {% tab label="Python [legacy]" %} ```python from datadog import initialize, api options = { 'api_key': '', 'app_key': '' } test_id = '' result_id = '' initialize(**options) api.Synthetics.get_result(id=test_id, result_id=result_id) ``` #### Instructions First [install the library and its dependencies](https://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=python-legacy) and then save the example to `example.py` and run following commands: ```bash DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" python "example.py" ``` {% /tab %} {% tab label="Ruby [legacy]" %} ```ruby require 'dogapi' api_key = '' app_key = '' test_id = '' result_id = '' dog = Dogapi::Client.new(api_key, app_key) dog.get_synthetics_result('test_id' => test_id , 'result_id' => result_id) ``` #### Instructions First [install the library and its dependencies](https://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=ruby-legacy) and then save the example to `example.rb` and run following commands: ```bash DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" rb "example.rb" ``` {% /tab %} {% /tabs %}