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.

Number of pieces produced

GET /reports/number-of-pieces

Estimates the total number of physical pieces produced by each machine, accounting for multi-head configurations. Pieces = passes × activeHeads. Active heads are detected automatically from logs, manual overrides or hardware specs.

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.

Response (200 OK)

FieldTypeDescription
data[].machineIdstring
data[].machineNamestring
data[].designIdstring
data[].designNamestring
data[].designStitchesinteger
data[].passesintegerCompleted pattern passes.
data[].activeHeadsintegerActive embroidery heads.
data[].piecesintegerpasses * activeHeads.
data[].totalStitchesintegerpieces * designStitches.

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

Example

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