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.

Threadbreaks by design

GET /reports/threadbreaks-by-design

Maps threadbreak occurrences to specific stitch positions within a design pattern. Useful for spotting weak digitizing or recurring problem zones.

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.
designIdstring (query)yesDesign / pattern ID to analyze.
designStitchesinteger (query)yesTotal stitch count of the design.

Response (200 OK)

FieldTypeDescription
data.designIdstring
data.designStitchesinteger
data.totalPassesintegerTotal completed passes of this design in the range.
data.threadbreaks[].stitchintegerStitch position where breaks occurred.
data.threadbreaks[].threadbreaksintegerCount of breaks at this stitch.

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
designId string (query) Design / pattern ID to analyze. Yes
designStitches integer (query) Total stitch count of the design. Yes

Example

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