Read Federated run

GET

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

const url = 'https://api.aerandil.com/v1/object-types/hospitality.federated_run/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.federated_run/objects/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>'

Read an existing instance.

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

aerandil_oauth
objects:read
aerandil_oauth
objects:hospitality.federated_run: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.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

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

Example

{
  "object_type": "hospitality.federated_run",
  "properties": {
    "aggregation_protocol": "plain_aggregate_reviewed",
    "status": "queued",
    "trigger_kind": "scheduled"
  },
  "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).