SignalFx Developers Guide

Developer Home

Product Docs

SignalFx

Trace Retrieval API

API for retrieving trace data from SignalFx

Retrieve Trace Data

Retrieves trace data specified by search criteria

post /trace

SignalFx API endpoint.
Replace {REALM} with the name of your realm. For example, if your realm is eu0, use https://api.eu0.signalfx.com/v2.
To find your realm, go to your profile page in the SignalFx web UI.
If you don't include a realm and use https:/api.signalfx.com/v2, SignalFx interprets the endpoint as pointing to the us0 realm.

https://api.{REALM}.signalfx.com/v2/trace

Retrieves trace data based on search criteria you specify.

header Parameters
Content-Type
required
string

Format of the request payload. Must be application/json.

X-SF-Token
required
string

A valid session token (referred to as a user API access token in the web UI)

Request Body schema: application/json
services
Array of string

Array of services for which you want trace data. Each element contains the name of a service.

operations
Array of string

Array of operations for which you want trace data. Each element contains the name of an operation.

filters
object

Specifies additional filters for the requested services and operations. The filters are arrays of tags that the API compares to the services and operations you specify in the search criteria.
The value of filters is an object containing one or more properties. Each property has this format.

  • key: A name for an array of tags
  • value: An array of tags
    The object contains one or more of these properties
duration
object

Object that specifies filter criteria for the duration of an operation in terms of elapsed times.
Both the gte and lte properties are optional:

  • If you don't specify them ("duration": {}), the API returns tags regardless of their duration.
  • If you specify gte but not lte, the API returns tags with no upper bound for duration and an lower bound of gte
  • If you specify lte but not gte, the API returns tags with no lower bound for duration and an upper bound of lte
time
object

Object that specifies filter critera for the duration of an operation in terms of starting and ending timestamps.
Both the gte and lte properties are optional:

  • If you don't specify either property ("time": {}), the API returns tags regardless of their start and end times.
  • If you specify gte but not lte, the API returns tags with no maximum start time and a minimum start time of gte
  • If you specify lte but not gte, the API returns tags with no minimum end time and a maximum end time of lte.
status
string
Enum:"ALL_ERRORS" "ANY" "ENDPOINT_ERRORS" "TRACE_ERRORS"

String specifying the type of error tracing data to show. The valid values are:

  • ALL_ERRORS: Select traces that have errors anywhere in the trace
  • ENDPOINT_ERRORS: Select traces only if they have have
    errors in an endpoint operation between services
  • TRACE_ERRORS: Select traces only if they have errors in the initiating operation
  • ANY: Select traces with any status

Responses

200

Successful request. This response code is returned even if the API doesn't find any matching traces.

Response Headers
Access-Control-Allow-Credentials
boolean
Default: true

If true, the response can be exposed to users even if they've authenticated with a front end client using cookies

Access-Control-Allow-Origin
string
Default: "URL of the agent making the request"

Specifies the URIs that can access the results of the request

Access-Control-Expose-Headers
string

A header that can be exposed to front end clients. The headers may contain multiple instances of this header.

Connection
string
Default: "keep-alive"

Specifies how connections should be handled for a series of API calls

Content-Encoding
required
string
Default: "gzip"

Specifies the content encoding of the response payload, as a standard HTTP content-encoding token

Content-Type
string

Specifies the format of the response payload. Must be set to "application/json".

Date
string
Example: "Mon, 01 Jan 2018 10:19:25 GMT"

'Timestamp of the response, formatted as ddd, dd mmm yyyy hh:mm:ss. The time is GMT+0'

Transfer-Encoding
string
Default: "chunked"

The form of encoding used to safely transfer the response to the user agent.

Vary
string
Default: "Accept-Encoding, User-Agent"

Indicates that the response payload may be encoded or compressed differently depending on the source of the request. Primarily used to inform caching agents whether content is static or may vary depending on the request settings.

Response Schema: application/json
histogram
object (Histogram data for the retrieved traces)
  • Histogram bucket entries for the overall distribution of latency values for the retrieved traces
  • Confidence values for the histogram
