list_entity_filter_values - Bigdata.com API developer docs

Overview

The list_entity_filter_values tool returns the values accepted by a find_entities filter. Use it before filtering when you do not know the exact spelling or format of a value.

When to Use

Use list_entity_filter_values when:

A find_entities filter requires an exact value and its spelling or format is unknown
A broad description needs to be mapped to an available classification
A filter returns no matches and its value needs to be checked

For example, a request for government-run investment funds can be mapped to the Sovereign Wealth Fund organization type.

Parameters

Parameter	Type	Required	Description
`entity_type`	enum	Yes	Entity category: `organization`, `person`, `place`, or `product`.
`filter`	string	Yes	Filter to list. The available filters depend on `entity_type`.

Filters

`entity_type`	Available filters
`organization`	`types`, `countries`, `owners`
`person`	`positions`, `employers`, `nationalities`, `genders`
`place`	`categories`, `types`, `continents`, `countries`, `regions`
`product`	`types`, `owners`

How It Works

The tool returns a values array for the selected entity type and filter. The agent can select the value that best matches the user’s request and pass it unchanged to the corresponding find_entities filter. Country values are returned as ISO 3166-1 alpha-2 codes, such as US, FR, and GB.

Some filters have very large value sets. The returned list may be incomplete, so a value that is not listed may still be accepted by find_entities.