Skip to content
aerandil.com
GitHub

Search Federated run

POST
/v1/object-types/hospitality.federated_run/search
curl --request POST \
  --url https://api.aerandil.com/v1/object-types/hospitality.federated_run/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.

One execution of an approved analysis definition against a cohort and time window. Pins the definition version, freezes the cohort snapshot and input window, reserves privacy budget, and drives the §5.11 lifecycle. Idempotent on run_key; retries with identical parameters return the existing run, retries with different parameters reject as idempotency mismatch (proposal 0021 §4.6 / §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 program_api_name definition_api_name definition_id definition_version cohort_id run_key status trigger_kind input_window_start input_window_end request_fingerprint participants_expected participants_requested participants_submitted participants_suppressed ci_width_warn_threshold aggregation_protocol secure_aggregation_session_ref clean_room_job_ref deadline_at started_at finished_at failure_reason correlation_id

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.federated_run
properties
required
object
aggregation_protocol
required
Aggregation protocol
string
Allowed values: plain_aggregate_reviewed secure_aggregation clean_room_dp external_protocol
ci_width_warn_threshold
Snapshot of the definition's maximum acceptable confidence-interval width at run start.
string format: decimal
clean_room_job_ref
Required for third-party clean room
string
cohort_id
required
Federated cohort definition object id. Part of the durable idempotency key.
string
cohort_snapshot
required
Frozen cohort rules and threshold settings (JSON)
correlation_id
required
Ties events together
string
deadline_at
Contribution deadline
string format: date-time
definition_api_name
required
Definition api name
string
definition_id
required
Federated analysis definition object id. Part of the durable idempotency key.
string
definition_version
required
Frozen at start
string
failure_reason
Bounded
string
finished_at
Set by aggregation result
string format: date-time
id
required
Run id
string
input_window_end
required
Input window end
string format: date-time
input_window_start
required
Input window start
string format: date-time
metric_warn_thresholds
Snapshot of the definition's per-metric minimum acceptable validation values at run start (JSON map).
participants_expected
required
Count at run start
integer
participants_requested
required
Count after eligibility checks
integer
participants_submitted
required
Count accepted before aggregation
integer
participants_suppressed
required
Count suppressed / rejected
integer
privacy_budget_reserved
Epsilon / delta / account refs reserved for the run (JSON)
program_api_name
required
Program api name
string
request_fingerprint
required
SHA-256 over canonical run-start request fields. Same run_key with a different fingerprint is rejected.
string
run_key
required
Stable idempotency key: program + definition + version + cohort + window
string
secure_aggregation_session_ref
Required for secure aggregation
string
started_at
Set by action
string format: date-time
status
required
Lifecycle status
string
Allowed values: queued privacy_review approved collecting aggregating output_review completed failed cancelled quarantined
trigger_kind
required
Scheduled / manual / workflow / agent / backfill
string
Allowed values: scheduled manual workflow agent_request backfill
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.federated_run",
      "properties": {
        "aggregation_protocol": "plain_aggregate_reviewed",
        "status": "queued",
        "trigger_kind": "scheduled"
      },
      "scope": {
        "level": "tenant"
      }
    }
  ]
}

422

Section titled “422”

Validation error — unknown property or filter type mismatch.