For AI agents: A markdown version of this page is available at https://docs.datadoghq.com/api/latest/apm-trace/get-a-trace-by-id.md. A documentation index is available at /llms.txt.

Get a trace by ID

Note: This endpoint is in preview and is subject to change. If you have any feedback, contact Datadog support.

GET https://api.ap1.datadoghq.com/api/v2/trace/{trace_id}https://api.ap2.datadoghq.com/api/v2/trace/{trace_id}https://api.datadoghq.eu/api/v2/trace/{trace_id}https://api.ddog-gov.com/api/v2/trace/{trace_id}https://api.us2.ddog-gov.com/api/v2/trace/{trace_id}https://api.uk1.datadoghq.com/api/v2/trace/{trace_id}https://api.datadoghq.com/api/v2/trace/{trace_id}https://api.us3.datadoghq.com/api/v2/trace/{trace_id}https://api.us5.datadoghq.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. 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.

Response

OK

Response containing a single trace.

Expand All

Field

Type

Description

data [required]

object

A trace resource document.

attributes [required]

object

The attributes of a trace returned by the Get trace by ID endpoint.

is_truncated [required]

boolean

Indicates whether the trace was truncated because its size exceeded the maximum response payload.

spans [required]

[object]

The list of spans that compose the trace.

duration [required]

int64

The duration of the span, in nanoseconds.

endTime [required]

int64

The end time of the span, in Unix nanoseconds.

error [required]

enum

Error flag for a span. 1 when the span is in error, 0 otherwise. Allowed enum values: 0,1

meta [required]

object

String-valued tags attached to the span. Tag keys starting with _ are filtered out of the response.

<any-key>

string

metrics [required]

object

Numeric metrics attached to the span. Metric keys starting with _ are filtered out of the response.

<any-key>

double

name [required]

string

The operation name of the span.

parentID [required]

int64

The ID of the parent span, or 0 when the span is a trace root.

resource [required]

string

The resource that the span describes.

resourceHash

string

A hash of the resource field.

restricted

boolean

Whether access to the span is restricted by the organization's data access policies.

self_time

double

The time spent in the span itself, excluding time spent in child spans, in nanoseconds.

service [required]

string

The name of the service that emitted the span.

spanID [required]

int64

The span ID, as an unsigned 64-bit integer.

startTime [required]

int64

The start time of the span, in Unix nanoseconds.

traceID [required]

int64

The lower 64 bits of the trace ID, as an unsigned 64-bit integer.

traceIDFull [required]

string

The full 128-bit trace ID, encoded as a 32-character hexadecimal string.

type [required]

string

The type of the span (for example, web, db, or rpc).

id [required]

string

The full 128-bit trace ID, encoded as a 32-character hexadecimal string.

type [required]

enum

The type of the trace resource. The value is always trace. Allowed enum values: trace

{
  "data": {
    "attributes": {
      "is_truncated": false,
      "spans": [
        {
          "duration": 500000000,
          "endTime": 1716800000500000000,
          "error": 0,
          "meta": {
            "<any-key>": "string"
          },
          "metrics": {
            "<any-key>": "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"
  }
}

Forbidden

API error response.

Expand All

Field

Type

Description

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

Short human-readable summary of the error.

{
  "errors": [
    {
      "detail": "Missing required attribute in body",
      "meta": {},
      "source": {
        "header": "Authorization",
        "parameter": "limit",
        "pointer": "/data/attributes/title"
      },
      "status": "400",
      "title": "Bad Request"
    }
  ]
}

Not Found

API error response.

Expand All

Field

Type

Description

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

Short human-readable summary of the error.

{
  "errors": [
    {
      "detail": "Missing required attribute in body",
      "meta": {},
      "source": {
        "header": "Authorization",
        "parameter": "limit",
        "pointer": "/data/attributes/title"
      },
      "status": "400",
      "title": "Bad Request"
    }
  ]
}

Payload Too Large

API error response.

Expand All

Field

Type

Description

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

Short human-readable summary of the error.

{
  "errors": [
    {
      "detail": "Missing required attribute in body",
      "meta": {},
      "source": {
        "header": "Authorization",
        "parameter": "limit",
        "pointer": "/data/attributes/title"
      },
      "status": "400",
      "title": "Bad Request"
    }
  ]
}

Too many requests

API error response.

Expand All

Field

Type

Description

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Code Example

                  # Path parameters
export trace_id="0000000000000000abc1230000000000"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

# Curl command
curl -X GET "https://api.ap1.datadoghq.com"https://api.ap2.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.us2.ddog-gov.com"https://api.uk1.datadoghq.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v2/trace/${trace_id}" \ -H "Accept: application/json" \ -H "Authorization: Bearer ${DD_BEARER_TOKEN}"
"""
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 and then save the example to example.py and run following commands:

    
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" 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 and then save the example to example.rb and run following commands:

    
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" 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 and then save the example to main.go and run following commands:

    
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" 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 and then save the example to Example.java and run following commands:

    
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
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.GetTraceByID", 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 and then save the example to src/main.rs and run following commands:

    
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";

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 and then save the example to example.ts and run following commands:

    
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"