Read Connector sync run

GET

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

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

Read an existing instance.

One audited extraction/load run of a connector: what triggered it, when it ran, how many records were pulled from the source, landed in staging, and rejected by ontology validation at the map/load hop. Run-grain only — per-record state stays in the raw staging schema. The rejected count is customer-facing by design: ‘your POS sent 14 rows the ontology refused’ is part of the trust story (0037 §8).

Authorizations

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

properties

required

object

cursor_window

Per-stream cursor window this run covered (summary; live cursors live in staging)

error_summary

Terminal failure summary (required when status = failed)

string

finished_at

When the run reached a terminal status

string format: date-time

required

Sync run id

string

mapping_ref

Mapping definition version used (defaults to the connector's at start)

string

records_landed

Records upserted into raw staging

integer

records_pulled

Records extracted from the source system

integer

records_rejected

Records refused by ontology validation at the map/load hop

integer

started_at

required

When the run started

string format: date-time

status

required

Sync-run lifecycle status

string

Allowed values: running succeeded failed cancelled

streams

Source streams this run pulled (vendor vocabulary)

Array<string>

trigger

required

What initiated this run

string

Allowed values: scheduled manual 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.connector_sync_run",
  "properties": {
    "status": "running",
    "trigger": "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).