Jump to

• Request
• Response

Gets progress of data load job

get

/data-tools/data-loads/{owner},{data_load_job_id}/progress

Gets progress of data load job

Request

Path Parameters

• data_load_job_id(required): string
  name of data load job to get
• owner(required): string
  Owner for the data load.

There's no request body for this operation.

Back to Top

Response

200 Response

Status of multiple data loads

Body ()

Root Schema : data-load-statuses

Type: object

Status of data load jobs

Show Source

• data_load_statuses: array data_load_statuses

{
    "type":"object",
    "description":"Status of data load jobs",
    "properties":{
        "data_load_statuses":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/data-load-status"
            }
        }
    }
}

Nested Schema : data_load_statuses

Type: array

Show Source

• Array of: object data-load-status
  Status of a data load job

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/data-load-status"
    }
}

Nested Schema : data-load-status

Type: object

Status of a data load job

Show Source

• data_load_job_id: string
  Name of data load job

  Example: SALES-LOAD-20220529-112233-4567
• exception_details: object exception_details
  Exception details for failed job
• progress: integer
  Percentage complete

  Example: 42
• rows_loaded: integer
  Rows loaded so far

  Example: 10342
• rows_rejected: integer
  Rows rejected so far

  Example: 3
• rows_total: integer
  Total rows for completed job

  Example: 16572
• rows_total_estimate: integer
  Estimated total rows for in-progress job

  Example: 15000
• state: string
  Allowed Values: [ "RUNNING", "COMPLETE", "INPROGRESS", "WAITING" ]
• time_completion: string
  Example: 2022-05-29 01:30:00
• timestamp: string
  Example: 2022-06-05 07:30:00

{
    "type":"object",
    "description":"Status of a data load job",
    "properties":{
        "data_load_job_id":{
            "$ref":"#/components/schemas/data_load_job_id"
        },
        "progress":{
            "type":"integer",
            "example":"42",
            "description":"Percentage complete"
        },
        "rows_loaded":{
            "type":"integer",
            "example":"10342",
            "description":"Rows loaded so far"
        },
        "rows_rejected":{
            "type":"integer",
            "example":"3",
            "description":"Rows rejected so far"
        },
        "rows_total":{
            "type":"integer",
            "example":"16572",
            "description":"Total rows for completed job"
        },
        "rows_total_estimate":{
            "type":"integer",
            "example":"15000",
            "description":"Estimated total rows for in-progress job"
        },
        "state":{
            "type":"string",
            "enum":[
                "RUNNING",
                "COMPLETE",
                "INPROGRESS",
                "WAITING"
            ]
        },
        "timestamp":{
            "type":"string",
            "example":"2022-06-05 07:30:00"
        },
        "time_completion":{
            "type":"string",
            "example":"2022-05-29 01:30:00"
        },
        "exception_details":{
            "type":"object",
            "description":"Exception details for failed job"
        }
    }
}

Nested Schema : exception_details

Type: object

Exception details for failed job

404 Response

Data Load Job not found

Back to Top