Capability surfaces (UCSA)
Analytics
UMG compiler. Privacy gates. Lineage. Materialization. Reports / Dashboards / Models / Metrics.
This page is the documentation contract for the Analytics surface in Vadyl's final form. It is not a marketing summary: it names the authorities, projections, runtime behavior, examples, limits, errors, and observability expectations that every product implementation must honor.
What this surface owns
- Analytics owns the canonical product-facing contract described here; provider-specific machinery stays behind capability declarations.
- UMG compiler. Privacy gates. Lineage. Materialization. Reports / Dashboards / Models / Metrics.
- The final docs treat this as complete: REST, GraphQL, gRPC, SDK, CLI, MCP, dashboard, observability, limits, errors, and explainability are all covered as projections of one authority.
Canonical authorities
| Authority | Role |
|---|---|
CapabilitySurfaceKind | Places Analytics inside the UCSA taxonomy and enforces binding, grants, conformance, and consumption. |
CapabilityImplementationDescriptor | Places Analytics inside the UCSA taxonomy and enforces binding, grants, conformance, and consumption. |
CapabilityDeclaration | Places Analytics inside the UCSA taxonomy and enforces binding, grants, conformance, and consumption. |
CapabilityBindingRegistry | Places Analytics inside the UCSA taxonomy and enforces binding, grants, conformance, and consumption. |
Projection coverage
| Surface kinds | GovernedConnectionAdapter, DatabaseInfrastructure, RuntimeSubstrate, Distribution, AnalyticsSubstrate, StorageInfrastructure, CacheInfrastructure |
| Projection facets | ExposureBindings, Analytics, Storage, Connections, RuntimeUnits |
| Protocols | Rest, OpenApi, Sdk, Cli, Dashboard |
| Public projections | provider binding APIs; connector APIs; SDK platform namespace; CLI connector/runtime/distribution/storage commands |
Project-scope parity
Publish, install, consume
Consumption evidence
Runtime behavior
- capability router
- implementation registry
- binding compiler
- conformance runner
- consumption emitter
REST and controller surface
Code-backed controllers are listed here so the docs menu does not hide the real endpoint surface. The complete route-by-route table remains in the REST controller atlas.
| Controller | Base route | Endpoint count | Examples |
|---|---|---|---|
| Connector | /api/Connector | 9 | GET contractsGET contracts/{kind}/{majorVersion:int}GET implementationsGET implementations/{implementationId} |
| DatabaseConnector | /api/DatabaseConnector | 9 | GET /GET {alias}POST /PUT {alias} |
| RuntimeFabric | /api/RuntimeFabric and /api/PlatformRuntimeFabric | 35 | GET {projectId}/fabricGET {projectId}/realization/{projectEnvironmentId}GET {projectId}/health/{projectEnvironmentId}GET {projectId}/topology |
| Distribution | /api/Distribution | 17 | GET projects/{projectId}/bindingsPOST projects/{projectId}/bindingsDELETE projects/{projectId}/bindings/{bindingId}GET projects/{projectId}/policy |
| Analytics | /api/Analytics | 45 | GET catalogGET catalog/subjects/{subjectId}GET catalog/dimensionsGET catalog/measures |
| Storage | /api/Storage | 7 | POST uploadGET download/{**storagePath}HEAD exists/{**storagePath}DELETE {**storagePath} |
| CacheProviderBinding | /api/CacheProviderBinding | 6 | GET /GET {id}POST /PUT {id} |
| Measure | /api/Measure | 3 | GET descriptorsGET descriptors/{nodeIdEncoded}POST query |
SDK and CLI surface
| Projection | Namespace / group | Coverage |
|---|---|---|
| SDK | platform | provider health/capabilities, runtime fabric scaling, distribution, version governance, data portability. Rendered methods: 12. |
| SDK | storage | upload, download, stream, exists, delete, list, presign, copy, move, metadata. Rendered methods: 6. |
| SDK | analytics | catalog, query validate/explain/execute, models, metrics, reports, dashboards, materializations. Rendered methods: 6. |
| SDK | connections | governed connection CRUD, operation invocation, diagnostics, secrets, egress. Rendered methods: 1. |
| CLI | vadyl connector | Contracts, implementations, bindings, builds, conformance, invocation. Rendered commands: 6. |
| CLI | vadyl runtime-fabric | Topology, scaling, resources, ingress, realization, health, binding, deployment plans, reconcile, drain. Rendered commands: 15. |
| CLI | vadyl distribution | CDN bindings, policy, realization, delivery, invalidation, replica policies. Rendered commands: 6. |
| CLI | vadyl storage | Object upload, download, list, metadata, presign, delete. Rendered commands: 7. |
| CLI | vadyl analytics | Catalog, query, models, metrics, reports, dashboards, materializations. Rendered commands: 10. |
Input request and output
GET /api/Connector/contracts HTTP/1.1
Host: api.vadyl.app
Authorization: Bearer $VADYL_TOKEN
X-Vadyl-Tenant: acme
X-Vadyl-Project: billing
Content-Type: application/json
{
"surface": "analytics",
"publicationVersion": 412,
"explain": true
}Limits and quotas
Error model
| Error | Meaning |
|---|