Bigquery.jobs.list

Lists all jobs that you started in the specified project. Job information is available for a six month period after creation. The job list is sorted in reverse chronological order, by job creation time. Requires the Can View project role, or the Is Owner project role if you set the allUsers property.

GET/projects/{projectId}/jobs

Use it in a workflow

Add a step and choose the BigQuery connector.
Pick the Bigquery.jobs.list action (under jobs).
Fill in the fields below, then reference the result from later steps as {{bigqueryJobsList.response.data}}.

Request

Path parameters

projectIdstringrequired

Project ID of the jobs to list

Query parameters

altstring

Data format for the response.

One ofjson

fieldsstring

Selector specifying which fields to include in a partial response.

keystring

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

oauth_tokenstring

OAuth 2.0 token for the current user.

prettyPrintboolean

Returns response with indentations and line breaks.

quotaUserstring

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

userIpstring

Deprecated. Please use quotaUser instead.

allUsersboolean

Whether to display jobs owned by all users in the project. Default false

maxCreationTimestring

Max value for job creation time, in milliseconds since the POSIX epoch. If set, only jobs created before or at this timestamp are returned

maxResultsinteger

Maximum number of results to return

minCreationTimestring

Min value for job creation time, in milliseconds since the POSIX epoch. If set, only jobs created after or at this timestamp are returned

pageTokenstring

Page token, returned by a previous call, to request the next page of results

parentJobIdstring

If set, retrieves only jobs whose parent is this job. Otherwise, retrieves only jobs which have no parent

projectionstring

Restrict information returned to a set of selected fields

One offullminimal

stateFilterarray<string>

Filter for job state

Response

Returns 200 with an object. Read it in later steps with {{bigqueryJobsList.response.data.<field>}}.

etagstring

A hash of this page of results.

jobsarray<object>

List of jobs that were requested.

configurationobject8 fields

errorResultobject4 fields

idstring

Unique opaque ID of the job.

jobReferenceobject3 fields

kindstring

The resource type.

Default "bigquery#job"

statestring

Running state of the job. When the state is DONE, errorResult can be checked to determine whether the job succeeded or failed.

statisticsobject20 fields

statusobject3 fields

user_emailstring

[Full-projection-only] Email address of the user who ran the job.

kindstring

The resource type of the response.

Default "bigquery#jobList"

nextPageTokenstring

A token to request the next page of results.

json

