Skip to main content
GET
/
jobs
/
comparison
curl -X GET "https://YOUR_BASE_URL/jobs/comparison?page=1&size=20&status_filters=FAILURE" \
  -H "Authorization: Bearer <api-key>" \
  -H "Workspace-Id: <workspace-id>"

{
  "data": {
    "items": [
      {
        "job_id": 1042,
        "comparison_id": "eeeeeeee-0000-0000-0000-000000000005",
        "comparison_name": "orders table comparison",
        "comparison_result_id": "ffffffff-0000-0000-0000-000000000006",
        "status": "SUCCESS",
        "source_datasource_name": "prod-postgres",
        "target_datasource_name": "prod-snowflake",
        "source_dataset_name": "orders",
        "target_dataset_name": "orders",
        "source_datasource_type": "postgresql",
        "target_datasource_type": "snowflake",
        "task_id": "7f3a1b2c-4d5e-6f7a-8b9c-0d1e2f3a4b5c",
        "created_at": "2025-01-15T10:00:00Z",
        "started_at": "2025-01-15T10:00:02Z",
        "date_done": "2025-01-15T10:01:45Z",
        "time_taken": 103.2,
        "retry_count": 0,
        "message": ""
      }
    ],
    "page": 1,
    "size": 20,
    "total": 1,
    "pages": 1
  },
  "meta": {
    "status_filters": ["SUCCESS", "FAILURE", "PENDING"],
    "source_dataset_filters": ["orders"],
    "target_dataset_filters": ["orders"]
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.datachecks.io/llms.txt

Use this file to discover all available pages before exploring further.

​
Authorization
string
required
Bearer token. Format: Bearer <api-key>
​
Workspace-Id
string
required
Your workspace UUID.
​
page
integer
default:"1"
Page number for pagination.
​
size
integer
default:"50"
Number of results per page.
​
filter
string
Search string to filter jobs by comparison name.
​
status_filters
string
Comma-separated list of statuses to include. Example: SUCCESS,FAILURE.
​
source_dataset_filters
string
Comma-separated list of source dataset names to filter by.
​
target_dataset_filters
string
Comma-separated list of target dataset names to filter by.
​
start_time
string
ISO 8601 start of the time range. Defaults to 30 days ago.
​
end_time
string
ISO 8601 end of the time range. Defaults to now.

​
Response

​
data
object
Paginated list of jobs.
​
meta
object
Includes available filter values for status_filters, source_dataset_filters, and target_dataset_filters.
curl -X GET "https://YOUR_BASE_URL/jobs/comparison?page=1&size=20&status_filters=FAILURE" \
  -H "Authorization: Bearer <api-key>" \
  -H "Workspace-Id: <workspace-id>"

{
  "data": {
    "items": [
      {
        "job_id": 1042,
        "comparison_id": "eeeeeeee-0000-0000-0000-000000000005",
        "comparison_name": "orders table comparison",
        "comparison_result_id": "ffffffff-0000-0000-0000-000000000006",
        "status": "SUCCESS",
        "source_datasource_name": "prod-postgres",
        "target_datasource_name": "prod-snowflake",
        "source_dataset_name": "orders",
        "target_dataset_name": "orders",
        "source_datasource_type": "postgresql",
        "target_datasource_type": "snowflake",
        "task_id": "7f3a1b2c-4d5e-6f7a-8b9c-0d1e2f3a4b5c",
        "created_at": "2025-01-15T10:00:00Z",
        "started_at": "2025-01-15T10:00:02Z",
        "date_done": "2025-01-15T10:01:45Z",
        "time_taken": 103.2,
        "retry_count": 0,
        "message": ""
      }
    ],
    "page": 1,
    "size": 20,
    "total": 1,
    "pages": 1
  },
  "meta": {
    "status_filters": ["SUCCESS", "FAILURE", "PENDING"],
    "source_dataset_filters": ["orders"],
    "target_dataset_filters": ["orders"]
  }
}