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.

Detailed design status intervals

GET /reports/design-summary

Returns individual production intervals (status logs) for a specific design across multiple machines. Returns each state transition with start/stop timestamps as strings (Unix milliseconds). Numerical values are returned as strings for legacy compatibility. pastTime is the interval duration in ms.

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.
designIdstring (query)yesDesign ID to report on.
designStitchesinteger (query)yesExpected stitch count of the design.

Response (200 OK)

FieldTypeDescription
data[].machineIdstring
data[].machineNamestring
data[].designIdstring
data[].designNamestring
data[].stitchesstringDesign stitch count (string).
data[].statusstringZSK status code (string).
data[].startstringStart timestamp (Unix ms).
data[].stopstringStop timestamp (Unix ms).
data[].pastTimestringDuration of the interval (ms).
data[].counterstringInterval occurrence counter (usually 1).

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
designId string (query) Design ID to report on. Yes
designStitches integer (query) Expected stitch count of the design. Yes

Example

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