Analyze Schedule Attainment

Beta

PUT/v1/core/analytics/schedule-attainment

This endpoint is idempotent. Learn more

Returns actual production measured against the plan that was live at the time.

The baseline for each week is the schedule version published on or before that week began, so republishing mid-horizon cannot rewrite a week the floor has already worked. baseline_schedules names the versions used.

Two ratios are returned because either alone misleads: attainment_pct caps each campaign at what was asked for, so over-building one SKU cannot hide a miss on another, while output_ratio_pct is uncapped and is what reveals over-production. Production with no matching planned campaign is reported as unplanned_quantity rather than discarded — that number is the clearest signal a schedule is being worked around.

Every ratio is null rather than zero when nothing was planned, and has_baseline is false when nothing was ever published over the period.

Permissions requiredValues:production_schedules: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.

group_byoptional stringenumValues:weekmachinedepartment

The dimension to break the results down by. Defaults to week.

machine_idsoptional array of string

Only measure production on these machines.

department_idsoptional array of string

Only measure production in these departments.

objectstringenumValues:analyze_schedule_attainment_response

Resource type identifier.

starts_atstring (date-time)

Start of the measured period.

ends_atstring (date-time)

End of the measured period.

group_bystringenumValues:weekmachinedepartment

The dimension the breakdown is grouped by.

baseline_scheduleslistnullable

The published versions the measurement was taken against.

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 entity

Resources in this page.

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

bucketslistnullable

The breakdown.

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.

keystring

Identifies the bucket within the chosen grouping — a week start, machine ID, department ID or item ID.

labelstring

Display label for the bucket.

week_starts_atstring (date-time)nullable

First day of the week, when grouping by week.

planned_quantitynumber

Units the live plan called for.

actual_quantitynumber

Units actually produced.

matched_quantitynumber

Units produced that were planned for, capped per campaign at what was asked.

waste_quantitynumber

Units scrapped.

unplanned_quantitynumber

Units produced with no matching planned campaign.

planned_run_hoursnumber

Machine hours the plan called for.

planned_linesinteger

Planned campaigns in this bucket.

batch_countinteger

Batches scanned in this bucket.

attainment_pctnumbernullable

Share of the plan that was met. Null when nothing was planned.

output_ratio_pctnumbernullable

Output as a share of plan, uncapped. Null when nothing was planned.

totalsobject

Every bucket combined.

keystring

Identifies the bucket within the chosen grouping — a week start, machine ID, department ID or item ID.

labelstring

Display label for the bucket.

week_starts_atstring (date-time)nullable

First day of the week, when grouping by week.

planned_quantitynumber

Units the live plan called for.

actual_quantitynumber

Units actually produced.

matched_quantitynumber

Units produced that were planned for, capped per campaign at what was asked.

waste_quantitynumber

Units scrapped.

unplanned_quantitynumber

Units produced with no matching planned campaign.

planned_run_hoursnumber

Machine hours the plan called for.

planned_linesinteger

Planned campaigns in this bucket.

batch_countinteger

Batches scanned in this bucket.

attainment_pctnumbernullable

Share of the plan that was met. Null when nothing was planned.

output_ratio_pctnumbernullable

Output as a share of plan, uncapped. Null when nothing was planned.

frozen_adherencelistnullable

Frozen-week adherence per baseline version.

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.

scheduleentitynullable

The published version this measures.

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

versioninteger

Version number of that schedule.

frozen_line_countinteger

Campaigns frozen at publish.

frozen_planned_quantitynumber

Units frozen at publish.

deviated_linesinteger

Frozen campaigns that were changed after publish.

added_linesinteger

Campaigns added into the frozen window after publish.

abs_delta_unitsnumber

Total absolute unit change across frozen-week deviations.

line_adherence_pctnumbernullable

Share of frozen campaigns that survived untouched. Null when nothing was frozen.

units_adherence_pctnumbernullable

Share of frozen units that survived untouched. Null when nothing was frozen.

frozen_through_atstring (date-time)nullable

Last day of the frozen window.

baseline_statusstringenumValues:measuredno_baseline

Whether the period had a plan to measure against. When no_baseline, every ratio is null and the period has no plan rather than a missed one.

Responses

200

Successful response for Analyze Schedule Attainment

Analyze Schedule Attainment

import Augno from '@augno/sdk';

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

const analyzeScheduleAttainmentResponse = await client.core.analytics.updateScheduleAttainment({
  end_date: '2026-05-10T00:23:00Z',
  start_date: '2026-05-10T00:00:00Z',
  group_by: 'week',
});

console.log(analyzeScheduleAttainmentResponse.baseline_schedules);

import Augno from '@augno/sdk';

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

const analyzeScheduleAttainmentResponse = await client.core.analytics.updateScheduleAttainment({
  end_date: '2026-05-10T00:23:00Z',
  start_date: '2026-05-10T00:00:00Z',
  group_by: 'week',
});

console.log(analyzeScheduleAttainmentResponse.baseline_schedules);

200 example

