Response object with all spans matching the request and pagination information.
Expand All
Field
Type
Description
data
[object]
Array of spans matching the request.
attributes
object
JSON object containing all span attributes and their associated values.
attributes
object
JSON object of attributes from your span.
custom
object
JSON object of custom spans data.
end_timestamp
date-time
End timestamp of your span.
env
string
Name of the environment from where the spans are being sent.
host
string
Name of the machine from where the spans are being sent.
ingestion_reason
string
The reason why the span was ingested.
parent_id
string
Id of the span that's parent of this span.
resource_hash
string
Unique identifier of the resource.
resource_name
string
The name of the resource.
retained_by
string
The reason why the span was indexed.
service
string
The name of the application or service generating the span events.
It is used to switch from APM to Logs, so make sure you define the same
value when you use both products.
single_span
boolean
Whether or not the span was collected as a stand-alone span. Always associated to "single_span" ingestion_reason if true.
span_id
string
Id of the span.
start_timestamp
date-time
Start timestamp of your span.
tags
[string]
Array of tags associated with your span.
trace_id
string
Id of the trace to which the span belongs.
type
string
The type of the span.
id
string
Unique ID of the Span.
type
enum
Type of the span.
Allowed enum values: spans
default: spans
links
object
Links attributes.
next
string
Link for the next set of results. Note that the request can also be made using the
POST endpoint.
meta
object
The metadata associated with a request.
elapsed
int64
The time elapsed in milliseconds.
page
object
Paging attributes.
after
string
The cursor to use to get the next results, if any. To make the next request, use the same
parameters with the addition of the page[cursor].
request_id
string
The identifier of the request.
status
enum
The status of the response.
Allowed enum values: done,timeout
warnings
[object]
A list of warnings (non fatal errors) encountered, partial results might be returned if
warnings are present in the response.
code
string
A unique code for this type of warning.
detail
string
A detailed explanation of this specific warning.
title
string
A short human-readable summary of the warning.
{"data":[{"attributes":{"attributes":{"customAttribute":123,"duration":2345},"custom":{},"end_timestamp":"2023-01-02T09:42:36.420Z","env":"prod","host":"i-0123","ingestion_reason":"rule","parent_id":"0","resource_hash":"a12345678b91c23d","resource_name":"agent","retained_by":"retention_filter","service":"agent","single_span":true,"span_id":"1234567890987654321","start_timestamp":"2023-01-02T09:42:36.320Z","tags":["team:A"],"trace_id":"1234567890987654321","type":"web"},"id":"AAAAAWgN8Xwgr1vKDQAAAABBV2dOOFh3ZzZobm1mWXJFYTR0OA","type":"spans"}],"links":{"next":"https://app.datadoghq.com/api/v2/spans/event?filter[query]=foo\u0026page[cursor]=eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ=="},"meta":{"elapsed":132,"page":{"after":"eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ=="},"request_id":"MWlFUjVaWGZTTTZPYzM0VXp1OXU2d3xLSVpEMjZKQ0VKUTI0dEYtM3RSOFVR","status":"done","warnings":[{"code":"unknown_index","detail":"indexes: foo, bar","title":"One or several indexes are missing or invalid, results hold data from the other indexes"}]}}
"""
Get a list of spans returns "OK" response
"""fromdatadog_api_clientimportApiClient,Configurationfromdatadog_api_client.v2.api.spans_apiimportSpansApiconfiguration=Configuration()withApiClient(configuration)asapi_client:api_instance=SpansApi(api_client)response=api_instance.list_spans_get()print(response)
// Get a list of spans returns "OK" responseimportcom.datadog.api.client.ApiClient;importcom.datadog.api.client.ApiException;importcom.datadog.api.client.v2.api.SpansApi;importcom.datadog.api.client.v2.model.SpansListResponse;publicclassExample{publicstaticvoidmain(String[]args){ApiClientdefaultClient=ApiClient.getDefaultApiClient();SpansApiapiInstance=newSpansApi(defaultClient);try{SpansListResponseresult=apiInstance.listSpansGet();System.out.println(result);}catch(ApiExceptione){System.err.println("Exception when calling SpansApi#listSpansGet");System.err.println("Status code: "+e.getCode());System.err.println("Reason: "+e.getResponseBody());System.err.println("Response headers: "+e.getResponseHeaders());e.printStackTrace();}}}
// Get a list of spans returns "OK" response
usedatadog_api_client::datadog;usedatadog_api_client::datadogV2::api_spans::ListSpansGetOptionalParams;usedatadog_api_client::datadogV2::api_spans::SpansAPI;#[tokio::main]asyncfnmain(){letconfiguration=datadog::Configuration::new();letapi=SpansAPI::with_config(configuration);letresp=api.list_spans_get(ListSpansGetOptionalParams::default()).await;ifletOk(value)=resp{println!("{:#?}",value);}else{println!("{:#?}",resp.unwrap_err());}}
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.comus2.ddog-gov.com"DD_API_KEY="<DD_API_KEY>"DD_APP_KEY="<DD_APP_KEY>"cargo run
/**
* Get a list of spans returns "OK" response
*/import{client,v2}from"@datadog/datadog-api-client";constconfiguration=client.createConfiguration();constapiInstance=newv2.SpansApi(configuration);apiInstance.listSpansGet().then((data: v2.SpansListResponse)=>{console.log("API called successfully. Returned data: "+JSON.stringify(data));}).catch((error: any)=>console.error(error));
// Get a list of spans 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())configuration:=datadog.NewConfiguration()apiClient:=datadog.NewAPIClient(configuration)api:=datadogV2.NewSpansApi(apiClient)resp,r,err:=api.ListSpansGet(ctx,*datadogV2.NewListSpansGetOptionalParameters())iferr!=nil{fmt.Fprintf(os.Stderr,"Error when calling `SpansApi.ListSpansGet`: %v\n",err)fmt.Fprintf(os.Stderr,"Full HTTP response: %v\n",r)}responseContent,_:=json.MarshalIndent(resp,""," ")fmt.Fprintf(os.Stdout,"Response from `SpansApi.ListSpansGet`:\n%s\n",responseContent)}