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.

Running time statistics per design

GET /reports/runningtime

Min/max/average running time per design execution (pass). A "pass" is the sequence from design start to PATTERN_END. Excludes non-running status codes (idle, error). Durations are floored to whole seconds. Supports outlier removal via ignoreOutliers.

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)noPercentage of fastest+slowest passes to trim.

Response (200 OK)

FieldTypeDescription
data[].designIdstring
data[].designNamestring
data[].designStitchesinteger
data[].passesinteger
data[].minTimeintegerShortest pass in seconds.
data[].maxTimeintegerLongest pass in seconds.
data[].avgTimeintegerAverage pass time in seconds.

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) Percentage of fastest+slowest passes to trim. No

Example

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