GET
/
api
/
v1
/
events
curl --request GET \
  --url https://oleander.dev/api/v1/events \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "parent_run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "parent_job_namespace": "<string>",
    "parent_job_name": "<string>",
    "run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "run_state": "START",
    "received_at": "2023-11-07T05:31:56Z",
    "job_name": "<string>",
    "job_namespace": "<string>",
    "inputs": [
      {
        "namespace": "<string>",
        "name": "<string>"
      }
    ],
    "outputs": [
      {
        "namespace": "<string>",
        "name": "<string>"
      }
    ],
    "event_time": "2023-11-07T05:31:56Z",
    "event_schema": "<string>",
    "event_schema_version": "<string>",
    "event_size_in_bytes": 123,
    "event_raw": {
      "eventTime": "2023-11-07T05:31:56Z",
      "producer": "https://github.com/OpenLineage/OpenLineage/blob/v1-0-0/client",
      "schemaURL": "https://openlineage.io/spec/0-0-1/OpenLineage.json",
      "eventType": "START|RUNNING|COMPLETE|ABORT|FAIL|OTHER",
      "run": {
        "runId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "facets": {}
      },
      "job": {
        "namespace": "my-scheduler-namespace",
        "name": "myjob.mytask",
        "facets": {}
      },
      "inputs": [
        {
          "namespace": "my-datasource-namespace",
          "name": "instance.schema.table",
          "facets": {},
          "inputFacets": {}
        }
      ],
      "outputs": [
        {
          "namespace": "my-datasource-namespace",
          "name": "instance.schema.table",
          "facets": {},
          "outputFacets": {}
        }
      ]
    },
    "produced_by": "<string>",
    "integration": "<string>",
    "integration_version": "<string>"
  }
]

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
start
integer
required

Start timestamp (UNIX epoch). Only events with event_time >= this value are returned.

Example:

1672531200

​
end
integer
required

End timestamp (UNIX epoch). Only events with event_time < this value are returned.

Example:

1672617600

​
sort_by
enum<string>
default:EVENT_TIME

Field by which results should be sorted. Defaults to EVENT_TIME.

Available options:
EVENT_TIME,
EVENT_SIZE_IN_BYTES
​
order
enum<string>
default:DESC

Sort order. Defaults to DESC.

Available options:
ASC,
DESC
​
run
string

Filter by run_id (UUID). Only events matching this run_id are returned.

Example:

"550e8400-e29b-41d4-a716-446655440000"

​
states
enum<string>

Comma-separated list of run states to filter by. E.g. 'START,RUNNING,COMPLETE'.

Available options:
START,
RUNNING,
COMPLETE,
ABORT,
FAIL,
OTHER
​
namespace
string

Filter by job namespace, partial matches included.

Example:

"my-scheduler-namespace"

​
job
string

Filter by job name, partial matches included.

Example:

"myjob.mytask"

​
integrations
string

Comma-separated list of integration names to filter by.

Example:

"airflow,dbt"

​
limit
integer
default:30

Number of results to return. Defaults to 30.

Example:

50

​
offset
integer
default:0

Offset for pagination. Defaults to 0.

Example:

100

Response

200
application/json
A list of lineage events.
​
id
string
required
​
run_id
string
required
​
run_state
enum<string>
required
Available options:
START,
RUNNING,
COMPLETE,
ABORT,
FAIL,
OTHER
​
received_at
string
required

Timestamp with offset, e.g. '2023-07-14T12:34:56Z'.

​
job_name
string
required
​
job_namespace
string
required
​
event_time
string
required

Event occurrence time (with offset).

​
event_schema
string
required
​
event_schema_version
string
required
​
event_size_in_bytes
integer
required

Size of the raw event payload in bytes.

​
event_raw
object
required

A RunEvent is an event that describes the lifecycle of a run.

​
produced_by
string
required
​
integration
string
required
​
integration_version
string
required
​
parent_run_id
string | null

Optional parent run ID.

​
parent_job_namespace
string | null

Optional parent job namespace.

​
parent_job_name
string | null

Optional parent job name.

​
inputs
object[] | null

List of input datasets.

​
outputs
object[] | null

List of output datasets.

Was this page helpful?