Conventions

Counting

Resources may be counted using either of the following two methods.

Path

Counting paths are built by appending '/count' to a valid resource path:

https://api.zenginehq.com/v1/forms/2/records/count

Use the counting path via a GET request to retrieve the total count for the resource:

{
	"status": 200,
	"code": 2000,
	"totalCount": 17
}

Within a Response

You can also access the total count for a resource while looping through paged responses. For example a GET request to retrieve a page of resources:

https://api.wizehive-dev.com/v1/forms/2/records?attributes=field88&page=0,limit=5

Whould return the total count within each response:

{
  "status": 200,
  "code": 2000,
  "totalCount": 17,
  "limit": 5,
  "offset": 0,
  "data": [
    {
      "id": 200000001,
      "field88": "2100215000.00000000"
    },
    {
      "id": 200000002,
      "field88": "2108230000.00000000"
    },
    {
      "id": 200000003,
      "field88": "2100544000.00000000"
    },
    {
      "id": 200000004,
      "field88": "2101823000.00000000"
    },
    {
      "id": 200000005,
      "field88": "2103007000.00000000"
    }
  ]
}