barChart
object (Data for errors over time)

An array of bar chart bucket entries that measure the time distribution of errors in the traces of errors in the retrieved traces

groups
Array of object (Trace groups retrieved by the request)

Array of trace groups for the retrieved data.
A trace group is a set of traces that all have the same trace identity. If relevant, this includes the initiating service and HTTP method.

map
object (Data that describes the service map for the retrieved traces)

The descriptor, data type, edges, and nodes for the service map that represents the retrieved traces

sampled
boolean (Sampling indicator)

Indicates that the API sampled the result set from the database. A true value means that the API reached its search limit before it found all the available results. You should set more restrictive search criteria and resubmit the request.

range
object (Range of timestamps for the retrieved traces)

Object that contains the lower and upper timestamp boundary for the traces retrieved

400

Invalid request body, caused by invalid JSON or improper values

403

Invalid authentication token in the X-SF-Token header parameter

Response Schema: application/json
code
integer (HTTP response code. Always `403`)

Indicates that the request contains an invalid authentication token

message
string (Error message)

API error response message. Always set to "Problem accessing /v2/trace. Reason: Forbidden"

404

Invalid request. The tracing API is not enabled for the organization associated with the authentication token.

Response Schema: application/json
code
integer (HTTP response code. Always `404`)

Indicates that the tracing API is not enabled for the organization associated with the authentication token.

message
string (Error message)

API error response message. Always set to "HTTP 404 Not Found"

500

Internal server error

Request samples

application/json
Copy
Expand all Collapse all
{
  • "services":
    [
    ],
  • "operations":
    [
    ],
  • "filters":
    {
    },
  • "duration":
    {
    },
  • "time":
    {
    },
  • "status": "ALL_ERRORS"
}

Response samples

application/json
Copy
Expand all Collapse all
{
  • "histogram":
    {
    },
  • "barChart":
    {
    },
  • "groups":
    [
    ],
  • "map":
    {
    },
  • "sampled": true,
  • "range":
    {
    }
}

Retrieve Trace Outlier Analysis

Retrieves trace outlier analysis specified by search criteria

post /trace/outliers

SignalFx API endpoint.
Replace {REALM} with the name of your realm. For example, if your realm is eu0, use https://api.eu0.signalfx.com/v2.
To find your realm, go to your profile page in the SignalFx web UI.
If you don't include a realm and use https:/api.signalfx.com/v2, SignalFx interprets the endpoint as pointing to the us0 realm.

https://api.{REALM}.signalfx.com/v2/trace/outliers

Requests a trace outlier analysis for search criteria you specify in the request body.
Outlier analysis returns two types of information:

  • Over-represented traces identified by tag. The API detects tags that occur frequently for high latency traces
  • The top contributors among operations for higher latency traces. The API reports on all operations in the 90th percentile of high latency operation, up to 100 operations total.
header Parameters
Content-Type
required
string

Format of the request payload. Must be application/json.

X-SF-Token
required
string

A valid session token (referred to as a user API access token in the web UI)

Request Body schema: application/json
services
Array of string

Array of services for which you want trace data. Each element contains the name of a service.

operations
Array of string

Array of operations for which you want trace data. Each element contains the name of an operation.

filters
object

Specifies additional filters for the requested services and operations. The filters are arrays of tags that the API compares to the services and operations you specify in the search criteria.
The value of filters is an object containing one or more properties. Each property has this format.

  • key: A name for an array of tags
  • value: An array of tags
    The object contains one or more of these properties
duration
object

Object that specifies filter criteria for the duration of an operation in terms of elapsed times.
Both the gte and lte properties are optional:

  • If you don't specify them ("duration": {}), the API returns tags regardless of their duration.
  • If you specify gte but not lte, the API returns tags with no upper bound for duration and an lower bound of gte
  • If you specify lte but not gte, the API returns tags with no lower bound for duration and an upper bound of lte
time
object

