Report SnapshotsSnapshot (with result)

Snapshot (with result)

Metadata, manifest, and the result itself. The hash lets you verify that the content hasn't changed since it was captured

curl -X GET "https://policy-engine-rest.ezig.workers.dev/api/v1/vaults/demo_vault/report-snapshots/example_string" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
{
  "id": "example_string",
  "vaultId": "example_string",
  "reportType": "example_string",
  "status": "example_string",
  "schemaVersion": "example_string",
  "parametersJson": {},
  "normalizedParametersHash": "example_string",
  "result": {},
  "resultHash": "example_string",
  "resultStorageKey": "example_string",
  "rowCount": 3.14,
  "includedOperationKeysJson": [
    "example_string"
  ],
  "includedOperationKeysStorageKey": "example_string",
  "dataCutoffAt": "example_string",
  "dataCutoffBlock": 3.14,
  "counterpartyClassificationMode": "example_string",
  "folderClassificationMode": "example_string",
  "errorCode": "example_string",
  "errorMessage": "example_string",
  "generatedById": "example_string",
  "generatedAt": "example_string",
  "createdAt": "example_string",
  "deletedAt": "example_string"
}
GET
/api/v1/vaults/{code}/report-snapshots/{id}
GET
Base URLstring

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

Bearer Token
Bearer Tokenstring
Required

Session token. Mobile/services. The web uses a cookie.

Session token. Mobile/services. The web uses a cookie.
API Key (cookie: session_token)
session_tokenstring
Required

API key (sent in cookie)

Request Preview
Response

Response will appear here after sending the request

Authentication

header
Authorizationstring
Required

Bearer token. Session token. Mobile/services. The web uses a cookie.

path
parameterstring
Required

API Key for authentication. Provide your API key in the cookie.

Path Parameters

codestring
Required

Unique Vault code (slug)

Example:
demo_vault

Responses

idstring
Required
vaultIdstring
Required
reportTypestring
Required

snake_case, as everywhere else

statusstring
Required
schemaVersionstring
Required
parametersJsonstring
Required
normalizedParametersHashstring
Required

Hash of the normalized parameters; the same request produces the same hash

resultstring
resultHashstring
Required

Canonical sha256 of the result; proof that the content hasn't been tampered with

resultStorageKeystring
Required

Reserved for R2; currently always null

rowCountstring
Required
includedOperationKeysJsonstring

Manifest: keys of the operations included in the snapshot (for drill-down by snapshot)

includedOperationKeysStorageKeystring
dataCutoffAtstring
Required
dataCutoffBlockstring
Required
counterpartyClassificationModestring
Required
folderClassificationModestring
Required
errorCodestring
Required
errorMessagestring
Required
generatedByIdstring
Required
generatedAtstring
Required
createdAtstring
Required
deletedAtstring
Required