GET
/
api
/
issues
/
v1
ListIssues
curl --request GET \
  --url https://developer.synq.io/api/issues/v1 \
  --header 'Authorization: Bearer <token>'
{
  "issues": [
    {
      "monitor": {
        "monitor": {
          "monitoredId": {
            "airflowDag": {
              "integrationId": "<string>",
              "dagId": "<string>"
            }
          },
          "monitorId": "<string>",
          "segment": "<string>",
          "integrationId": "<string>"
        },
        "metricId": "<string>",
        "metricVersion": 123,
        "segmentValue": "<string>"
      },
      "id": "<string>",
      "name": "<string>",
      "message": "<string>",
      "currentMessage": "<string>",
      "lastErrorMessage": "<string>",
      "severity": "SEVERITY_UNSPECIFIED",
      "triggerEntity": {
        "airflowDag": {
          "integrationId": "<string>",
          "dagId": "<string>"
        }
      },
      "affectedEntities": [
        {
          "airflowDag": {
            "integrationId": "<string>",
            "dagId": "<string>"
          }
        }
      ],
      "state": "STATE_UNSPECIFIED",
      "startedAt": "1s",
      "updatedAt": "1s",
      "endedAt": "1s",
      "latestStatus": "STATUS_UNSPECIFIED",
      "latestStatusActor": {
        "email": {
          "userEmail": "jsmith@example.com"
        },
        "name": "<string>"
      },
      "comments": [
        {
          "id": "<string>",
          "message": "<string>",
          "createdAt": "1s",
          "actor": {
            "email": {
              "userEmail": "jsmith@example.com"
            },
            "name": "<string>"
          }
        }
      ],
      "lifecycleState": "LIFECYCLE_STATE_UNSPECIFIED"
    }
  ]
}

Authorizations

Authorization
string
header
required

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

Query Parameters

from.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.

from.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.

limit.max
integer
limit.afterId
string
entities.dbtCoreNode.integrationId
string<uuid>
required

SYNQ integration_id that identifies the dbt Core project

entities.dbtCoreNode.nodeId
string
required

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

entities.dbtCloudNode.projectId
string
required

Your dbt Cloud project id

entities.dbtCloudNode.accountId
string

Your dbt Cloud account id

entities.dbtCloudNode.nodeId
string
required

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

entities.bigqueryTable.project
string
required

BigQuery project

entities.bigqueryTable.dataset
string
required

BigQuery dataset id

entities.bigqueryTable.table
string
required

BigQuery table name

entities.snowflakeTable.account
string
required

Snowflake account

entities.snowflakeTable.database
string
required

Snowflake database

entities.snowflakeTable.schema
string
required

Snowflake schema

entities.snowflakeTable.table
string
required

Snowflake table

entities.redshiftTable.cluster
string

Redshift cluster

entities.redshiftTable.database
string
required

Redshift database

entities.redshiftTable.schema
string
required

Redshift schema

entities.redshiftTable.table
string
required

Redshift table

entities.postgresTable.host
string
required

Postgres hostname without port

entities.postgresTable.database
string
required

Postgres database

entities.postgresTable.schema
string
required

Postgres schema

entities.postgresTable.table
string
required

Postgres table

entities.mysqlTable.host
string
required

Mysql hostname without port

entities.mysqlTable.schema
string
required

Mysql database

entities.mysqlTable.table
string
required

Mysql table

entities.clickhouseTable.host
string
required

Clickhouse hostname without port

entities.clickhouseTable.schema
string
required

Clickhouse database

entities.clickhouseTable.table
string
required

Clickhouse table

entities.airflowDag.integrationId
string
required

SYNQ integration_id that identifies the Airflow instance

entities.airflowDag.dagId
string
required

Airflow dag_id that identifies the DAG

entities.airflowTask.integrationId
string
required

SYNQ integration_id that identifies the Airflow instance

entities.airflowTask.dagId
string
required

Airflow dag_id that identifies the DAG

entities.airflowTask.taskId
string
required

Airflow task_id that identifies the task within the DAG

entities.custom.id
string
required

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

entities.dataproduct.id
string<uuid>
required

Dataproduct id that identifies the Dataproduct

entities.synqPath.path
string
required

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

entities.databricksTable.workspace
string
required

URL of Databricks workspace

entities.databricksTable.catalog
string
required

Databricks catalog

entities.databricksTable.schema
string
required

Databricks schema

entities.databricksTable.table
string
required

Databricks table or view

entities.trinoTable.host
string
required

Hostname of the Trino instance

entities.trinoTable.catalog
string
required

Trino catalog

entities.trinoTable.schema
string
required

Trino schema

entities.trinoTable.table
string
required

Trino table or view

entities.sqlMeshModel.integrationId
string<uuid>
required

SYNQ integration_id that identifies the dbt Core project

entities.sqlMeshModel.fqn
string
required

SQLMesh model fully qualified name

entities.sqlMeshAudit.integrationId
string<uuid>
required

SYNQ integration_id that identifies the dbt Core project

entities.sqlMeshAudit.fqn
string
required

SQLMesh model fully qualified name

entities.sqlMeshAudit.auditId
string
required

Identifier of the audit

entities.monitor.monitorId
string
required

Identifier of the monitor

entities.monitor.segment
string

Optional monitor segmentation identifier

entities.monitor.integrationId
string
deprecated

SYNQ integration_id of the monitored identifier

Response

200
application/json

Success

The response is of type object.