Get search criteria
curl --request GET \
--url https://rest.forestreet.com/v2/discovery/{marketId}/search-criteria \
--header 'x-api-key: <api-key>'import requests
url = "https://rest.forestreet.com/v2/discovery/{marketId}/search-criteria"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://rest.forestreet.com/v2/discovery/{marketId}/search-criteria', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://rest.forestreet.com/v2/discovery/{marketId}/search-criteria",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://rest.forestreet.com/v2/discovery/{marketId}/search-criteria"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://rest.forestreet.com/v2/discovery/{marketId}/search-criteria")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://rest.forestreet.com/v2/discovery/{marketId}/search-criteria")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"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": [
{
"country": "GB",
"address": [
"123 Healthcare St",
"Suite 100"
],
"coordinates": [
51.5074,
-0.1278
]
}
],
"createdAt": "2023-01-15T10:30:00Z"
}
}{
"success": false,
"errorCode": "INVALID_INPUT",
"message": "Bad Request"
}{
"success": false,
"errorCode": "FORBIDDEN",
"message": "Forbidden"
}{
"success": false,
"errorCode": "NOT_FOUND",
"message": "Not Found"
}{
"success": false,
"errorCode": "INTERNAL_SERVER_ERROR",
"message": "Internal Server Error"
}Company Review
Get search criteria
Retrieve the search criteria used for a specific market discovery.
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>'import requests
url = "https://rest.forestreet.com/v2/discovery/{marketId}/search-criteria"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://rest.forestreet.com/v2/discovery/{marketId}/search-criteria', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://rest.forestreet.com/v2/discovery/{marketId}/search-criteria",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://rest.forestreet.com/v2/discovery/{marketId}/search-criteria"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://rest.forestreet.com/v2/discovery/{marketId}/search-criteria")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://rest.forestreet.com/v2/discovery/{marketId}/search-criteria")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"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": [
{
"country": "GB",
"address": [
"123 Healthcare St",
"Suite 100"
],
"coordinates": [
51.5074,
-0.1278
]
}
],
"createdAt": "2023-01-15T10:30:00Z"
}
}{
"success": false,
"errorCode": "INVALID_INPUT",
"message": "Bad Request"
}{
"success": false,
"errorCode": "FORBIDDEN",
"message": "Forbidden"
}{
"success": false,
"errorCode": "NOT_FOUND",
"message": "Not Found"
}{
"success": false,
"errorCode": "INTERNAL_SERVER_ERROR",
"message": "Internal Server Error"
}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
apiKeyAuthbearerAuthsessionIdQuery
Pass a static API key for every request, provided by your customer support.
Path Parameters
Unique identifier for the market study.
⌘I