Count Rows

Count the rows matching a typed predicate across the entire table. The paged reads carry no total, and rowCount on the table resource counts every row rather than the matches. Omit the predicate to count the whole table. A predicate larger than the request-body ceiling is a 413.

POST/api/v2/tables/{tableId}/query/count

Authorization

apiKey

X-API-Key<token>

Your Sim API key, personal or workspace-scoped. Generate one under Settings, then API Keys. Operations that reject workspace keys say so in their own description.

In: header

Path Parameters

tableId*string

Unique table identifier.

Length1 <= length

Request Body

application/json

Workspace scope and the optional predicate whose matches are counted.

TypeScript Definitions

Use the request body type in TypeScript.

workspaceId*string

Unique workspace identifier.

Length1 <= length

predicate?|

Recursive predicate tree. Each group node is exactly one non-empty all or any array whose members are further groups or { field, op, value } conditions; the root must be a group, not a bare condition. At most 100 members per group, 10 levels of nesting, and 500 nodes in total. The negating operators include nulls: ne, nin, ncontains, nlike, and nilike match rows whose column is null or absent, so "not X" is not the complement of "X" over a nullable column. That holds for every column type, multi-select included. To exclude nulls, all-combine the negation with isNotEmpty (multi-select) or isNotNull. Comparison: eq, ne, gt, gte, lt, lte. Membership: in, nin (array operand). Emptiness: isEmpty, isNotEmpty, isNull, isNotNull (no operand). Substring, always case-insensitive, operand matched literally: contains, ncontains, startsWith, endsWith. Pattern: like/nlike (case-sensitive), ilike/nilike (case-insensitive). * is the only wildcard and stands for any run of characters; %, _, and backslash match themselves. Use like: "Hi*", not like: "Hi%". A select column compares by option id and restricts its operators: single-select accepts eq, ne, in, nin; multi-select accepts contains, ncontains. Option names are accepted as operands and resolved to ids.

Response Body

`application/json`

curl -X POST "https://www.sim.ai/api/v2/tables/string/query/count" \  -H "X-API-Key: YOUR_API_KEY" \  -H "Content-Type: application/json" \  -d '{    "workspaceId": "a91c4b2e-6d3f-4e8a-b5c7-0d9e2f1a8c64",    "predicate": {      "all": [        {          "field": "status",          "op": "eq",          "value": "active"        }      ]    }  }'

{
  "data": {
    "totalCount": 0
  }
}

{
  "error": {
    "code": "BAD_REQUEST",
    "message": "The request is invalid."
  }
}

{
  "error": {
    "code": "BAD_REQUEST",
    "message": "The request is invalid."
  }
}

{
  "error": {
    "code": "BAD_REQUEST",
    "message": "The request is invalid."
  }
}

{
  "error": {
    "code": "BAD_REQUEST",
    "message": "The request is invalid."
  }
}

{
  "error": {
    "code": "BAD_REQUEST",
    "message": "The request is invalid."
  }
}

{
  "error": {
    "code": "BAD_REQUEST",
    "message": "The request is invalid."
  }
}

{
  "error": {
    "code": "BAD_REQUEST",
    "message": "The request is invalid."
  }
}

{
  "error": {
    "code": "BAD_REQUEST",
    "message": "The request is invalid."
  }
}

Count Rows

Authorization

Path Parameters

Request Body

Response Body

200application/json

400application/json

401application/json

403application/json

404application/json

413application/json

429application/json

500application/json

503application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`