Skip to main content

synthetics_test_poll_results

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

Overview

Namesynthetics_test_poll_results
TypeResource
Iddatadog.monitoring.synthetics_test_poll_results

Fields

The following fields are returned by SELECT queries:

NameDatatypeDescription
idstringThe result ID. (example: 5158904793181869365)
attributesobjectAttributes of a Synthetic test result.
relationshipsobjectRelationships for a Synthetic test result.
typestringType of the Synthetic test result resource, result. (result) (default: result, example: result)

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
poll_synthetics_test_resultsselectresult_idsPoll for test results given a list of result IDs. This is typically used after<br />triggering tests with CI/CD to retrieve results once they are available.

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.

NameDatatypeDescription
result_idsstringA JSON-encoded array of result IDs to poll for. (example: ["id1","id2","id3"])
sitestringThe 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.

SELECT examples

Poll for test results given a list of result IDs. This is typically used after<br />triggering tests with CI/CD to retrieve results once they are available.

SELECT
id,
attributes,
relationships,
type
FROM datadog.monitoring.synthetics_test_poll_results
WHERE result_ids = '{{ result_ids }}' -- required
;