synthetics_ci_batches

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

Overview

Name	synthetics_ci_batches
Type	Resource
Id	datadog.monitoring.synthetics_ci_batches

Fields

The following fields are returned by SELECT queries:

get_synthetics_cibatch

Name	Datatype	Description
metadata	object	Metadata for the Synthetic tests run.
results	array	List of results for the batch.
status	string	Determines whether the batch has passed, failed, or is in progress. (passed, skipped, failed)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_synthetics_cibatch	select	batch_id		Get a batch's updated details.

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
batch_id	string	The ID of the batch.
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.

SELECT examples

get_synthetics_cibatch

Get a batch's updated details.

SELECT
metadata,
results,
status
FROM datadog.monitoring.synthetics_ci_batches
WHERE batch_id = '{{ batch_id }}' -- required
;