--- title: Get details of batch description: Datadog, the leading service for cloud-scale monitoring. breadcrumbs: Docs > API Reference > Synthetics --- # Get details of batch{% #get-details-of-batch %} Copy pageCopied {% tab title="v1" %} | Datadog site | API endpoint | | ----------------- | ----------------------------------------------------------------------- | | ap1.datadoghq.com | GET https://api.ap1.datadoghq.com/api/v1/synthetics/ci/batch/{batch_id} | | ap2.datadoghq.com | GET https://api.ap2.datadoghq.com/api/v1/synthetics/ci/batch/{batch_id} | | app.datadoghq.eu | GET https://api.datadoghq.eu/api/v1/synthetics/ci/batch/{batch_id} | | app.ddog-gov.com | GET https://api.ddog-gov.com/api/v1/synthetics/ci/batch/{batch_id} | | us2.ddog-gov.com | GET https://api.us2.ddog-gov.com/api/v1/synthetics/ci/batch/{batch_id} | | app.datadoghq.com | GET https://api.datadoghq.com/api/v1/synthetics/ci/batch/{batch_id} | | us3.datadoghq.com | GET https://api.us3.datadoghq.com/api/v1/synthetics/ci/batch/{batch_id} | | us5.datadoghq.com | GET https://api.us5.datadoghq.com/api/v1/synthetics/ci/batch/{batch_id} | ### Overview Get a batch's updated details. This endpoint requires the `synthetics_read` permission. OAuth apps require the `synthetics_read` authorization [scope](https://docs.datadoghq.com/api/latest/scopes.md#synthetics) to access this endpoint. ### Arguments #### Path Parameters | Name | Type | Description | | -------------------------- | ------ | -------------------- | | batch_id [*required*] | string | The ID of the batch. | ### Response {% tab title="200" %} OK {% tab title="Model" %} Details about a batch response. | Parent field | Field | Type | Description | | ------------ | -------------- | -------- | ---------------------------------------------------------------------------------------------------------------- | | | data | object | Wrapper object that contains the details of a batch. | | data | metadata | object | Metadata for the Synthetic tests run. | | metadata | ci | object | Description of the CI provider. | | ci | pipeline | object | Description of the CI pipeline. | | pipeline | url | string | URL of the pipeline. | | ci | provider | object | Description of the CI provider. | | provider | name | string | Name of the CI provider. | | metadata | git | object | Git information. | | git | branch | string | Branch name. | | git | commitSha | string | The commit SHA. | | data | results | [object] | List of results for the batch. | | results | device | string | The device ID. | | results | duration | double | Total duration in millisecond of the test. | | results | execution_rule | enum | Execution rule for a Synthetic test. Allowed enum values: `blocking,non_blocking,skipped` | | results | location | string | Name of the location. | | results | result_id | string | The ID of the result to get. | | results | retries | double | Number of times this result has been retried. | | results | status | enum | Determines whether the batch has passed, failed, or is in progress. Allowed enum values: `passed,skipped,failed` | | results | test_name | string | Name of the test. | | results | test_public_id | string | The public ID of the Synthetic test. | | results | test_type | enum | Type of the Synthetic test. Allowed enum values: `api,browser,mobile,network` | | data | status | enum | Determines whether the batch has passed, failed, or is in progress. Allowed enum values: `passed,skipped,failed` | {% /tab %} {% tab title="Example" %} ```json { "data": { "metadata": { "ci": { "pipeline": { "url": "string" }, "provider": { "name": "string" } }, "git": { "branch": "string", "commitSha": "string" } }, "results": [ { "device": "chrome.laptop_large", "duration": "number", "execution_rule": "blocking", "location": "string", "result_id": "string", "retries": "number", "status": "string", "test_name": "string", "test_public_id": "string", "test_type": "string" } ], "status": "string" } } ``` {% /tab %} {% /tab %} {% tab title="404" %} Batch does not exist. {% tab title="Model" %} Error response object. | Field | Type | Description | | ------------------------ | -------- | ------------------------------------ | | errors [*required*] | [string] | Array of errors returned by the API. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tab %} {% tab title="429" %} Too many requests {% tab title="Model" %} Error response object. | Field | Type | Description | | ------------------------ | -------- | ------------------------------------ | | errors [*required*] | [string] | Array of errors returned by the API. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tab %} ### Code Example ##### \# Path parameters export batch_id="CHANGE_ME" \# Curl command curl -X GET "https://api.datadoghq.com/api/v1/synthetics/ci/batch/${batch_id}" \ -H "Accept: application/json" \ -H "DD-API-KEY: ${DD_API_KEY}" \ -H "DD-APPLICATION-KEY: ${DD_APP_KEY}" ##### ```python """ Get details of batch returns "OK" response """ from datadog_api_client import ApiClient, Configuration from datadog_api_client.v1.api.synthetics_api import SyntheticsApi configuration = Configuration() with ApiClient(configuration) as api_client: api_instance = SyntheticsApi(api_client) response = api_instance.get_synthetics_ci_batch( batch_id="batch_id", ) print(response) ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=python) and then save the example to `example.py` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" python3 "example.py" ##### ```ruby # Get details of batch returns "OK" response require "datadog_api_client" api_instance = DatadogAPIClient::V1::SyntheticsAPI.new p api_instance.get_synthetics_ci_batch("batch_id") ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=ruby) and then save the example to `example.rb` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" rb "example.rb" ##### ```go // Get details of batch returns "OK" response package main import ( "context" "encoding/json" "fmt" "os" "github.com/DataDog/datadog-api-client-go/v2/api/datadog" "github.com/DataDog/datadog-api-client-go/v2/api/datadogV1" ) func main() { ctx := datadog.NewDefaultContext(context.Background()) configuration := datadog.NewConfiguration() apiClient := datadog.NewAPIClient(configuration) api := datadogV1.NewSyntheticsApi(apiClient) resp, r, err := api.GetSyntheticsCIBatch(ctx, "batch_id") if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `SyntheticsApi.GetSyntheticsCIBatch`: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } responseContent, _ := json.MarshalIndent(resp, "", " ") fmt.Fprintf(os.Stdout, "Response from `SyntheticsApi.GetSyntheticsCIBatch`:\n%s\n", responseContent) } ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=go) and then save the example to `main.go` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" go run "main.go" ##### ```java // Get details of batch returns "OK" response import com.datadog.api.client.ApiClient; import com.datadog.api.client.ApiException; import com.datadog.api.client.v1.api.SyntheticsApi; import com.datadog.api.client.v1.model.SyntheticsBatchDetails; public class Example { public static void main(String[] args) { ApiClient defaultClient = ApiClient.getDefaultApiClient(); SyntheticsApi apiInstance = new SyntheticsApi(defaultClient); try { SyntheticsBatchDetails result = apiInstance.getSyntheticsCIBatch("batch_id"); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling SyntheticsApi#getSyntheticsCIBatch"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=java) and then save the example to `Example.java` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" java "Example.java" ##### ```rust // Get details of batch returns "OK" response use datadog_api_client::datadog; use datadog_api_client::datadogV1::api_synthetics::SyntheticsAPI; #[tokio::main] async fn main() { let configuration = datadog::Configuration::new(); let api = SyntheticsAPI::with_config(configuration); let resp = api.get_synthetics_ci_batch("batch_id".to_string()).await; if let Ok(value) = resp { println!("{:#?}", value); } else { println!("{:#?}", resp.unwrap_err()); } } ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=rust) and then save the example to `src/main.rs` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" cargo run ##### ```typescript /** * Get details of batch returns "OK" response */ import { client, v1 } from "@datadog/datadog-api-client"; const configuration = client.createConfiguration(); const apiInstance = new v1.SyntheticsApi(configuration); const params: v1.SyntheticsApiGetSyntheticsCIBatchRequest = { batchId: "batch_id", }; apiInstance .getSyntheticsCIBatch(params) .then((data: v1.SyntheticsBatchDetails) => { console.log( "API called successfully. Returned data: " + JSON.stringify(data) ); }) .catch((error: any) => console.error(error)); ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=typescript) and then save the example to `example.ts` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" tsc "example.ts" {% /tab %}