MyZSK API

The MyZSK API is a read-only REST interface that allows for the retrieval of embroidery data, machine statuses, and analytics from the MyZSK platform. It is designed for the programmatic analysis of production, thread breaks, shifts, and operators.

Average RPM per machine

GET /reports/average-rpm

Calculates the average rotation speed (Revolutions Per Minute) per machine, based on productive time during design executions. RPM = total stitches / productive time (minutes).

Authentication

Requires the X-API-Key header.

Parameters

NameTypeRequiredDescription
frominteger (query, Unix s)yesStart of time range.
tillinteger (query, Unix s)yesEnd of time range.
locationIdinteger (default 0)noOptional location filter.
shiftstring (query, JSON)noOptional shift filter.

Response (200 OK)

FieldTypeDescription
data[].locationIdinteger
data[].locationNamestring
data[].machineIdstring
data[].machineNamestring
data[].productiveTimeintegerTotal productive time in seconds.
data[].stitchesinteger
data[].averageRpmnumber (float)e.g. 666.67.

Parameters

Parameter Type Description Required
from integer (query, Unix s) Start of time range. Yes
till integer (query, Unix s) End of time range. Yes
locationId integer (default 0) Optional location filter. No
shift string (query, JSON) Optional shift filter. No

Example

curl -H "X-API-Key: $MYZSK_API_KEY" \
     "https://my.zsk.de/customer-api/reports/average-rpm?from=1700000000&till=1700086400"