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

# /create/trigger/byarea

```
URL: http://<db.host>:<db.port>/create/trigger/byarea
```

Sets up an area trigger mechanism for two column\_names for one or more tables.
(This function is essentially the two-dimensional version of
[/create/trigger/byrange](/content/api/rest/create_trigger_byrange_rest).) Once the
trigger has been activated, any record added to the listed tables(s) via
[/insert/records](/content/api/rest/insert_records_rest) with the chosen columns'
values falling within the specified region will trip the trigger. All such
records will be queued at the trigger port (by default '9001' but able to be
retrieved via [/show/system/status](/content/api/rest/show_system_status_rest)) for
any listening client to collect. Active triggers can be cancelled by using the
[/clear/trigger](/content/api/rest/clear_trigger_rest) endpoint or by clearing all
relevant tables.

The output returns the trigger handle as well as indicating success or failure
of the trigger activation.

## Input Parameter Description

<ParamField body="request_id" type="string">
  User-created ID for the trigger. The ID can be alphanumeric, contain symbols, and must contain at least one character.
</ParamField>

<ParamField body="table_names" type="array of strings">
  Names of the tables on which the trigger will be activated and maintained, each in \[schema\_name.]table\_name format, using standard [name resolution rules](../../concepts/tables/#table-name-resolution).
</ParamField>

<ParamField body="x_column_name" type="string">
  Name of a numeric column on which the trigger is activated. Usually 'x' for geospatial data points.
</ParamField>

<ParamField body="x_vector" type="array of doubles">
  The respective coordinate values for the region on which the trigger is activated. This usually translates to the x-coordinates of a geospatial region.
</ParamField>

<ParamField body="y_column_name" type="string">
  Name of a second numeric column on which the trigger is activated. Usually 'y' for geospatial data points.
</ParamField>

<ParamField body="y_vector" type="array of doubles">
  The respective coordinate values for the region on which the trigger is activated. This usually translates to the y-coordinates of a geospatial region. Must be the same length as xvals.
</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">
  'create\_trigger\_by\_area\_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 /create/trigger/byarea endpoint:

  <Expandable title="data_str">
    <ResponseField name="trigger_id" type="string">
      Value of input parameter *request\_id*.
    </ResponseField>

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

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