---
title: "List observer definitions"
method: GET
path: "/v1/observers"
tags: ["Observer"]
---

# List observer definitions

`GET /v1/observers`

## Request

- Base URL: `https://api.cloud.precisely.com`
- URL: `https://api.cloud.precisely.com/v1/observers`
- Auth: HTTP bearer

Returns a paginated list of observer definitions with optional filtering by name, type, status, and asset group.

## Query parameters

- `name` string
- `type` 'NUMERIC' | 'TEMPORAL' | 'STRUCTURAL'
- `status` 'ACTIVE' | 'INACTIVE' | 'PAUSED'
- `assetIds` string[]
- `assetGroups` string[]
- `tags` string[]
- `observationKind` string
- `page` integer
- `size` integer
- `ascending` boolean
- `sortBy` string

## Response `200`

Paginated list of observers returned successfully

- ObserverPageView: Paginated response containing observer definitions
  - `currentPage` integer: Current page number
  - `items` ObserverResponse[]
    - `createdDate` string, date-time
    - `description` string
    - `id` string
    - `lastModifiedDate` string, date-time
    - `name` string
    - `observations` ObservationConfig[]
      - `alertingConfig` AlertConfig: Configuration that controls how observer alerts and warnings are evaluated
        - `alertLogic` 'AND' | 'OR'
        - `alertingMode` 'HYBRID' | 'CONFIDENCE_ONLY' | 'THRESHOLD_ONLY'
        - `ciAlertPercent` integer
        - `ciWarnPercent` integer
        - `comparisonMethod` 'LAST_VALUE' | 'MOVING_AVERAGE'
        - `sensitivity` integer
        - `thresholdAlertValue` number, double
        - `thresholdDuringLearning` boolean
        - `thresholdType` 'PERCENT' | 'RELATIVE' | 'ABSOLUTE'
        - `thresholdWarnValue` number, double
        - `trainingWindow` TrainingWindow: Training window used to establish observer alert baselines
          - `type` 'DAYS' | 'METRIC_POINTS'
          - `value` integer
        - `warnEnabled` boolean
        - `warnLogic` 'AND' | 'OR'
      - `evaluationType` 'NUMERIC' | 'TEMPORAL' | 'STRUCTURAL'
      - `excludedColumns` ExcludeColumn[]
        - `name` string
      - `metricTypeId` string
      - `observationKind` string
      - `significanceFilterValue` number, double
      - `significanceMode` 'PERCENTAGE_OF_VALUE' | 'ABSOLUTE_POINT'
      - `sourcingMode` 'SCHEDULE' | 'NONE'
      - `tags` string[]
      - `timeUnit` 'HOURS' | 'DAYS' | 'WEEKS'
      - `triggers` SchemaConfig[]
        - `enabled` boolean
        - `severity` 'WARN' | 'ALERT'
        - `triggerType` 'TABLE_DELETED' | 'COLUMN_DELETED' | 'COLUMN_ADDED' | 'TYPE_CHANGED' | 'COLUMN_RENAMED' | 'COLUMN_ORDER' | 'NULLABLE_CHANGED'
    - `status` 'ACTIVE' | 'INACTIVE' | 'PAUSED'
    - `targetAssetGroupId` string
    - `targeting` union
      - AssetGroupConfig: Observer targeting configuration for an asset group
        - `type` string
        - `assetGroupId` string
      - AssetIdConfig: Observer targeting configuration for a single asset
        - `type` string
        - `assetId` string
  - `pageSize` integer: Number of items per page
  - `totalItems` integer: Total number of items across all pages
  - `totalPages` integer: Total number of pages available based on page size and total items

## Other responses

- `400`: Invalid request parameters
- `500`: Internal server error

---

[API](https://skmtc.dev/precisely/apis/verify-api-portal.md) · [All operations](https://skmtc.dev/precisely/apis/verify-api-portal/llms.txt) · [OpenAPI document](https://skmtc.dev/precisely/apis/verify-api-portal/revisions/380735465266?raw)
