read

Every write made to this store, with who, on whose approval, before, after, revert and cost.

One row per recorded write, newest first, across every place a write is recorded. action_id joins the rows that belong to one action. actor is <kind>:<name> with kind one of user, agent, app, key, operator or system; unattributed marks a row written before actors were recorded. before is the value the write replaced, or an object naming why it is absent (_unavailable) or where it will be captured (_pending). action_cost_credits is the credits the whole action cost, repeated on each of its rows, and null when nothing was attributed to it — not zero. Pages are keyset: pass next_cursor back as cursor. A json page answers { ok, result: { receipts, page, scope } }; a csv or jsonl page carries its cursor in the x-next-cursor header. all=true streams the whole history as CSV or JSONL and ends with a manifest line (rows, sha256 of every line before it, complete, next_cursor); when complete is false the export stopped after 50 seconds and next_cursor resumes it.

post/api/v1/receipts

Request

  • Base URL: https://app.magistry.io
  • URL: https://app.magistry.io/api/v1/receipts
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://app.magistry.io/api/oauth/authorize, token URL https://app.magistry.io/api/oauth/token, scopes: automation:read)

Request body

store_idstring uuid

One store this credential covers. Defaults to all of them; never widens.

kindsstring[]

Sources to include. Defaults to all six.

action_idstring uuid

Only the rows of this action.

sincestring date-time

Inclusive lower bound on occurred_at.

untilstring date-time

Exclusive upper bound on occurred_at.

limitinteger

Rows per page.

cursorstring

The next_cursor of the previous page or export manifest.

format'json' | 'csv' | 'jsonl'
allboolean

Stream every page as csv or jsonl, ending with a manifest line.

subjectsstring[]

Only rows about one of these: a variant or product uuid, a Shopify numeric id, a gid or a theme handle, matched against the key each source records its subject under.

Response

Result

okboolean required
resultunknown required

Changes

No recorded changes to this operation across all 2 revisions of this API.