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.

Aggregated threadbreak counts by head/needle

GET /reports/threadbreaks-by-machine/aggregated

Aggregates threadbreak frequency across machine components to identify problematic heads or needles. Flexible grouping (Head, Needle, or both); supports reverse head order for different machine orientations.

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.
includeBobbinThreadbreaksboolean (default false)noInclude bobbin threadbreaks.
groupingstring enum=head|needle|bothyesAggregation mode.
reverseHeadOrderboolean (default false)noIf true, order heads descending.

Response (200 OK)

FieldTypeDescription
data[].id_machinestring
data[].machine_namestring
data[].headinteger
data[].needleinteger
data[].threadbreaksintegerAggregated threadbreak count.

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
includeBobbinThreadbreaks boolean (default false) Include bobbin threadbreaks. No
grouping string enum=head|needle|both Aggregation mode. Yes
reverseHeadOrder boolean (default false) If true, order heads descending. No

Example

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