Merkl Developer Portal logo
get

/v4/reallocations/jobs/{jobId}

Poll a reallocation walk job (BETA)

Poll a Reallocation Walk

Returns the status of a walk started by POST /v4/reallocations/report/{campaignId}/walk. progress is a percentage of the waves attributed; once status is completed, result holds the report. Check result.walk.complete before trusting per-sender amounts.


State lives in Redis for 30 minutes and is not persisted, so an unknown or expired job ID answers 404 — start a new walk. Any pod can serve the poll, not just the one running the walk.


Authentication: Requires either a valid x-api-key header or the identity token of an operator granted global:backoffice.view.


⚠️ Beta: this endpoint is in beta. The behavior, response shape and data format may change at any time without notice.

Path parameters

jobIdstring
required

Job ID returned by POST /v4/reallocations/report/:campaignId/walk

Responses

200
Response for status 200
Schema
object
jobIdstring
required
Unique job identifier
statusenum
required
pendingprocessingcompletedfailed
progressnumberProgress percentage of the job (0-100)
resultany
required
Result of the job if completed
errorstringError message if job failed
createdAtnumber
required
Timestamp when job was created
completedAtnumberTimestamp when job completed
durationSecondsnumber
required
Duration of the job in seconds (elapsed time if still processing, final duration if completed)
Example
{
  "jobId": "string",
  "status": "pending",
  "progress": 0,
  "result": null,
  "error": "string",
  "createdAt": 0,
  "completedAt": 0,
  "durationSeconds": 0
}