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.
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 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
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.
# Path parameters exporttrace_id="0000000000000000abc1230000000000" # Use a Personal Access Token or Service Access Token exportDD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
"""
Get a trace by ID returns "OK" response
"""fromosimportenvironfromdatadog_api_clientimportApiClient,Configurationfromdatadog_api_client.v2.api.apm_trace_apiimportAPMTraceApiconfiguration=Configuration()configuration.access_token=environ["DD_BEARER_TOKEN"]configuration.unstable_operations["get_trace_by_id"]=TruewithApiClient(configuration)asapi_client:api_instance=APMTraceApi(api_client)response=api_instance.get_trace_by_id(trace_id="trace_id",)print(response)
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com"DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"python3"example.py"
# Get a trace by ID returns "OK" responserequire"datadog_api_client"DatadogAPIClient.configuredo|config|config.access_token=ENV["DD_BEARER_TOKEN"]config.unstable_operations["v2.get_trace_by_id".to_sym]=trueendapi_instance=DatadogAPIClient::V2::APMTraceAPI.newpapi_instance.get_trace_by_id("trace_id")
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com"DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"rb"example.rb"
// Get a trace by ID returns "OK" responsepackagemainimport("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")funcmain(){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())iferr!=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)}
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com"DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"go run"main.go"
// Get a trace by ID returns "OK" responseimportcom.datadog.api.client.ApiClient;importcom.datadog.api.client.ApiException;importcom.datadog.api.client.v2.api.ApmTraceApi;importcom.datadog.api.client.v2.model.TraceResponse;publicclassExample{publicstaticvoidmain(String[]args){ApiClientdefaultClient=ApiClient.getDefaultApiClient();defaultClient.setAccessToken(System.getenv("DD_BEARER_TOKEN"));defaultClient.setUnstableOperationEnabled("v2.getTraceByID",true);ApmTraceApiapiInstance=newApmTraceApi(defaultClient);try{TraceResponseresult=apiInstance.getTraceByID("0000000000000000abc1230000000000");System.out.println(result);}catch(ApiExceptione){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();}}}
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com"DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"java"Example.java"
// Get a trace by ID returns "OK" response
usedatadog_api_client::datadog;usedatadog_api_client::datadogV2::api_apm_trace::APMTraceAPI;usedatadog_api_client::datadogV2::api_apm_trace::GetTraceByIDOptionalParams;#[tokio::main]asyncfnmain(){letmutconfiguration=datadog::Configuration::new();configuration.set_unstable_operation_enabled("v2.GetTraceByID",true);letapi=APMTraceAPI::with_config(configuration);letresp=api.get_trace_by_id("trace_id".to_string(),GetTraceByIDOptionalParams::default(),).await;ifletOk(value)=resp{println!("{:#?}",value);}else{println!("{:#?}",resp.unwrap_err());}}
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com"DD_API_KEY="<DD_API_KEY>"DD_APP_KEY="<DD_APP_KEY>"cargo run
/**
* Get a trace by ID returns "OK" response
*/import{client,v2}from"@datadog/datadog-api-client";constconfiguration=client.createConfiguration({authMethods:{AuthZ:{accessToken: process.env.DD_BEARER_TOKENasstring,},},});configuration.unstableOperations["v2.getTraceByID"]=true;constapiInstance=newv2.APMTraceApi(configuration);constparams: 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));
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com"DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"tsc"example.ts"
Request a personalized demo
Get Started with Datadog
Ask AI
AI-generated responses may be inaccurate. Verify important info.