# DealSearchResultsByTerm ## Documentation The deals found by a search term. Each request costs 20 tokens of the daily budget of the company. - Catalog: `Pipedrive` - Schema: `Search` This is a read-only table function. The Pipedrive API may not support changing the data or the Invantive UniversalSQL driver for Pipedrive does not cover it. In the latter case, please use the table NativePlatformScalarRequests to upload data to the Pipedrive API. ## Parameters of Table Function The following parameters can be used to control the behaviour of the table function `DealSearchResultsByTerm`. A value must be provided at all times for required parameters, but optional parameters in general do not need to have a value and the execution will default to a pre-defined behaviour. Values can be specified by position and by name. In both cases, all parameters not specified will be evaluated using their default values. Value specification by position is done by listing all values from the first to the last needed value. For example: a `select * from table(value1, value2, value3)` on a table with four parameters will use the default value for the fourth parameter and the specified values for the first three. Value specification by name is done by listing all values that require a value. For example with `select * from table(name1 => value1, name3 => value3)` on the same table will use the default values for the second and fourth parameters and the specified values for the first and third. | Name | Data Type | Required | Default Value | Documentation | |---|:---:|:---:|:---:|---| | `term` | `varchar2` | ☑ | | The term. | ## Columns of Table Function The columns of the table function `DealSearchResultsByTerm` are shown below. Each column has an SQL data type. | Name | Data Type | Label | Required | Documentation | |---|:---:|---|:---:|---| | `currency` | `varchar2` | | ☐ | The currency of the deal. | | `id` | `int64` | | ☐ | The ID of the deal. | | `is_archived` | `char` | | ☐ | A flag indicating whether the deal is archived or not. | | `notes` | `varchar2` | | ☐ | An array of notes. | | `organization_id` | `int64` | | ☐ | The ID of the organization the deal is associated with. | | `organization_name` | `varchar2` | | ☐ | The name of the organization the deal is associated with. | | `owner_id` | `int64` | | ☐ | The ID of the owner of the deal. | | `person_id` | `int64` | | ☐ | The ID of the person the deal is associated with. | | `person_name` | `varchar2` | | ☐ | The name of the person the deal is associated with. | | `result_score` | `decimal` | | ☐ | How well the item matches the search term. | | `stage_id` | `int64` | | ☐ | The ID of the stage of the deal. | | `stage_name` | `varchar2` | | ☐ | The name of the stage of the deal. | | `status` | `varchar2` | | ☐ | The status of the deal. | | `term` | `varchar2` | | ☐ | The term the rows were read for. | | `title` | `varchar2` | | ☐ | The title of the deal. | | `type` | `varchar2` | | ☐ | The type of the item. | | `value` | `decimal` | | ☐ | The value of the deal. | | `visible_to` | `int64` | | ☐ | The visibility of the deal. |