{
  "etag": "string",
  "jobs": [
    {
      "configuration": {
        "copy": {
          "createDisposition": "string",
          "destinationEncryptionConfiguration": {
            "kmsKeyName": "string"
          },
          "destinationExpirationTime": null,
          "destinationTable": {
            "datasetId": "string",
            "projectId": "string",
            "tableId": "string"
          },
          "operationType": "string",
          "sourceTable": {
            "datasetId": "string",
            "projectId": "string",
            "tableId": "string"
          },
          "sourceTables": [
            {
              "datasetId": null,
              "projectId": null,
              "tableId": null
            }
          ],
          "writeDisposition": "string"
        },
        "dryRun": false,
        "extract": {
          "compression": "string",
          "destinationFormat": "string",
          "destinationUri": "string",
          "destinationUris": [
            "string"
          ],
          "fieldDelimiter": "string",
          "printHeader": true,
          "sourceModel": {
            "datasetId": "string",
            "modelId": "string",
            "projectId": "string"
          },
          "sourceTable": {
            "datasetId": "string",
            "projectId": "string",
            "tableId": "string"
          },
          "useAvroLogicalTypes": false
        },
        "jobTimeoutMs": "string",
        "jobType": "string",
        "labels": {},
        "load": {
          "allowJaggedRows": false,
          "allowQuotedNewlines": false,
          "autodetect": false,
          "clustering": {
            "fields": [
              null
            ]
          },
          "connectionProperties": [
            {
              "key": null,
              "value": null
            }
          ],
          "createDisposition": "string",
          "createSession": false,
          "decimalTargetTypes": [
            "string"
          ],
          "destinationEncryptionConfiguration": {
            "kmsKeyName": "string"
          },
          "destinationTable": {
            "datasetId": "string",
            "projectId": "string",
            "tableId": "string"
          },
          "destinationTableProperties": {
            "description": "string",
            "expirationTime": "2025-01-01T00:00:00Z",
            "friendlyName": "string",
            "labels": {}
          },
          "encoding": "string"
        },
        "query": {
          "allowLargeResults": false,
          "clustering": {
            "fields": [
              null
            ]
          },
          "connectionProperties": [
            {
              "key": null,
              "value": null
            }
          ],
          "continuous": false,
          "createDisposition": "string",
          "createSession": false,
          "defaultDataset": {
            "datasetId": "string",
            "projectId": "string"
          },
          "destinationEncryptionConfiguration": {
            "kmsKeyName": "string"
          },
          "destinationTable": {
            "datasetId": "string",
            "projectId": "string",
            "tableId": "string"
          },
          "flattenResults": true,
          "maximumBillingTier": 1,
          "maximumBytesBilled": "string"
        }
      },
      "errorResult": {
        "debugInfo": "string",
        "location": "string",
        "message": "string",
        "reason": "string"
      },
      "id": "string",
      "jobReference": {
        "jobId": "string",
        "location": "string",
        "projectId": "string"
      },
      "kind": "bigquery#job",
      "state": "string",
      "statistics": {
        "completionRatio": 0,
        "copy": {
          "copied_logical_bytes": "string",
          "copied_rows": "string"
        },
        "creationTime": "string",
        "dataMaskingStatistics": {
          "dataMaskingApplied": false
        },
        "endTime": "string",
        "extract": {
          "destinationUriFileCounts": [
            "string"
          ],
          "inputBytes": "string"
        },
        "load": {
          "badRecords": "string",
          "inputFileBytes": "string",
          "inputFiles": "string",
          "outputBytes": "string",
          "outputRows": "string"
        },
        "numChildJobs": "string",
        "parentJobId": "string",
        "query": {
          "biEngineStatistics": {
            "accelerationMode": "",
            "biEngineMode": "",
            "biEngineReasons": [
              null
            ]
          },
          "billingTier": 0,
          "cacheHit": false,
          "ddlAffectedRowAccessPolicyCount": "string",
          "ddlDestinationTable": {
            "datasetId": "string",
            "projectId": "string",
            "tableId": "string"
          },
          "ddlOperationPerformed": "string",
          "ddlTargetDataset": {
            "datasetId": "string",
            "projectId": "string"
          },
          "ddlTargetRoutine": {
            "datasetId": "string",
            "projectId": "string",
            "routineId": "string"
          },
          "ddlTargetRowAccessPolicy": {
            "datasetId": "string",
            "policyId": "string",
            "projectId": "string",
            "tableId": "string"
          },
          "ddlTargetTable": {
            "datasetId": "string",
            "projectId": "string",
            "tableId": "string"
          },
          "dmlStats": {
            "deletedRowCount": "string",
            "insertedRowCount": "string",
            "updatedRowCount": "string"
          },
          "estimatedBytesProcessed": "string"
        },
        "quotaDeferments": [
          "string"
        ],
        "reservationUsage": [
          {
            "name": "string",
            "slotMs": "string"
          }
        ]
      },
      "status": {
        "errorResult": {
          "debugInfo": "string",
          "location": "string",
          "message": "string",
          "reason": "string"
        },
        "errors": [
          {
            "debugInfo": "string",
            "location": "string",
            "message": "string",
            "reason": "string"
          }
        ],
        "state": "string"
      },
      "user_email": "string"
    }
  ],
  "kind": "bigquery#jobList",
  "nextPageToken": "string"
}

Need more? See the BigQuery guide for connection setup and behaviour shared by every action.

Was this page helpful?