Analyze OEE

Beta
PUT/v1/core/analytics/oee

This endpoint is idempotent. Learn more

Returns Overall Equipment Effectiveness (OEE) metrics by department.

Availability is measured from logged machine downtime rather than inferred, so it requires both planned_time for the department and downtime events in the period. Departments with has_downtime_data false have no availability measurement, and their ratios are returned as null rather than as 100%.

Permissions requiredValues:machine_downtime:read
The role behind your API key or agent must grant every one of these permissions.
start_datestring (date-time)

The start date for the analysis period.

end_datestring (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

Scheduled production time per department for the period. Availability, performance and OEE are only returned for departments this 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.

null when the last page has been reached.

previous_page_urlstringnullable

Relative URL that fetches the previous page of results.

null while on the first page.

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. 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.

null when the last page has been reached.

previous_page_urlstringnullable

Relative URL that fetches the previous page of results.

null while on the first page.

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 time net of not-scheduled downtime, in seconds.

run_time_secondsnumber

Scheduled time net of availability losses, in seconds.

measured_ideal_secondsnumber

The ideal time of the batch tickets in the performance sample, in seconds: what their output should have taken at each production step's ideal cycle time.

measured_run_secondsnumber

The actual time the sampled tickets took, in seconds, measured from the gaps between consecutive batch-ticket scans per machine, net of downtime already charged elsewhere.

performance_ticket_countinteger

The number of batch tickets in the performance sample.

performance_basisstringnullableenumValues:scan_intervalsrun_time_estimate

How performance_pct was obtained: measured from scan intervals, or fallen back to the shift-pattern run-time estimate. Null when performance_pct is null.

availability_pctnumbernullable

Run time divided by scheduled time.

performance_pctnumbernullable

Ideal time over actual time for the sampled batch tickets (measured), or standard seconds earned divided by run time (estimated fallback).

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 labelled 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