Object that specifies filter critera for the duration of an operation in terms of starting and ending timestamps.
Both the gte and lte properties are optional:

  • If you don't specify either property ("time": {}), the API returns tags regardless of their start and end times.
  • If you specify gte but not lte, the API returns tags with no maximum start time and a minimum start time of gte
  • If you specify lte but not gte, the API returns tags with no minimum end time and a maximum end time of lte.
status
string
Enum:"ALL_ERRORS" "ANY" "ENDPOINT_ERRORS" "TRACE_ERRORS"

String specifying the type of error tracing data to show. The valid values are:

  • ALL_ERRORS: Select traces that have errors anywhere in the trace
  • ENDPOINT_ERRORS: Select traces only if they have have
    errors in an endpoint operation between services
  • TRACE_ERRORS: Select traces only if they have errors in the initiating operation
  • ANY: Select traces with any status
histogramMin
integer <int64> (Minimum trace duration to include, in microseconds)

Optional: Limits the analyzed traces to those that had a duration longer than or equal to this value in microseconds

histogramMax
integer <int64> (Maximum trace duration to include, in microseconds)

Optional: Limits the analyzed traces to those that had a duration shorter than or equal to this value in microseconds

numBins
integer <int32> (Number of latency bins in the analysis histogram)

Requests a number of bins for the latency histogram produced by the analysis

Responses

200

Successful request. This response code is returned even if the API doesn't find any matching traces.

Response Headers
Access-Control-Allow-Credentials
boolean
Default: true

If true, the response can be exposed to users even if they've authenticated with a front end client using cookies

Access-Control-Allow-Origin
string
Default: "URL of the agent making the request"

Specifies the URIs that can access the results of the request

Access-Control-Expose-Headers
string

A header that can be exposed to front end clients. The headers may contain multiple instances of this header.

Connection
string
Default: "keep-alive"

Specifies how connections should be handled for a series of API calls

Content-Encoding
string
Default: "gzip"

Specifies the content encoding of the response payload, as a standard HTTP content-encoding token

Content-Type
string
Default: "application/json"

Specifies the format of the response payload. Must be set to "application/json".

Date
string
Example: "Mon, 01 Jan 2018 10:19:25 GMT"

Timestamp of the response, formatted as ddd, dd mmm yyyy hh:mm:ss. The time is GMT+0'

Transfer-Encoding
string
Default: "chunked"

The form of encoding used to safely transfer the response to the user agent.

Vary
string
Default: "Accept-Encoding, User-Agent"

Indicates that the response payload may be encoded or compressed differently depending on the source of the request. Primarily used to inform caching agents whether content is static or may vary depending on the request settings.

Response Schema: application/json
analyzeResults
object (Outlier analysis results)

Object containing the results of an outlier analysis

processed
integer <int64> (Number of traces processed)

The number of traces processed by this request

tags
Array of object (Array of data for tags analysis)

An array that contains one element for each tag analyzed

400

Invalid request body, caused by invalid JSON or improper values

403

Invalid authentication token in the X-SF-Token header parameter

Response Schema: application/json
code
integer (HTTP response code. Always `403`)

Indicates that the request contains an invalid authentication token

message
string (Error message)

API error response message. Always set to "Problem accessing /v2/trace. Reason: Forbidden"

404

Invalid request. The tracing API is not enabled for the organization associated with the authentication token.

Response Schema: application/json
code
integer (HTTP response code. Always `404`)

Indicates that the tracing API is not enabled for the organization associated with the authentication token.

message
string (Error message)

API error response message. Always set to "HTTP 404 Not Found"

500

Internal server error

Request samples

application/json
Copy
Expand all Collapse all
{
  • "services":
    [
    ],
  • "operations":
    [
    ],
  • "filters":
    {
    },
  • "duration":
    {
    },
  • "time":
    {
    },
  • "status": "ALL_ERRORS",
  • "histogramMin": 0,
  • "histogramMax": 0,
  • "numBins": 0
}

Response samples

