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

The response is of type object.