Skip to content
LeadMCPDocs

get collect status

GET/signals/collect/{id}

Returns the status of one collect job: queued, running, completed or failed. It also returns the leads and contacts so far, the premium credits held and charged, and the list_signals arguments that read the rows. After collect_signals, call it every 30 to 60 seconds until status is completed or failed. Then read the rows with GET /signals and the query in read.arguments. Free.

FreeFree.

Returns the status of one collect job: queued, running, completed or failed. It also returns the leads and contacts so far, the premium credits held and charged, and the list_signals arguments that read the rows. After collect_signals, call it every 30 to 60 seconds until status is completed or failed. Then read the rows with GET /signals and the query in read.arguments. Free.

Parameters

idstringin pathrequired

The collect job id: job.id in the collect_signals answer.

Response

The fields inside data.

idstringrequired

kindenumrequired

linkedin_profilelinkedin_postlinkedin_company

targetstringrequired

statusenumrequired

queued: no runner has started the job. running: the job collects or matches rows; call get_collect again in 30 to 60 seconds. completed: all rows are written; read them with list_signals. failed: the job stopped; the rows it wrote stay readable, and error says what to do.

queuedrunningcompletedfailed

requestedintegerrequired

The leads the job asks for: the requested company followers, or the expected engagers of a profile or post.

signalsintegerrequired

The rows the job wrote so far.

leadsintegerrequired

The unique new leads so far. Each one costs one premium credit when the job settles.

contacts_matchedintegerrequired

The rows that carry a stored contact so far. Each one cost one contact credit.

premium_creditsobjectrequired

Show child attributes

heldintegerrequired

The premium credits held for this job now. The hold returns when the job settles.

chargedintegerrequired

The premium credits this job charged. It is 0 until the job settles.

errorstring or nullrequired

Present only when status is failed: what went wrong and what to do.

created_atstringrequired

finished_atanyrequired

When the job completed or failed. Null while it is queued or running.

readobjectrequired

The list_signals arguments that read this job's rows. On REST, send them as the query of GET /signals.

Show child attributes

toolstringrequired

argumentsobjectrequired

Show child attributes

source_typestringrequired

source_idstringrequired

Failures

StatusMeaning
400The request shape, a filter key, a value, a cursor or the enrichment mode was rejected.
401The credential is missing, unknown or revoked.
404Unknown collect job id, an alert run, or a job of another account.
429The key passed 300 requests a minute or 2 concurrent requests.
503The data is unavailable for a short time.