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.

Stitches by pattern

GET /reports/stitches

Provides a detailed breakdown of stitches and threadbreaks for each embroidery design (pattern) executed on the selected machines.

  • Stitch calculation: aggregates stitch counts from minute-by-minute machine logs (MIN tables).
  • Threadbreak attribution: counts threadbreaks occurring while a specific pattern was active.
  • Pattern mapping: uses status logs to correlate machine activity with design IDs and names.
  • Grouping: results aggregated by pattern.

Authentication

Requires the X-API-Key header.

Parameters

NameTypeRequiredDescription
frominteger (query, Unix s)yesStart of time range (Unix seconds).
tillinteger (query, Unix s)yesEnd of time range (Unix seconds).
machineIdsstring (query)yesComma-separated machine IDs or "all".
shiftstring (query, JSON)noOptional shift filter.

Response (200 OK)

FieldTypeDescription
data[].machine_idstring
data[].stitchesintegerTotal stitches recorded for the pattern.
data[].threadbreaksintegerThreadbreaks recorded while the pattern was active.
data[].id_designstringDesign / pattern identifier.
data[].design_namestring
data[].design_stitchesintegerTotal stitch count of the design.

Error responses

  • 400 – Validation error (missing or invalid parameters).

Parameters

Parameter Type Description Required
from integer (query, Unix s) Start of time range (Unix seconds). Yes
till integer (query, Unix s) End of time range (Unix seconds). Yes
machineIds string (query) Comma-separated machine IDs or "all". Yes
shift string (query, JSON) Optional shift filter. No

Example

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