Get record counts

GET

Returns counts of records from a sheet

sheetIdstringRequired

ID of sheet

X-Disable-Hooks"true"RequiredDefaults to true

versionIdstringOptional

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

sinceVersionIdstringOptionalDeprecated

Deprecated, use sinceCommitId instead.

commitIdstringOptional

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

sinceCommitIdstringOptional

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

filterenumOptional

Options to filter records

Allowed values: validerrorallnone

filterFieldstringOptional

The field to filter the data on.

searchValuestringOptional

The value to search for data on.

searchFieldstringOptional

The field to search for data on.

byFieldbooleanOptional

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

qstringOptional

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

This endpoint returns an object.

dataobject

1	curl -G https://api.x.flatfile.com/v1/sheets/us_sh_YOUR_ID/counts \
2	-H "X-Disable-Hooks: true" \
3	-H "Authorization: Bearer <token>" \
4	-d versionId=us_vr_YOUR_ID