Datadog Synthetics

Get browser 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 (browser) Synthetic test.

Inputs

Champ

Type

Description

public_id [required]

string

The ID of the browser 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 browser test was conducted.

check_version

number

Version of the browser test used.

probe_dc

string

Location from which the browser test was performed.

result_id

string

ID of the browser test result.

status

enum

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

check

object

Object describing the browser 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 browser test.

browserType

string

Type of browser device used for the browser test.

browserVersion

string

Browser version used for the browser test.

device

object

Object describing the device used to perform the Synthetic test.

id [required]

enum

The device ID. Allowed enum values: laptop_large,tablet,mobile_small,chrome.laptop_large,chrome.tablet,chrome.mobile_small,firefox.laptop_large,firefox.tablet,firefox.mobile_small,edge.laptop_large,edge.tablet,edge.mobile_small

name [required]

string

The device name.

isMobile

boolean

Whether or not the device is a mobile.

height [required]

number

Screen height of the device.

width [required]

number

Screen width of the device.

duration

number

Global duration in second of the browser test.

error

string

Error returned for the browser test.

failure

object

The browser test failure details.

code

enum

Error code that can be returned by a Synthetic test. Allowed enum values: API_REQUEST_FAILURE,ASSERTION_FAILURE,DOWNLOAD_FILE_TOO_LARGE,ELEMENT_NOT_INTERACTABLE,EMAIL_VARIABLE_NOT_DEFINED,EVALUATE_JAVASCRIPT,EVALUATE_JAVASCRIPT_CONTEXT,EXTRACT_VARIABLE,FORBIDDEN_URL,FRAME_DETACHED,INCONSISTENCIES,INTERNAL_ERROR,INVALID_TYPE_TEXT_DELAY,INVALID_URL,INVALID_VARIABLE_PATTERN,INVISIBLE_ELEMENT,LOCATE_ELEMENT,NAVIGATE_TO_LINK,OPEN_URL,PRESS_KEY,SERVER_CERTIFICATE,SELECT_OPTION,STEP_TIMEOUT,SUB_TEST_NOT_PASSED,TEST_TIMEOUT,TOO_MANY_HTTP_REQUESTS,UNAVAILABLE_BROWSER,UNKNOWN,UNSUPPORTED_AUTH_SCHEMA,UPLOAD_FILES_ELEMENT_TYPE,UPLOAD_FILES_DIALOG,UPLOAD_FILES_DYNAMIC_ELEMENT,UPLOAD_FILES_NAME

message

string

The browser test error message.

passed

boolean

Whether or not the browser test was conducted.

receivedEmailCount

number

The amount of email received during the browser test.

startUrl

string

Starting URL for the browser test.

stepDetails

[object]

Array containing the different browser test steps.

browserErrors

[object]

Array of errors collected for a browser test.

description [required]

string

Description of the error.

name [required]

string

Name of the error.

type [required]

enum

Error type returned by a browser test. Allowed enum values: network,js

status

number

Status Code of the error.

checkType

enum

Type of assertion to apply in an API test. Allowed enum values: equals,notEquals,contains,notContains,startsWith,notStartsWith,greater,lower,greaterEquals,lowerEquals,matchRegex,between,isEmpty,notIsEmpty

description

string

Description of the test.

duration

number

Total duration in millisecond of the test.

error

string

Error returned by the test.

playingTab

enum

Navigate between different tabs for your browser test. Allowed enum values: -1,0,1,2,3

screenshotBucketKey

boolean

Whether or not screenshots where collected by the test.

snapshotBucketKey

boolean

Whether or not snapshots where collected by the test.

skipped

boolean

Whether or not to skip this step.

stepId

number

The step ID.

subTestStepDetails

[object]

If this steps include a sub-test.

browserErrors

[object]

Array of errors collected for a browser test.

description [required]

string

Description of the error.

name [required]

string

Name of the error.

type [required]

enum

Error type returned by a browser test. Allowed enum values: network,js

status

number

Status Code of the error.

checkType

enum

