Analyze OEE trend

Beta

PUT/v1/core/analytics/oee-trend

This endpoint is idempotent. Learn more

Returns Overall Equipment Effectiveness (OEE) by production week.

Each period carries the same four terms /v1/core/analytics/oee reports for a single window, rolled up across departments and weighted by seconds rather than averaged, so a department that ran for an hour does not weigh as heavily as one that ran all week. Weeks start on Monday, and the first and last period of a window are clipped to the window itself.

Only departments with scheduled time take part: a department with no machines has no availability, so counting its output in quality would leave the three terms describing different plants. Compare two windows by calling this twice.

Permissions requiredValues:machine_downtime:read

The role behind your API key or agent must grant every one of these permissions.

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

Restrict the analysis to these departments.

objectstringenumValues:analyze_oee_trend_response

Resource type identifier.

periodslistnullable

One entry per production week in the requested window, oldest 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.

starts_atstring (date-time)

The first instant this period covers. Weeks start on Monday; the first and last periods of a window are clipped to the window itself.

ends_atstring (date-time)

The instant this period ends, exclusive.

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.

scheduled_secondsnumber

Planned time net of not-scheduled downtime, in seconds.

run_time_secondsnumber

Scheduled time net of availability losses, in seconds.

availability_loss_secondsnumber

Logged downtime charged against availability, in seconds.

not_scheduled_secondsnumber

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

availability_pctnumbernullable

Run time divided by scheduled time.

performance_pctnumbernullable

Standard seconds earned divided by run time.

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.

downtime_event_countinteger

Number of downtime events overlapping this period.

Responses

200

Successful response for Analyze OEE trend

Analyze OEE trend

import Augno from '@augno/sdk';

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

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

console.log(analyzeOeeTrendResponse.object);

import Augno from '@augno/sdk';

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

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

console.log(analyzeOeeTrendResponse.object);

200 example

{
  "object": "analyze_oee_trend_response",
  "periods": {
    "object": "list",
    "page_info": {
      "next_page_url": null,
      "previous_page_url": null,
      "has_next_page": false,
      "has_prev_page": false
    },
    "data": [
      {
        "starts_at": "2026-05-10T00:00:00Z",
        "ends_at": "2026-05-10T00:23:00Z",
        "good_units": 980,
        "waste_units": 20,
        "seconds_units": 5,
        "standard_seconds_earned": 126000,
        "scheduled_seconds": 165000,
        "run_time_seconds": 150150,
        "availability_loss_seconds": 14850,
        "not_scheduled_seconds": 3600,
        "availability_pct": 0.91,
        "performance_pct": 0.84,
        "quality_pct": 0.98,
        "oee_pct": 0.749112,
        "measurement_status": "measured",
        "downtime_event_count": 6
      }
    ]
  }
}

{
  "object": "analyze_oee_trend_response",
  "periods": {
    "object": "list",
    "page_info": {
      "next_page_url": null,
      "previous_page_url": null,
      "has_next_page": false,
      "has_prev_page": false
    },
    "data": [
      {
        "starts_at": "2026-05-10T00:00:00Z",
        "ends_at": "2026-05-10T00:23:00Z",
        "good_units": 980,
        "waste_units": 20,
        "seconds_units": 5,
        "standard_seconds_earned": 126000,
        "scheduled_seconds": 165000,
        "run_time_seconds": 150150,
        "availability_loss_seconds": 14850,
        "not_scheduled_seconds": 3600,
        "availability_pct": 0.91,
        "performance_pct": 0.84,
        "quality_pct": 0.98,
        "oee_pct": 0.749112,
        "measurement_status": "measured",
        "downtime_event_count": 6
      }
    ]
  }
}

Analyze OEE trend

Authorization

Request Body

Returns

Responses