Skip to main content
GET
/
v2
/
discovery
/
{marketId}
/
search-criteria
Get search criteria
curl --request GET \
  --url https://rest.forestreet.com/v2/discovery/{marketId}/search-criteria \
  --header 'x-api-key: <api-key>'
{
  "marketName": "<string>",
  "userPrompt": "<string>",
  "marketType": "service",
  "marketRole": "manufacturer",
  "keywords": {
    "features": [
      "<string>"
    ],
    "user": [
      "<string>"
    ],
    "synonyms": [
      "<string>"
    ],
    "irrelevant": [
      "<string>"
    ]
  },
  "seedDomains": [
    "<string>"
  ],
  "count": 123,
  "assertions": "<any>",
  "constraints": "<any>",
  "projectKind": "first_pass",
  "performSearch": true,
  "studyId": 123,
  "jobId": 123,
  "user": {
    "userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "studyUserGroupId": 1
  }
}

Authorizations

​
x-api-key
string
header
required

Pass a static API key for every request, provided by your customer support.

Path Parameters

​
marketId
string
required

Unique identifier for the market study.

Response

200 - application/json

Search criteria retrieved

​
marketName
string
required

Name of the market associated with the study.

​
userPrompt
string
required

Prompt used to generate the search criteria.

​
marketType
enum<string>
required

Type classification of the market, such as region or category.

Available options:
service,
product
​
marketRole
enum<string>
required

Try to limit the companies to ones that fit a specific role in the market. Possible values are:

  • "manufacturer" – physical product manufacturing, e.g. a car manufacturer
  • "distributor" – physical product distribution, e.g. a car dealership
  • "service provider" – contractor or provider of pre-defined services, e.g. a car repair shop
  • "consultant" – consultants or advisers not themselves participating in the market, but offer advice to those who do, e.g. a motor regulatory consultant

This is a hint to the discovery process and does not guarantee that all returned companies will fit this role. If insufficient companies are found, the search will be broadened to include other roles.

If not provided, the AI will attempt to infer the role based on the market name, and assumes "manufacturer" if the market is too broad.

💡 It is recommended to write your intended role in the market name, which the AI will be able to infer from. Supplying a marketRole incompatible with the market name might degrade the output.

Available options:
manufacturer,
distributor,
serviceProvider,
service provider,
consultant,
provider
​
keywords
object
required

Grouped keywords associated with the search criteria.

​
seedDomains
string[]
required

List of seed domains associated with the search criteria.

​
count
number
required

Number of results returned for the search criteria.

​
projectKind
enum<string>
required

Type of project associated with the search criteria.

Available options:
first_pass,
second_pass,
manually_added
​
performSearch
boolean
required

Indicates whether the search criteria should be used to perform a search.

​
studyId
number | null
required

Unique identifier for the market study.

​
jobId
number | null
required

Unique identifier for the job associated with the market study.

​
user
object | null
required
​
assertions
any

Assumptions made during the search criteria generation process.

​
constraints
any

Constraints applied to the search criteria generation process.