Type of assertion to apply in an API test. Allowed enum values: equals,notEquals,contains,notContains,startsWith,notStartsWith,greater,lower,greaterEquals,lowerEquals,matchRegex,between,isEmpty,notIsEmpty

description

string

Description of the test.

duration

number

Total duration in millisecond of the test.

error

string

Error returned by the test.

playingTab

enum

Navigate between different tabs for your browser test. Allowed enum values: -1,0,1,2,3

screenshotBucketKey

boolean

Whether or not screenshots where collected by the test.

snapshotBucketKey

boolean

Whether or not snapshots where collected by the test.

skipped

boolean

Whether or not to skip this step.

stepId

number

The step ID.

subTestStepDetails

[object]

If this steps include a sub-test.

browserErrors

[object]

Array of errors collected for a browser test.

description [required]

string

Description of the error.

name [required]

string

Name of the error.

type [required]

enum

Error type returned by a browser test. Allowed enum values: network,js

status

number

Status Code of the error.

checkType

enum

Type of assertion to apply in an API test. Allowed enum values: equals,notEquals,contains,notContains,startsWith,notStartsWith,greater,lower,greaterEquals,lowerEquals,matchRegex,between,isEmpty,notIsEmpty

description

string

Description of the test.

duration

number

Total duration in millisecond of the test.

error

string

Error returned by the test.

playingTab

enum

Navigate between different tabs for your browser test. Allowed enum values: -1,0,1,2,3

screenshotBucketKey

boolean

Whether or not screenshots where collected by the test.

snapshotBucketKey

boolean

Whether or not snapshots where collected by the test.

skipped

boolean

Whether or not to skip this step.

stepId

number

The step ID.

subTestStepDetails

[object]

If this steps include a sub-test.

browserErrors

[object]

Array of errors collected for a browser test.

description [required]

string

Description of the error.

name [required]

string

Name of the error.

type [required]

enum

Error type returned by a browser test. Allowed enum values: network,js

status

number

Status Code of the error.

checkType

enum

Type of assertion to apply in an API test. Allowed enum values: equals,notEquals,contains,notContains,startsWith,notStartsWith,greater,lower,greaterEquals,lowerEquals,matchRegex,between,isEmpty,notIsEmpty

description

string

Description of the test.

duration

number

Total duration in millisecond of the test.

error

string

Error returned by the test.

playingTab

enum

Navigate between different tabs for your browser test. Allowed enum values: -1,0,1,2,3

screenshotBucketKey

boolean

Whether or not screenshots where collected by the test.

snapshotBucketKey

boolean

Whether or not snapshots where collected by the test.

skipped

boolean

Whether or not to skip this step.

stepId

number

The step ID.

subTestStepDetails

[object]

If this steps include a sub-test.

browserErrors

[object]

Array of errors collected for a browser test.

description [required]

string

Description of the error.

name [required]

string

Name of the error.

type [required]

enum

Error type returned by a browser test. Allowed enum values: network,js

status

number

Status Code of the error.

checkType

enum

Type of assertion to apply in an API test. Allowed enum values: equals,notEquals,contains,notContains,startsWith,notStartsWith,greater,lower,greaterEquals,lowerEquals,matchRegex,between,isEmpty,notIsEmpty

description

string

Description of the test.

duration

number

Total duration in millisecond of the test.

error

string

Error returned by the test.

playingTab

enum

Navigate between different tabs for your browser test. Allowed enum values: -1,0,1,2,3

screenshotBucketKey

boolean

Whether or not screenshots where collected by the test.

snapshotBucketKey

boolean

Whether or not snapshots where collected by the test.

skipped

boolean

Whether or not to skip this step.

stepId

number

The step ID.

subTestStepDetails

[object]

If this steps include a sub-test.

browserErrors

[object]

Array of errors collected for a browser test.

description [required]

string

Description of the error.

name [required]

string

Name of the error.

type [required]

enum

Error type returned by a browser test. Allowed enum values: network,js

status

number

Status Code of the error.

checkType

enum

