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 summary

GET /reports/machine-summary

Comprehensive summary of performance metrics per machine within a timeframe. Aggregates stitches, threadbreaks, status durations (Running, Stopped, Manual etc.) and computes utilization and SPM. Includes a statusBreakdown map of status code to total seconds.

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.

Response (200 OK)

FieldTypeDescription
data[].machineIdstring
data[].machineNamestring
data[].stitchesinteger
data[].threadbreaksinteger
data[].passesintegerNumber of completed pattern passes.
data[].piecesintegerpasses * active heads.
data[].totalTimeintegerTotal time in seconds (all status durations).
data[].productionTimeintegerProduction time in seconds.
data[].utilizationnumber (float)(productionTime / totalTime) * 100.
data[].stitchesPerMinutenumber (float)stitches / (totalTime / 60).
data[].statusBreakdownobjectMap of status code to total 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
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

Example

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