Get Job Status

Returns the current status and progress metrics for a specific batch job. Poll this endpoint after submitting an upload to monitor completion.

A job is terminal when its status is complete, partialcomplete, or failed. At that point completedDateTime will be populated and percentageProgress will be 100.

Headers:

AuthorizationstringRequired

The authorization token for accessing the API. The header value should be set to "Bearer {your-access-token}", where {your-access-token} is the access token assigned to the user.

Path Parameters:

siteIdstringRequired

The unique identifier of the site.

jobIdstringRequired

The unique identifier for the batch job, returned by the upload endpoint.

Status Values:

pending

The job has been created and is waiting to begin processing.

processing

The job is actively processing rows.

complete

All rows were processed successfully. failureCount will be 0.

partialcomplete

Processing finished but some rows failed. At least one row succeeded and at least one row failed. Use the Get Revenue Failures endpoint to retrieve the rows that could not be processed.

failed

The job failed entirely. This can occur when all rows failed, or when a fatal error prevented processing (e.g. the file could not be read, the file was empty, or the job type is not supported). See failureReason for details.

Response Fields:

statusstring

The current status of the job (see Status Values above).

totalRowsinteger

The total number of rows in the CSV (excluding the header).

processedRowsinteger

The number of rows processed so far.

percentageProgressinteger

Processing progress from 0 to 100.

successCountinteger

The number of rows that were processed successfully.

failureCountinteger

The number of rows that failed to process.

createdDateTimedatetime

The UTC datetime the job was created.

completedDateTimedatetime

The UTC datetime the job completed. null while the job is still pending or processing.

failureReasonstring

Populated only when status is failed. Describes why the job failed at a file or system level (not row-level validation errors). null otherwise.

Request
GET
{siteId}/batch/{jobId}/status
curl -X GET \
  'https://rest.rulerapi.com/v1/{siteId}/batch/{jobId}/status' \
  -H 'Authorization: Bearer {your-access-token}'
Response
200 OK
{
    "status": "partialcomplete",
    "totalRows": 100,
    "processedRows": 100,
    "percentageProgress": 100,
    "successCount": 95,
    "failureCount": 5,
    "createdDateTime": "2024-01-15T10:00:00",
    "completedDateTime": "2024-01-15T10:02:30",
    "failureReason": null
}