Get Batch Jobs

Returns a list of batch jobs for the given site. Each entry provides a summary of the job including its type, current status, and progress.

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.

Response Fields:

jobIdstring

The unique identifier for the job. Use this value with the status and failures endpoints.

jobTypestring

The type of batch job. Possible values: revenue, opportunity.

statusstring

The current job status. Possible values: pending, processing, complete, partialcomplete, failed. See Get Job Status for full status descriptions.

percentageProgressinteger

Processing progress from 0 to 100.

failureReasonstring

Populated only when the job status is failed. Describes the reason for the failure. null otherwise.

Request

GET

{siteId}/batch/jobs

curl -X GET \
  'https://rest.rulerapi.com/v1/{siteId}/batch/jobs' \
  -H 'Authorization: Bearer {your-access-token}'

Response

200 OK
[
    {
        "jobId": "{jobId}",
        "jobType": "revenue",
        "status": "complete",
        "percentageProgress": 100,
        "failureReason": null
    },
    {
        "jobId": "{jobId}",
        "jobType": "opportunity",
        "status": "partialcomplete",
        "percentageProgress": 100,
        "failureReason": null
    }
]