Sheets

Get record counts

GET
Returns counts of records from a sheet

Path parameters

sheetIdstringRequired
ID of sheet

Query parameters

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

Response

This endpoint returns an object
data
object
GET
$curl -G https://api.x.flatfile.com/v1/sheets/us_sh_YOUR_ID/counts \
>     -H "Authorization: Bearer <token>" \
>     -d versionId=us_vr_YOUR_ID
Response
1{
2  "data": {
3    "counts": {
4      "total": 1000,
5      "valid": 1000,
6      "error": 0
7    },
8    "success": true
9  }
10}
Built with