GET
/
api
/
incidents
/
v1
ListIncidents
curl --request GET \
  --url https://developer.synq.io/api/incidents/v1 \
  --header 'Authorization: Bearer <token>'
{
  "incidents": [
    {
      "id": "<string>",
      "index": 123,
      "name": "<string>",
      "issueIds": [
        "<string>"
      ],
      "createdBy": {
        "email": {
          "userEmail": "jsmith@example.com"
        },
        "name": "<string>"
      },
      "createdAt": "1s",
      "updatedBy": {
        "email": {
          "userEmail": "jsmith@example.com"
        },
        "name": "<string>"
      },
      "updatedAt": "1s",
      "state": "STATE_UNSPECIFIED",
      "comments": [
        {
          "id": "<string>",
          "message": "<string>",
          "createdAt": "1s",
          "actor": {
            "email": {
              "userEmail": "jsmith@example.com"
            },
            "name": "<string>"
          }
        }
      ]
    }
  ]
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
time.field
enum<string>
Available options:
FIELD_UNSPECIFIED,
FIELD_CREATED_AT,
FIELD_UPDATED_AT
​
time.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.

​
time.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.

​
sort.sortBy
enum<string>
Available options:
FIELD_UNSPECIFIED,
FIELD_CREATED_AT,
FIELD_UPDATED_AT
​
sort.order
enum<string>
Available options:
ORDER_UNSPECIFIED,
ORDER_ASC,
ORDER_DESC
​
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.

​
states
enum<string>[]

Filter by states

​
affectedEntities.dbtCoreNode.integrationId
string
required

SYNQ integration_id that identifies the dbt Core project

​
affectedEntities.dbtCoreNode.nodeId
string
required

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

​
affectedEntities.dbtCloudNode.projectId
string
required

Your dbt Cloud project id

​
affectedEntities.dbtCloudNode.accountId
string

Your dbt Cloud account id

​
affectedEntities.dbtCloudNode.nodeId
string
required

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

​
affectedEntities.bigqueryTable.project
string
required

BigQuery project

​
affectedEntities.bigqueryTable.dataset
string
required

BigQuery dataset id

​
affectedEntities.bigqueryTable.table
string
required

BigQuery table name

​
affectedEntities.snowflakeTable.account
string
required

Snowflake account

​
affectedEntities.snowflakeTable.database
string
required

Snowflake database

​
affectedEntities.snowflakeTable.schema
string
required

Snowflake schema

​
affectedEntities.snowflakeTable.table
string
required

Snowflake table

​
affectedEntities.redshiftTable.cluster
string

Redshift cluster

​
affectedEntities.redshiftTable.database
string
required

Redshift database

​
affectedEntities.redshiftTable.schema
string
required

Redshift schema

​
affectedEntities.redshiftTable.table
string
required

Redshift table

​
affectedEntities.postgresTable.host
string
required

Postgres hostname without port

​
affectedEntities.postgresTable.database
string
required

Postgres database

​
affectedEntities.postgresTable.schema
string
required

Postgres schema

​
affectedEntities.postgresTable.table
string
required

Postgres table

​
affectedEntities.mysqlTable.host
string
required

Mysql hostname without port

​
affectedEntities.mysqlTable.schema
string
required

Mysql database

​
affectedEntities.mysqlTable.table
string
required

Mysql table

​
affectedEntities.clickhouseTable.host
string
required

Clickhouse hostname without port

​
affectedEntities.clickhouseTable.schema
string
required

Clickhouse database

​
affectedEntities.clickhouseTable.table
string
required

Clickhouse table

​
affectedEntities.airflowDag.integrationId
string
required

SYNQ integration_id that identifies the Airflow instance

​
affectedEntities.airflowDag.dagId
string
required

Airflow dag_id that identifies the DAG

​
affectedEntities.airflowTask.integrationId
string
required

SYNQ integration_id that identifies the Airflow instance

​
affectedEntities.airflowTask.dagId
string
required

Airflow dag_id that identifies the DAG

​
affectedEntities.airflowTask.taskId
string
required

Airflow task_id that identifies the task within the DAG

​
affectedEntities.custom.id
string
required

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

​
affectedEntities.dataproduct.id
string
required

Dataproduct id that identifies the Dataproduct

​
affectedEntities.synqPath.path
string
required

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

​
affectedEntities.databricksTable.workspace
string
required

URL of Databricks workspace

​
affectedEntities.databricksTable.catalog
string
required

Databricks catalog

​
affectedEntities.databricksTable.schema
string
required

Databricks schema

​
affectedEntities.databricksTable.table
string
required

Databricks table or view

​
affectedEntities.trinoTable.host
string
required

Hostname of the Trino instance

​
affectedEntities.trinoTable.catalog
string
required

Trino catalog

​
affectedEntities.trinoTable.schema
string
required

Trino schema

​
affectedEntities.trinoTable.table
string
required

Trino table or view

​
affectedEntities.sqlMeshModel.integrationId
string
required

SYNQ integration_id that identifies the dbt Core project

​
affectedEntities.sqlMeshModel.fqn
string
required

SQLMesh model fully qualified name

​
affectedEntities.sqlMeshAudit.integrationId
string
required

SYNQ integration_id that identifies the dbt Core project

​
affectedEntities.sqlMeshAudit.fqn
string
required

SQLMesh model fully qualified name

​
affectedEntities.sqlMeshAudit.auditId
string
required

Identifier of the audit

​
affectedEntities.monitor.monitorId
string
required

Identifier of the monitor

​
affectedEntities.monitor.segment
string

Optional monitor segmentation identifier

​
affectedEntities.monitor.integrationId
string
deprecated

SYNQ integration_id of the monitored identifier

Response

200
application/json

Success

The response is of type object.