Enterprise API Integration Guide

The Enterprise API allows you to programmatically interact with dmaic.app to automate data streams and analysis.

Core Capabilities

Ingest real-time metric data (Single or Batch).
Retrieve historical readings for analysis in external tools.
Create new metrics dynamically in your Data Collection Plan.

Enterprise Plan Only

Authentication

All requests must include the x-api-key header. You can generate keys in Project Settings -> Integrations.

Security Note: API keys are only shown once upon creation. Store them securely.

POST

/api/v1/ingest

Submit new readings for a specific metric. Supports single objects or high-volume batch arrays.

Single Reading Payload

{
  "alias": "OVEN_TEMP_01",
  "value": 225.5,
  "timestamp": "2024-01-01T12:00:00Z",
  "notes": "Sensor reading",
  "batchNumber": "BATCH-001"
}

GET

/api/v1/metrics

Retrieve the definition of all metrics in your project. Useful for mapping aliases before data ingestion.

{
  "projectId": "cmk...",
  "metrics": [
    {
      "id": "m123",
      "name": "Oven Temperature",
      "alias": "OVEN_01",
      "type": "variable",
      "unitOfMeasure": "Celsius"
    }
  ]
}

GET

/api/v1/metrics/readings

Important: Use URL Query Parameters

For GET requests, parameters must be in the URL (e.g. ?alias=...), NOT in the request body.

Full Request URL Example

/api/v1/metrics/readings?alias=OVEN_01&limit=50

Parameter	Type	Description
`alias`	string	Required. The API Alias of the metric.
`limit`	number	Number of records to return (Max 1000). Default 100.

Automatic Field Normalization

The API is designed to be resilient. If you define custom fields in the UI (e.g., "Batch Number"), the API will automatically match incoming JSON keys regardless of casing or spacing (e.g., batchnumber matches Batch Number).

On YouTube