List all received OpenLineage events.

Returns a list of OpenLineage events, sorted in direction of passed sort parameter. By default it is desc.

Query Parameters

sortDirection string
before date-time

Returns events before passed date.

after date-time

Returns events after passed date.

limit integer

Default value: 100

The number of results to return from offset.

offset integer

The initial position from which to return results.

Responses

• 200

---

OK

application/json

Schema

Example (from schema)

---

Schema

events LineageEvent[]
totalCount number

The total number of events returned matching our conditions.

{
  "events": [
    {
      "eventType": "COMPLETE",
      "eventTime": "2019-05-09T19:49:24.201361Z",
      "run": {
        "runId": "d46e465b-d358-4d32-83d4-df660ff614dd"
      },
      "job": {
        "namespace": "my-namespace",
        "name": "my-job"
      },
      "outputs": [
        {
          "namespace": "my-namespace",
          "name": "my-output",
          "facets": {
            "schema": {
              "_producer": "https://github.com/OpenLineage/OpenLineage/blob/v1-0-0/client",
              "_schemaURL": "https://github.com/OpenLineage/OpenLineage/blob/v1-0-0/spec/OpenLineage.json#/definitions/SchemaDatasetFacet",
              "fields": [
                {
                  "name": "a",
                  "type": "INTEGER"
                },
                {
                  "name": "b",
                  "type": "TIMESTAMP"
                },
                {
                  "name": "c",
                  "type": "INTEGER"
                },
                {
                  "name": "d",
                  "type": "INTEGER"
                }
              ]
            }
          }
        }
      ],
      "producer": "https://github.com/OpenLineage/OpenLineage/blob/v1-0-0/client"
    }
  ],
  "totalCount": 0
}

GET /events/lineage

Request

Base URL

http://localhost:5000/api/v1

sortDirection — query

before — query

after — query

limit — query

offset — query

curl / cURL

curl -L -X GET 'http://localhost:5000/api/v1/events/lineage' \
-H 'Accept: application/json'

python / requests

curl -L -X GET 'http://localhost:5000/api/v1/events/lineage' \
-H 'Accept: application/json'

go / native

curl -L -X GET 'http://localhost:5000/api/v1/events/lineage' \
-H 'Accept: application/json'

nodejs / axios

curl -L -X GET 'http://localhost:5000/api/v1/events/lineage' \
-H 'Accept: application/json'

ruby / Net::HTTP

curl -L -X GET 'http://localhost:5000/api/v1/events/lineage' \
-H 'Accept: application/json'

csharp / RestSharp

curl -L -X GET 'http://localhost:5000/api/v1/events/lineage' \
-H 'Accept: application/json'

php / cURL

curl -L -X GET 'http://localhost:5000/api/v1/events/lineage' \
-H 'Accept: application/json'

java / OkHttp

curl -L -X GET 'http://localhost:5000/api/v1/events/lineage' \
-H 'Accept: application/json'

powershell / RestMethod

curl -L -X GET 'http://localhost:5000/api/v1/events/lineage' \
-H 'Accept: application/json'