RanklyBee logoRanklyBee
Discovery jobs

Get a discovery job

GET
/workspaces/{workspaceId}/sites/{siteId}/discovery-jobs/{jobId}

Authorization

bearerAuth
AuthorizationBearer <token>

Use a token created in Settings → API access.

In: header

Path Parameters

workspaceId*string

Workspace ID returned by GET /workspaces.

siteId*string

Site ID returned by GET /workspaces/{workspaceId}/sites.

jobId*string

Query Parameters

page?integer
Range1 <= value
Default1
limit?integer
Range1 <= value <= 100
Default25

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/workspaces/string/sites/string/discovery-jobs/string"
{  "ok": true,  "data": {    "job": {      "id": "string",      "type": "string",      "status": "string",      "subjectType": "string",      "subjectId": "string",      "currentAttempt": 0,      "maxAttempts": 0,      "scheduledAt": "2019-08-24T14:15:22Z",      "canceledAt": "2019-08-24T14:15:22Z",      "completedAt": "2019-08-24T14:15:22Z",      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z"    },    "queryCount": 0,    "queries": [      {        "id": "string",        "query": "string",        "status": "string",        "opportunityType": "string",        "rawResultCount": 0,        "uniqueCandidateCount": 0,        "qualifiedCount": 0,        "startedAt": "2019-08-24T14:15:22Z",        "completedAt": "2019-08-24T14:15:22Z",        "errorCode": "string",        "hasError": true      }    ],    "pagination": {      "page": 0,      "limit": 0,      "total": 0,      "hasMore": true    }  }}