Analytics APIs¶

Why This Exists¶

This document defines API responsibilities for the Analytics Domain. It does not define final OpenAPI specifications.

Owner¶

The owner is the Chief Product Officer and Enterprise Architect.

Business Value¶

Analytics APIs give dashboards, reports, Executive Office workflows, and Digital Professionals a controlled way to access reporting models and insight records.

API Groups¶

API group	Responsibilities	Example endpoints
KPI Definition API	Create, approve, revise, and retrieve KPI definitions.	`GET /analytics/kpis`, `POST /analytics/kpis`, `POST /analytics/kpis/{kpiId}/approve`
Dashboard API	Retrieve and manage dashboards.	`GET /analytics/dashboards`, `GET /analytics/dashboards/{dashboardId}`
Report API	Generate and retrieve reports.	`POST /analytics/reports/{reportId}/generate`, `GET /analytics/reports`
Metric Snapshot API	Retrieve metric snapshots by scope and period.	`GET /analytics/snapshots?organizationId=&period=`
Analytical View API	Retrieve approved analytical views.	`GET /analytics/views`, `POST /analytics/views/{viewId}/refresh`
Insight API	Create, review, and retrieve insight records.	`GET /analytics/insights`, `POST /analytics/insights/{insightId}/review`
CEO Briefing API	Create and retrieve executive briefings.	`POST /analytics/briefings`, `GET /analytics/briefings/{briefingId}`
Procurement Performance API	Retrieve overall procurement dashboard metrics.	`GET /analytics/procurement-performance`
Win/Loss API	Retrieve bid outcome and win/loss analytics.	`GET /analytics/win-loss`
Compliance Trend API	Retrieve compliance readiness and expiry trends.	`GET /analytics/compliance-trends`
Contract Performance API	Retrieve milestone, payment, risk, and delivery performance.	`GET /analytics/contract-performance`
Supplier Performance API	Retrieve supplier performance summaries.	`GET /analytics/supplier-performance`
Funding Analytics API	Retrieve funding readiness and cash-flow risk analytics.	`GET /analytics/funding`
Learning Analytics API	Retrieve learning progress and maturity analytics.	`GET /analytics/learning`

API Design Rules¶

Analytics APIs expose reporting models, not source-domain command endpoints.
Source domain corrections must be made in the owning domain, then reflected through refresh or event processing.
Executive briefing APIs must expose source lineage and generated-at metadata.
Final OpenAPI contracts will be defined later.

Example Briefing Flow¶

sequenceDiagram
    participant ExecutiveOffice as Executive Office
    participant AnalyticsAPI as Analytics API
    participant Analytics
    participant Intelligence

    ExecutiveOffice->>AnalyticsAPI: POST /analytics/briefings
    AnalyticsAPI->>Analytics: Prepare briefing
    Analytics->>Intelligence: Request explanation support
    Intelligence-->>Analytics: Explanation metadata
    Analytics-->>AnalyticsAPI: CEO briefing
    AnalyticsAPI-->>ExecutiveOffice: Briefing response