Skip to content

Metrics

Report counters, gauges and timings, then query time-series aggregates (p50/p99/sum/avg) — StatsD/Prometheus-style metrics.

Overview

Base path: https://api.infrai.cc/v1/metrics
Auth header: Authorization: Bearer $INFRAI_API_KEY
bash
# Call any /v1/metrics capability over raw HTTP — no SDK to install.
# curl:
curl https://api.infrai.cc/v1/metrics/... \
  -H "Authorization: Bearer $INFRAI_API_KEY" \
  -H "Content-Type: application/json"

Methods

metrics.report

POST /v1/metrics/report

Report one or more metric points.

Parameters

NameTypeRequiredDescription
namestring
Required
Metric name.
valuenumber
Required
Numeric metric value.
tagsRecord<string, string>OptionalKey/value tags for grouping.

Returns

{ ok: boolean }

Example

一次性前置(每个范例都假定已完成):

bash
# No SDK to install — every call is a plain HTTPS request.
# Get a project key by signing in at https://infrai.cc/login (Google/GitHub gives
# you $2 free credit; email sign-in starts at $0). On 402 INSUFFICIENT_CREDIT, add
# funds at https://infrai.cc/billing (or POST /v1/account/topup and open the
# returned checkout_url).
export INFRAI_API_KEY="ifr_..."
bash
curl -X POST https://api.infrai.cc/v1/metrics/report \
  -H "Authorization: Bearer $INFRAI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name": "...", "value": 0, "type": "counter"}'

metrics.batch

POST /v1/metrics/batch

批量上报指标数据点

Parameters

NameTypeRequiredDescription
pointsMetricPoint[]
Required
指标数据点数组
idempotency_keystringOptional幂等键,用于避免重复写入

Returns

MetricBatchResult

Example

一次性前置(每个范例都假定已完成):

bash
# No SDK to install — every call is a plain HTTPS request.
# Get a project key by signing in at https://infrai.cc/login (Google/GitHub gives
# you $2 free credit; email sign-in starts at $0). On 402 INSUFFICIENT_CREDIT, add
# funds at https://infrai.cc/billing (or POST /v1/account/topup and open the
# returned checkout_url).
export INFRAI_API_KEY="ifr_..."
bash
curl -X POST https://api.infrai.cc/v1/metrics/batch \
  -H "Authorization: Bearer $INFRAI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"points": []}'

metrics.query

GET /v1/metrics/query

查询指标时间序列

Parameters

NameTypeRequiredDescription
namestring
Required
指标名称
agg'p50' | 'p99' | 'sum' | 'avg' | 'count'
Required
聚合方式:p50/p99/sum/avg/count
tagsRecord<string, string>Optional按标签过滤
windowstringOptional聚合时间窗,如 5m、1h
sincestringOptional起始时间
untilstringOptional结束时间

Returns

MetricSeries

Example

一次性前置(每个范例都假定已完成):

bash
# No SDK to install — every call is a plain HTTPS request.
# Get a project key by signing in at https://infrai.cc/login (Google/GitHub gives
# you $2 free credit; email sign-in starts at $0). On 402 INSUFFICIENT_CREDIT, add
# funds at https://infrai.cc/billing (or POST /v1/account/topup and open the
# returned checkout_url).
export INFRAI_API_KEY="ifr_..."
bash
curl -X GET https://api.infrai.cc/v1/metrics/query \
  -H "Authorization: Bearer $INFRAI_API_KEY"

All capabilities

Every routed capability in this module — the complete public REST contract. The methods above are the guided walkthrough; this index is the full reference.

CapabilityEndpointDescription
metrics.batchPOST /v1/metrics/batchReport a batch of metric data points.
metrics.queryGET /v1/metrics/queryQuery a metric time series with aggregation.
metrics.reportPOST /v1/metrics/reportReport a single metric point (counter, gauge, timing, or distribution) with tags and idempotency.

End-to-end example

A production-style walkthrough of this module: configure once, then run the flow. It exercises most of the module's APIs.

A copy-paste-runnable single-file Python program (stdlib only, no SDK): set your INFRAI_API_KEY, run it, and walk this module's core flow with REAL billed calls — later steps reuse real fields returned by earlier ones. The 12-line helper is the entire integration.

python
#!/usr/bin/env python3
"""Infrai · metrics — runnable real-app example (single file, zero deps).

Copy this file, set your key, run it: every step is a REAL call to
api.infrai.cc, billed at the real (tiny) per-call price, printing the
live JSON response. Get a key at https://infrai.cc/login (Google/
GitHub sign-in grants $2 free credit); add funds at
https://infrai.cc/billing. No SDK — the 12-line helper below is the
entire integration."""
import json
import os
from urllib import error, request

KEY = os.environ.get("INFRAI_API_KEY") or "ifr_..."  # <- your key
BASE = "https://api.infrai.cc"


# Same raw HTTPS POST/GET as every per-method example on this page —
# wrapped once for reuse. There is nothing else to it: no SDK.
def infrai(method, path, body=None):
    req = request.Request(
        BASE + path, method=method,
        data=json.dumps(body).encode() if body is not None else None,
        headers={"Authorization": f"Bearer {KEY}",
                 "Content-Type": "application/json"})
    try:
        with request.urlopen(req, timeout=60) as r:
            return json.loads(r.read())
    except error.HTTPError as e:
        return json.loads(e.read())


def show(label, resp):
    print(f"\n== {label} ==")
    print(json.dumps(resp, indent=2, ensure_ascii=False))
    return resp


# 1) metrics.report — POST /v1/metrics/report · Report a single metric point (counter, gauge, timing, or distribution) with tags and idempotency.
r1 = show("metrics.report", infrai("POST", "/v1/metrics/report", {"name":"...","value":0,"type":"counter"}))

# 2) metrics.batch — POST /v1/metrics/batch · Report a batch of metric data points.
r2 = show("metrics.batch", infrai("POST", "/v1/metrics/batch", {"points":[]}))

# 3) metrics.query — GET /v1/metrics/query · Query a metric time series with aggregation.
r3 = show("metrics.query", infrai("GET", "/v1/metrics/query"))