GET /api/v1/analytics/instances/{instance_id}

Status: GA Access: token required API contract: 0.3.0 · capability 2026-09-03.1 View as Markdown Open in Claude Open in ChatGPT

Instance Dashboard

Everything one per-instance analytics panel needs (snapshot + trends + queries + pages + index).

Auth: Authorization: Bearer <token> required

Request

curl -sS -X GET "https://entherium.duckdns.org:8443/api/v1/analytics/instances/<instance_id>" \
  -H "Authorization: Bearer <token>"

The contract carries no example for this response; schema: InstanceDashboard. Field-level shape: interactive explorer.

InstanceDashboard — Successful Response

Field	Type	Description
`authority`	`array of AuthoritySnapshotRead` (opt.)
`domain`	`string \| null` (opt.)
`health_flags`	`array of HealthFlag` (opt.)
`index_push_effect`	`IndexPushEffect \| null` (opt.)
`indexation`	`array of IndexCheckRead` (opt.)
`instance_id`	`string`
`latest`	`InstanceSnapshotRead \| null` (opt.)
`top_pages`	`array of PageStatRead` (opt.)
`top_queries`	`array of QueryStatRead` (opt.)
`trends`	`array of TrendSeries` (opt.)

Parameter	In	Required	Type	Default	Constraints	Description
`instance_id`	path	yes	`string`	—	—

Code	Meaning	Body
`401`	Missing or invalid authentication credentials	`ErrorResponse`
`422`	Validation Error	`HTTPValidationError`

Every error body is {detail, code?, request_id, doc_url} — request_id is the value to quote, doc_url points at the Errors reference.