Skip to content
aerandil.com
GitHub

Search Privacy budget account

POST
/v1/object-types/hospitality.privacy_budget_account/search
curl --request POST \
  --url https://api.aerandil.com/v1/object-types/hospitality.privacy_budget_account/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "branch": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "cursor": "example", "filters": [ { "property": "id", "type": "eq", "value": "example" } ], "limit": 1, "order": "asc", "property_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "scope": { "level": "tenant" }, "sort_by": "created_at" }'

Search for instances. Filters eq, contains, gte and lte AND-compose; or / not are additive follow-ups. Pages with an opaque cursor; the +1 fetch returns has_more without a second round-trip. Ordered by sort_by (default created_at) in order (default ascending), id breaking ties; rows with no value for a property key sort last.

Tracks privacy spend for a participant, program, definition, or composition group. Epsilon / delta totals and the running spent / reserved totals are the durable evidence of DP accounting; replays cannot double-spend (proposal 0021 §4.5 / §9).

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
branch

Optional open-branch id. Search composes that branch’s copy-on-first-write overlay instead of main, so a preview reads its own hypothetical writes. Omit to read main.

string format: uuid
cursor

Opaque cursor from a prior response’s next_cursor. Pass back verbatim; do not introspect.

string
filters

Conjunctive list of predicates. Empty or omitted matches every row in scope, capped by limit.

Array
One of:
object
property
required
Allowed value: id
type
required
Allowed value: eq
value
required
string
limit

Page size. Server defaults to 50, silently clamps at 500 (AIP-158 §3).

integer
>= 1 <= 500
order

Direction of sort_by: asc (oldest / smallest first) or desc. A cursor is bound to the sort_by and order it was minted under; another pair is refused (422).

string
default: asc
Allowed values: asc desc
property_id

The house a desk stands in: keeps this property’s rows (property- or venue-scoped there) and every row scoped to no property (tenant, brand, portfolio), and drops a sibling house’s — the meaning property_id has on the event tail.

string format: uuid
scope
One of: discriminator: level
object
level
required
string
Allowed value: tenant
Allowed values: tenant
sort_by

What the page is ordered by: the row’s created_at or updated_at, or a property whose type orders — strings, enums and dates as text, ints, decimals and durations as numbers, datetimes as instants. Rows with no value sort last in either direction. A property the caller is not cleared to read is refused (403).

string
default: created_at
Allowed values: created_at updated_at id account_scope program_api_name definition_api_name composition_group status period_kind period_start period_end epsilon_total epsilon_reserved epsilon_spent delta_total composition_strategy mechanism_family last_spend_at

Responses

Section titled “Responses”

200

Section titled “200”

Search results, ordered by (sort_by, id) in the requested order (ascending by default).

Media typeapplication/json
object
data
required
Array<object>
object
created_at
required
string format: date-time
id
required
string format: uuid
object_type
required
Allowed value: hospitality.privacy_budget_account
properties
required
object
account_scope
required
tenant_program / property_program / definition / composition_group / output_recipient
string
Allowed values: tenant_program property_program definition composition_group output_recipient
alert_thresholds
Optional thresholds for operator warnings
Array<string>
composition_group
Composition group
string
composition_strategy
required
Basic / advanced / RDP / zCDP / operator_supplied_reviewed
string
Allowed values: basic advanced rdp zcdp operator_supplied_reviewed
definition_api_name
Definition api name
string
delta_total
Required when delta applies
string format: decimal
epsilon_reserved
Defaults 0
string format: decimal
epsilon_spent
Defaults 0
string format: decimal
epsilon_total
Required for DP accounts
string format: decimal
id
required
Account id
string
last_spend_at
Audit convenience
string format: date-time
mechanism_family
required
Central DP / local DP / DP-SGD / DP clean room / threshold-only
string
Allowed values: central_dp local_dp dp_sgd dp_clean_room none_threshold_only
period_end
Required unless lifetime
string format: date-time
period_kind
required
Run / day / month / quarter / year / lifetime
string
Allowed values: run day month quarter year lifetime
period_start
required
Period start
string format: date-time
program_api_name
required
Program api name
string
status
required
Lifecycle status
string
Allowed values: active reserved exhausted paused closed
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
has_more
required
boolean
next_cursor

Cursor for the next page; omitted when the result set is exhausted.

string
Example
{
  "data": [
    {
      "object_type": "hospitality.privacy_budget_account",
      "properties": {
        "account_scope": "tenant_program",
        "composition_strategy": "basic",
        "mechanism_family": "central_dp",
        "period_kind": "run",
        "status": "active"
      },
      "scope": {
        "level": "tenant"
      }
    }
  ]
}

422

Section titled “422”

Validation error — unknown property or filter type mismatch.