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.

Shift comparison

GET /reports/shift-comparison

Compares productivity metrics (stitches and threadbreaks) across machines and shifts in a selected time frame. If no specific shift is provided, all configured shifts are compared.

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.
includeBobbinThreadbreaksboolean (default false)noInclude bobbin threadbreaks.

Response (200 OK)

FieldTypeDescription
data[].machineIdstring
data[].machineNamestring
data[].locationIdinteger
data[].locationNamestring
data[].stitchesinteger
data[].threadbreaksinteger
data[].shifts[].shiftIdinteger
data[].shifts[].shiftNamestring
data[].shifts[].stitchesinteger
data[].shifts[].threadbreaksinteger

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
includeBobbinThreadbreaks boolean (default false) Include bobbin threadbreaks. No

Example

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