Get Account Metrics

GET /metrics

Retrieve account-level metrics for your S2 account. This endpoint allows you to query different metric sets with optional time ranges and aggregation intervals.

Query Parameters

set

string

required

Metric set to return. Available values:

active-basins - Set of all basins that had at least one stream during the specified period
account-ops - Count of append RPC operations, per interval

start

integer

Start timestamp as Unix epoch seconds. Required for timeseries metric sets.

end

integer

End timestamp as Unix epoch seconds. Required for timeseries metric sets.

interval

string

Interval to aggregate over for timeseries metric sets. Available values:

minute
hour
day

Response

Returns a MetricSetResponse object containing the requested metrics.

values

array

Array of metrics comprising the set. Each metric can be one of four types:

Show Metric Types

scalar

object

Single named value

Show properties

name

string

Metric name

unit

string

Unit of the metric (bytes or operations)

value

number

Metric value

accumulation

object

Named series of (timestamp, value) points representing an accumulation over a specified interval

Show properties

name

string

Timeseries name

unit

string

Unit of the metric (bytes or operations)

interval

string

The interval at which data points are accumulated (minute, hour, or day)

values

array

Array of [timestamp, value] tuples. Each tuple represents the accumulated value for the time period starting at the timestamp, spanning one interval.

gauge

object

Named series of (timestamp, value) points each representing an instantaneous value

Show properties

name

string

Timeseries name

unit

string

Unit of the metric (bytes or operations)

values

array

Array of [timestamp, value] tuples. Each tuple represents the value at the instant of the timestamp.

label

object

Set of string labels

Show properties

name

string

Label name

values

array

Array of string values

curl -X GET "https://aws.s2.dev/v1/metrics?set=active-basins&start=1704067200&end=1704153600" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

{
  "values": [
    {
      "label": {
        "name": "active-basins",
        "values": ["analytics", "logs", "events"]
      }
    }
  ]
}

Error Responses

400

Bad Request

Invalid query parameters or malformed request

403

Forbidden

Invalid or missing authentication token

408

Request Timeout

Request took too long to process

Overview

Basins

Streams

Records

Access Tokens

Metrics

Get Account Metrics

GET /metrics

Query Parameters

Response

Error Responses

Build docs developers (and LLMs) love

Overview

Basins

Streams

Records

Access Tokens

Metrics

​GET /metrics

​Query Parameters

​Response

​Error Responses

Build docs developers (and LLMs) love

GET /metrics

Query Parameters

Response

Error Responses