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.

Reports

The Reports endpoints provide aggregated production analytics derived from live machine logs (STATUS and MIN tables). All endpoints are read-only HTTP GET, require the X-API-Key header and return JSON.

This section is an overview – each individual report endpoint is documented in its own sub-page (Unterpunkt) listed in the left navigation under Reports.

Shared query parameters

Most report endpoints accept the following parameters (referenced as $ref in the OpenAPI spec):

NameTypeRequiredDescription
frominteger (Unix seconds)yesStart of time range (e.g. 1700000000)
tillinteger (Unix seconds)yesEnd of time range (e.g. 1700086400)
machineIdsstringyesComma-separated machine IDs or "all" (e.g. "26027,26028")
locationIdinteger (default 0)noFilter by location. 0 = all locations.
shiftstring (JSON)noShift filter, e.g. {"from":"06:00","to":"14:00"}. Cross-midnight ranges supported.
includeBobbinThreadbreaksboolean (default false)noIf true, include bobbin threadbreaks (needle = 0).

Endpoints in this section

  1. GET /reports/stitches – Stitches by pattern
  2. GET /reports/threadbreaks – Threadbreaks grouped by head/needle
  3. GET /reports/machine-summary – Machine summary
  4. GET /reports/average-rpm – Average RPM per machine
  5. GET /reports/machine-productivity – Machine productivity
  6. GET /reports/runningtime – Running time statistics per design
  7. GET /reports/productiontime – Production time statistics per design
  8. GET /reports/shift-comparison – Shift comparison
  9. GET /reports/time-comparison – Time comparison (monthly aggregation)
  10. GET /reports/threadbreaks-by-machine – Threadbreak event log
  11. GET /reports/threadbreaks-by-machine/aggregated – Aggregated threadbreak counts by head/needle
  12. GET /reports/threadbreaks-by-design – Threadbreaks by design
  13. GET /reports/design-summary – Detailed design status intervals
  14. GET /reports/daily-design – Daily production by design
  15. GET /reports/number-of-pieces – Number of pieces produced
  16. GET /reports/operator-overview – Operator productivity overview