Type of assertion to apply in an API test. Allowed enum values: equals,notEquals,contains,notContains,startsWith,notStartsWith,greater,lower,greaterEquals,lowerEquals,matchRegex,between,isEmpty,notIsEmpty

description

string

Description of the test.

duration

number

Total duration in millisecond of the test.

error

string

Error returned by the test.

playingTab

enum

Navigate between different tabs for your browser test. Allowed enum values: -1,0,1,2,3

screenshotBucketKey

boolean

Whether or not screenshots where collected by the test.

snapshotBucketKey

boolean

Whether or not snapshots where collected by the test.

skipped

boolean

Whether or not to skip this step.

stepId

number

The step ID.

subTestStepDetails

[object]

If this steps include a sub-test.

browserErrors

[object]

Array of errors collected for a browser test.

description [required]

string

Description of the error.

name [required]

string

Name of the error.

type [required]

enum

Error type returned by a browser test. Allowed enum values: network,js

status

number

Status Code of the error.

checkType

enum

Type of assertion to apply in an API test. Allowed enum values: equals,notEquals,contains,notContains,startsWith,notStartsWith,greater,lower,greaterEquals,lowerEquals,matchRegex,between,isEmpty,notIsEmpty

description

string

Description of the test.

duration

number

Total duration in millisecond of the test.

error

string

Error returned by the test.

playingTab

enum

Navigate between different tabs for your browser test. Allowed enum values: -1,0,1,2,3

screenshotBucketKey

boolean

Whether or not screenshots where collected by the test.

snapshotBucketKey

boolean

Whether or not snapshots where collected by the test.

skipped

boolean

Whether or not to skip this step.

stepId

number

The step ID.

subTestStepDetails

[object]

If this steps include a sub-test.

browserErrors

[object]

Array of errors collected for a browser test.

description [required]

string

Description of the error.

name [required]

string

Name of the error.

type [required]

enum

Error type returned by a browser test. Allowed enum values: network,js

status

number

Status Code of the error.

checkType

enum

Type of assertion to apply in an API test. Allowed enum values: equals,notEquals,contains,notContains,startsWith,notStartsWith,greater,lower,greaterEquals,lowerEquals,matchRegex,between,isEmpty,notIsEmpty

description

string

Description of the test.

duration

number

Total duration in millisecond of the test.

error

string

Error returned by the test.

playingTab

enum

Navigate between different tabs for your browser test. Allowed enum values: -1,0,1,2,3

screenshotBucketKey

boolean

Whether or not screenshots where collected by the test.

snapshotBucketKey

boolean

Whether or not snapshots where collected by the test.

skipped

boolean

Whether or not to skip this step.

stepId

number

The step ID.

subTestStepDetails

[object]

If this steps include a sub-test.

browserErrors

[object]

Array of errors collected for a browser test.

checkType

enum

Type of assertion to apply in an API test. Allowed enum values: equals,notEquals,contains,notContains,startsWith,notStartsWith,greater,lower,greaterEquals,lowerEquals,matchRegex,between,isEmpty,notIsEmpty

description

string

Description of the test.

duration

number

Total duration in millisecond of the test.

error

string

Error returned by the test.

playingTab

enum

Navigate between different tabs for your browser test. Allowed enum values: -1,0,1,2,3

screenshotBucketKey

boolean

Whether or not screenshots where collected by the test.

snapshotBucketKey

boolean

Whether or not snapshots where collected by the test.

skipped

boolean

Whether or not to skip this step.

stepId

number

The step ID.

subTestStepDetails

[object]

If this steps include a sub-test.

timeToInteractive

number

Time before starting the step.

type

enum

Step type used in your Synthetic test. Allowed enum values: assertCurrentUrl,assertElementAttribute,assertElementContent,assertElementPresent,assertEmail,assertFileDownload,assertFromJavascript,assertPageContains,assertPageLacks,click,extractFromJavascript,extractVariable,goToEmailLink,goToUrl,goToUrlAndMeasureTti,hover,playSubTest,pressKey,refresh,runApiTest,scroll,selectOption,typeText,uploadFiles,wait

