Coming soon · Contract draft

Reporting, Utilization & Forecasts

Planned

A bounded analytics surface with explicit cost controls, financial scopes, stable aggregate definitions, and operation-backed exports.

Reviewable specification — not callable

Documentation-first contract draft. The proposed additions on this page are not callable or available yet. Paths, payloads, scopes, names, and examples are intentionally concrete so customers can review the intended contract before and during implementation.

Canonical owner

Reporting, utilization, performance, and forecast services

Contract posture

P2 · Documentation first · implementation follows approval

Contract metadata

Draft version

0.2 review draft

Review owner

Work/Finance + Developer Platform

Last reviewed

July 14, 2026

Target wave

Wave 5 · Financial operations

Contract dependencies

  • Financial/privacy scope matrix
  • Generic Operation resource
  • Transactional audit and event contracts

What this unlocks

Build stable dashboards

Read a stable domain model for reporting, utilization & forecasts without depending on GUI routes or database shapes.

Explain performance variance

Create a reviewable proposal and apply only the bounded commands the canonical owner permits.

Export governed datasets

React to durable lifecycle facts and connect external systems with explicit direction and provenance.

Lifecycle and invariants

Reporting, Utilization & Forecasts exposes a bounded lifecycle with explicit commands and named authority at every transition.

draftreadyrunningcompletedfailedexpired
FromToCommandAuthority
draftreadyValidate reportReporting and aggregate services
readyrunningRun reportReporting and aggregate services
runningcompletedComplete reportReporting and aggregate services
completedexpiredExpire exportReporting and aggregate services

Lifecycle invariants

  • Aggregate definitions are versioned.
  • Person-level and financial fields require separate scopes.

Authority boundaries

The interfaces expose canonical capabilities; they do not become a second owner of domain rules or state.

DigitalStack owns

  • Aggregate and metric definitions
  • Report filters and saved definitions
  • Export operation and threshold state

Explicitly not building

  • Unbounded GraphQL analytics
  • Person-level financial leakage
  • Webhook events for every metric tick

Surface decisions

Deliberate additions, retained boundaries, and removals from the proposed external contract.

add

Stable aggregate queries, saved definitions, thresholds, and asynchronous exports

Dashboards and warehouses need bounded, repeatable metrics.

keep

Cost controls, pagination, and Operation-backed exports

Analytics cannot become an unbounded compute surface.

remove

Arbitrary GraphQL analytics and person-level financial leakage

These create cost, privacy, and least-privilege failures.

Interface plan

REST API

Planned

Versioned reporting, utilization & forecasts resources, commands, idempotency, and operation status.

Reads + explicit commands

GraphQL

Planned

Composable ReportDefinition reads with mutations delegated to the same canonical domain service.

Composable reads + bounded delegated mutations

MCP / Agent API

Planned

Bounded read, draft, and confirmed apply tools with evidence and audit attribution.

Read + proposal/confirmed commands only

Webhooks

Planned

Past-tense report export lifecycle facts with minimal payloads.

Past-tense durable facts only

Connected Apps

Planned

Power BI / Tableau / warehouse plus consumer clients, with declared direction and authority.

Declared direction and field authority required

Cross-interface parity

Each surface delegates to the named canonical owner; a blank surface is an intentional denial of authority, not missing documentation.

CapabilityRESTGraphQLMCPWebhookCanonical owner
Primary readGET /reportsreportDefinition(id: ID!): ReportDefinitionget_reporting_utilizationReporting, utilization, performance, and forecast services
Primary commandPOST /reportsdraftReportDefinitionChange(input: DraftReportDefinitionChangeInput!): ReportDefinitionChangeProposal!draft_reporting_utilization_changereport_export.createdReporting, utilization, performance, and forecast services

Proposed scopes

Proposed scopes are not grantable yet.

reports:readplanned scope
Read governed reporting, utilization & forecasts resources.
reports:writeplanned scope
Create and edit bounded reporting, utilization & forecasts fields.
reports:operateplanned scope
Run explicit reporting, utilization & forecasts lifecycle commands.

Behavioral contract

Cross-cutting rules every implementation and interface must satisfy.

Canonical delegation

Every interface delegates to Reporting, utilization, performance, and forecast services; no resolver, gateway, worker, or connector reimplements domain rules.

Least-privilege principals

Scopes are evaluated with tenant, role, field-visibility, and principal-type constraints before data is read or changed.

Safe writes

Mutations use explicit confirmation where required, optimistic concurrency, idempotency, and durable actor attribution.

Transactional facts

Webhook facts are emitted from the canonical commit path, versioned, minimal, and safe to redeliver.

Declared provider authority

Every Connected App declares direction, field authority, provenance, and conflict behavior before activation.

REST API

Proposed endpoints

Planned
GET/api/v1/reports

List reporting, utilization & forecasts

Return an authorized, paginated collection with stable filters and provenance.

reports:read

POST/api/v1/reportsconfirmation

Create ReportDefinition

Create one canonical resource with idempotency and actor attribution.

reports:write

GET/api/v1/reports/{id}

Retrieve ReportDefinition

Return canonical detail, lifecycle state, permissions, and allowed actions.

