Skip to main content

List Monitors

GET 
/monitors

Retrieves a list of monitor configurations.

Request​

Query Parameters

    limit integer

    Default value: 10

    Number of items to return in the response list.

    filter string

    Filter results that match values in the given key separated by a colon. These are not exact matches, so filtering on a value of pet:cat will return cat along with caterpillar pets. Filter parameters may be repeated if multiple filters are desired, but a given field can only be queried once because all filters will be logically ANDed.

    sort string

    Possible values: [asc, desc]

    Default value: desc

    Sort order, desc for descending chronological order of creation date (latest first), asc for ascending order.

    starting_after string

    The token (base64 string) next_page_token returned in the previous page of results. This is used to fetch the next page of results when the sort order is asc.

    ending_before string

    The token (base64 string) next_page_token returned in the previous page of results. This is used to fetch the next page of results when the sort order is desc.

Responses​

OK

Schema
    data object
    request_timestamp string
    response_timestamp string
    request_duration number
    links object
    request string
    monitors object[]
  • Array [
    • source string
    start_datetime string

    ISO-8601-formatted datetime string indicating when the monitor should start listening for events; if not provided, the monitor will start immediately

    end_datetime string

    ISO-8601-formatted datetime string indicating when the monitor should stop listening for events; if not provided, the monitor will continue listening until canceled by the owner

    description string
    aoi_geojson object

    Geojson Polygon object

    erode_area boolean
    order_templates object[]
  • Array [
    • pipeline string
    template object
    output_config objectrequired

    Configures output delivery location

    oneOf
    amazon_s3 objectrequired
    bucket stringrequired
    prefix stringrequired
    role_arn string
    notifications object[]

    Sets order notifications

  • Array [
    • oneOf
    config object
    headers object
    internal_auth_provider string
    level string

    Possible values: [FINAL_ONLY, INTERMEDIATE, INITIAL_FINAL, ON_FAIL]

    target stringrequired
    type stringrequired

    Possible values: [http]

  • ]
    • settings object

    Specifies pipeline specific settings

    metadata object

    Arbitrary user key-value metadata

  • ]
    • match_criteria object
    monitor_notifications object[]
    id string
    date_created string
    date_modified string
    creator_id string
    creator_group_id string
    state
    enabled boolean
    monitor_links object
    self string
    events string
  • ]
Loading...