{
  "object": "analyze_schedule_attainment_response",
  "starts_at": "2026-05-10T00:00:00Z",
  "ends_at": "2026-05-10T00:23:00Z",
  "group_by": "week",
  "baseline_schedules": {
    "object": "list",
    "page_info": {
      "next_page_url": null,
      "previous_page_url": null,
      "has_next_page": false,
      "has_prev_page": false
    },
    "data": [
      {
        "id": "pnsc_0192a4c17b3e4f8a91c2d0",
        "object": "entity",
        "type": "production_schedule",
        "name": null,
        "handle": null
      }
    ]
  },
  "buckets": {
    "object": "list",
    "page_info": {
      "next_page_url": null,
      "previous_page_url": null,
      "has_next_page": false,
      "has_prev_page": false
    },
    "data": [
      {
        "key": "2026-07-27T00:00:00Z",
        "label": "2026-07-27T00:00:00Z",
        "week_starts_at": null,
        "planned_quantity": 4200,
        "actual_quantity": 4032,
        "matched_quantity": 3885,
        "waste_quantity": 48,
        "unplanned_quantity": 147,
        "planned_run_hours": 63,
        "planned_lines": 7,
        "batch_count": 58,
        "attainment_pct": 92.5,
        "output_ratio_pct": 96
      }
    ]
  },
  "totals": {
    "key": "total",
    "label": "Total",
    "week_starts_at": null,
    "planned_quantity": 4200,
    "actual_quantity": 4032,
    "matched_quantity": 3885,
    "waste_quantity": 48,
    "unplanned_quantity": 147,
    "planned_run_hours": 63,
    "planned_lines": 7,
    "batch_count": 58,
    "attainment_pct": 92.5,
    "output_ratio_pct": 96
  },
  "frozen_adherence": {
    "object": "list",
    "page_info": {
      "next_page_url": null,
      "previous_page_url": null,
      "has_next_page": false,
      "has_prev_page": false
    },
    "data": [
      {
        "schedule": {
          "id": "pnsc_0192a4c17b3e4f8a91c2d0",
          "object": "entity",
          "type": "production_schedule",
          "name": null,
          "handle": null
        },
        "version": 1,
        "frozen_line_count": 8,
        "frozen_planned_quantity": 4200,
        "deviated_lines": 1,
        "added_lines": 0,
        "abs_delta_units": 252,
        "line_adherence_pct": 87.5,
        "units_adherence_pct": 94,
        "frozen_through_at": null
      }
    ]
  },
  "baseline_status": "measured"
}

{
  "object": "analyze_schedule_attainment_response",
  "starts_at": "2026-05-10T00:00:00Z",
  "ends_at": "2026-05-10T00:23:00Z",
  "group_by": "week",
  "baseline_schedules": {
    "object": "list",
    "page_info": {
      "next_page_url": null,
      "previous_page_url": null,
      "has_next_page": false,
      "has_prev_page": false
    },
    "data": [
      {
        "id": "pnsc_0192a4c17b3e4f8a91c2d0",
        "object": "entity",
        "type": "production_schedule",
        "name": null,
        "handle": null
      }
    ]
  },
  "buckets": {
    "object": "list",
    "page_info": {
      "next_page_url": null,
      "previous_page_url": null,
      "has_next_page": false,
      "has_prev_page": false
    },
    "data": [
      {
        "key": "2026-07-27T00:00:00Z",
        "label": "2026-07-27T00:00:00Z",
        "week_starts_at": null,
        "planned_quantity": 4200,
        "actual_quantity": 4032,
        "matched_quantity": 3885,
        "waste_quantity": 48,
        "unplanned_quantity": 147,
        "planned_run_hours": 63,
        "planned_lines": 7,
        "batch_count": 58,
        "attainment_pct": 92.5,
        "output_ratio_pct": 96
      }
    ]
  },
  "totals": {
    "key": "total",
    "label": "Total",
    "week_starts_at": null,
    "planned_quantity": 4200,
    "actual_quantity": 4032,
    "matched_quantity": 3885,
    "waste_quantity": 48,
    "unplanned_quantity": 147,
    "planned_run_hours": 63,
    "planned_lines": 7,
    "batch_count": 58,
    "attainment_pct": 92.5,
    "output_ratio_pct": 96
  },
  "frozen_adherence": {
    "object": "list",
    "page_info": {
      "next_page_url": null,
      "previous_page_url": null,
      "has_next_page": false,
      "has_prev_page": false
    },
    "data": [
      {
        "schedule": {
          "id": "pnsc_0192a4c17b3e4f8a91c2d0",
          "object": "entity",
          "type": "production_schedule",
          "name": null,
          "handle": null
        },
        "version": 1,
        "frozen_line_count": 8,
        "frozen_planned_quantity": 4200,
        "deviated_lines": 1,
        "added_lines": 0,
        "abs_delta_units": 252,
        "line_adherence_pct": 87.5,
        "units_adherence_pct": 94,
        "frozen_through_at": null
      }
    ]
  },
  "baseline_status": "measured"
}

Analyze Schedule Attainment

Authorization

Request Body

Returns

Responses