reports:read

PATCH/api/v1/reports/{id}confirmation

Update ReportDefinition

Update bounded editable fields using optimistic versioning.

reports:write

POST/api/v1/reports/{id}/runconfirmation

run ReportDefinition

Run one explicit domain command after validation and authorization.

reports:operate

run a ReportDefinition

curl --request POST \
+  --url https://www.digitalstack360.com/api/v1/reports/report_export_123/run \
+  --header "Authorization: Bearer $DSTACK_API_KEY" \
+  --header "Content-Type: application/json" \
+  --header "Idempotency-Key: reporting-utilization-run-v2" \
+  --data '{
    "expected_version": 2,
    "reason": "Confirmed through the reviewed integration workflow"
  }'
Planned response
{
  "data": {
    "id": "report_export_123",
    "status": "completed",
    "version": 3,
    "operation_id": "op_01k4..."
  }
}

GraphQL

Proposed graph

Planned

Types

ReportDefinition
ReportDefinitionConnection
ReportDefinitionChangeProposal
Operation

Queries

reportDefinition(id: ID!): ReportDefinition
reportDefinitionList(filter: ReportDefinitionFilter, pagination: PaginationInput): ReportDefinitionConnection!

Mutations

draftReportDefinitionChange(input: DraftReportDefinitionChangeInput!): ReportDefinitionChangeProposal!
applyReportDefinitionChange(input: ApplyReportDefinitionChangeInput!): ReportDefinitionPayload!
Planned GraphQL query
query ReportDefinitionDetail($id: ID!) {
  reportDefinition(id: $id) {
    id
    status
    version
    updatedAt
    allowedActions { id label requiresConfirmation }
    source { kind externalId }
  }
}

MCP / Agent API

Proposed tools

Planned

Get Reporting, Utilization & Forecasts

get_reporting_utilization
Planned

Read the authorized reporting, utilization & forecasts state, provenance, and allowed actions.

Scope
reports:read
Input
Resource id or a bounded filter.
Output
Canonical detail with source provenance and allowed actions.
Write boundary
Read only.

Draft Reporting, Utilization & Forecasts change

draft_reporting_utilization_change
Planned

Build a reviewable proposal from explicit user intent and DigitalStack evidence.

Scope
reports:write
Input
Target, requested outcome, expected version, and optional evidence references.
Output
A persisted proposal, validation results, and conflicts.
Write boundary
Creates a proposal; it does not mutate canonical state.

Apply Reporting, Utilization & Forecasts change

apply_reporting_utilization_change
Planned

Apply a reviewed proposal through the canonical service.

Scope
reports:operate
Input
Proposal id, expected version, idempotency key, and explicit confirmation.
Output
Updated canonical resource and audit reference.
Write boundary
Confirmation, optimistic versioning, and idempotency required.
Planned agent workflow
User: Review the proposed reporting, utilization & forecasts change and help me apply it.

1. Call get_reporting_utilization to inspect current state, provenance, and allowed actions.
2. Call draft_reporting_utilization_change to create a proposal without changing canonical state.
3. Show validation results, conflicts, and the exact command to the user.
4. After explicit confirmation, call apply_reporting_utilization_change with the proposal version.

Never infer authority from access to the MCP client.

Webhooks

Proposed event catalog

Planned

Event types

report_export.createdplanned event

A canonical ReportDefinition was created.

payload: report_export_id, status, created_at

report_export.updatedplanned event

Governed ReportDefinition fields changed.

payload: report_export_id, changed_fields, version, occurred_at

report_export.completedplanned event

The run command completed.

payload: report_export_id, prior_status, status, occurred_at

Planned event example
{
  "event_id": "evt_01k4...",
  "type": "report_export.completed",
  "event_version": 1,
  "occurred_at": "2026-07-16T14:22:04Z",
  "workspace_id": "ws_abc123",
  "resource": {
    "type": "report_export",
    "id": "report_export_123"
  },
  "actor": {
    "id": "user_123"
  },
  "payload": {
    "report_export_id": "report_export_123",
    "prior_status": "draft",
    "status": "completed"
  },
  "source": null
}

Connected Apps

Proposed connection roles

Planned

Claude / ChatGPT / IDE clients

Consumer application

Read, explain, and submit bounded reporting, utilization & forecasts proposals through MCP.

Authority: Client access never implies domain approval or unrestricted mutation authority.

Power BI / Tableau / warehouse

Analytics sink

Consume aggregates, exports, and threshold facts.

Authority: Read-only analytics; no mutation of operational truth.

Open contract decisions

Resolve before implementation approval

  • Which aggregates are safe for near-real-time reads versus snapshot-only export?

Proof obligations

Must remain trueFailure indicator
Reporting, utilization, performance, and forecast services remains the singular canonical owner.An interface or connector persists a second authoritative lifecycle state.
Draft and apply remain separate actions.An agent or integration silently converts inferred intent into a canonical mutation.
Every write is attributable, versioned, and idempotent.A retry duplicates work or stale state overwrites a newer human decision.
Connected App direction and field authority are explicit.Provider data silently becomes canonical or conflicts are resolved without policy.