Analyze OEE

Beta

PUT/v1/core/analytics/oee

This endpoint is idempotent. Learn more

Returns Overall Equipment Effectiveness (OEE) metrics by department.

Availability is the scheduled machine time the plant actually planned, net of logged machine downtime — the planned time comes from the published production schedule (or planned_time when supplied), and a department the schedule never covered has no availability rather than a fabricated one. Departments with has_downtime_data false have no downtime measured, and their ratios are returned as null rather than as 100%.

Permission requiredValues:machine_downtime:read

The role behind your API key or agent must grant this permission.

starts_atstring (date-time)

The start date for the analysis period.

ends_atstring (date-time)

The end date for the analysis period.

department_idsoptional array of string

Optional department IDs to filter by.

planned_timeoptional array of object

Overrides the scheduled production time per department for the period. When omitted it is taken from the published production schedule, so this is only needed to measure a period the schedule does not cover. Availability, performance and OEE are only returned for departments the scheduled time covers.

department_idstring

The department ID.

planned_hoursnumber

Scheduled production hours for the period.

objectstringenumValues:analyze_oee_response

Resource type identifier.

departmentslistnullable

The OEE data by department.

objectstringenumValues:list

Resource type identifier.

page_infoobject

Pagination metadata.

next_page_urlstringnullable

Relative URL that fetches the next page of results.

previous_page_urlstringnullable

Relative URL that fetches the previous page of results.

has_next_pageboolean

Whether more results exist after this page.

has_prev_pageboolean

Whether results exist before this page.

dataarray of object

Resources in this page.

departmententitynullable

The department.

idstring

Unique identifier for the entity.

objectstringenumValues:entity

Resource type identifier.

typestringenumValues:accountactorentity

The resource kind that this entity references, as an object-type value (e.g. user, account).

Unlike object — which is always entity — this names the underlying resource the id points to.

namestringnullable

