v1

latestOpenAPI 3.1.02026-08-04222461539.5 KB
sheets

Get record counts

Returns counts of records from a sheet

get/sheets/{sheetId}/counts

Path parameters

sheetIdstring required

Sheet ID

ID of sheet

Query parameters

versionIdstring

Returns records that were changed in that version and only those records.

sinceVersionIdstring

Version ID

Deprecated, use sinceCommitId instead.

commitIdstring

Commit ID

Returns records that were changed in that version in addition to any records from versions after that version.

sinceCommitIdstring

Commit ID

Listing a commit ID here will return all records since the specified commit.

filter'valid' | 'error' | 'all' | 'none'

Options to filter records

Options to filter records

filterFieldstring

Use this to narrow the valid/error filter results to a specific field

The field to filter the data on.

searchValuestring

Search for the given value, returning matching rows. For exact matches, wrap the value in double quotes ("Bob"). To search for null values, send empty double quotes ("")

The value to search for data on.

searchFieldstring

Use this to narrow the searchValue results to a specific field

The field to search for data on.

byFieldboolean

If true, the counts for each field will also be returned

qstring

An FFQL query used to filter the result set to be counted

Headers

Authorizationstring required

Bearer authentication

X-Disable-Hooks'true' required

Response

Response with status 200