Skip to main content
GET
/
api
/
executions
/
v2
/
list
ListExecutions
curl --request GET \
  --url https://developer.synq.io/api/executions/v2/list \
  --header 'Authorization: Bearer <token>'
{
  "executions": [
    {
      "id": "<string>",
      "entities": [
        {
          "airflowDag": {
            "integrationId": "<string>",
            "dagId": "<string>"
          }
        }
      ],
      "entitiesSynqPaths": [
        "<string>"
      ],
      "targets": [
        {
          "airflowDag": {
            "integrationId": "<string>",
            "dagId": "<string>"
          }
        }
      ],
      "targetsSynqPaths": [
        "<string>"
      ],
      "extraReferences": [
        {
          "airflowDag": {
            "integrationId": "<string>",
            "dagId": "<string>"
          }
        }
      ],
      "extraReferencesSynqPaths": [
        "<string>"
      ],
      "executionType": "EXECUTION_TYPE_UNSPECIFIED",
      "status": "EXECUTION_STATUS_UNSPECIFIED",
      "skipped": true,
      "message": "<string>",
      "createdAt": "2023-01-15T01:30:15.01Z",
      "startedAt": "2023-01-15T01:30:15.01Z",
      "finishedAt": "2023-01-15T01:30:15.01Z",
      "parentExecutionIds": [
        "<string>"
      ],
      "durationSeconds": 123
    }
  ],
  "pageInfo": {
    "totalCount": 123,
    "count": 123,
    "lastId": "<string>"
  }
}

Authorizations

Authorization
string
header
required

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

Query Parameters

entityIds.dbtCoreNode.integrationId
string<uuid>
required

SYNQ integration_id that identifies the dbt Core project

entityIds.dbtCoreNode.nodeId
string
required

Dbt node_id that identifies one of dbt DAG nodes (model, test, etc)

entityIds.dbtCloudNode.projectId
string
required

Your dbt Cloud project id

entityIds.dbtCloudNode.accountId
string

Your dbt Cloud account id

entityIds.dbtCloudNode.nodeId
string
required

Dbt node_id that identifies one of dbt DAG nodes (model, test, etc)

entityIds.bigqueryTable.project
string
required

BigQuery project

entityIds.bigqueryTable.dataset
string
required

BigQuery dataset id

entityIds.bigqueryTable.table
string
required

BigQuery table name

entityIds.snowflakeTable.account
string
required

Snowflake account

entityIds.snowflakeTable.database
string
required

Snowflake database

entityIds.snowflakeTable.schema
string
required

Snowflake schema

entityIds.snowflakeTable.table
string
required

Snowflake table

entityIds.redshiftTable.cluster
string

Redshift cluster

entityIds.redshiftTable.database
string
required

Redshift database

entityIds.redshiftTable.schema
string
required

Redshift schema

entityIds.redshiftTable.table
string
required

Redshift table

entityIds.postgresTable.host
string
required

Postgres hostname without port

entityIds.postgresTable.database
string
required

Postgres database

entityIds.postgresTable.schema
string
required

Postgres schema

entityIds.postgresTable.table
string
required

Postgres table

entityIds.mysqlTable.host
string
required

Mysql hostname without port

entityIds.mysqlTable.schema
string
required

Mysql database

entityIds.mysqlTable.table
string
required

Mysql table

entityIds.clickhouseTable.host
string
required

Clickhouse hostname without port

entityIds.clickhouseTable.schema
string
required

Clickhouse database

entityIds.clickhouseTable.table
string
required

Clickhouse table

entityIds.airflowDag.integrationId
string
required

SYNQ integration_id that identifies the Airflow instance

entityIds.airflowDag.dagId
string
required

Airflow dag_id that identifies the DAG

entityIds.airflowTask.integrationId
string
required

SYNQ integration_id that identifies the Airflow instance

entityIds.airflowTask.dagId
string
required

Airflow dag_id that identifies the DAG

entityIds.airflowTask.taskId
string
required

Airflow task_id that identifies the task within the DAG

entityIds.custom.id
string
required

Id that identifies the custom entity The Id should be unique within the custom entity Identifier.

entityIds.dataproduct.id
string<uuid>
required

Dataproduct id that identifies the Dataproduct

entityIds.synqPath.path
string
required

SYNQ path that identifies the SYNQ entity, needs to be one of supported paths

entityIds.databricksTable.workspace
string
required

URL of Databricks workspace

entityIds.databricksTable.catalog
string
required

Databricks catalog

entityIds.databricksTable.schema
string
required

Databricks schema

entityIds.databricksTable.table
string
required

Databricks table or view

entityIds.trinoTable.host
string
required

Hostname of the Trino instance

entityIds.trinoTable.catalog
string
required

Trino catalog

entityIds.trinoTable.schema
string
required

Trino schema

entityIds.trinoTable.table
string
required

Trino table or view

entityIds.sqlMeshModel.integrationId
string<uuid>
required

SYNQ integration_id that identifies the dbt Core project

entityIds.sqlMeshModel.fqn
string
required

SQLMesh model fully qualified name

entityIds.sqlMeshAudit.integrationId
string<uuid>
required

SYNQ integration_id that identifies the dbt Core project

entityIds.sqlMeshAudit.fqn
string
required

SQLMesh model fully qualified name

entityIds.sqlMeshAudit.auditId
string
required

Identifier of the audit

entityIds.monitor.monitorId
string
required

Identifier of the monitor

entityIds.monitor.segment
string

Optional monitor segmentation identifier

entityIds.monitor.integrationId
string
deprecated

SYNQ integration_id of the monitored identifier

executionStartedAfter.seconds

Represents seconds of UTC time since Unix epoch 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59Z inclusive.

executionStartedAfter.nanos
integer

Non-negative fractions of a second at nanosecond resolution. Negative second values with fractions must still have non-negative nanos values that count forward in time. Must be from 0 to 999,999,999 inclusive.

executionTypes
enum<string>[]

Filter by specific execution types. If empty, all execution types are included.

statuses
enum<string>[]

Filter by execution status. If empty, all statuses are included.

includeReferencedExecutions
boolean

Include executions that reference the specified entities (not just primary entities). If true, executions where entity_ids appear in targets or extra_references are also returned.

pagination.cursor
string

Cursor for the next page of results. If not provided, returns the first page.

pagination.pageSize
integer

Maximum number of items to return in a single page. If not provided, defaults vary per API.

Required range: x >= 0

Response

200 - application/json

Success

ListExecutionsResponse contains the paginated list of executions.

executions
EntityExecution · object[]

List of executions matching the filter criteria, ordered by started_at descending.

pageInfo
object

Pagination information.