Skip to main content
Sumo Logic

Traces API

The Traces API allows you to browse traces collected in the system. You can execute queries to find traces matching provided search criteria as well as gather detailed information about individual traces and spans.

The Traces API allows you to browse traces collected in the system. You can execute queries to find traces matching provided search criteria as well as gather detailed information about individual traces and spans. For more information see View and investigate traces.

Endpoints for API access 

Sumo Logic has deployments that are assigned depending on the geographic location and the date an account is created. For API access, you must manually direct your API client to the correct Sumo Logic API URL.

See Sumo Logic Endpoints for the list of the URLs.

API authentication 

See API Authentication for a description of options for API authentication.

Session Timeout

While the trace search query is running you need to request the query status based on the query ID. The API keeps the query alive by either polling for status or gathering results. If the query is not kept alive by API requests, it is canceled after fifteen minutes. When a query is canceled after fifteen minutes of inactivity, you will get a 404 status.

Errors Edit section

The APIs return operation failures with a description and error code, including the following generic errors that apply to all APIs:

Code

Error

Description

301

moved

The requested resource SHOULD be accessed through returned URI in Location Header.

401

unauthorized

Credential could not be verified.

403

forbidden

This operation is not allowed for your account type.

404

notfound

Requested resource could not be found.

405

method.unsupported

Unsupported method for URL.

415

contenttype.invalid

Invalid content type.

429

rate.limit.exceeded

The API request rate is higher than 4 request per second.

500

internal.error

Internal server error.

503

service.unavailable

Service is currently unavailable.

Rate limit throttling 

  • A rate limit of four API requests per second (240 requests per minute) applies to all API calls from a user.

  • A rate limit of 10 concurrent requests to any API endpoint applies to an access key.

    If a rate is exceeded, a rate limit exceeded 429 status code is returned.

  • A limit of 10 active concurrent trace search requests applies to your organization. Bear in mind that a single API request can consist of multiple queries and each query is treated as a separate trace search.

    Once you reach the limit of 10 concurrent active searches, attempting an additional search will result in a status code of 429 Too Many Requests telling you that you are over the allowed concurrent search requests limit. 

API authentication 

See API Authentication for a description of options for API authentication.

Documentation  Edit section

Documentation for OpenAPI built APIs is hosted on each deployment. Sumo Logic has several deployments that are assigned depending on the geographic location and the date an account is created. See how to determine which endpoint to use if you are unsure.

Select the documentation link for your deployment:

Deployment

Documentation URL

AU

https://api.au.sumologic.com/docs/#tag/traces

CA

https://api.ca.sumologic.com/docs/#tag/traces

DE

https://api.de.sumologic.com/docs/#tag/traces

EU

https://api.eu.sumologic.com/docs/#tag/traces

FED

https://api.fed.sumologic.com/docs/#tag/traces

IN

https://api.in.sumologic.com/docs/#tag/traces

JP

https://api.jp.sumologic.com/docs/#tag/traces

US1

https://api.sumologic.com/docs/#tag/traces

US2

https://api.us2.sumologic.com/docs/#tag/traces