Get Analytics Summary

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

Bearer token or X-API-Keyscope: org memberoperation_id: analytics.summary

Authentication

Send either Authorization: Bearer <token> or X-API-Key: <token>. Any org token with sufficient scope. Create tokens from the console or the /v1/orgs/{org_id}/tokens endpoints. Requests without a valid credential are rejected with 401.

SDK install

pip install znyx-sdknpm install @znyx/sdk

Code samples

Request

curl -X GET "$ZNYX_API_URL/v1/orgs/00000000-0000-0000-0000-000000000000/analytics/summary?days=7&tz=UTC" \
  -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

Path parameters

Name	Type	Required	Description
org_id#path	string	required	-

Query parameters

Name	Type	Required	Description
days#query	integer	optional	-
project_id#query	string \| null	optional	Filter by project (app_id)
environment#query	string \| null	optional	Filter by environment name
tz#query	string	optional	IANA timezone for date bucketing, e.g. Asia/Kolkata

Header parameters

Name	Type	Required	Description
X-API-Key#header	string \| null	optional	-
authorization#header	string \| null	optional	-

Responses

Status	Description
200	Successful Response
422	Validation 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

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