Signal

Gets a single signal run by its id.

Changed on
get/signal/run/{runId}

Request

  • Base URL
    https://api.rapidata.ai
  • URL
    https://api.rapidata.ai/signal/run/{runId}
  • Auth
    OpenID Connect (https://auth.rapidata.ai/.well-known/openid-configuration, scopes: openid, profile, email, offline_access, api)

Path parameters

runIdstring required

The id of the run to retrieve.

Response

OK

idstring required

The unique identifier of the run.

signalIdstring required

The id of the parent signal.

triggerSource'Scheduled' | 'Manual' required
status'Pending' | 'Running' | 'Completed' | 'Failed' | 'Skipped' required
startedAtstring date-time required

When the run was started.

audienceJobIdstring nullable

The id of the audience job this run spawned (null until orders confirms creation).

completedAtstring date-time nullable

When the run reached a terminal state.

resultFileNamestring nullable

File name of the audience-job result, when completed.

failureMessagestring nullable

Reason the run failed.

skippedReasonstring nullable

Reason the run was skipped without spawning an audience job.

Changes