Timeseries

Returns timeseries data for a stream

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Name of the customer organization

string
required

Name of the project that contains the stream

string
required

The ID of the stream to fetch timeseries data for

Query Params
date-time
required

Beginning of the time range being queried, e.g., 2018-01-20T02:30:00-08:00. Note that oldest-time will be rounded down to the nearest 15 seconds, e.g., if 2018-01-20T02:30:18-08:00 is requested then the resulting start time will be 2018-01-20T02:30:15-08:00. Because of this rounding down, the actual oldest-time queried (and returned in the response) may differ from the requested oldest-time.

date-time
required

End of the time range being queried, e.g., 2018-01-22T06:30:00-08:00. If youngest-time is within the last 10m and oldest-time is outside your project's span retention window, then the results will exclude data that fall within the last 10m. The actual youngest-time queried (and returned in the response) may differ from the requested youngest-time. The requested duration (difference between oldest-time and youngest-time will be truncated to the requested resolution-ms (which itself is truncated to 15s boundaries). For example, if oldest-time is 2018-01-20T06:00:18 and youngest-time is 2018-01-20T06:30:19, then the resulting interval will be [2018-01-20T06:00:15, 2018-01-20T06:30:15]. The requested duration is 30 minutes and 1 second, which is rounded down to 30 minutes, and added to oldest-time to produce the resulting youngest-time.

integer
required
≥ 60000
Defaults to 60000

Length of time represented by each "point" (time window) in the timeseries, in milliseconds. The minimum value (highest resolution data) for this parameter is 60000 (representing 1 minute of data per point). Larger values will result in latency distributions being merged. resolution-ms will also be truncated to the nearest 15s and the response will contain the truncated resolution-ms.

integer
0 to 1
Defaults to 0

Boolean value that indicates whether the response should include example trace information for each time window. 0=false, 1=true

integer
0 to 1
Defaults to 0

Indicates whether the response should specify the number of spans represented by each time window. 0=false, 1=true

integer
0 to 1
Defaults to 0

Indicates whether the response should specify the number of spans with errors in each time window. 0=false, 1=true

percentile
array of numbers

A (possibly) repeated field that indicates what latency percentiles to return for each time window, if any. Valid for values [0, 99.99].

percentile
integer
0 to 1
Defaults to 0

If false or unspecified, the response will have a time-window for every interval in the query range and zero-fill the data arrays (op-counts, error-counts, latencies, etc.) for any time windows where there is no data available. If skip-data-gaps is true, the time-windows array will contain only windows for which there is data available (including potentially no elements if there is no data available). The data arrays be of the same length as the time-windows array and with each element representing value for that time-window index. As an example, if a query spanned 4 time windows and had data only for the final window, a request with skip-data-gaps=0 would return a point-count of 4, 4 time-window objects, and 4 elements in the op-counts array where the first three op-counts values would be 0. If the request were made with skip-data-gaps=1, the response would contain a point-count of 1, 1 time-window object corresponding only to the final time windows, and 1 element in the op-counts array.

Responses
200

JSON representation of a timeseries

400

One or more of the request parameter(s) is not valid

401

The API Key does not provide access to this resource

404

Project name is not found

500

Stream ID is not valid, or other internal error

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here!