--- title: Get a list of spans description: Datadog, the leading service for cloud-scale monitoring. breadcrumbs: Docs > API Reference > Spans --- # Get a list of spans{% #get-a-list-of-spans %} Copy pageCopied {% tab title="v2" %} | Datadog site | API endpoint | | ----------------- | ----------------------------------------------------- | | ap1.datadoghq.com | GET https://api.ap1.datadoghq.com/api/v2/spans/events | | ap2.datadoghq.com | GET https://api.ap2.datadoghq.com/api/v2/spans/events | | app.datadoghq.eu | GET https://api.datadoghq.eu/api/v2/spans/events | | app.ddog-gov.com | GET https://api.ddog-gov.com/api/v2/spans/events | | us2.ddog-gov.com | GET https://api.us2.ddog-gov.com/api/v2/spans/events | | app.datadoghq.com | GET https://api.datadoghq.com/api/v2/spans/events | | us3.datadoghq.com | GET https://api.us3.datadoghq.com/api/v2/spans/events | | us5.datadoghq.com | GET https://api.us5.datadoghq.com/api/v2/spans/events | ### Overview List endpoint returns spans that match a span search query. [Results are paginated](https://docs.datadoghq.com/logs/guide/collect-multiple-logs-with-pagination.md?tab=v2api). Use this endpoint to see your latest spans. This endpoint is rate limited to `300` requests per hour. OAuth apps require the `apm_read` authorization [scope](https://docs.datadoghq.com/api/latest/scopes.md#spans) to access this endpoint. ### Arguments #### Query Strings | Name | Type | Description | | ------------- | ------- | -------------------------------------------------------------------------------------------------------------------- | | filter[query] | string | Search query following spans syntax. | | filter[from] | string | Minimum timestamp for requested spans. Supports date-time ISO8601, date math, and regular timestamps (milliseconds). | | filter[to] | string | Maximum timestamp for requested spans. Supports date-time ISO8601, date math, and regular timestamps (milliseconds). | | sort | enum | Order of spans in results. Allowed enum values: `timestamp, -timestamp` | | page[cursor] | string | List following results with a cursor provided in the previous query. | | page[limit] | integer | Maximum number of spans in the response. | ### Response {% tab title="200" %} OK {% tab title="Model" %} Response object with all spans matching the request and pagination information. | Parent field | Field | Type | Description | | ------------ | ---------------- | --------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | | data | [object] | Array of spans matching the request. | | data | attributes | object | JSON object containing all span attributes and their associated values. | | attributes | attributes | object | JSON object of attributes from your span. | | attributes | custom | object | JSON object of custom spans data. | | attributes | end_timestamp | date-time | End timestamp of your span. | | attributes | env | string | Name of the environment from where the spans are being sent. | | attributes | host | string | Name of the machine from where the spans are being sent. | | attributes | ingestion_reason | string | The reason why the span was ingested. | | attributes | parent_id | string | Id of the span that's parent of this span. | | attributes | resource_hash | string | Unique identifier of the resource. | | attributes | resource_name | string | The name of the resource. | | attributes | retained_by | string | The reason why the span was indexed. | | attributes | 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. | | attributes | single_span | boolean | Whether or not the span was collected as a stand-alone span. Always associated to "single_span" ingestion_reason if true. | | attributes | span_id | string | Id of the span. | | attributes | start_timestamp | date-time | Start timestamp of your span. | | attributes | tags | [string] | Array of tags associated with your span. | | attributes | trace_id | string | Id of the trace to which the span belongs. | | attributes | type | string | The type of the span. | | data | id | string | Unique ID of the Span. | | data | type | enum | Type of the span. Allowed enum values: `spans` | | | links | object | Links attributes. | | links | 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. | | meta | elapsed | int64 | The time elapsed in milliseconds. | | meta | page | object | Paging attributes. | | page | 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]`. | | meta | request_id | string | The identifier of the request. | | meta | status | enum | The status of the response. Allowed enum values: `done,timeout` | | meta | warnings | [object] | A list of warnings (non fatal errors) encountered, partial results might be returned if warnings are present in the response. | | warnings | code | string | A unique code for this type of warning. | | warnings | detail | string | A detailed explanation of this specific warning. | | warnings | title | string | A short human-readable summary of the warning. | {% /tab %} {% tab title="Example" %} ```json { "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" } ] } } ``` {% /tab %} {% /tab %} {% tab title="400" %} Bad Request. {% 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="403" %} Forbidden: Access denied. {% 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="422" %} Unprocessable Entity. {% 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: The rate limit set by the API has been exceeded. {% 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 ##### \# Curl command curl -X GET "https://api.datadoghq.com/api/v2/spans/events" \ -H "Accept: application/json" \ -H "DD-API-KEY: ${DD_API_KEY}" \ -H "DD-APPLICATION-KEY: ${DD_APP_KEY}" ##### ```python """ Get a list of spans returns "OK" response """ from datadog_api_client import ApiClient, Configuration from datadog_api_client.v2.api.spans_api import SpansApi configuration = Configuration() with ApiClient(configuration) as api_client: api_instance = SpansApi(api_client) response = api_instance.list_spans_get() 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 list of spans returns "OK" response require "datadog_api_client" api_instance = DatadogAPIClient::V2::SpansAPI.new p api_instance.list_spans_get() ``` #### 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" ##### ```java // Get a list of spans returns "OK" response import com.datadog.api.client.ApiClient; import com.datadog.api.client.ApiException; import com.datadog.api.client.v2.api.SpansApi; import com.datadog.api.client.v2.model.SpansListResponse; public class Example { public static void main(String[] args) { ApiClient defaultClient = ApiClient.getDefaultApiClient(); SpansApi apiInstance = new SpansApi(defaultClient); try { SpansListResponse result = apiInstance.listSpansGet(); System.out.println(result); } catch (ApiException e) { 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(); } } } ``` #### 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 list of spans returns "OK" response use datadog_api_client::datadog; use datadog_api_client::datadogV2::api_spans::ListSpansGetOptionalParams; use datadog_api_client::datadogV2::api_spans::SpansAPI; #[tokio::main] async fn main() { let configuration = datadog::Configuration::new(); let api = SpansAPI::with_config(configuration); let resp = api .list_spans_get(ListSpansGetOptionalParams::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 list of spans returns "OK" response */ import { client, v2 } from "@datadog/datadog-api-client"; const configuration = client.createConfiguration(); const apiInstance = new v2.SpansApi(configuration); apiInstance .listSpansGet() .then((data: v2.SpansListResponse) => { 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" ##### ```go // Get a list of spans 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() apiClient := datadog.NewAPIClient(configuration) api := datadogV2.NewSpansApi(apiClient) resp, r, err := api.ListSpansGet(ctx, *datadogV2.NewListSpansGetOptionalParameters()) if err != 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) } ``` #### 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" {% /tab %}