Relationship events

Retrieve the World events behind one relationship, newest first.

GET/api/v2.0-preview/atlas/relationships/events

Authorizations

Bearer

Authorizationstringrequiredheader

Required Bearer API key: your NOSIBLE API key from the API Dashboard.

Example: Bearer nos_sk_...

Parameters

query & path

subject_typeenumrequiredquery

Type of the subject.

Example: ORG

subjectstringrequiredquery

Name of the subject.

Example: TSMC

predicatestringrequiredquery

Relationship type.

Example: supplier_to

object_typeenumrequiredquery

Type of the object.

Example: ORG

objectstringrequiredquery

Name of the object.

Example: Nvidia

limitintegerquery

Page size. Defaults to 50, maximum 500.

Example: 3

cursorstringquery

next_cursor from the previous page.

as_ofdatequery

Point in time (YYYY-MM-DD). Only events dated on or before it count. Defaults to the latest date in the release. `to` is accepted as the same parameter, as in the World API.

Example: 2024-12-31

fromdatequery

Optional start of the evidence window (YYYY-MM-DD, inclusive).

Example: 2020-01-01

How to use this endpoint

guidance

Use Relationship events to see the evidence for a relationship. Each event id is a World API event: fetch the full record, with sources and text, from World V2.0-preview Event details (GET /api/v2.0-preview/events/{date}/{event_id}).

Response body

application/json

These are the fields you can build against. Nested names use dot notation; optional sections are called out in their descriptions.

relationshipobject

{subject, predicate, object, support, first_seen, last_seen}. support counts distinct World events inside the window; first_seen and last_seen are the earliest and latest of them.

eventsobject[]

[{event_id, date}], newest first.

totalinteger

Supporting events inside the window.

countinteger

Events in this page.

orderstring

Always desc.

next_cursorstring | null

Cursor for the next page, null on the last.

schemastring

Response schema name.

as_ofdate

The point in time the answer is computed for.

date_windowobject

The evidence window: from, to, archive_cutoff and include_live (always false).

releasestring

Immutable id of the graph release that answered. The same request against the same release returns identical bytes.

took_msinteger

Server time in milliseconds.

Responses and errors

HTTP

200Request succeeded. The response body is shown in the panel on the right.

400invalid_request — A parameter is missing, malformed or out of range; the message names it.

400invalid_entity_type — The entity type is not one Atlas holds. TICKER is refused: send the company as an ORG.

400unknown_predicate — A relationship type is not in the graph; list them with Relationship types.

401api_key_required — No API key was sent. Send it as Authorization: Bearer <key> or the api-key header.

401invalid_api_key — The API key is invalid or has been revoked.

404unknown_entity — No entity of that type has that name in this release. When the name exists under another type, the message says which.

404not_found — The relationship has no supporting event inside the window, so it does not exist at that point in time.

410cursor_expired — The cursor belongs to another release or request; restart from the first page.

422unprocessable_request — Each value is valid but not together, such as from after as_of.

422request_too_broad — The request ran out of its work budget before it could answer; narrow it.

429rate_limited — Too many requests for this key; wait for Retry-After.

501backend_not_configured — The Atlas backend is not configured for this deployment.

502backend_error — The Atlas backend could not be reached; retry shortly.

503unavailable — The service is busy or starting; retry after Retry-After.

503api_key_auth_unavailable — API key authentication is temporarily unavailable; retry shortly.

504request_timeout — The request took longer than 25 seconds; narrow it.

504backend_timeout — The Atlas backend did not answer before the deadline; retry.