url

string

URL to perform the step against.

value

object

Value for the step.

vitalsMetrics

[object]

Array of Core Web Vitals metrics for the step.

warnings

[object]

Warning collected that didn't failed the step.

timeToInteractive

number

Time before starting the step.

type

enum

Step type used in your Synthetic test. Allowed enum values: assertCurrentUrl,assertElementAttribute,assertElementContent,assertElementPresent,assertEmail,assertFileDownload,assertFromJavascript,assertPageContains,assertPageLacks,click,extractFromJavascript,extractVariable,goToEmailLink,goToUrl,goToUrlAndMeasureTti,hover,playSubTest,pressKey,refresh,runApiTest,scroll,selectOption,typeText,uploadFiles,wait

url

string

URL to perform the step against.

value

object

Value for the step.

vitalsMetrics

[object]

Array of Core Web Vitals metrics for the step.

url

string

URL attached to the metrics.

cls

number

Cumulative Layout Shift.

lcp

number

Largest Contentful Paint in milliseconds.

warnings

[object]

Warning collected that didn't failed the step.

message [required]

string

Message for the warning.

type [required]

string

User locator used.

timeToInteractive

number

Time before starting the step.

type

enum

Step type used in your Synthetic test. Allowed enum values: assertCurrentUrl,assertElementAttribute,assertElementContent,assertElementPresent,assertEmail,assertFileDownload,assertFromJavascript,assertPageContains,assertPageLacks,click,extractFromJavascript,extractVariable,goToEmailLink,goToUrl,goToUrlAndMeasureTti,hover,playSubTest,pressKey,refresh,runApiTest,scroll,selectOption,typeText,uploadFiles,wait

url

string

URL to perform the step against.

value

object

Value for the step.

vitalsMetrics

[object]

Array of Core Web Vitals metrics for the step.

url

string

URL attached to the metrics.

cls

number

Cumulative Layout Shift.

lcp

number

Largest Contentful Paint in milliseconds.

warnings

[object]

Warning collected that didn't failed the step.

message [required]

string

Message for the warning.

type [required]

string

User locator used.

timeToInteractive

number

Time before starting the step.

type

enum

Step type used in your Synthetic test. Allowed enum values: assertCurrentUrl,assertElementAttribute,assertElementContent,assertElementPresent,assertEmail,assertFileDownload,assertFromJavascript,assertPageContains,assertPageLacks,click,extractFromJavascript,extractVariable,goToEmailLink,goToUrl,goToUrlAndMeasureTti,hover,playSubTest,pressKey,refresh,runApiTest,scroll,selectOption,typeText,uploadFiles,wait

url

string

URL to perform the step against.

value

object

Value for the step.

vitalsMetrics

[object]

Array of Core Web Vitals metrics for the step.

url

string

URL attached to the metrics.

cls

number

Cumulative Layout Shift.

lcp

number

Largest Contentful Paint in milliseconds.

warnings

[object]

Warning collected that didn't failed the step.

message [required]

string

Message for the warning.

type [required]

string

User locator used.

timeToInteractive

number

Time before starting the step.

type

enum

Step type used in your Synthetic test. Allowed enum values: assertCurrentUrl,assertElementAttribute,assertElementContent,assertElementPresent,assertEmail,assertFileDownload,assertFromJavascript,assertPageContains,assertPageLacks,click,extractFromJavascript,extractVariable,goToEmailLink,goToUrl,goToUrlAndMeasureTti,hover,playSubTest,pressKey,refresh,runApiTest,scroll,selectOption,typeText,uploadFiles,wait

url

string

URL to perform the step against.

value

object

Value for the step.

vitalsMetrics

[object]

Array of Core Web Vitals metrics for the step.

url

string

URL attached to the metrics.

cls

number

Cumulative Layout Shift.

lcp

number

Largest Contentful Paint in milliseconds.

warnings

[object]

Warning collected that didn't failed the step.

message [required]

