Skip to main content
POST
/
v2
/
discovery
/
{marketId}
/
publish
Publish a market
curl --request POST \
  --url https://rest.forestreet.com/v2/discovery/{marketId}/publish \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "pipelineChoices": {
    "skipDiscoveryReview": false,
    "runReverseGeocoding": true,
    "runDunsMapper": true,
    "runPeople": true,
    "runNews": true,
    "runEsg": true,
    "runMomentumScore": true,
    "runMarketRadar": true,
    "runTopicAnalysis": true,
    "runPhraseExplorer": true,
    "runGenerateFeatureMap": true,
    "sendPublishEmail": true
  }
}'
{
  "message": "Market published successfully",
  "metadata": {
    "marketId": 12345
  },
  "data": [
    {
      "jobId": 67890,
      "serviceName": "enrichment",
      "startTime": "2024-01-15T10:30:00Z"
    },
    {
      "jobId": 67891,
      "serviceName": "scrape",
      "startTime": "2024-01-15T10:30:00Z"
    },
    {
      "jobId": 67892,
      "serviceName": "web_traffic",
      "startTime": "2024-01-15T10:30:00Z"
    }
  ]
}

​
Overview

This endpoint publishes your discovered companies and triggers comprehensive analysis including financial data, ESG metrics, news analysis, and competitive insights.
Workflow Step: This is Step 4 of the Discovery Workflow.
Important: This is an asynchronous process that can take 45-60 minutes to complete. Use the status endpoint to monitor progress

​
Usage

The endpoint accepts pipeline configuration options to control which analysis steps are performed:
  • Pipeline Choices: Configure which analysis steps to run
  • Response: Job IDs for monitoring the publishing process
Pipeline Configuration: Choose analysis steps based on your research goals. Each step adds valuable insights but increases processing time.

​
Pipeline Steps

The publishing process includes several analysis steps:
  • Reverse Geocoding: Convert company addresses to geographic coordinates
  • DUNS Mapper: Map companies to DUNS numbers for enhanced data
  • People: Extract and analyse key personnel information
  • News: Gather and analyse recent news and media coverage
  • ESG: Collect Environmental, Social, and Governance data
  • Momentum Score: Calculate market momentum and sentiment scores
  • Market Radar: Generate competitive landscape analysis
  • Topic Analysis: Identify key themes and topics in the market
  • Phrase Explorer: Analyse market terminology and language patterns
  • Feature Map: Generate visual feature maps for market insights
  • Publish Email: Send notification emails upon completion

​
Monitoring Progress

After starting the publishing process, you can monitor progress using the same status endpoint: 
GET /v2/markets/{marketId}/services/publish/status

​
Accessing Published Data

Once publishing is complete, you can access your market data through various endpoints: 
  # Get companies in the market
  GET /v2/markets/12345/companies

  # Get ESG data
  GET /v2/markets/12345/esg

​
Best Practices

For Better Results: - Ensure discovery is fully completed before publishing - Choose pipeline steps relevant to your research goals - Consider the review step for quality control
Important Notes: - Only one publishing process can run per market at a time - The process cannot be interrupted once started

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
  • Option 1 · object
  • Option 2 · any
  • Option 3 · any
​
pipelineChoices
object

Choices for the publish pipeline.

Response

Publish a market in discovery workflow response

​
metadata
object
required
​
data
object[]
required
⌘I