Skip to main content
GET
/
v2
/
discovery
/
{marketId}
/
jobs
Get job status
curl --request GET \
  --url https://rest.forestreet.com/v2/discovery/{marketId}/jobs \
  --header 'x-api-key: <api-key>'
{
  "metadata": {},
  "data": [
    {
      "jobId": 67890,
      "status": "running",
      "serviceName": "first_pass",
      "jobProgress": 65,
      "startTime": "2024-01-15T10:30:00Z",
      "endTime": null
    },
    {
      "jobId": 67891,
      "status": "pending",
      "serviceName": "second_pass",
      "jobProgress": 0,
      "startTime": "2024-01-15T10:30:00Z",
      "endTime": null
    }
  ]
}

​
Overview

This endpoint allows you to monitor the progress of asynchronous jobs (including both discovery and publish jobs) for a specific market. Use it to check which steps have completed and the current progress of each job.
Workflow Step: This endpoint is used throughout the Market Research Workflow, including both discovery and publish phases.

​
Usage

Call this endpoint with the marketId to get a list of all jobs and their statuses.

​
Best Practices

Polling Strategy: Check the status every 30-60 seconds

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.

Query Parameters

​
jobId

Filter by unique identifier for the job.

​
serviceName

Filter by name of the service.

Available options:
first_pass,
second_pass,
manually_added,
enrichment,
scrape,
web_traffic,
momentum_scoring,
competitors,
news,
news_article_scrape,
search_esg,
extract_phrases,
embed_scrapes,
topic_analysis,
auto_feature_map
​
status
enum<string>

Filter by status of the job.

Available options:
pending,
running,
completed
​
startTime
string<date-time>

Filter by timestamp indicating when the job started. Must be an ISO 8601 UTC string (e.g. 2023-01-01T12:00Z).

​
endTime
string<date-time>

Filter by timestamp indicating when the job ended. Must be an ISO 8601 UTC string (e.g. 2023-01-01T12:00Z).

Response

Job status retrieved

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