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.

Threadbreak event log

GET /reports/threadbreaks-by-machine

Detailed log of individual threadbreak events. Includes exact stitch position within the pattern and rotation speed at the moment of the break. Returned in reverse chronological order (newest first).

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".
shiftstring (query, JSON)noOptional shift filter.
includeBobbinThreadbreaksboolean (default false)noInclude bobbin threadbreaks.

Response (200 OK)

FieldTypeDescription
data[].timestampintegerEvent time in ms since epoch.
data[].id_machinestring
data[].machine_namestring
data[].headinteger
data[].needleinteger
data[].patternstringPattern ID.
data[].pattern_stitchnumberintegerStitch position within the pattern at the break.
data[].stitchesintegerTotal stitches in the pattern.
data[].rotation_speedintegerRPM at the time of the break.

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
shift string (query, JSON) Optional shift filter. No
includeBobbinThreadbreaks boolean (default false) Include bobbin threadbreaks. No

Example

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