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.

Daily production by design

GET /reports/daily-design

Production data grouped by design key (ID + stitch count). Within each group, data is further broken down by machine and status. duration is total seconds in a status, status_count is the number of times that status occurred. Monitoring patterns (MonM*) are excluded; only designs with at least one "completed" event (status 1012) in the range are included.

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.
locationIdinteger (default 0)noOptional location filter.
shiftstring (query, JSON)noOptional shift filter.

Response (200 OK)

FieldTypeDescription
data[].keystringe.g. 12345_1000.
data[].designIdstring
data[].stitchesstring
data[].data[].machineIdstring
data[].data[].machineNamestring
data[].data[].statusinteger
data[].data[].designIdstring
data[].data[].designNamestring
data[].data[].stitchesinteger
data[].data[].durationintegerTotal duration in seconds.
data[].data[].status_countintegerNumber of times the status occurred.

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
locationId integer (default 0) Optional location filter. No
shift string (query, JSON) Optional shift filter. No

Example

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