List Machine Downtime Events
Beta/v1/operations/machine-downtime-eventsThis endpoint is idempotent. Learn more
Returns a paginated list of machine downtime events, most recent first.
cursoroptional stringOpaque cursor token identifying where the page of results starts.
Use the cursor value embedded in a previous response's next_page_url or previous_page_url to fetch the adjacent page. Omit to start from the first page.
limitoptional integerMaximum number of results to return in a single page.
qoptional stringFree-text search term used to filter results.
Which fields are matched against the term varies by endpoint.
machine_ids[]optional arrayOnly return events for these machines.
department_ids[]optional arrayOnly return events for machines in these departments.
reasons[]optional arrayenumValues:breakdownchangeovermaterial_shortageOnly return events logged against these reasons.
openoptional booleanOnly return events that are still open, meaning the machine is down right now.
start_dateoptional stringOnly return events that started on or after this timestamp, formatted as RFC3339.
end_dateoptional stringOnly return events that started on or before this timestamp, formatted as RFC3339.
include[]optional arrayenumValues:machinedepartmentitemSub-objects to expand in the response. When omitted, sub-objects are returned as null.
objectstringenumValues:listResource type identifier.
page_infoobjectPagination metadata.
next_page_urlstringnullableRelative URL that fetches the next page of results.
null when the last page has been reached.
previous_page_urlstringnullableRelative URL that fetches the previous page of results.
null while on the first page.
has_next_pagebooleanWhether more results exist after this page.
has_prev_pagebooleanWhether results exist before this page.
dataarray of machine_downtime_eventResources in this page.
idstringDowntime event ID.
objectstringenumValues:machine_downtime_eventResource type identifier.
machinemachineExpandablenullableThe machine that stopped.
idstringMachine ID.
objectstringenumValues:machineResource type identifier.
namestringDisplay name of the machine.
Unique within the account.
serial_numberstringSerial number of the machine.
notesstringnullableFree-form notes about the machine.
departmentdepartmentnullableThe department this machine belongs to.
null in this endpoint.created_atstring (date-time)Creation timestamp.
updated_atstring (date-time)Last updated timestamp.
departmentdepartmentExpandablenullableThe department the machine belongs to, captured when the event was logged.
idstringDepartment ID.
objectstringenumValues:departmentResource type identifier.
namestringDisplay name of the department.
Unique within the account.
notesstringnullableFree-form notes about the department.
locationlocationnullableThe storage location where this department operates.
null in this endpoint.Scanning stations in this department.
null in this endpoint.Machines in this department.
null in this endpoint.created_atstring (date-time)Creation timestamp.
updated_atstring (date-time)Last update timestamp.
reasonmachine_downtime_reasonnullableWhy the machine stopped.
objectstringenumValues:machine_downtime_reasonResource type identifier.
codestringenumValues:breakdownchangeovermaterial_shortageStable code identifying the reason.
namestringnullableDisplay name of the reason.
oee_bucketstringnullableenumValues:availabilityperformancequalityWhich OEE term this reason charges.
started_atstring (date-time)When the machine stopped.
ended_atstring (date-time)nullableWhen the machine started running again.
duration_secondsintegernullableHow long the machine was down, in seconds.
shift_atstring (date-time)The business day the stoppage is counted against.
shift_codestringnullableThe shift the stoppage is counted against.
What the machine was running when it stopped.
idstringItem ID.
objectstringenumValues:itemResource type identifier.
skustringStock keeping unit code, unique within the account.
descriptionstringnullableItem description.
notesstringnullableFree-form notes about the item.
typestringenumValues:productmaterialpartWhat kind of item this is.
product: a finished product.material: a raw material or component consumed in production.part: a part used in production.
The category this item belongs to.
The category's unit group determines the base unit the item's rates (unit_value, unit_cost, burn_rate) are expressed in.
null in this endpoint.unit_valueratenullableSelling value per unit, expressed as a rate (e.g. $25.50 / kg).
null in this endpoint.unit_costratenullableCost per unit, expressed as a rate (e.g. $10.00 / kg).
null in this endpoint.burn_rateratenullableRate at which this item is consumed in production, expressed as a quantity over time (e.g. 100 kg / hr).
null in this endpoint.Attributes assigned to this item.
null in this endpoint.created_atstring (date-time)Creation timestamp.
updated_atstring (date-time)Last updated timestamp.
production_runentitynullableThe production run in progress when the machine stopped.
idstringUnique identifier for the entity.
objectstringenumValues:entityResource type identifier.
typestringenumValues:accountactorentityThe 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.
namestringnullableHuman-readable display name for the entity (e.g. a user's full name, a sales order number).
handlestringnullableSecondary human-readable identifier (e.g. email address, username, redacted API key value).
batchentitynullableThe batch in progress when the machine stopped.
idstringUnique identifier for the entity.
objectstringenumValues:entityResource type identifier.
typestringenumValues:accountactorentityThe 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.
namestringnullableHuman-readable display name for the entity (e.g. a user's full name, a sales order number).
handlestringnullableSecondary human-readable identifier (e.g. email address, username, redacted API key value).
schedule_lineentitynullableThe scheduled campaign the stoppage interrupted.
idstringUnique identifier for the entity.
objectstringenumValues:entityResource type identifier.
typestringenumValues:accountactorentityThe 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.
namestringnullableHuman-readable display name for the entity (e.g. a user's full name, a sales order number).
handlestringnullableSecondary human-readable identifier (e.g. email address, username, redacted API key value).
notestringnullableFree-form notes about the stoppage.
reported_byactorExpandablenullableThe actor that logged the event — a user, API key, or agent. Expandable.
idstringUnique identifier of the actor.
objectstringenumValues:actorResource type identifier.
typestringenumValues:userapi_keyagentActor type.
user: a human user account.api_key: a programmatic caller authenticating with an API key.agent: an automated agent acting on the account's behalf.group: a shared group identity, such as a "Customer Service" persona, rather than a single individual.
namestringnullableThe actor's display name.
handlestringnullableHuman-readable handle identifying the actor.
- For
useractors: the user's email address. - For
api_keyactors: the redacted key value.
Other actor types carry no handle.
avatar_urlstringnullableURL of the actor's profile photo, if one is set.
Only populated for user actors.
Assigned role.
null in this endpoint.sourcestringenumValues:manualscannerinferredHow the event was recorded.
created_atstring (date-time)Creation timestamp.
updated_atstring (date-time)Last updated timestamp.
Responses
Successful response for List Machine Downtime Events