Skip to main content
GET
Stream-level metrics.

Metrics concepts

Review metric sets, parameters, scopes, and response types.

​
Metric sets

​
storage

Returns a gauge representing the cumulative stored bytes, per minute, of the specified stream. Requires a start and end timestamp.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your access token.

Path Parameters

​
basin
string
required

Basin name.

Required string length: 8 - 48
​
stream
string
required

Stream name.

Required string length: 1 - 512

Query Parameters

​
set
enum<string>
required

Metric set to return.

Available options:
storage
​
start
integer<int32>

Start timestamp as Unix epoch seconds, if applicable for the metric set.

Required range: x >= 0
​
end
integer<int32>

End timestamp as Unix epoch seconds, if applicable for metric set.

Required range: x >= 0
​
interval
enum<string>

Interval to aggregate over for timeseries metric sets.

Available options:
minute,
hour,
day

Response

​
values
object[]
required

Metrics comprising the set.

Single named value.