application/json
Copy
Expand all Collapse all
{
  • "analyzeResults":
    {
    },
  • "processed": 0,
  • "tags":
    [
    ]
}

Retrieve Span Tags

Retrieves span tags specified by search criteria

post /trace/spantags

SignalFx API endpoint.
Replace {REALM} with the name of your realm. For example, if your realm is eu0, use https://api.eu0.signalfx.com/v2.
To find your realm, go to your profile page in the SignalFx web UI.
If you don't include a realm and use https:/api.signalfx.com/v2, SignalFx interprets the endpoint as pointing to the us0 realm.

https://api.{REALM}.signalfx.com/v2/trace/spantags

Retrieves span tags based on the search criteria you specify

header Parameters
Content-Type
required
string

Format of the request payload. Must be application/json.

X-SF-Token
required
string

A valid session token (referred to as a user API access token in the web UI)

Request Body schema: application/json
services
Array of string

Array of services for which you want span tags. Each element contains the name of a service.

operations
Array of string

Array of operations for which you want span tags. Each element contains the name of an operation.

initiators
Array of string

Array of trace intiators for which you want span tags. A trace initiator is the first operation recorded for a trace.

duration
object

Object that specifies filter criteria for the duration of an operation in terms of elapsed times.
Both the gte and lte properties are optional:

  • If you don't specify them ("duration": {}), the API returns tags regardless of their duration.
  • If you specify gte but not lte, the API returns tags with no upper bound for duration and an lower bound of gte
  • If you specify lte but not gte, the API returns tags with no lower bound for duration and an upper bound of lte
time
object

Object that specifies filter critera for the duration of an operation in terms of starting and ending timestamps.
Both the gte and lte properties are optional:

  • If you don't specify either property ("time": {}), the API returns tags regardless of their start and end times.
  • If you specify gte but not lte, the API returns tags with no maximum start time and a minimum start time of gte
  • If you specify lte but not gte, the API returns tags with no minimum end time and a maximum end time of lte.
partialUserInput
string

A string that the API tries to match to the beginning of a span tag key or value.
The API interprets the string value according to these rules:

  • If the value ends with a colon (:), the API uses the string before the colon as a key. For example, if partialUserInput is input:, then the API returns spans that have a span key of input:.
  • If the value contains a colon (:), the API uses the string before the colon as a key and the string after the colon as a partial value. For example, if partialUserInput is input: val, then the API returns spans with a key value that starts with val for the key input.
  • In all other cases, the API looks for span keys that start with the value of partialUserInput. For example, if partialUserInput is input (without a colon), then the API returns spans that have a key value staring with input, including input, input_tag, and so forth.

Responses

200

Successful request. This response code is returned even if the API doesn't find any matching span tags.
The response body contains an array of span tags for spans that match the search criteria. Each span tag in the array is an object containing one property. The key for this property is the span tag key, and the value is the data stored in the tag.
A tag value can be any primitive type, including string, double, long, binary, or boolean. These map to JSON Schema types with some exceptions. To learn more, see the Data Types section in the OAS 3.0 specification.

Response Headers
Access-Control-Allow-Credentials
boolean
Default: true

If true, the response can be exposed to users even if they've authenticated with a front end client using cookies

Access-Control-Allow-Origin
string
Default: "URL of the agent making the request"

Specifies the URIs that can access the results of the request

Access-Control-Expose-Headers
string

A header that can be exposed to front end clients. The headers may contain multiple instances of this header.

Connection
string
Default: "keep-alive"

Specifies how connections should be handled for a series of API calls

Content-Encoding
string
Default: "gzip"

Specifies the content encoding of the response payload, as a standard HTTP content-encoding token

Content-Type
string
Default: "application/json"

Specifies the format of the response payload. Must be set to "application/json".

Date
string
Example: "Mon, 01 Jan 2018 10:19:25 GMT"

Timestamp of the response, formatted as ddd, dd mmm yyyy hh:mm:ss. The time is GMT+0'

Transfer-Encoding
string
Default: "chunked"

