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.

Production time statistics per design

GET /reports/productiontime

Like Running Time, but uses a broader definition of "productive" time (includes status codes treating certain pauses or secondary activities as productive). Durations are rounded up (ceiling) to whole seconds. Same response schema as /reports/runningtime.

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.
designIdstring (query)noOptional design ID filter.
designStitchesinteger (query)noStitch count of the design.
ignoreOutliersinteger enum=0|10|20|30 (default 0)noOutlier trim percentage.

Response (200 OK)

FieldTypeDescription
data[].designIdstring
data[].designNamestring
data[].designStitchesinteger
data[].passesinteger
data[].minTimeintegerSeconds.
data[].maxTimeintegerSeconds.
data[].avgTimeintegerSeconds.

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
designId string (query) Optional design ID filter. No
designStitches integer (query) Stitch count of the design. No
ignoreOutliers integer enum=0|10|20|30 (default 0) Outlier trim percentage. No

Example

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