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.

Time comparison (monthly aggregation)

GET /reports/time-comparison

Long-term performance analysis aggregating stitch counts and threadbreaks across the requested period. Includes a normalized "threadbreaks per 10k stitches" metric. Automatically generates entries across the full from/till range.

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[].dayintegerDay as Unix timestamp (seconds, midnight-aligned).
data[].stitchesinteger
data[].threadbreaksinteger
data[].tbPer10knumber (float)Threadbreaks per 10,000 stitches.

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/time-comparison?from=1700000000&till=1700086400"