GET
/
v2
/
discovery
/
{marketId}
/
status
Get discovery job status
curl --request GET \
  --url https://rest.forestreet.com/v2/discovery/{marketId}/status \
  --header 'x-api-key: <api-key>'
{
  "jobStatuses": [
    {
      "jobId": 123,
      "completed": true,
      "serviceName": "first_pass",
      "jobProgress": 123,
      "startTime": "<string>",
      "endTime": "<string>"
    }
  ]
}

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

serviceName
enum<string>

Name of the service.

Available options:
first_pass,
second_pass,
manually_added

Response

200 - application/json

Discovery job status retrieved

The response is of type object.