The form of encoding used to safely transfer the response to the user agent.

Vary
string
Default: "Accept-Encoding, User-Agent"

Indicates that the response payload may be encoded or compressed differently depending on the source of the request. Primarily used to inform caching agents whether content is static or may vary depending on the request settings.

Response Schema: application/json
property name *
Array of object
400

Invalid request body, caused by invalid JSON or improper values

403

Invalid authentication token in the X-SF-Token header parameter

Response Schema: application/json
code
integer (HTTP response code. Always `403`)

Indicates that the request contains an invalid authentication token

message
string (Error message)

API error response message. Always set to "Problem accessing /v2/trace. Reason: Forbidden"

404

Invalid request. The tracing API is not enabled for the organization associated with the authentication token.

Response Schema: application/json
code
integer (HTTP response code. Always `404`)

Indicates that the tracing API is not enabled for the organization associated with the authentication token.

message
string (Error message)

API error response message. Always set to "HTTP 404 Not Found"

500

Internal server error

Request samples

application/json
Copy
Expand all Collapse all
{
  • "services":
    [
    ],
  • "operations":
    [
    ],
  • "initiators":
    [
    ],
  • "duration":
    {
    },
  • "time":
    {
    },
  • "partialUserInput": "string"
}

Response samples

application/json
Copy
Expand all Collapse all
{
  • "property1":
    [
    ],
  • "property2":
    [
    ]
}

Retrieve Spans

Retrieves all the spans for the trace specified in the {id} path parameter

get /trace/{id}

SignalFx API endpoint.
Replace {REALM} with the name of your realm. For example, if your realm is eu0, use https://api.eu0.signalfx.com/v2.
To find your realm, go to your profile page in the SignalFx web UI.
If you don't include a realm and use https:/api.signalfx.com/v2, SignalFx interprets the endpoint as pointing to the us0 realm.

https://api.{REALM}.signalfx.com/v2/trace/{id}

Retrieves all the spans for the trace specified in the id path parameter. This endpoint doesn't use a request body

path Parameters
id
required
string

Trace ID value of a retained trace

header Parameters
Content-Type
required
string

Format of the request payload. Must be application/json.

X-SF-Token
required
string

A valid session token (referred to as a user API access token in the web UI)

Responses

200

Array of Span objects for the specified trace

Response Headers
Access-Control-Allow-Credentials
boolean
Default: true

If true, the response can be exposed to users even if they've authenticated with a front end client using cookies

Access-Control-Allow-Origin
string
Default: "URL of the agent making the request"

Specifies the URIs that can access the results of the request

Access-Control-Expose-Headers
string

A header that can be exposed to front end clients. The headers may contain multiple instances of this header.

Connection
string
Default: "keep-alive"

Specifies how connections should be handled for a series of API calls

Content-Encoding
string
Default: "gzip"

Specifies the content encoding of the response payload, as a standard HTTP content-encoding token

Content-Type
string
Default: "application/json"

Specifies the format of the response payload. Must be set to "application/json".

Date
string
Example: "Mon, 01 Jan 2018 10:19:25 GMT"

Timestamp of the response, formatted as ddd, dd mmm yyyy hh:mm:ss. The time is GMT+0'

Transfer-Encoding
string
Default: "chunked"

The form of encoding used to safely transfer the response to the user agent.

Vary
string
Default: "Accept-Encoding, User-Agent"

Indicates that the response payload may be encoded or compressed differently depending on the source of the request. Primarily used to inform caching agents whether content is static or may vary depending on the request settings.

Response Schema: application/json
Array
traceId
string (Trace ID for this span)

The trace ID for this span. This is the value of {id} specified in the path parameter of the request.

name
string (Operation name)

The operation name for this span

parentId
string (Parent span ID)

ID of the parent span to this span, if one exists.

