--- title: Get a trace by ID description: Retrieve a full APM trace by its trace ID, including every span in the trace. breadcrumbs: Docs > API > Get a trace by ID --- > For the complete documentation index, see [llms.txt](https://dnd37xeb23o8n.cloudfront.net/jen.gilbert/astro-base/llms.txt). # Get a trace by ID ## v2 (latest) {% alert level="warning" %} **Note**: This endpoint is in preview and is subject to change. If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help.md). {% /alert %} | Datadog site | API endpoint | | ----------------- | --------------------------------------------------------- | | app.datadoghq.com | GET https://api.datadoghq.com/api/v2/trace/{trace_id} | | us3.datadoghq.com | GET https://api.us3.datadoghq.com/api/v2/trace/{trace_id} | | us5.datadoghq.com | GET https://api.us5.datadoghq.com/api/v2/trace/{trace_id} | | app.datadoghq.eu | GET https://api.datadoghq.eu/api/v2/trace/{trace_id} | | ap1.datadoghq.com | GET https://api.ap1.datadoghq.com/api/v2/trace/{trace_id} | | ap2.datadoghq.com | GET https://api.ap2.datadoghq.com/api/v2/trace/{trace_id} | | uk1.datadoghq.com | GET https://api.uk1.datadoghq.com/api/v2/trace/{trace_id} | | app.ddog-gov.com | GET https://api.ddog-gov.com/api/v2/trace/{trace_id} | | us2.ddog-gov.com | GET https://api.us2.ddog-gov.com/api/v2/trace/{trace_id} | ### Overview Retrieve a full APM trace by its trace ID, including every span in the trace. Traces are returned from live storage when available and fall back to longer-term storage. A `400 Bad Request` response means the trace ID is malformed. A `404 Not Found` response means no trace with this ID is available, such as when the trace is outside the retention period. This endpoint is rate limited to `60` requests per minute per organization. This endpoint requires the `apm_read` permission. OAuth apps require the `apm_read` authorization [scope](https://dnd37xeb23o8n.cloudfront.net/jen.gilbert/astro-base/api/latest/scopes.md#apm-trace) to access this endpoint. ### Arguments #### Path Parameters | Field | Type | Description | | --------------------- | ------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | trace_id [*required*] | string | The trace ID. Accepts either a hexadecimal string of up to 32 characters (128-bit trace ID) or a decimal string of up to 39 digits. Hexadecimal IDs are case-insensitive, and shorter values are left-padded with zeros. Use the `trace_id` attribute of a span returned by the Search spans or Get a list of spans endpoints. Values in any other format, such as UUIDs, return `400 Bad Request`. A well-formed ID with no matching trace returns `404 Not Found`. | #### Query Strings | Field | Type | Description | | -------------- | ----- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | include_fields | array | List of span fields to include in the response. When omitted, every available field is returned. Values may be passed as repeated query parameters or as a single comma-separated value. | ### Response {% tabs %} {% tab label="200" %} OK {% tabs %} {% tab label="Model" %} Response containing a single trace. | Parent field | Field | Type | Description | | -------------------- | ------------------------- | -------- | ----------------------------------------------------------------------------------------------------- | | | data [*required*] | object | A trace resource document. | | data | attributes [*required*] | object | The attributes of a trace returned by the Get trace by ID endpoint. | | attributes | is_truncated [*required*] | boolean | Indicates whether the trace was truncated because its size exceeded the maximum response payload. | | attributes | spans [*required*] | [object] | The list of spans that compose the trace. | | spans | duration [*required*] | int64 | The duration of the span, in nanoseconds. | | spans | endTime [*required*] | int64 | The end time of the span, in Unix nanoseconds. | | spans | error [*required*] | enum | Error flag for a span. `1` when the span is in error, `0` otherwise. Allowed enum values: `0`, `1`. | | spans | meta [*required*] | object | String-valued tags attached to the span. Tag keys starting with `_` are filtered out of the response. | | additionalProperties | | string | | | spans | metrics [*required*] | object | Numeric metrics attached to the span. Metric keys starting with `_` are filtered out of the response. | | additionalProperties | | double | | | spans | name [*required*] | string | The operation name of the span. | | spans | parentID [*required*] | int64 | The ID of the parent span, or `0` when the span is a trace root. | | spans | resource [*required*] | string | The resource that the span describes. | | spans | resourceHash | string | A hash of the resource field. | | spans | restricted | boolean | Whether access to the span is restricted by the organization's data access policies. | | spans | self_time | double | The time spent in the span itself, excluding time spent in child spans, in nanoseconds. | | spans | service [*required*] | string | The name of the service that emitted the span. | | spans | spanID [*required*] | int64 | The span ID, as an unsigned 64-bit integer. | | spans | startTime [*required*] | int64 | The start time of the span, in Unix nanoseconds. | | spans | traceID [*required*] | int64 | The lower 64 bits of the trace ID, as an unsigned 64-bit integer. | | spans | traceIDFull [*required*] | string | The full 128-bit trace ID, encoded as a 32-character hexadecimal string. | | spans | type [*required*] | string | The type of the span (for example, `web`, `db`, or `rpc`). | | data | id [*required*] | string | The full 128-bit trace ID, encoded as a 32-character hexadecimal string. | | data | type [*required*] | enum | The type of the trace resource. The value is always `trace`. Allowed enum values: `trace`. | {% /tab %} {% tab label="Example" %} ```json { "data": { "attributes": { "is_truncated": false, "spans": [ { "duration": 500000000, "endTime": 1716800000500000000, "error": 0, "meta": { "": "string" }, "metrics": { "": "number" }, "name": "web.request", "parentID": 0, "resource": "GET /products", "resourceHash": "6a4e9b7f", "restricted": false, "self_time": 250000000, "service": "web-store", "spanID": 9876543210987655000, "startTime": 1716800000000000000, "traceID": 12345678901234567000, "traceIDFull": "0000000000000000abc1230000000000", "type": "web" } ] }, "id": "0000000000000000abc1230000000000", "type": "trace" } } ``` {% /tab %} {% /tabs %} {% /tab %} {% tab label="400" %} Bad Request {% tabs %} {% tab label="Model" %} API error response. | Parent field | Field | Type | Description | | ------------ | ------------------- | -------- | ------------------------------------------------------------------------------- | | | errors [*required*] | [object] | A list of errors. | | errors | detail | string | A human-readable explanation specific to this occurrence of the error. | | errors | meta | object | Non-standard meta-information about the error | | errors | source | object | References to the source of the error. | | source | header | string | A string indicating the name of a single request header which caused the error. | | source | parameter | string | A string indicating which URI query parameter caused the error. | | source | pointer | string | A JSON pointer to the value in the request document that caused the error. | | errors | status | string | Status code of the response. | | errors | title | string | Short human-readable summary of the error. | {% /tab %} {% tab label="Example" %} ```json { "errors": [ { "detail": "Missing required attribute in body", "meta": {}, "source": { "header": "Authorization", "parameter": "limit", "pointer": "/data/attributes/title" }, "status": "400", "title": "Bad Request" } ] } ``` {% /tab %} {% /tabs %} {% /tab %} {% tab label="403" %} Forbidden {% tabs %} {% tab label="Model" %} API error response. | Parent field | Field | Type | Description | | ------------ | ------------------- | -------- | ------------------------------------------------------------------------------- | | | errors [*required*] | [object] | A list of errors. | | errors | detail | string | A human-readable explanation specific to this occurrence of the error. | | errors | meta | object | Non-standard meta-information about the error | | errors | source | object | References to the source of the error. | | source | header | string | A string indicating the name of a single request header which caused the error. | | source | parameter | string | A string indicating which URI query parameter caused the error. | | source | pointer | string | A JSON pointer to the value in the request document that caused the error. | | errors | status | string | Status code of the response. | | errors | title | string | Short human-readable summary of the error. | {% /tab %} {% tab label="Example" %} ```json { "errors": [ { "detail": "Missing required attribute in body", "meta": {}, "source": { "header": "Authorization", "parameter": "limit", "pointer": "/data/attributes/title" }, "status": "400", "title": "Bad Request" } ] } ``` {% /tab %} {% /tabs %} {% /tab %} {% tab label="404" %} Not Found {% tabs %} {% tab label="Model" %} API error response. | Parent field | Field | Type | Description | | ------------ | ------------------- | -------- | ------------------------------------------------------------------------------- | | | errors [*required*] | [object] | A list of errors. | | errors | detail | string | A human-readable explanation specific to this occurrence of the error. | | errors | meta | object | Non-standard meta-information about the error | | errors | source | object | References to the source of the error. | | source | header | string | A string indicating the name of a single request header which caused the error. | | source | parameter | string | A string indicating which URI query parameter caused the error. | | source | pointer | string | A JSON pointer to the value in the request document that caused the error. | | errors | status | string | Status code of the response. | | errors | title | string | Short human-readable summary of the error. | {% /tab %} {% tab label="Example" %} ```json { "errors": [ { "detail": "Missing required attribute in body", "meta": {}, "source": { "header": "Authorization", "parameter": "limit", "pointer": "/data/attributes/title" }, "status": "400", "title": "Bad Request" } ] } ``` {% /tab %} {% /tabs %} {% /tab %} {% tab label="413" %} Payload Too Large {% tabs %} {% tab label="Model" %} API error response. | Parent field | Field | Type | Description | | ------------ | ------------------- | -------- | ------------------------------------------------------------------------------- | | | errors [*required*] | [object] | A list of errors. | | errors | detail | string | A human-readable explanation specific to this occurrence of the error. | | errors | meta | object | Non-standard meta-information about the error | | errors | source | object | References to the source of the error. | | source | header | string | A string indicating the name of a single request header which caused the error. | | source | parameter | string | A string indicating which URI query parameter caused the error. | | source | pointer | string | A JSON pointer to the value in the request document that caused the error. | | errors | status | string | Status code of the response. | | errors | title | string | Short human-readable summary of the error. | {% /tab %} {% tab label="Example" %} ```json { "errors": [ { "detail": "Missing required attribute in body", "meta": {}, "source": { "header": "Authorization", "parameter": "limit", "pointer": "/data/attributes/title" }, "status": "400", "title": "Bad Request" } ] } ``` {% /tab %} {% /tabs %} {% /tab %} {% tab label="429" %} Too many requests {% tabs %} {% tab label="Model" %} API error response. | Field | Type | Description | | ------------------- | -------- | ----------------- | | errors [*required*] | [string] | A list of errors. | {% /tab %} {% tab label="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tabs %} {% /tab %} {% /tabs %} ### Code Example {% tabs %} {% tab label="Curl" %} ```bash # Path parameters export trace_id="0000000000000000abc1230000000000" # Set your Datadog site and credentials export DD_SITE="datadoghq.com" # Or us3.datadoghq.com, us5.datadoghq.com, datadoghq.eu, ap1.datadoghq.com, ap2.datadoghq.com, uk1.datadoghq.com, ddog-gov.com, us2.ddog-gov.com # Use a Personal Access Token or Service Access Token export DD_BEARER_TOKEN="" curl -X GET "https://api.${DD_SITE}/api/v2/trace/${trace_id}" \ -H "Accept: application/json" \ -H "Authorization: Bearer ${DD_BEARER_TOKEN}" ``` {% /tab %} {% tab label="Go" %} ```go // Get a trace by ID 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/datadogV2" ) func main() { ctx := datadog.NewDefaultContext(context.Background()) ctx = context.WithValue(ctx, datadog.ContextAccessToken, os.Getenv("DD_BEARER_TOKEN")) configuration := datadog.NewConfiguration() configuration.SetUnstableOperationEnabled("v2.GetTraceByID", true) apiClient := datadog.NewAPIClient(configuration) api := datadogV2.NewAPMTraceApi(apiClient) resp, r, err := api.GetTraceByID(ctx, "trace_id", *datadogV2.NewGetTraceByIDOptionalParameters()) if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `APMTraceApi.GetTraceByID`: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } responseContent, _ := json.MarshalIndent(resp, "", " ") fmt.Fprintf(os.Stdout, "Response from `APMTraceApi.GetTraceByID`:\n%s\n", responseContent) } ``` #### Instructions First [install the library and its dependencies](https://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=go) and then save the example to `main.go` and run following commands: ```bash DD_SITE="datadoghq.com" DD_BEARER_TOKEN="" go run "main.go" ``` {% /tab %} {% tab label="Java" %} ```java // Get a trace by ID returns "OK" response import com.datadog.api.client.ApiClient; import com.datadog.api.client.ApiException; import com.datadog.api.client.v2.api.ApmTraceApi; import com.datadog.api.client.v2.model.TraceResponse; public class Example { public static void main(String[] args) { ApiClient defaultClient = ApiClient.getDefaultApiClient(); defaultClient.setAccessToken(System.getenv("DD_BEARER_TOKEN")); defaultClient.setUnstableOperationEnabled("v2.getTraceByID", true); ApmTraceApi apiInstance = new ApmTraceApi(defaultClient); try { TraceResponse result = apiInstance.getTraceByID("0000000000000000abc1230000000000"); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling ApmTraceApi#getTraceByID"); 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://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=java) and then save the example to `Example.java` and run following commands: ```bash DD_SITE="datadoghq.com" DD_BEARER_TOKEN="" java "Example.java" ``` {% /tab %} {% tab label="Python" %} ```python """ Get a trace by ID returns "OK" response """ from os import environ from datadog_api_client import ApiClient, Configuration from datadog_api_client.v2.api.apm_trace_api import APMTraceApi configuration = Configuration() configuration.access_token = environ["DD_BEARER_TOKEN"] configuration.unstable_operations["get_trace_by_id"] = True with ApiClient(configuration) as api_client: api_instance = APMTraceApi(api_client) response = api_instance.get_trace_by_id( trace_id="trace_id", ) print(response) ``` #### Instructions First [install the library and its dependencies](https://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=python) and then save the example to `example.py` and run following commands: ```bash DD_SITE="datadoghq.com" DD_BEARER_TOKEN="" python3 "example.py" ``` {% /tab %} {% tab label="Ruby" %} ```ruby # Get a trace by ID returns "OK" response require "datadog_api_client" DatadogAPIClient.configure do |config| config.access_token = ENV["DD_BEARER_TOKEN"] config.unstable_operations["v2.get_trace_by_id".to_sym] = true end api_instance = DatadogAPIClient::V2::APMTraceAPI.new p api_instance.get_trace_by_id("trace_id") ``` #### Instructions First [install the library and its dependencies](https://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=ruby) and then save the example to `example.rb` and run following commands: ```bash DD_SITE="datadoghq.com" DD_BEARER_TOKEN="" rb "example.rb" ``` {% /tab %} {% tab label="Rust" %} ```rust // Get a trace by ID returns "OK" response use datadog_api_client::datadog; use datadog_api_client::datadogV2::api_apm_trace::APMTraceAPI; use datadog_api_client::datadogV2::api_apm_trace::GetTraceByIDOptionalParams; #[tokio::main] async fn main() { let mut configuration = datadog::Configuration::new(); configuration.set_unstable_operation_enabled("v2.get_trace_by_id", true); let api = APMTraceAPI::with_config(configuration); let resp = api .get_trace_by_id( "trace_id".to_string(), GetTraceByIDOptionalParams::default(), ) .await; if let Ok(value) = resp { println!("{:#?}", value); } else { println!("{:#?}", resp.unwrap_err()); } } ``` #### Instructions First [install the library and its dependencies](https://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=rust) and then save the example to `src/main.rs` and run following commands: ```bash DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" cargo run ``` {% /tab %} {% tab label="TypeScript" %} ```typescript /** * Get a trace by ID returns "OK" response */ import { client, v2 } from "@datadog/datadog-api-client"; const configuration = client.createConfiguration({ authMethods: { AuthZ: { accessToken: process.env.DD_BEARER_TOKEN as string, }, }, }); configuration.unstableOperations["v2.getTraceByID"] = true; const apiInstance = new v2.APMTraceApi(configuration); const params: v2.APMTraceApiGetTraceByIDRequest = { traceId: "trace_id", }; apiInstance .getTraceByID(params) .then((data: v2.TraceResponse) => { 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://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=typescript) and then save the example to `example.ts` and run following commands: ```bash DD_SITE="datadoghq.com" DD_BEARER_TOKEN="" tsc "example.ts" ``` {% /tab %} {% /tabs %}