synthetics_test_browser_results

Creates, updates, deletes, gets or lists a synthetics_test_browser_results resource.

Overview

Name	synthetics_test_browser_results
Type	Resource
Id	datadog.monitoring.synthetics_test_browser_results

Fields

The following fields are returned by SELECT queries:

get_synthetics_browser_test_result

Name	Datatype	Description
id	string	The result ID. (example: 5158904793181869365)
attributes	object	Attributes of a Synthetic test result.
relationships	object	Relationships for a Synthetic test result.
type	string	Type of the Synthetic test result resource, result. (result) (default: result, example: result)

list_synthetics_browser_test_latest_results

Name	Datatype	Description
id	string	The result ID. (example: 5158904793181869365)
attributes	object	Attributes of a Synthetic test result summary.
relationships	object	Relationships for a Synthetic test result.
type	string	Type of the Synthetic test result summary resource, result_summary. (result_summary) (default: result_summary, example: result_summary)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_synthetics_browser_test_result	select	public_id, result_id	event_id, timestamp	Get a specific full result from a given Synthetic browser test.
list_synthetics_browser_test_latest_results	select	public_id	from_ts, to_ts, status, run_type, probe_dc, device_id	Get the latest result summaries for a given Synthetic browser test.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
public_id	string	The public ID of the Synthetic browser test for which to search results.
result_id	string	The ID of the result to get.
site	string	The Datadog site (region) for your organization, for example datadoghq.com, us3.datadoghq.com, us5.datadoghq.com, ap1.datadoghq.com, ap2.datadoghq.com, datadoghq.eu, ddog-gov.com. Resolved from the DD_SITE environment variable when set. Optional: defaults to datadoghq.com, or the value of the DD_SITE environment variable when set; a WHERE value overrides both.
device_id	array	Device IDs for which to query results.
event_id	string	The event ID used to look up the result in the event store.
from_ts	integer (int64)	Timestamp in milliseconds from which to start querying results.
probe_dc	array	Locations for which to query results.
run_type	string	Filter results by run type. (wire: runType)
status	string	Filter results by status.
timestamp	integer (int64)	Timestamp in seconds to look up the result.
to_ts	integer (int64)	Timestamp in milliseconds up to which to query results.

SELECT examples

get_synthetics_browser_test_result

Get a specific full result from a given Synthetic browser test.

SELECT
id,
attributes,
relationships,
type
FROM datadog.monitoring.synthetics_test_browser_results
WHERE public_id = '{{ public_id }}' -- required
AND result_id = '{{ result_id }}' -- required
AND event_id = '{{ event_id }}'
AND timestamp = '{{ timestamp }}'
;

list_synthetics_browser_test_latest_results

Get the latest result summaries for a given Synthetic browser test.

SELECT
id,
attributes,
relationships,
type
FROM datadog.monitoring.synthetics_test_browser_results
WHERE public_id = '{{ public_id }}' -- required
AND from_ts = '{{ from_ts }}'
AND to_ts = '{{ to_ts }}'
AND status = '{{ status }}'
AND run_type = '{{ run_type }}'
AND probe_dc = '{{ probe_dc }}'
AND device_id = '{{ device_id }}'
;