id
string (This span's ID) [ 16 .. 32 ] characters

ID of the span represented by the properties of this object, in the form of 16 to 32 hexidecimal digits.

kind
string (Span type)
Enum:"CLIENT" "SERVER" "PRODUCER" "CONSUMER"

The type of this span. The possible values are:

  • CLIENT
  • SERVER
  • PRODUCER
  • CONSUMER
timestamp
integer <int64> (Span creation timestamp)

The creation timestamp for this span, in the form of milliseconds since the UNIX epoch 1970-01-01T00:00:00+0

duration
integer <int64> (Span duration)

The time in microseconds between the start and end of the span

debug
boolean (Debug sampling flag)

If true, indicates that debug sampling was enabled for this span

shared
boolean (Shared span flag)

If true, indicates that this is a shared span

localEndpoint
object (Local endpoint for a span)

Properties that describe a span's local (starting) endpoint

remoteEndpoint
object (Remote endpoint for a span)

Properties that describe a span's remote (destination) endpoint

annotations
Array of object (List of annotations for a span)

Array containing annotation objects for a span retrieved by the /trace/{id} POST endpoint.

tags
object

Object that contains tags associated with the retrieved spans.
Each property has this format:

  • key: A name for an array of tags
  • value: An array of tags
403

Invalid authentication token in the X-SF-Token header parameter

Response Schema: application/json
code
integer (HTTP response code. Always `403`)

Indicates that the request contains an invalid authentication token

message
string (Error message)

API error response message. Always set to "Problem accessing /v2/trace. Reason: Forbidden"

404

Invalid request. The tracing API is not enabled for the organization associated with the authentication token.

Response Schema: application/json
code
integer (HTTP response code. Always `404`)

Indicates that the tracing API is not enabled for the organization associated with the authentication token.

message
string (Error message)

API error response message. Always set to "HTTP 404 Not Found"

500

Internal server error

Response samples

application/json
Copy
Expand all Collapse all
[
  • {
    }
]

Retrieve Anomaly Analysis

Retrieves all the anomaly data for the trace specified in the {id} path parameter

get /trace/{id}/analysis

SignalFx API endpoint.
Replace {REALM} with the name of your realm. For example, if your realm is eu0, use https://api.eu0.signalfx.com/v2.
To find your realm, go to your profile page in the SignalFx web UI.
If you don't include a realm and use https:/api.signalfx.com/v2, SignalFx interprets the endpoint as pointing to the us0 realm.

https://api.{REALM}.signalfx.com/v2/trace/{id}/analysis

Retrieves anomaly data for the trace specified by the id path parameter

path Parameters
id
required
string

Trace ID value of a retained trace

header Parameters
Content-Type
required
string

Format of the request payload. Must be application/json.

X-SF-Token
required
string

A valid session token (referred to as a user API access token in the web UI)

Responses

200

The API processed the request successfully.

Response Headers
Access-Control-Allow-Credentials
boolean
Default: true

If true, the response can be exposed to users even if they've authenticated with a front end client using cookies

Access-Control-Allow-Origin
string
Default: "URL of the agent making the request"

Specifies the URIs that can access the results of the request

Access-Control-Expose-Headers
string

A header that can be exposed to front end clients. The headers may contain multiple instances of this header.

Connection
string
Default: "keep-alive"

Specifies how connections should be handled for a series of API calls

Content-Encoding
string
Default: "gzip"

Specifies the content encoding of the response payload, as a standard HTTP content-encoding token

Content-Type
string
Default: "application/json"

Specifies the format of the response payload. Must be set to "application/json".

Date
string
Example: "Mon, 01 Jan 2018 10:19:25 GMT"

Timestamp of the response, formatted as ddd, dd mmm yyyy hh:mm:ss. The time is GMT+0'

Transfer-Encoding
string
Default: "chunked"

The form of encoding used to safely transfer the response to the user agent.

Vary
string
Default: "Accept-Encoding, User-Agent"

Indicates that the response payload may be encoded or compressed differently depending on the source of the request. Primarily used to inform caching agents whether content is static or may vary depending on the request settings.

Response Schema: application/json
Array
service
string

Service that ran the operation

operation
string

Span identifier; the name of the operation

duration
integer <int64>

Duration in microseconds of this operation. The API calculates this value to ensure it's the unique contribution of the operation to the trace duration. For example, if two spans run in parallel, each of them get 1/2 their duration assigned to duration.

proportion
number <float>

The proportion of the total trace duration that can be attributed to operation, calculated as (duration / total duration of trace).

count
integer <int64>

Number of times this operation appeared in the trace

403

Invalid authentication token in the X-SF-Token header parameter

Response Schema: application/json
code
integer (HTTP response code. Always `403`)

Indicates that the request contains an invalid authentication token

message
string (Error message)

API error response message. Always set to "Problem accessing /v2/trace. Reason: Forbidden"

404

Invalid request. The tracing API is not enabled for the organization associated with the authentication token.

Response Schema: application/json
code
integer (HTTP response code. Always `404`)

Indicates that the tracing API is not enabled for the organization associated with the authentication token.

message
string (Error message)

API error response message. Always set to "HTTP 404 Not Found"

500

Internal server error

Response samples

application/json
Copy
Expand all Collapse all
[
  • {
    }
]

Retrieve Recent Operation Names

Retrieves span operation names for spans received in the last 48 hours.

get /trace/spannamesbyservice

SignalFx API endpoint.
Replace {REALM} with the name of your realm. For example, if your realm is eu0, use https://api.eu0.signalfx.com/v2.
To find your realm, go to your profile page in the SignalFx web UI.
If you don't include a realm and use https:/api.signalfx.com/v2, SignalFx interprets the endpoint as pointing to the us0 realm.

https://api.{REALM}.signalfx.com/v2/trace/spannamesbyservice

Retrieves span operation names for spans received in the last 48 hours. The results are aggregated by service.

header Parameters
Content-Type
required
string

Format of the request payload. Must be application/json.

X-SF-Token
required
string

A valid session token (referred to as a user API access token in the web UI)

Responses

200

Object containing key-value pairs for each service name received in the last 48 hours

Response Headers
Access-Control-Allow-Credentials
boolean
Default: true

If true, the response can be exposed to users even if they've authenticated with a front end client using cookies

Access-Control-Allow-Origin
string
Default: "URL of the agent making the request"

Specifies the URIs that can access the results of the request

Access-Control-Expose-Headers
string

A header that can be exposed to front end clients. The headers may contain multiple instances of this header.

Connection
string
Default: "keep-alive"

Specifies how connections should be handled for a series of API calls

Content-Encoding
string
Default: "gzip"

Specifies the content encoding of the response payload, as a standard HTTP content-encoding token

Content-Type
string
Default: "application/json"

Specifies the format of the response payload. Must be set to "application/json".

Date
string
Example: "Mon, 01 Jan 2018 10:19:25 GMT"

Timestamp of the response, formatted as ddd, dd mmm yyyy hh:mm:ss. The time is GMT+0'

Transfer-Encoding
string
Default: "chunked"

The form of encoding used to safely transfer the response to the user agent.

Vary
string
Default: "Accept-Encoding, User-Agent"

Indicates that the response payload may be encoded or compressed differently depending on the source of the request. Primarily used to inform caching agents whether content is static or may vary depending on the request settings.

Response Schema: application/json
property name *
object
403

Invalid authentication token in the X-SF-Token header parameter

Response Schema: application/json
code
integer (HTTP response code. Always `403`)

Indicates that the request contains an invalid authentication token

message
string (Error message)

API error response message. Always set to "Problem accessing /v2/trace. Reason: Forbidden"

404

Invalid request. The tracing API is not enabled for the organization associated with the authentication token.

Response Schema: application/json
code
integer (HTTP response code. Always `404`)

Indicates that the tracing API is not enabled for the organization associated with the authentication token.

message
string (Error message)

API error response message. Always set to "HTTP 404 Not Found"

500

Internal server error

Response samples

application/json
Copy
Expand all Collapse all
{
  • "property1":
    {
    },
  • "property2":
    {
    }
}