AdminRead a Matter device's recent shadow changes

Read a Matter device's recent shadow changes

Returns the last ~200 shadow records for one device — the reported and desired halves of each inbound AWS IoT shadow event, plus outbound desired writes we sent. Every arrival is kept, including repeats. Kept in Durable Object storage as a bounded ring buffer, deliberately NOT in the event log. Payloads are stored VERBATIM and WHOLE so the exact wire document is readable — nothing is masked (including PIN codes on Door Lock commands) and nothing is size-trimmed short of the DO storage limit itself (~100 KB), so document tails like reported.lastCommand survive. Requires dual auth: X-Admin-API-Key + JWT.

curl -X GET "https://api.spkey.co/admin/shadow-log/John Doe?limit=42&direction=reported" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN (JWT)" \
  -H "X-API-Key: YOUR_API_KEY"
{
  "thingName": "John Doe",
  "capacity": 3.14,
  "total": 3.14,
  "entries": [
    {
      "seq": 3.14,
      "at": "example_string",
      "direction": "reported",
      "shadowName": "John Doe",
      "source": "shadow-webhook",
      "version": "null",
      "payload": "example_string",
      "truncated": true,
      "note": "example_string"
    }
  ]
}
GET
/admin/shadow-log/{thingName}
GET
Base URLstring

Target server for requests. Edit to use your own host.

Bearer Token (JWT)
Bearer Tokenstring
Required

JWT token from SmartphoneKey authentication. Identifies the B2C user or B2B service.

JWT token from SmartphoneKey authentication. Identifies the B2C user or B2B service.
API Key (header: X-API-Key)
X-API-Keystring
Required

API key for B2B organization access. Provided during organization onboarding.

API key for B2B organization access. Provided during organization onboarding.
path
thingNamestring
Required

AWS IoT thing name — identical to the Matter device UUID / aggregate id.

Min length: 1
query
limitinteger

Max entries to return, newest first (default/max 200 — the retained window).

Min: 1 • Max: 200
query
directionstring

Filter to the reported or the desired half of the record stream. Omit for both.

Options: reported, desired
Request Preview
Response

Response will appear here after sending the request

Authentication

header
Authorizationstring
Required

Bearer token (JWT). JWT token from SmartphoneKey authentication. Identifies the B2C user or B2B service.

header
X-API-Keystring
Required

API Key for authentication. API key for B2B organization access. Provided during organization onboarding.

Path Parameters

thingNamestring
Required

AWS IoT thing name — identical to the Matter device UUID / aggregate id.

Query Parameters

limitinteger

Max entries to return, newest first (default/max 200 — the retained window).

directionstring

Filter to the reported or the desired half of the record stream. Omit for both.

Allowed values:reporteddesired

Responses

thingNamestring
Required
capacitynumber
Required
totalnumber
Required
entriesarray
Required