API v3 is live and in beta: expect possible malfunctions and breaking changes in the coming days. If you find a bug, please report it to your Sillage contact.
v2DeprecatedSignal Runs

Poll Signal Run

Track the progress of a running signal run.

Returns the current status of a signal run. Poll this endpoint after calling POST .../signal-runs until stage is completed or failed.

Poll a signal run

GET/api/v2/partner/workspaces/{partner_workspace_id}/signal-runs/{id}

Path parameters

ParameterTypeDescription
partner_workspace_idstringOpaque workspace identifier from the partner system.
idintegerId of the signal run (signal_request_id from the launch response).

Example request

curl "https://api.getsillage.com/api/v2/partner/workspaces/ws_123/signal-runs/501" \
  -H "Authorization: Bearer $SILLAGE_API_KEY"

Example response

{
  "signal_request_id": 501,
  "stage": "completed",
  "metadata": null
}

When some accounts could not be scanned, metadata reports them so you can retry:

{
  "signal_request_id": 501,
  "stage": "completed_partial",
  "metadata": { "failed": { "dropped_account_ids": [202, 203] } }
}

Response fields

FieldTypeDescription
signal_request_idintegerId of the run.
stagestringProcessing stage. Poll until completed, completed_partial, or failed.
metadataobject or nullAccounts that were not scanned (failed.dropped_account_ids). null when every account was scanned or when the run failed entirely (failed).
metadata.failed.dropped_account_idsarray of integersIDs of accounts that could not be scanned in this run.

Errors

StatusMeaning
400Invalid id path parameter.
401The master key is missing or invalid.
403The master key is not authorized to access this resource.
404No signal run found for this id.
429Too many requests.
500An unexpected server error occurred.

Error responses use RFC 9457 problem documents with Content-Type: application/problem+json.

On this page