synthetics_api_test_results

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

Overview

Name	synthetics_api_test_results
Type	Resource
Id	datadog.monitoring.synthetics_api_test_results

Fields

The following fields are returned by SELECT queries:

get_apitest_result

Name	Datatype	Description
result_id	string	ID of the API test result.
check	object	Object describing the API test configuration.
check_time	number (double)	When the API test was conducted.
check_version	integer (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.
status	integer (int64)	The status of your Synthetic monitor. * O for not triggered * 1 for triggered * 2 for no data (0, 1, 2)

get_apitest_latest_results

Name	Datatype	Description
result_id	string	ID of the API test result.
check_time	number (double)	Last time the API test was performed.
probe_dc	string	Location from which the API test was performed.
result	object	Result of the last API test run.
status	integer (int64)	The status of your Synthetic monitor. * O for not triggered * 1 for triggered * 2 for no data (0, 1, 2)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_apitest_result	select	public_id, result_id		Get a specific full result from a given Synthetic API test.
get_apitest_latest_results	select	public_id	from_ts, to_ts, probe_dc	Get the last 150 test results summaries for a given Synthetic API 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 test for which to search results for.
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.
from_ts	integer (int64)	Timestamp in milliseconds from which to start querying results.
probe_dc	array	Locations for which to query results.
to_ts	integer (int64)	Timestamp in milliseconds up to which to query results.

SELECT examples

get_apitest_result

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

SELECT
result_id,
check,
check_time,
check_version,
probe_dc,
result,
status
FROM datadog.monitoring.synthetics_api_test_results
WHERE public_id = '{{ public_id }}' -- required
AND result_id = '{{ result_id }}' -- required
;

get_apitest_latest_results

Get the last 150 test results summaries for a given Synthetic API test.

SELECT
result_id,
check_time,
probe_dc,
result,
status
FROM datadog.monitoring.synthetics_api_test_results
WHERE public_id = '{{ public_id }}' -- required
AND from_ts = '{{ from_ts }}'
AND to_ts = '{{ to_ts }}'
AND probe_dc = '{{ probe_dc }}'
;