curl --request GET \
--url https://rest.forestreet.com/v2/discovery/{marketId}/search-criteria/history \
--header 'x-api-key: <api-key>'{
"metadata": {
"isFromPrimarySource": true
},
"data": [
{
"marketId": 12345,
"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"
]
},
"count": 50,
"locations": [
{
"country": "GB",
"address": [
"123 Healthcare St",
"Suite 100"
],
"coordinates": [
51.5074,
-0.1278
]
}
],
"jobId": 12345,
"projectKind": "first_pass",
"performSearch": true,
"createdAt": "2023-01-15T10:30:00Z"
},
{
"marketId": 12345,
"marketName": "AI Transcription Services",
"userPrompt": "Find AI transcription services",
"marketType": "service",
"marketRole": "serviceProvider",
"keywords": {
"features": [
"AI transcription",
"speech-to-text"
],
"user": [
"enterprise"
],
"synonyms": [
"transcription",
"dictation"
],
"irrelevant": [
"manual transcription"
]
},
"count": 25,
"locations": [
{
"country": "GB",
"address": [
"123 Healthcare St",
"Suite 100"
],
"coordinates": [
51.5074,
-0.1278
]
}
],
"jobId": 12345,
"projectKind": "second_pass",
"performSearch": false,
"createdAt": "2023-01-15T10:30:00Z"
}
]
}Get search criteria history
Retrieve the history of search criteria iterations for a specific market.
curl --request GET \
--url https://rest.forestreet.com/v2/discovery/{marketId}/search-criteria/history \
--header 'x-api-key: <api-key>'{
"metadata": {
"isFromPrimarySource": true
},
"data": [
{
"marketId": 12345,
"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"
]
},
"count": 50,
"locations": [
{
"country": "GB",
"address": [
"123 Healthcare St",
"Suite 100"
],
"coordinates": [
51.5074,
-0.1278
]
}
],
"jobId": 12345,
"projectKind": "first_pass",
"performSearch": true,
"createdAt": "2023-01-15T10:30:00Z"
},
{
"marketId": 12345,
"marketName": "AI Transcription Services",
"userPrompt": "Find AI transcription services",
"marketType": "service",
"marketRole": "serviceProvider",
"keywords": {
"features": [
"AI transcription",
"speech-to-text"
],
"user": [
"enterprise"
],
"synonyms": [
"transcription",
"dictation"
],
"irrelevant": [
"manual transcription"
]
},
"count": 25,
"locations": [
{
"country": "GB",
"address": [
"123 Healthcare St",
"Suite 100"
],
"coordinates": [
51.5074,
-0.1278
]
}
],
"jobId": 12345,
"projectKind": "second_pass",
"performSearch": false,
"createdAt": "2023-01-15T10:30:00Z"
}
]
}Overview
This endpoint retrieves the complete history of search criteria iterations that have been used for a specific market discovery.Usage
Use this endpoint to track the evolution of search criteria for a market, which is helpful for:- Iteration: See how search criteria evolved over time
- Documentation: Maintain a complete history of search parameters
Best Practices
Authorizations
Pass a static API key for every request, provided by your customer support.
Path Parameters
Unique identifier for the market study. Unique identifier for the market study.
Response
Search criteria history retrieved
Returned when querying markets with search criteria. Includes detailed market classifications and grouped keywords.
- Option 1
- Option 2
Show child attributes
Show child attributes
Prompt used to generate the search criteria.
Name of the market associated with the study.
Type classification of the market, such as region or category.
service, product 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
marketRoleincompatible with the market name might degrade the output.
manufacturer, distributor, serviceProvider, service provider, consultant, provider Grouped keywords associated with the search criteria.
Show child attributes
Show child attributes
Keywords related to the market's features.
Keywords related to user preferences or behavior.
Alternative terms related to the market search.
Terms identified as irrelevant for the search criteria.
Unique identifier for the market study.
Unique identifier for the job associated with the market study.
Type of project associated with the search criteria.
first_pass, second_pass, manually_added Timestamp indicating when the record was created.
List of company domains you already know (if any).
Assumptions made during the search criteria generation process.
Constraints applied to the search criteria generation process.