Read Privacy budget event

GET

/v1/object-types/hospitality.privacy_budget_event/objects/{id}

const url = 'https://api.aerandil.com/v1/object-types/hospitality.privacy_budget_event/objects/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api.aerandil.com/v1/object-types/hospitality.privacy_budget_event/objects/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>'

Read an existing instance.

Immutable ledger row recording one reservation / commit / release / exhaustion / adjustment against a privacy_budget_account. UNIQUE on (account_id, correlation_id, event_kind) (migration 0015) so duplicate submissions are no-ops — the Brandur idempotency pattern transposed onto DP accounting.

Authorizations

aerandil_oauth
objects:read
aerandil_oauth
objects:hospitality.privacy_budget_event:read

Parameters

Path Parameters

required

string format: uuid

Object id (UUID v7, server-generated at create time).

Query Parameters

branch

string format: uuid

Read through an open branch’s copy-on-first-write overlay view instead of the canonical (main) plane. Does not compose with as_of (422). The branch must exist under the caller’s tenant.

Responses

200

Object found.

application/json

object

created_at

required

string format: date-time

required

string format: uuid

object_type

required

Allowed value: hospitality.privacy_budget_event

properties

required

object

account_id

required

Privacy budget account this event acts on

string

applied_at

required

Wall-clock timestamp of the ledger write

string format: date-time

correlation_id

required

Originating run / batch correlation id — keys the commit-once idempotency

string

delta_delta

Signed change in δ; populated when the account carries an explicit (ε, δ) shape.

string format: decimal

epsilon_delta

Signed change in ε; required for basic / advanced composition accounts. Positive on reserve / commit (budget consumed); positive on release (budget returned to available). The account projection reads delta and the kind together to know whether to increment epsilon_reserved or epsilon_spent.

string format: decimal

event_kind

required

reserve / commit / release / exhaust / adjust

string

Allowed values: reserve commit release exhaust adjust

required

Event id

string

reason

Optional free-text reason (audit only; bounded)

string

rho_delta

Signed change in ρ for zCDP-accounted accounts. The seam to rho-additive composition (Bun–Steinke 2016); v1 leaves this field unwritten for basic-composition accounts.

string format: decimal

provenance

Per-property source attribution and pins. An entry under properties means the property’s current value came from that source (on the source’s own clock, source_updated_at); an entry under pins is a human override protecting the property from sourced writes.

object

pins

object

key

additional properties

object

pinned_at

string format: date-time

pinned_by

object

reason

required

string

properties

object

key

additional properties

object

external_id

string

recorded_at

required

string format: date-time

source

required

string

source_updated_at

string format: date-time

stream

string

scope

required

One of: discriminator: level

object

level

required

string

Allowed value: tenant

Allowed values: tenant

tenant_id

required

string format: uuid

updated_at

required

string format: date-time

version

required

integer

>= 1

Example

{
  "object_type": "hospitality.privacy_budget_event",
  "properties": {
    "event_kind": "reserve"
  },
  "scope": {
    "level": "tenant"
  }
}

Headers

ETag

string

/^"\d+"$/

Quoted strong validator (RFC 7232 §2.3) carrying the object’s monotonic version. Informational on the read path — object mutation goes through typed actions on /v1/actions/{action}/apply, not raw CRUD.

404

No object with that id (or soft-deleted).