Skip to main content

Span Analytics APIs

Thumbnail icon

The Span Analytics API allows you to browse spans collected in the system. You can execute queries to find individual spans matching provided search criteria as well as run aggregated span queries and retrieve their results. For more information, see Spans.

Other Tracing APIs

See also: Service Map APIs and Traces APIs.

Tracing APIs give you the ability to browse and execute queries for traces and span analytics, and request a service map of your application environment.

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.

An HTTP 301 Moved error suggests that the wrong endpoint was specified.

Session Timeout

While the span analytics 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 search job 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

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

CodeErrorDescription
301movedThe requested resource SHOULD be accessed through returned URI in Location Header.
401unauthorizedCredential could not be verified.
403forbiddenThis operation is not allowed for your account type.
404notfoundRequested resource could not be found.
405method.unsupportedUnsupported method for URL.
415contenttype.invalidInvalid content type.
429rate.limit.exceededThe API request rate is higher than 4 request per second.
500internal.errorInternal server error.
503service.unavailableService is currently unavailable.

Documentation

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:

DeploymentDocumentation URL
AUhttps://api.au.sumologic.com/docs/#tag/spanAnalytics
CAhttps://api.ca.sumologic.com/docs/#tag/spanAnalytics
DEhttps://api.de.sumologic.com/docs/#tag/spanAnalytics
EUhttps://api.eu.sumologic.com/docs/#tag/spanAnalytics
FEDhttps://api.fed.sumologic.com/docs/#tag/spanAnalytics
INhttps://api.in.sumologic.com/docs/#tag/spanAnalytics
JPhttps://api.jp.sumologic.com/docs/#tag/spanAnalytics
US1https://api.sumologic.com/docs/#tag/spanAnalytics
US2https://api.us2.sumologic.com/docs/#tag/spanAnalytics
Legal
Privacy Statement
Terms of Use

Copyright © 2024 by Sumo Logic, Inc.