Skip to main content

Traces & Observability

GET/v1/orgs/{org_id}/analytics/summary

Get Analytics Summary

Get aggregated analytics summary for an organization, optionally scoped to a project/environment.

Runtime, CI or Admin tokenscope: readoperation_id: analytics.summary

Authentication

Any bearer token belonging to the org can read this endpoint.

SDK install

pip install znyx-sdknpm install @znyx/sdk

Path parameters

NameTypeRequiredDescription
org_id#pathstringrequired

Query parameters

NameTypeRequiredDescription
days#queryintegeroptional
project_id#querystring | nulloptionalFilter by project (app_id)
environment#querystring | nulloptionalFilter by environment name

Header parameters

NameTypeRequiredDescription
X-API-Key#headerstring | nulloptional
authorization#headerstring | nulloptional

Responses

StatusDescription
200Successful Response
422Validation Error

Response schema

period_daysrequiredinteger
total_evaluationsrequiredinteger
decisionsrequiredobject
block_rate_percentrequirednumber
avg_latency_msrequirednumber
daily_trendobject | null
latency_statsLatencyStats | null
risk_distributionRiskBucket[] | null
hourly_volumeHourlyVolume[] | null
top_detectorsDetectorHit[] | null

Errors & what triggers them

CodeTriggerFix
401Missing or expired Authorization header.
403Token does not have org access (wrong org_id, or insufficient role).
404Resource does not exist in this org.

Request

curl -X GET 'https://api.znyx.ai/v1/orgs/00000000-0000-0000-0000-000000000000/analytics/summary' \
  -H 'Authorization: Bearer $ZNYX_TOKEN'

Response

application/json

Successful Response

{
  "period_days": 0,
  "total_evaluations": 0,
  "decisions": {},
  "block_rate_percent": 0,
  "avg_latency_ms": 0,
  "daily_trend": null,
  "latency_stats": null,
  "risk_distribution": null,
  "hourly_volume": null,
  "top_detectors": null
}

Schema: object