Human-readable display name for the entity (e.g. a user's full name, a sales order number).

handlestringnullable

Secondary human-readable identifier (e.g. email address, username, redacted API key value).

good_unitsnumber

The number of good units produced.

waste_unitsnumber

The number of waste units.

seconds_unitsnumber

The number of seconds units.

standard_seconds_earnednumber

The time this output should have taken at each production step's own labor rate: ideal cycle time multiplied by the units produced. This is the numerator of Performance.

estimated_runtime_hoursnumber

The estimated runtime in hours.

availability_loss_secondsnumber

Logged downtime charged against availability, in seconds.

performance_loss_secondsnumber

Logged downtime charged against performance, in seconds.

quality_loss_secondsnumber

Logged downtime charged against quality, in seconds.

not_scheduled_secondsnumber

Time nobody planned to run, removed from the OEE denominator rather than counted as a loss.

changeover_secondsnumber

Time spent changing over between products, in seconds.

downtime_event_countinteger

Number of downtime events logged in the period.

downtime_breakdownlistnullable

Downtime split by reason, largest first.

objectstringenumValues:list

Resource type identifier.

page_infoobject

Pagination metadata.

next_page_urlstringnullable

Relative URL that fetches the next page of results.

previous_page_urlstringnullable

Relative URL that fetches the previous page of results.

has_next_pageboolean

Whether more results exist after this page.

has_prev_pageboolean

Whether results exist before this page.

dataarray of object

Resources in this page.

reasonstringenumValues:breakdownchangeovermaterial_shortage

Why the machine stopped.

oee_bucketstringenumValues:availabilityperformancequality

Which OEE term this reason charges.

downtime_secondsnumber

Downtime attributed to this reason, in seconds.

event_countinteger

Number of events logged against this reason.

scheduled_secondsnumber

Planned production time net of not-scheduled downtime, in seconds. Availability's denominator.

operating_time_secondsnumber

The scheduled machines' measured run time (first-to-last scan per machine per day), in seconds. Performance's denominator.

run_time_secondsnumber

Operating time counted toward availability: measured run time capped at scheduled time, in seconds.

overrun_secondsnumber

Measured run time beyond the scheduled window, in seconds. A schedule-adherence signal reported apart from OEE, so overtime is not counted as extra availability.

availability_pctnumbernullable

Run time (capped at scheduled) divided by scheduled time.

performance_pctnumbernullable

Standard seconds earned divided by measured operating time: how fast the department ran against the designed speed of its production steps.

quality_pctnumbernullable

Good units divided by total units produced.

oee_pctnumbernullable

Availability multiplied by performance multiplied by quality.

measurement_statusstringenumValues:measuredestimated

Whether availability was measured from logged downtime or estimated from runtime. A department with no logged downtime computes as perfectly available, so an estimate is labeled rather than presented as a measurement.

anomaliesarray of stringenumValues:performance_above_capacity

Data-quality warnings for this grouping. Empty when the numbers can be taken at face value.

Responses

200

Successful response for Analyze OEE

Analyze OEE

import OpenMRP from '@openmrp/sdk';

const client = new OpenMRP({
  bearerToken: 'YOUR_API_KEY', // Your API key goes here
});

const analyzeOeeResponse = await client.core.analytics.updateOee({
  ends_at: '2026-05-10T00:23:00Z',
  starts_at: '2026-05-10T00:00:00Z',
  department_ids: ['dp_m0jayebxnkos'],
});

console.log(analyzeOeeResponse.departments);

import OpenMRP from '@openmrp/sdk';

const client = new OpenMRP({
  bearerToken: 'YOUR_API_KEY', // Your API key goes here
});

const analyzeOeeResponse = await client.core.analytics.updateOee({
  ends_at: '2026-05-10T00:23:00Z',
  starts_at: '2026-05-10T00:00:00Z',
  department_ids: ['dp_m0jayebxnkos'],
});

console.log(analyzeOeeResponse.departments);

200 example

{
  "object": "analyze_oee_response",
  "departments": {
    "object": "list",
    "page_info": {
      "next_page_url": null,
      "previous_page_url": null,
      "has_next_page": false,
      "has_prev_page": false
    },
    "data": [
      {
        "department": {
          "id": "dp_m0jayebxnkos",
          "object": "entity",
          "type": "department",
          "name": "Fabrication",
          "handle": null
        },
        "good_units": 980,
        "waste_units": 20,
        "seconds_units": 5,
        "standard_seconds_earned": 126000,
        "estimated_runtime_hours": 40,
        "availability_loss_seconds": 14850,
        "performance_loss_seconds": 0,
        "quality_loss_seconds": 0,
        "not_scheduled_seconds": 3600,
        "changeover_seconds": 0,
        "downtime_event_count": 6,
        "downtime_breakdown": null,
        "scheduled_seconds": 165000,
        "operating_time_seconds": 0,
        "run_time_seconds": 150150,
        "overrun_seconds": 0,
        "availability_pct": 0.91,
        "performance_pct": 0.84,
        "quality_pct": 0.98,
        "oee_pct": 0.749112,
        "measurement_status": "measured",
        "anomalies": []
      }
    ]
  }
}

{
  "object": "analyze_oee_response",
  "departments": {
    "object": "list",
    "page_info": {
      "next_page_url": null,
      "previous_page_url": null,
      "has_next_page": false,
      "has_prev_page": false
    },
    "data": [
      {
        "department": {
          "id": "dp_m0jayebxnkos",
          "object": "entity",
          "type": "department",
          "name": "Fabrication",
          "handle": null
        },
        "good_units": 980,
        "waste_units": 20,
        "seconds_units": 5,
        "standard_seconds_earned": 126000,
        "estimated_runtime_hours": 40,
        "availability_loss_seconds": 14850,
        "performance_loss_seconds": 0,
        "quality_loss_seconds": 0,
        "not_scheduled_seconds": 3600,
        "changeover_seconds": 0,
        "downtime_event_count": 6,
        "downtime_breakdown": null,
        "scheduled_seconds": 165000,
        "operating_time_seconds": 0,
        "run_time_seconds": 150150,
        "overrun_seconds": 0,
        "availability_pct": 0.91,
        "performance_pct": 0.84,
        "quality_pct": 0.98,
        "oee_pct": 0.749112,
        "measurement_status": "measured",
        "anomalies": []
      }
    ]
  }
}

Analyze OEE

Authorization

Request Body

Returns

Responses