Execute a grid - QX Labs Docs

POST

grids

{grid_id}

sheets

{sheet_id}

execute

cURL

curl https://api.qxlabs.com/v1/grids/3e7a9c415b2d4f8ea6c19d0b2e4f7a18/sheets/b2d4f6a81c3e4a5b8d7f0e9c2a4b6d81/execute \
  -H "Authorization: Bearer <YOUR_QX_API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{
    "mode": "row",
    "target_row_ids": ["7d1e3f5a9b2c4d6e8f0a1b3c5d7e9f20"],
    "target_column_ids": ["9f8e7d6c5b4a439281706f5e4d3c2b1a"]
  }'

import requests

headers = {"Authorization": "Bearer <YOUR_QX_API_KEY>"}

execution = requests.post(
    "https://api.qxlabs.com/v1/grids/3e7a9c415b2d4f8ea6c19d0b2e4f7a18/sheets/b2d4f6a81c3e4a5b8d7f0e9c2a4b6d81/execute",
    json={
        "mode": "row",
        "target_row_ids": ["7d1e3f5a9b2c4d6e8f0a1b3c5d7e9f20"],
        "target_column_ids": ["9f8e7d6c5b4a439281706f5e4d3c2b1a"],
    },
    headers=headers,
).json()
print(execution["execution_id"])

const headers = { Authorization: "Bearer <YOUR_QX_API_KEY>", "Content-Type": "application/json" };

const response = await fetch(
  "https://api.qxlabs.com/v1/grids/3e7a9c415b2d4f8ea6c19d0b2e4f7a18/sheets/b2d4f6a81c3e4a5b8d7f0e9c2a4b6d81/execute",
  {
    method: "POST",
    headers,
    body: JSON.stringify({
      mode: "row",
      target_row_ids: ["7d1e3f5a9b2c4d6e8f0a1b3c5d7e9f20"],
      target_column_ids: ["9f8e7d6c5b4a439281706f5e4d3c2b1a"],
    }),
  },
);
const execution = await response.json();
console.log(execution.execution_id);

{
  "execution_id": "5c8a2e4f-6b1d-4a3c-9e7f-2d4b6a8c0e13",
  "grid_id": "3e7a9c415b2d4f8ea6c19d0b2e4f7a18",
  "sheet_id": "b2d4f6a81c3e4a5b8d7f0e9c2a4b6d81"
}

{
  "error": "mode must be sheet, row, column or cell"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "Write 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, as shown in its URL in the app

sheet_id

string

required

The sheet's ID, from the grid endpoint

Body

application/json

mode

enum<string>

default:sheet

sheet: every computed column (or target_column_ids) on every row that has input values or stale cells. column: target_column_ids on every row that has input values or stale cells. row: every computed column (or target_column_ids) on target_row_ids. cell: the cell at target_row_id and target_column_id.

Available options:

sheet,

row,

column,

cell

target_row_ids

string[]

The rows to execute, in row mode

target_column_ids

string[]

The columns to execute in column mode. Narrows sheet and row mode

target_row_id

string

The cell's row, in cell mode

target_column_id

string

The cell's column, in cell mode

stale_only

boolean

default:false

Skip cells that are already up to date

Response

Execution started

execution_id

string

grid_id

string

sheet_id

string

cURL

curl https://api.qxlabs.com/v1/grids/3e7a9c415b2d4f8ea6c19d0b2e4f7a18/sheets/b2d4f6a81c3e4a5b8d7f0e9c2a4b6d81/execute \
  -H "Authorization: Bearer <YOUR_QX_API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{
    "mode": "row",
    "target_row_ids": ["7d1e3f5a9b2c4d6e8f0a1b3c5d7e9f20"],
    "target_column_ids": ["9f8e7d6c5b4a439281706f5e4d3c2b1a"]
  }'

import requests

headers = {"Authorization": "Bearer <YOUR_QX_API_KEY>"}

execution = requests.post(
    "https://api.qxlabs.com/v1/grids/3e7a9c415b2d4f8ea6c19d0b2e4f7a18/sheets/b2d4f6a81c3e4a5b8d7f0e9c2a4b6d81/execute",
    json={
        "mode": "row",
        "target_row_ids": ["7d1e3f5a9b2c4d6e8f0a1b3c5d7e9f20"],
        "target_column_ids": ["9f8e7d6c5b4a439281706f5e4d3c2b1a"],
    },
    headers=headers,
).json()
print(execution["execution_id"])

const headers = { Authorization: "Bearer <YOUR_QX_API_KEY>", "Content-Type": "application/json" };

const response = await fetch(
  "https://api.qxlabs.com/v1/grids/3e7a9c415b2d4f8ea6c19d0b2e4f7a18/sheets/b2d4f6a81c3e4a5b8d7f0e9c2a4b6d81/execute",
  {
    method: "POST",
    headers,
    body: JSON.stringify({
      mode: "row",
      target_row_ids: ["7d1e3f5a9b2c4d6e8f0a1b3c5d7e9f20"],
      target_column_ids: ["9f8e7d6c5b4a439281706f5e4d3c2b1a"],
    }),
  },
);
const execution = await response.json();
console.log(execution.execution_id);

{
  "execution_id": "5c8a2e4f-6b1d-4a3c-9e7f-2d4b6a8c0e13",
  "grid_id": "3e7a9c415b2d4f8ea6c19d0b2e4f7a18",
  "sheet_id": "b2d4f6a81c3e4a5b8d7f0e9c2a4b6d81"
}

{
  "error": "mode must be sheet, row, column or cell"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

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