Get a grid execution - QX Labs Docs

GET

grids

{grid_id}

sheets

{sheet_id}

executions

{execution_id}

cURL

curl https://api.qxlabs.com/v1/grids/3e7a9c415b2d4f8ea6c19d0b2e4f7a18/sheets/b2d4f6a81c3e4a5b8d7f0e9c2a4b6d81/executions/5c8a2e4f-6b1d-4a3c-9e7f-2d4b6a8c0e13 \
  -H "Authorization: Bearer <YOUR_QX_API_KEY>"

import time

import requests

headers = {"Authorization": "Bearer <YOUR_QX_API_KEY>"}
url = "https://api.qxlabs.com/v1/grids/3e7a9c415b2d4f8ea6c19d0b2e4f7a18/sheets/b2d4f6a81c3e4a5b8d7f0e9c2a4b6d81/executions/5c8a2e4f-6b1d-4a3c-9e7f-2d4b6a8c0e13"

# Poll until the execution has finished
while True:
    execution = requests.get(url, headers=headers).json()
    if execution["status"] in ("completed", "error", "cancelled"):
        break
    time.sleep(3)
print(execution["progress"], execution["row_ids"])

const headers = { Authorization: "Bearer <YOUR_QX_API_KEY>" };
const url = "https://api.qxlabs.com/v1/grids/3e7a9c415b2d4f8ea6c19d0b2e4f7a18/sheets/b2d4f6a81c3e4a5b8d7f0e9c2a4b6d81/executions/5c8a2e4f-6b1d-4a3c-9e7f-2d4b6a8c0e13";

// Poll until the execution has finished
let execution;
while (true) {
  execution = await (await fetch(url, { headers })).json();
  if (["completed", "error", "cancelled"].includes(execution.status)) break;
  await new Promise((resolve) => setTimeout(resolve, 3000));
}
console.log(execution.progress, execution.row_ids);

{
  "execution_id": "5c8a2e4f-6b1d-4a3c-9e7f-2d4b6a8c0e13",
  "grid_id": "3e7a9c415b2d4f8ea6c19d0b2e4f7a18",
  "sheet_id": "b2d4f6a81c3e4a5b8d7f0e9c2a4b6d81",
  "status": "processing",
  "progress": {
    "total_cells": 240,
    "completed_cells": 150,
    "skipped_cells": 6,
    "failed_cells": 4,
    "cancelled_cells": 0
  },
  "error": null,
  "column_ids": [
    "9f8e7d6c5b4a439281706f5e4d3c2b1a"
  ],
  "row_ids": [
    "7d1e3f5a9b2c4d6e8f0a1b3c5d7e9f20",
    "e4a6c8b02d1f4e3ab5c79d0e1f2a3b46"
  ]
}

{
  "error": "<string>"
}

{
  "error": "Execution run not found"
}

{
  "error": "Read rate limit exceeded for grids endpoints"
}

Authorizations

Authorization

string

header

required

Your QX API key. The X-API-Key header works too

Path Parameters

grid_id

string

required

The grid's ID

sheet_id

string

required

The sheet's ID

execution_id

string

required

The execution's ID, from the execute endpoint

Response

The execution

execution_id

string

grid_id

string

sheet_id

string

status

enum<string>

Available options:

queued,

processing,

completed,

error,

cancelled

progress

object

Cell counts. A cell that failed shows its own error in the sheet endpoint

Show child attributes

error

string | null

The error for the execution as a whole, if there is one

column_ids

string[]

The IDs of the columns the execution covers

row_ids

string[]

The IDs of the rows the execution covers, up to the first 500

cURL

curl https://api.qxlabs.com/v1/grids/3e7a9c415b2d4f8ea6c19d0b2e4f7a18/sheets/b2d4f6a81c3e4a5b8d7f0e9c2a4b6d81/executions/5c8a2e4f-6b1d-4a3c-9e7f-2d4b6a8c0e13 \
  -H "Authorization: Bearer <YOUR_QX_API_KEY>"

import time

import requests

headers = {"Authorization": "Bearer <YOUR_QX_API_KEY>"}
url = "https://api.qxlabs.com/v1/grids/3e7a9c415b2d4f8ea6c19d0b2e4f7a18/sheets/b2d4f6a81c3e4a5b8d7f0e9c2a4b6d81/executions/5c8a2e4f-6b1d-4a3c-9e7f-2d4b6a8c0e13"

# Poll until the execution has finished
while True:
    execution = requests.get(url, headers=headers).json()
    if execution["status"] in ("completed", "error", "cancelled"):
        break
    time.sleep(3)
print(execution["progress"], execution["row_ids"])

const headers = { Authorization: "Bearer <YOUR_QX_API_KEY>" };
const url = "https://api.qxlabs.com/v1/grids/3e7a9c415b2d4f8ea6c19d0b2e4f7a18/sheets/b2d4f6a81c3e4a5b8d7f0e9c2a4b6d81/executions/5c8a2e4f-6b1d-4a3c-9e7f-2d4b6a8c0e13";

// Poll until the execution has finished
let execution;
while (true) {
  execution = await (await fetch(url, { headers })).json();
  if (["completed", "error", "cancelled"].includes(execution.status)) break;
  await new Promise((resolve) => setTimeout(resolve, 3000));
}
console.log(execution.progress, execution.row_ids);

{
  "execution_id": "5c8a2e4f-6b1d-4a3c-9e7f-2d4b6a8c0e13",
  "grid_id": "3e7a9c415b2d4f8ea6c19d0b2e4f7a18",
  "sheet_id": "b2d4f6a81c3e4a5b8d7f0e9c2a4b6d81",
  "status": "processing",
  "progress": {
    "total_cells": 240,
    "completed_cells": 150,
    "skipped_cells": 6,
    "failed_cells": 4,
    "cancelled_cells": 0
  },
  "error": null,
  "column_ids": [
    "9f8e7d6c5b4a439281706f5e4d3c2b1a"
  ],
  "row_ids": [
    "7d1e3f5a9b2c4d6e8f0a1b3c5d7e9f20",
    "e4a6c8b02d1f4e3ab5c79d0e1f2a3b46"
  ]
}

{
  "error": "<string>"
}

{
  "error": "Execution run not found"
}

{
  "error": "Read rate limit exceeded for grids endpoints"
}