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.

Machine productivity

GET /reports/machine-productivity

Detailed productivity report per machine and design. Tracks running time, completed passes and total stitches for each design. Threadbreaks are correlated to the design active at the time. Total stitches = design stitch count × passes.

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 if true.
designIdstring (query)noOptional design ID filter; empty = all designs.
designStitchesinteger (query)noStitch count of the design (required when designId is set).

Response (200 OK)

FieldTypeDescription
data[].machineIdstring
data[].machineNamestring
data[].designIdstring
data[].designStitchesinteger
data[].runningTimeintegerTotal running time in seconds.
data[].totalStitchesintegerdesignStitches * passes.
data[].passesintegerNumber of completed pattern passes.
data[].threadbreaksinteger

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 if true. No
designId string (query) Optional design ID filter; empty = all designs. No
designStitches integer (query) Stitch count of the design (required when designId is set). No

Example

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