string

Message for the warning.

type [required]

string

User locator used.

timeToInteractive

number

Time before starting the step.

type

enum

Step type used in your Synthetic test. Allowed enum values: assertCurrentUrl,assertElementAttribute,assertElementContent,assertElementPresent,assertEmail,assertFileDownload,assertFromJavascript,assertPageContains,assertPageLacks,click,extractFromJavascript,extractVariable,goToEmailLink,goToUrl,goToUrlAndMeasureTti,hover,playSubTest,pressKey,refresh,runApiTest,scroll,selectOption,typeText,uploadFiles,wait

url

string

URL to perform the step against.

value

object

Value for the step.

vitalsMetrics

[object]

Array of Core Web Vitals metrics for the step.

url

string

URL attached to the metrics.

cls

number

Cumulative Layout Shift.

lcp

number

Largest Contentful Paint in milliseconds.

warnings

[object]

Warning collected that didn't failed the step.

message [required]

string

Message for the warning.

type [required]

string

User locator used.

timeToInteractive

number

Time before starting the step.

type

enum

Step type used in your Synthetic test. Allowed enum values: assertCurrentUrl,assertElementAttribute,assertElementContent,assertElementPresent,assertEmail,assertFileDownload,assertFromJavascript,assertPageContains,assertPageLacks,click,extractFromJavascript,extractVariable,goToEmailLink,goToUrl,goToUrlAndMeasureTti,hover,playSubTest,pressKey,refresh,runApiTest,scroll,selectOption,typeText,uploadFiles,wait

url

string

URL to perform the step against.

value

object

Value for the step.

vitalsMetrics

[object]

Array of Core Web Vitals metrics for the step.

url

string

URL attached to the metrics.

cls

number

Cumulative Layout Shift.

lcp

number

Largest Contentful Paint in milliseconds.

warnings

[object]

Warning collected that didn't failed the step.

message [required]

string

Message for the warning.

type [required]

string

User locator used.

timeToInteractive

number

Time before starting the step.

type

enum

Step type used in your Synthetic test. Allowed enum values: assertCurrentUrl,assertElementAttribute,assertElementContent,assertElementPresent,assertEmail,assertFileDownload,assertFromJavascript,assertPageContains,assertPageLacks,click,extractFromJavascript,extractVariable,goToEmailLink,goToUrl,goToUrlAndMeasureTti,hover,playSubTest,pressKey,refresh,runApiTest,scroll,selectOption,typeText,uploadFiles,wait

url

string

URL to perform the step against.

value

object

Value for the step.

vitalsMetrics

[object]

Array of Core Web Vitals metrics for the step.

url

string

URL attached to the metrics.

cls

number

Cumulative Layout Shift.

lcp

number

Largest Contentful Paint in milliseconds.

warnings

[object]

Warning collected that didn't failed the step.

message [required]

string

Message for the warning.

type [required]

string

User locator used.

timeToInteractive

number

Time before starting the step.

type

enum

Step type used in your Synthetic test. Allowed enum values: assertCurrentUrl,assertElementAttribute,assertElementContent,assertElementPresent,assertEmail,assertFileDownload,assertFromJavascript,assertPageContains,assertPageLacks,click,extractFromJavascript,extractVariable,goToEmailLink,goToUrl,goToUrlAndMeasureTti,hover,playSubTest,pressKey,refresh,runApiTest,scroll,selectOption,typeText,uploadFiles,wait

url

string

URL to perform the step against.

value

object

Value for the step.

vitalsMetrics

[object]

Array of Core Web Vitals metrics for the step.

url

string

URL attached to the metrics.

cls

number

Cumulative Layout Shift.

lcp

number

Largest Contentful Paint in milliseconds.

warnings

[object]

Warning collected that didn't failed the step.

message [required]

string

Message for the warning.

type [required]

string

User locator used.

timeToInteractive

number

Time in second to wait before the browser test starts after reaching the start URL.

thumbnailsBucketKey

boolean

Whether or not a thumbnail is associated with the browser test.