--- title: Get a pruned trace by ID description: Datadog, the leading service for cloud-scale monitoring. breadcrumbs: Docs > API Reference > APM Trace --- # Get a pruned trace by ID{% #get-a-pruned-trace-by-id %} Copy pageCopied {% tab title="v2" %} **Note**: This endpoint is in preview and is subject to change. If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). | Datadog site | API endpoint | | ----------------- | ---------------------------------------------------------------- | | ap1.datadoghq.com | GET https://api.ap1.datadoghq.com/api/v2/pruned_trace/{trace_id} | | ap2.datadoghq.com | GET https://api.ap2.datadoghq.com/api/v2/pruned_trace/{trace_id} | | app.datadoghq.eu | GET https://api.datadoghq.eu/api/v2/pruned_trace/{trace_id} | | app.ddog-gov.com | GET https://api.ddog-gov.com/api/v2/pruned_trace/{trace_id} | | us2.ddog-gov.com | GET https://api.us2.ddog-gov.com/api/v2/pruned_trace/{trace_id} | | app.datadoghq.com | GET https://api.datadoghq.com/api/v2/pruned_trace/{trace_id} | | us3.datadoghq.com | GET https://api.us3.datadoghq.com/api/v2/pruned_trace/{trace_id} | | us5.datadoghq.com | GET https://api.us5.datadoghq.com/api/v2/pruned_trace/{trace_id} | ### Overview Retrieve a pruned, hierarchical view of an APM trace by its trace ID. The trace is summarized as a tree of spans rooted at the trace root and reduced in size to keep rendering large traces in the UI practical. 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://docs.datadoghq.com/api/latest/scopes.md#apm-trace) to access this endpoint. ### Arguments #### Path Parameters | Name | Type | Description | | -------------------------- | ------ | ------------------------------------------------------------------------------------------------------------------------- | | trace_id [*required*] | string | The trace ID. Accepts either a 32-character hexadecimal string (128-bit trace ID) or a decimal string of up to 39 digits. | #### Query Strings | Name | Type | Description | | ------------------------ | ------- | ---------------------------------------------------------------------------------------------------------------------------------- | | expand_span_id | integer | Span ID to expand and preserve in the pruned tree even when its branch would normally be summarized. | | time_hint | integer | Optional Unix time hint, in seconds, used to optimize the lookup of the trace in long-term storage. | | force_source | string | Force the trace to be loaded from a specific source. When unset, the API picks the source automatically. | | include_path | array | Restrict the pruned tree to spans matching the given `key:value` pairs. Values may be passed as repeated query parameters. | | tag_include | array | Regex patterns of tag keys whose values must be included in the pruned spans. Values may be passed as repeated query parameters. | | tag_exclude | array | Regex patterns of tag keys whose values must be excluded from the pruned spans. Values may be passed as repeated query parameters. | | only_service_entry_spans | boolean | When set to `true`, only service entry spans are included in the pruned tree. | ### Response {% tab title="200" %} OK {% tab title="Model" %} Response containing a single pruned trace. | Parent field | Field | Type | Description | | -------------------- | ------------------------------------------ | --------- | ------------------------------------------------------------------------------------------------------------------------------ | | | data [*required*] | object | A pruned trace resource document. | | data | attributes [*required*] | object | The attributes of a pruned trace returned by the Get pruned trace by ID endpoint. | | attributes | is_truncated [*required*] | boolean | Indicates whether the underlying trace was truncated because its size exceeded the maximum that can be retrieved from storage. | | attributes | size_bytes [*required*] | int32 | The size, in bytes, of the original (non-pruned) trace before summarization. | | attributes | summarized_trace [*required*] | object | A summarized, hierarchical view of a trace. | | summarized_trace | root [*required*] | object | A node in the pruned trace tree. | | root | children [*required*] | [object] | The child spans of this node in the pruned tree. | | root | durationSeconds [*required*] | double | The duration of the span, in seconds. | | root | endTime [*required*] | date-time | The end time of the span, in RFC3339 format. | | root | error [*required*] | enum | Error flag for a span. `1` when the span is in error, `0` otherwise. Allowed enum values: `0,1` | | root | hidden_child_spans_count [*required*] | int32 | The number of child spans that were pruned from this node when summarizing the trace. | | root | meta [*required*] | object | String-valued tags attached to the span. | | additionalProperties | | string | | root | metrics [*required*] | object | Numeric metrics attached to the span. | | additionalProperties | | double | | root | name [*required*] | string | The operation name of the span. | | root | parentID [*required*] | int64 | The ID of the parent span, or `0` when the span is the trace root. | | root | resource [*required*] | string | The resource that the span describes. | | root | service [*required*] | string | The name of the service that emitted the span. | | root | spanID [*required*] | int64 | The span ID, as an unsigned 64-bit integer. | | root | span_kind [*required*] | string | The OpenTelemetry span kind, for example `INTERNAL`, `SERVER`, `CLIENT`, `PRODUCER`, or `CONSUMER`. | | root | startTime [*required*] | date-time | The start time of the span, in RFC3339 format. | | summarized_trace | traceId [*required*] | string | The full 128-bit trace ID, encoded as a 32-character hexadecimal string. | | 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 pruned trace resource. The value is always `pruned_trace`. Allowed enum values: `pruned_trace` | {% /tab %} {% tab title="Example" %} ```json { "data": { "attributes": { "is_truncated": false, "size_bytes": 12345, "summarized_trace": { "root": { "children": [ [] ], "durationSeconds": 0.5, "endTime": "2026-05-27T12:00:00.5Z", "error": 0, "hidden_child_spans_count": 0, "meta": { "": "string" }, "metrics": { "": "number" }, "name": "web.request", "parentID": 0, "resource": "GET /products", "service": "web-store", "spanID": 9876543210987655000, "span_kind": "SERVER", "startTime": "2026-05-27T12:00:00Z" }, "traceId": "0000000000000000abc1230000000000" } }, "id": "0000000000000000abc1230000000000", "type": "pruned_trace" } } ``` {% /tab %} {% /tab %} {% tab title="403" %} Forbidden {% tab title="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 title="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 %} {% /tab %} {% tab title="404" %} Not Found {% tab title="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 title="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 %} {% /tab %} {% tab title="429" %} Too many requests {% tab title="Model" %} API error response. | Field | Type | Description | | ------------------------ | -------- | ----------------- | | errors [*required*] | [string] | A list of errors. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tab %} {% tab title="504" %} Gateway Timeout {% tab title="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 title="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 %} {% /tab %} ### Code Example ##### \# Path parameters export trace_id="0000000000000000abc1230000000000" \# Curl command curl -X GET "https://api.datadoghq.com/api/v2/pruned_trace/${trace_id}" \ -H "Accept: application/json" \ -H "DD-API-KEY: ${DD_API_KEY}" \ -H "DD-APPLICATION-KEY: ${DD_APP_KEY}" ##### ```python """ Get a pruned trace by ID returns "OK" response """ from datadog_api_client import ApiClient, Configuration from datadog_api_client.v2.api.apm_trace_api import APMTraceApi configuration = Configuration() configuration.unstable_operations["get_pruned_trace_by_id"] = True with ApiClient(configuration) as api_client: api_instance = APMTraceApi(api_client) response = api_instance.get_pruned_trace_by_id( trace_id="trace_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 a pruned trace by ID returns "OK" response require "datadog_api_client" DatadogAPIClient.configure do |config| config.unstable_operations["v2.get_pruned_trace_by_id".to_sym] = true end api_instance = DatadogAPIClient::V2::APMTraceAPI.new p api_instance.get_pruned_trace_by_id("trace_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 a pruned 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()) configuration := datadog.NewConfiguration() configuration.SetUnstableOperationEnabled("v2.GetPrunedTraceByID", true) apiClient := datadog.NewAPIClient(configuration) api := datadogV2.NewAPMTraceApi(apiClient) resp, r, err := api.GetPrunedTraceByID(ctx, "trace_id", *datadogV2.NewGetPrunedTraceByIDOptionalParameters()) if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `APMTraceApi.GetPrunedTraceByID`: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } responseContent, _ := json.MarshalIndent(resp, "", " ") fmt.Fprintf(os.Stdout, "Response from `APMTraceApi.GetPrunedTraceByID`:\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 a pruned 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.PrunedTraceResponse; public class Example { public static void main(String[] args) { ApiClient defaultClient = ApiClient.getDefaultApiClient(); defaultClient.setUnstableOperationEnabled("v2.getPrunedTraceByID", true); ApmTraceApi apiInstance = new ApmTraceApi(defaultClient); try { PrunedTraceResponse result = apiInstance.getPrunedTraceByID("0000000000000000abc1230000000000"); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling ApmTraceApi#getPrunedTraceByID"); 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 a pruned 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::GetPrunedTraceByIDOptionalParams; #[tokio::main] async fn main() { let mut configuration = datadog::Configuration::new(); configuration.set_unstable_operation_enabled("v2.GetPrunedTraceByID", true); let api = APMTraceAPI::with_config(configuration); let resp = api .get_pruned_trace_by_id( "trace_id".to_string(), GetPrunedTraceByIDOptionalParams::default(), ) .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 a pruned trace by ID returns "OK" response */ import { client, v2 } from "@datadog/datadog-api-client"; const configuration = client.createConfiguration(); configuration.unstableOperations["v2.getPrunedTraceByID"] = true; const apiInstance = new v2.APMTraceApi(configuration); const params: v2.APMTraceApiGetPrunedTraceByIDRequest = { traceId: "trace_id", }; apiInstance .getPrunedTraceByID(params) .then((data: v2.PrunedTraceResponse) => { 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 %}