Analytics API¶

Retrieve aggregated analytics including ROI, forecasts, trends, and benchmarks.

Who this is for¶

Developer Admin Executive

Endpoints¶

Method	Path	Description
GET	`/v1/analytics/roi`	ROI analysis
GET	`/v1/analytics/forecasts`	Forecast accuracy
GET	`/v1/analytics/trends`	Trend analysis
GET	`/v1/analytics/benchmarks`	Peer benchmarking
GET	`/v1/analytics/realization`	Value realization

ROI analysis¶

GET /v1/analytics/roi?initiative_id=init_abc123&period=annual

Response:

{
  "initiative_id": "init_abc123",
  "period": "annual",
  "roi_percent": 245,
  "payback_months": 14,
  "npv": 1200000,
  "irr": 0.32,
  "confidence": "high",
  "sensitivity": {
    "best_case": { "roi_percent": 310 },
    "expected": { "roi_percent": 245 },
    "worst_case": { "roi_percent": 180 }
  }
}

Benchmarking¶

GET /v1/analytics/benchmarks?industry=manufacturing&metric=throughput

Compares your metrics against peer datasets from Layer 6 Benchmarks.

Permissions¶

Action	Required Permission
All analytics	`analytics:read`

Limits¶

Limit Analytics queries: 30 per minute.

Limit Historical data: 5 years maximum.