List All Jobs for a Pipeline

get

https://us.hevodata.com/api/v2/pipelines/{pipeline_id}/jobs

Retrieves a list of jobs executed for the specified pipeline_id. A job is one run of the Pipeline. It can be the historical load, a scheduled or on-demand incremental sync, a data refresher run, or a resync. The most recently started job is listed first, and each job includes its type, execution status, duration, object-level processing counts, and latency metrics.

Refer to Viewing Pipeline Job History for more information about job types, job statuses, and the counts each job reports.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

pipeline_id

int64

required

≥ 1

Unique identifier of the Pipeline.

Query Params

cursor

string

Value used to retrieve the next set of results. Provide the next_cursor value returned in the previous API response. The cursor holds a position in the list rather than a job, so send the same limit and the same filters with it. Jobs are listed newest first, so a job that starts while you are reading the pages moves the other jobs down, and a job can appear on two pages. Remove the repeats by id.

limit

integer

1 to 500

Defaults to 100

Maximum number of results the API should return. If not set, the API returns up to 100 items.

status

array of strings

Returns only the jobs in the specified statuses. To filter by more than one status, repeat the parameter. For example, to list the jobs that completed along with those that failed, specify ?status=COMPLETED&status=FAILED. The response then contains only the jobs in these two statuses. This value is not case-sensitive. The spellings CANCELLED and CANCELLING are not accepted and return a 400.

status

type

array of strings

Returns only the jobs of the specified types. To filter by more than one type, repeat the parameter. For example, to list the historical loads along with the resync jobs, specify ?type=HISTORICAL&type=RESYNC. The response then contains only the jobs of these two types. This value is not case-sensitive.

type

Allowed:

Responses

400

The list of Pipeline jobs could not be retrieved. This occurs when:

The status or type value is not valid.
The limit value is not an integer, or is outside the range of 1 to 500.
The cursor value is not valid.

404

The Pipeline could not be found. This occurs when:

No Pipeline exists with the specified pipeline_id, or you do not have access to it.
The Pipeline is deleted, or its deletion is in progress.
The Pipeline is in a different region from the base URL that you call.

200List of Pipeline jobs retrieved successfully.