Everything a home-automation client renders, in one response.

Printers (with connection health, the current print and the last finished print), what is loaded in each slot, every spool with its remaining and used grams, and this month's totals. schemaVersion versions the shape: new fields can appear without a bump, so ignore fields you do not know. remainingGrams is null for a spool with no initial weight. Send the response's ETag back in If-None-Match to get a 304 Not Modified. Fetch this when GET /api/sync/version changes, and conditionally every few minutes so connection health (stale after 15 minutes without a heartbeat) stays current.

get/api/Sync/snapshot

Request

Base URL: https://api.3dprintlog.com
URL: https://api.3dprintlog.com/api/Sync/snapshot
Auth: one of:
- OAuth 2 (authorization code, authorization URL https://3dprintlog.auth0.com/authorize, token URL https://3dprintlog.auth0.com/oauth/token)
- API key in header X-Api-Key
- API key in query parameter api_key

Query parameters

timeZonestring

IANA (or Windows) time zone the month totals are counted in. Defaults to the time zone saved in the user's settings, else UTC. Aliases are read back under one canonical id.

Response

Returned with the snapshot.

schemaVersioninteger

The shape's version. Additive fields do not change it.

versionstring nullable

The same opaque value GET /api/sync/version returns.

Changes

No recorded changes to this operation across all 1 revision of this API.