synthetics_test_search_results

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

Overview

Name	synthetics_test_search_results
Type	Resource
Id	datadog.monitoring.synthetics_test_search_results

Fields

The following fields are returned by SELECT queries:

search_tests

OK - Returns the list of Synthetic tests matching the search.

Name	Datatype	Description
name	string	Name of the test.
monitor_id	integer (int64)	The associated monitor ID.
public_id	string	The test public ID.
config	object	Configuration object for a Synthetic test.
creator	object	Object describing the creator of the shared element.
locations	array	Array of locations used to run the test.
message	string	Notification message associated with the test.
options	object	Object describing the extra options for a Synthetic test.
status	string	Define whether you want to start (live) or pause (paused) a Synthetic test. (live, paused) (example: live)
subtype	string	The subtype of the Synthetic API test, http, ssl, tcp, dns, icmp, udp, websocket, grpc or multi. (http, ssl, tcp, dns, multi, icmp, udp, websocket, grpc) (example: http)
tags	array	Array of tags attached to the test.
type	string	Type of the Synthetic test. (api, browser, mobile, network)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
search_tests	select		text, include_full_config, facets_only, start, count, sort	Search for Synthetic tests.

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
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.
count	integer (int64)	The maximum number of results to return.
facets_only	boolean	If true, return only facets instead of full test details.
include_full_config	boolean	If true, include the full configuration for each test in the response.
sort	string	The sort order for the results (e.g., name,asc or name,desc).
start	integer (int64)	The offset from which to start returning results.
text	string	The search query.

SELECT examples

search_tests

Search for Synthetic tests.

SELECT
name,
monitor_id,
public_id,
config,
creator,
locations,
message,
options,
status,
subtype,
tags,
type
FROM datadog.monitoring.synthetics_test_search_results
WHERE text = '{{ text }}'
AND include_full_config = '{{ include_full_config }}'
AND facets_only = '{{ facets_only }}'
AND start = '{{ start }}'
AND count = '{{ count }}'
AND sort = '{{ sort }}'
;