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>'
{
  "metadata": {},
  "data": {
    "marketName": "AI Healthcare Transcription Services",
    "userPrompt": "Find AI-powered transcription services that serve enterprise healthcare customers",
    "marketType": "service",
    "marketRole": "serviceProvider",
    "keywords": {
      "features": [
        "AI transcription",
        "speech-to-text",
        "healthcare"
      ],
      "user": [
        "healthcare",
        "enterprise",
        "hospitals"
      ],
      "synonyms": [
        "transcription",
        "dictation",
        "voice-to-text"
      ],
      "irrelevant": [
        "manual transcription",
        "human transcription"
      ]
    },
    "seedDomains": [],
    "count": 50,
    "assertions": null,
    "constraints": null,
    "projectKind": "first_pass",
    "performSearch": true,
    "locations": [
      {
        "countryCode": "GB",
        "countryName": "United Kingdom"
      }
    ],
    "createdAt": "2023-01-15T10:30:00Z"
  }
}

Overview

This endpoint retrieves the search criteria that was used to discover companies for a specific market.
Workflow Step: This is part of Phase 3 (Company Review) of the Market Research Workflow.

Usage

Use this endpoint to review the search criteria that was used for discovery, which is helpful for:
  • Iteration: Understanding what criteria led to the current results
  • Documentation: Keeping track of search parameters used

Best Practices

Review Process: This endpoint is particularly useful during the company review phase to understand what criteria led to the discovered companies.
Important: This endpoint only works for markets that have completed the discovery process. Make sure discovery is finished before calling this endpoint.

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

Search criteria retrieved

metadata
object
required
data
object
required
I