Account-level metrics.
curl --request GET \
--url https://a.s2.dev/v1/metrics \
--header 'Authorization: Bearer <token>'{
"values": [
{
"scalar": {
"name": "<string>",
"unit": "bytes",
"value": 123
}
}
]
}{
"code": "<string>",
"message": "<string>"
}{
"code": "<string>",
"message": "<string>"
}{
"code": "<string>",
"message": "<string>"
}metrics
Account-level metrics.
Get account-level S2 metrics for active basins, account operations, and estimated billable usage.
GET
/
metrics
Account-level metrics.
curl --request GET \
--url https://a.s2.dev/v1/metrics \
--header 'Authorization: Bearer <token>'{
"values": [
{
"scalar": {
"name": "<string>",
"unit": "bytes",
"value": 123
}
}
]
}{
"code": "<string>",
"message": "<string>"
}{
"code": "<string>",
"message": "<string>"
}{
"code": "<string>",
"message": "<string>"
}Metrics concepts
Review metric sets, parameters, scopes, and response types.
Metric sets
active-basins
Returns a label metric representing all basins which had at least one stream within the specified period.
This can be used to determine which basins to request basin-specific metrics for, when attempting to summarize account-level metrics for a period.
Requires a start and end timestamp.
account-ops
Returns a set of accumulation metrics, one per account operation. Each account-level request is a single operation, and this endpoint will return as many timeseries as there are distinct account operations with non-zero values within the specified period.
Requires a start and end timestamp. Accepts an optional interval parameter for minute / hour / day aggregations.
Requests for
account-metrics, basin-metrics, and stream-metrics are also account operations that are metered the same way!estimated-billable-usage
Returns account-wide accumulation metrics of estimated charges by pricing category. The unit is usd: values are fractional dollars, not cents.
Series names use the ops.*, storage.*, and transfer.* prefixes for operations, storage, and transfers. other captures uncategorized charges, and total sums all categories. Do not add total to the category series when calculating overall usage.
Requires start and end timestamps, with a maximum range of 90 days. Accepts interval=hour (the default) or interval=day; minute intervals are not supported.
curl \
--request GET \
--url "https://a.s2.dev/v1/metrics?set=estimated-billable-usage&start=${START}&end=${END}&interval=day" \
--header "Authorization: Bearer ${S2_ACCESS_TOKEN}"
Only finalized hours are included, so a daily point may be incomplete. Estimates reflect gross usage; the actual invoice may differ.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your access token.
Query Parameters
Metric set to return.
Account-level metric sets.
estimated-billable-usage returns estimated USD by billing dimension and as a total series.
Supports hour (default) and day intervals, aggregating finalized hours. Daily points may be partial.
Available options:
active-basins, account-ops, estimated-billable-usage Start timestamp as Unix epoch seconds, if applicable for the metric set. Time ranges may span at most 90 days.
Required range:
x >= 0End timestamp as Unix epoch seconds, if applicable for the metric set.
Required range:
x >= 0Interval to aggregate over for timeseries metric sets.
Available options:
minute, hour, day Response
Metrics comprising the set.
Single named value.
- Option 1
- Option 2
- Option 3
- Option 4
Show child attributes
Show child attributes