POST
/
v2
/
discovery
/
{marketId}
/
start
Start discovery
curl --request POST \
  --url https://rest.forestreet.com/v2/discovery/{marketId}/start \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "searchCriteria": {
    "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,
    "locations": {
      "countryCodes": [
        "<string>"
      ],
      "countryNames": [
        "<string>"
      ]
    }
  },
  "pipelineChoices": {
    "skipDiscoveryReview": false,
    "runReverseGeocoding": true,
    "runDunsMapper": true,
    "runPeople": true,
    "runNews": true,
    "runEsg": true,
    "runMomentumScore": true,
    "runMarketRadar": true,
    "runTopicAnalysis": true,
    "runPhraseExplorer": true,
    "runGenerateFeatureMap": true,
    "runSendPublishEmail": true
  }
}'
{
  "success": true,
  "message": "<string>",
  "metadata": {
    "marketId": 123,
    "jobIds": [
      123
    ]
  }
}

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.

Body

application/json

Response

200 - application/json

Discovery started

The response is of type object.