Datadog Synthetics

Get API test result

Cette page n'est pas encore disponible en français, sa traduction est en cours.
Si vous avez des questions ou des retours sur notre projet de traduction actuel, n'hésitez pas à nous contacter.

Get a specific full result from a given (API) Synthetic test.

Inputs

Champ

Type

Description

public_id [required]

string

The ID of the API test to which the target result belongs.

result_id [required]

string

The ID of the result to get.

Outputs

Expand All

Champ

Type

Description

check_time

number

When the API test was conducted.

check_version

number

Version of the API test used.

probe_dc

string

Locations for which to query the API test results.

result_id

string

ID of the API test result.

status

enum

The status of your Synthetic monitor. Allowed enum values: 0,1,2

check

object

Object describing the API test configuration.

config [required]

object

Configuration object for a Synthetic test.

request

object

Object describing the Synthetic test request.

method

enum

url

string

URL to perform the test with.

body

string

Body to include in the test.

timeout

number

Timeout in seconds for the test.

host

string

Host name to perform the test with.

port

number

Port to use when performing the test.

query

object

Query to use for the test.

dnsServer

string

DNS server to use for DNS tests.

basicAuth

Object to handle basic authentication when performing the test.

headers

object

Headers to include when performing the test.

certificate

object

Client certificate to use when performing the test request.

cert

object

Define a request certificate.

content

string

Content of the certificate or key.

filename

string

File name for the certificate or key.

updatedAt

string

Date of update of the certificate or key, ISO format.

key

object

Define a request certificate.

content

string

Content of the certificate or key.

filename

string

File name for the certificate or key.

updatedAt

string

Date of update of the certificate or key, ISO format.

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.

noSavingResponseBody

boolean

Determines whether or not to save the response body.

dnsServerPort

number

DNS server port to use for DNS tests.

numberOfPackets

number

Number of pings to use per test.

shouldTrackHops

boolean

Turns on a traceroute probe to discover all gateways along the path to the host destination.

allow_insecure

boolean

Allows loading insecure content for an HTTP request in a multistep test step.

follow_redirects

boolean

Specifies whether or not the request follows redirects.

message

string

Message to send for UDP or WebSocket tests.

service

string

gRPC service on which you want to perform the healthcheck.

metadata

object

Metadata to include when performing the gRPC test.

proxy

object

The proxy to perform the test.

url [required]

string

URL of the proxy to perform the test.

headers

object

Headers to include when performing the test.

variables

[object]

Browser tests only - array of variables used for the test steps.

type [required]

enum

Type of browser test variable. Allowed enum values: element,email,global,javascript,text

name [required]

string

Name of the variable.

pattern

string

Pattern of the variable.

example

string

Example for the variable.

id

string

ID for the variable.

configVariables

[object]

Array of variables used for the test.

type [required]

enum

Type of the configuration variable. Allowed enum values: global,text

name [required]

string

Name of the variable.

pattern

string

Pattern of the variable.

example

string

Example for the variable.

id

string

ID of the variable for global variables.

assertions

[]

Array of assertions used for the test.

default:

result

object

Object containing results for your Synthetic API test.

timings

object

Object containing all metrics and their values collected for a Synthetic API test.

dns

number

The duration in millisecond of the DNS lookup.

firstByte

number

The time in millisecond to first byte.

download

number

The time in millisecond to download the response.

handshake

number

The duration in millisecond of the TLS handshake.

redirect

number

The time in millisecond spent during redirections.

ssl

number

The duration in millisecond of the TLS handshake.

tcp

number

Time in millisecond to establish the TCP connection.

total

number

The overall time in millisecond the request took to be processed.

wait

number

Time spent in millisecond waiting for a response.

eventType

enum

Status of a Synthetic test. Allowed enum values: not_scheduled,scheduled,started,finished,finished_with_error

failure

object

The API test failure details.

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

message

string

The API test error message.

cert

object

Object describing the SSL certificate used for a Synthetic test.

validFrom

date-time

Date from which the SSL certificate is valid.

validTo

date-time

Date until which the SSL certificate is valid.

subject

object

Object describing the SSL certificate used for the test.

C

string

Country Name associated with the certificate.

ST

string

State Or Province Name associated with the certificate.

L

string

Locality associated with the certificate.

O

string

Organization associated with the certificate.

OU

string

Organizational Unit associated with the certificate.

CN

string

Common Name that associated with the certificate.

altName

string

Subject Alternative Name associated with the certificate.

issuer

object

Object describing the issuer of a SSL certificate.

C

string

Country Name that issued the certificate.

ST

string

State Or Province Name that issued the certificate.

L

string

Locality that issued the certificate.

O

string

Organization that issued the certificate.

OU

string

Organizational Unit that issued the certificate.

CN

string

Common Name that issued certificate.

fingerprint

string

MD5 digest of the DER-encoded Certificate information.

fingerprint256

string

SHA-1 digest of the DER-encoded Certificate information.

extKeyUsage

[string]

Array of extensions and details used for the certificate.

serialNumber

string

Serial Number assigned by Symantec to the SSL certificate.

cipher

string

Cipher used for the connection.

protocol

string

TLS protocol used for the test.

modulus

string

Modulus associated to the SSL certificate private key.

exponent

number

Exponent associated to the certificate.

httpStatusCode

number

The API test HTTP status code.

requestHeaders

object

Request header object used for the API test.

responseBody

string

Response body returned for the API test.

responseHeaders

object

Response headers returned for the API test.

responseSize

number

Global size in byte of the API test response.