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.

Operator productivity overview

GET /reports/operator-overview

Productivity report attributed to individual operators. Uses login sessions and token mappings to link machine data (stitches, threadbreaks, pieces) to specific staff members. Includes a per-operator status breakdown.

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.
machineIdsstring (query)yesMachine IDs or "all".
locationIdinteger (default 0)noOptional location filter.
shiftstring (query, JSON)noOptional shift filter.
includeBobbinThreadbreaksboolean (default false)noInclude bobbin threadbreaks.
operatorIdstring (default "all")noFilter by operator ID, or "all".

Response (200 OK)

FieldTypeDescription
data[].operatorIdstring
data[].operatorNamestringName from operator_data.
data[].stitchesinteger
data[].threadbreaksinteger
data[].passingsintegerCompleted pattern passes.
data[].piecesintegerpasses * active heads.
data[].workTimeintegerTotal work time in seconds (operator sessions).
data[].status[].statusinteger
data[].status[].counterinteger
data[].status[].pastTimeintegerDuration in ms.

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
machineIds string (query) Machine IDs or "all". Yes
locationId integer (default 0) Optional location filter. No
shift string (query, JSON) Optional shift filter. No
includeBobbinThreadbreaks boolean (default false) Include bobbin threadbreaks. No
operatorId string (default "all") Filter by operator ID, or "all". No

Example

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