Skip to main content
GET
/
metrics
/
{basin}
/
{stream}
Stream-level metrics.
curl --request GET \
  --url https://aws.s2.dev/v1/metrics/{basin}/{stream} \
  --header 'Authorization: Bearer <token>'
{
  "values": [
    {
      "scalar": {
        "name": "<string>",
        "unit": "bytes",
        "value": 123
      }
    }
  ]
}

​
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.

​
stream
string
required

Stream name.

Query Parameters

​
set
enum<string>
required

Metric set to return.

Available options:
storage
​
start
integer

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

Required range: x >= 0
​
end
integer

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.

  • Option 1
  • Option 2
  • Option 3
  • Option 4