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.

Threadbreaks grouped by head/needle

GET /reports/threadbreaks

Analyzes threadbreak distribution across machine components (heads and needles) to identify persistent mechanical issues or problematic thread/needle combinations.

  • Grouping: Head and Needle (HN), Head only (H), or Needle only (N).
  • Bobbin filter: include or exclude bobbin threadbreaks (needle = 0).
  • Ordering: results ordered by machine then by threadbreak frequency (highest first).

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 if true.
groupingstring enum=HN|H|N (default HN)noGrouping mode.

Response (200 OK)

FieldTypeDescription
data[].id_machinestring
data[].machine_namestring
data[].headintegerHead number.
data[].needleintegerNeedle number.
data[].threadbreaksintegerNumber of threadbreaks for this combination.

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 if true. No
grouping string enum=HN|H|N (default HN) Grouping mode. No

Example

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