---
title: API: analytics
description: REST endpoints tagged analytics — generated from the platform's OpenAPI contract (4 operations).
locale: en
version: 0.2.0
canonical: https://enterium-developer-docs.pages.dev/developers/api/analytics/
---

> Documentation index: https://enterium-developer-docs.pages.dev/developers/llms.txt — every page of this portal has a Markdown twin at <route>.md; the frozen API contract is at https://enterium-developer-docs.pages.dev/developers/api/openapi.json.

:::note
Generated from the OpenAPI contract — do not edit by hand. Interactive explorer with full schemas: [https://entherium.duckdns.org:8443/reference](https://entherium.duckdns.org:8443/reference); frozen spec for this build: [openapi.json](/developers/api/openapi.json).
:::

## `POST /api/v1/analytics/collect`

Collect

[Open as a page →](./post-analytics-collect/)

Trigger a collection run (idempotent; safe to re-run).

`collect=false` runs the cheap SYNCHRONOUS mode: external collectors are not called,
only the ingest of already-fetched files and topic scoring run, and the caller gets the
RESULT instead of an "accepted" — so a scheduled caller can tell whether the loop
actually computed.

**Auth:** `Authorization: Bearer <token>` required

| Parameter | In | Required | Type | Description |
| --- | --- | --- | --- | --- |
| `Idempotency-Key` | header | no | `string` | Optional. |

**Request body:** `application/json` — schema `CollectTrigger`

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `collect` | `boolean` | no |  |
| `date` | `string \| null` | no |  |
| `with_psi` | `boolean` | no |  |

**Responses:**

| Code | Meaning | Body |
| --- | --- | --- |
| `200` | Successful Response | `object` |
| `401` | Missing or invalid authentication credentials | `ErrorResponse` |
| `422` | Validation Error | `HTTPValidationError` |

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

Instance Dashboard

[Open as a page →](./get-analytics-instances-instance-id/)

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

**Auth:** `Authorization: Bearer <token>` required

| Parameter | In | Required | Type | Description |
| --- | --- | --- | --- | --- |
| `instance_id` | path | yes | `string` |  |

**Responses:**

| Code | Meaning | Body |
| --- | --- | --- |
| `200` | Successful Response | `InstanceDashboard` |
| `401` | Missing or invalid authentication credentials | `ErrorResponse` |
| `422` | Validation Error | `HTTPValidationError` |

## `GET /api/v1/analytics/overview`

Overview

[Open as a page →](./get-analytics-overview/)

Cross-instance grid: latest snapshot KPIs + health per instance.

**Auth:** `Authorization: Bearer <token>` required

**Responses:**

| Code | Meaning | Body |
| --- | --- | --- |
| `200` | Successful Response | `OverviewResponse` |
| `401` | Missing or invalid authentication credentials | `ErrorResponse` |

## `GET /api/v1/analytics/runs`

Runs

[Open as a page →](./get-analytics-runs/)

Recent collection-run manifests.

**Auth:** `Authorization: Bearer <token>` required

**Responses:**

| Code | Meaning | Body |
| --- | --- | --- |
| `200` | Successful Response | `array of CollectionRunRead` |
| `401` | Missing or invalid authentication credentials | `ErrorResponse` |