Tawa docs
Analytics

Prometheus scrape endpoint

The org's current billing period as Prometheus text-exposition format — the native scrape target for Grafana's Prometheus data source and Datadog's OpenMetrics/Prometheus check. Always the current billing period; the only query parameter is `include_preview`.

GET
/analytics/metrics

The org's current billing period as Prometheus text-exposition format — the native scrape target for Grafana's Prometheus data source and Datadog's OpenMetrics/Prometheus check. Always the current billing period; the only query parameter is include_preview.

Authorization

AuthorizationBearer <token>

Your API key as a bearer token.

In: header

Query Parameters

include_preview?boolean

Include scans run from the dashboard (free preview scans). Defaults to false, so figures reflect production traffic only.

Response Body

text/plain

application/json

application/json

application/json

curl -X GET "https://example.com/analytics/metrics"
"# HELP tawa_jobs_total Jobs in the current billing period, by status.\n# TYPE tawa_jobs_total counter\ntawa_jobs_total{status=\"completed\"} 4213\n"
{
  "error": "Invalid API key",
  "code": "INVALID_API_KEY",
  "retryAfter": 0
}
{
  "error": "Invalid API key",
  "code": "INVALID_API_KEY",
  "retryAfter": 0
}
{
  "error": "Invalid API key",
  "code": "INVALID_API_KEY",
  "retryAfter": 0
}

Best practices

Rate limits, retries, timeouts, and session grouping — for building your own client against the raw API.

Aggregate metrics for a period GET

Call volume, decisions, latency, credits, and an organization-wide billing snapshot for the calling app. Defaults to the org's current billing period when `start`/`end` are omitted. Requires an analytics API key — a regular scan key is rejected.