> ## Documentation Index
> Fetch the complete documentation index at: https://docs.kinetica.com/llms.txt
> Use this file to discover all available pages before exploring further.

# /show/tablemonitors

```
URL: http://<db.host>:<db.port>/show/tablemonitors
```

Show table monitors and their properties. Table monitors are created using
[/create/tablemonitor](/content/api/rest/create_tablemonitor_rest). Returns
detailed information about existing table monitors.

## Input Parameter Description

<ParamField body="monitor_ids" type="array of strings">
  List of monitors to be shown. An empty list or a single entry with an empty string returns all table monitors.
</ParamField>

<ParamField body="options" type="map of string to strings">
  Optional parameters.

  The default value is an empty map ( \{} ).
</ParamField>

## Output Parameter Description

The Kinetica server embeds the endpoint response inside a standard response structure which contains status information and the actual response to the query.  Here is a description of the various fields of the wrapper:

<ResponseField name="status" type="String">
  'OK' or 'ERROR'
</ResponseField>

<ResponseField name="message" type="String">
  Empty if success or an error message
</ResponseField>

<ResponseField name="data_type" type="String">
  'show\_table\_monitors\_response' or 'none' in case of an error
</ResponseField>

<ResponseField name="data" type="String">
  Empty string
</ResponseField>

<ResponseField name="data_str" type="JSON or String">
  This embedded JSON represents the result of the /show/tablemonitors endpoint:

  <Expandable title="data_str">
    <ResponseField name="monitor_ids" type="array of strings">
      List of monitor IDs.
    </ResponseField>

    <ResponseField name="table_names" type="array of strings">
      List of source tables being monitored for the respective output parameter *monitor\_ids*.
    </ResponseField>

    <ResponseField name="events" type="array of strings">
      List of notification events for the respective output parameter *monitor\_ids*.
    </ResponseField>

    <ResponseField name="increasing_columns" type="array of strings">
      List of columns used on the respective tables in output parameter *table\_names* that will increase for new records.
    </ResponseField>

    <ResponseField name="filter_expressions" type="array of strings">
      List of filter expressions used on the respective tables in output parameter *table\_names* to limit records for notifications.
    </ResponseField>

    <ResponseField name="join_table_names" type="array of strings">
      List of join table names.
    </ResponseField>

    <ResponseField name="join_column_names" type="array of strings">
      List of join column names.
    </ResponseField>

    <ResponseField name="join_expressions" type="array of strings">
      List of join expressions.
    </ResponseField>

    <ResponseField name="refresh_method" type="array of strings">
      List of refresh methods used on the respective tables in output parameter *table\_names*.
    </ResponseField>

    <ResponseField name="refresh_period" type="array of strings">
      List of refresh periods used on the respective tables in output parameter *table\_names*.
    </ResponseField>

    <ResponseField name="refresh_start_time" type="array of strings">
      List of refresh start times used on the respective tables in output parameter *table\_names*.
    </ResponseField>

    <ResponseField name="datasink_names" type="array of strings">
      List of datasink names for the respective output parameter *monitor\_ids* if one is defined.
    </ResponseField>

    <ResponseField name="max_consecutive_failures" type="array of ints">
      Maximum number of consecutive failures for the respective output parameter *monitor\_ids* before stream is automatically suspended.
    </ResponseField>

    <ResponseField name="failed_notifications_table_names" type="array of strings">
      List of table names that will hold failed notification events when the respective output parameter *monitor\_ids* is suspended.
    </ResponseField>

    <ResponseField name="statuses" type="array of strings">
      Status of stream for the respective output parameter *monitor\_ids*.
    </ResponseField>

    <ResponseField name="additional_info" type="array of maps of string to strings">
      Additional information about the respective monitors in output parameter *monitor\_ids*.

      <Expandable title="additional_info">
        <ResponseField name="monitor_type">
          Notification type for the respective output parameter *monitor\_ids* and output parameter *table\_names*.

          The default value is ''.
        </ResponseField>

        <ResponseField name="type_schema">
          Notification type schemas for the respective output parameter *monitor\_ids* and output parameter *table\_names*.

          The default value is ''.
        </ResponseField>

        <ResponseField name="materialized_view_for_change_detector">
          Materialized view that implements the change detector.
        </ResponseField>

        <ResponseField name="materialized_view_for_filter">
          Materialized views created for the output parameter *filter\_expressions*.

          The default value is ''.
        </ResponseField>

        <ResponseField name="references">
          Reference count on the respective output parameter *monitor\_ids*.

          The default value is ''.
        </ResponseField>

        <ResponseField name="datasink_json">
          Datasink info in JSON format for the respective output parameter *monitor\_ids* if one is defined.

          The default value is ''.
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="info" type="map of string to strings">
      Additional information.
    </ResponseField>
  </Expandable>

  Empty string in case of an error.
</ResponseField>
