Skip to main content
POST
/
api
/
v1
/
lineage
Record a lineage event
curl --request POST \
  --url https://oleander.dev/api/v1/lineage \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "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",
  "run": {
    "runId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "facets": {}
  },
  "job": {
    "namespace": "my-scheduler-namespace",
    "name": "myjob.mytask",
    "facets": {}
  },
  "eventType": "START|RUNNING|COMPLETE|ABORT|FAIL|OTHER",
  "inputs": [
    {
      "namespace": "my-datasource-namespace",
      "name": "instance.schema.table",
      "facets": {},
      "inputFacets": {}
    }
  ],
  "outputs": [
    {
      "namespace": "my-datasource-namespace",
      "name": "instance.schema.table",
      "facets": {},
      "outputFacets": {}
    }
  ]
}
'
{
  "status": 200
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json

This is an OpenLineage compliant payload

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

​
eventTime
string<date-time>
required

the time the event occurred at

​
producer
string<uri>
required

URI identifying the producer of this metadata. For example this could be a git url with a given tag or sha

Example:

"https://github.com/OpenLineage/OpenLineage/blob/v1-0-0/client"

​
schemaURL
string<uri>
required

The JSON Pointer (https://tools.ietf.org/html/rfc6901) URL to the corresponding version of the schema definition for this RunEvent

Example:

"https://openlineage.io/spec/0-0-1/OpenLineage.json"

​
run
object
required
​
job
object
required
​
eventType
enum<string>

the current transition of the run state. It is required to issue 1 START event and 1 of [ COMPLETE, ABORT, FAIL ] event per run. Additional events with OTHER eventType can be added to the same run. For example to send additional metadata after the run is complete

Available options:
START,
RUNNING,
COMPLETE,
ABORT,
FAIL,
OTHER
Example:

"START|RUNNING|COMPLETE|ABORT|FAIL|OTHER"

​
inputs
object[]

The set of input datasets.

​
outputs
object[]

The set of output datasets.

Response

Success response

​
status
integer<int32>
default:200
required