EaserixDocs
DevelopersAPI referenceFormsSubmissions

Submission counts by field value

Counts of the form's submissions grouped by the value of one or more submitted fields (data->>field), largest first, with a missing or blank value counted as "(none)". Each breakdown keeps the top 100 values; other is how many submissions fall in values past that cap. Spam is excluded unless includeSpam=true. Readable: the caller's own form or one a teammate shared with the organization.

View as Markdown
GET
/v1/forms/{id}/summary
AuthorizationBearer <token>

In: header

Path Parameters

id*string

Query Parameters

field*array<>

Field name to group by — letters, digits, _ - . only, up to 100 characters. Repeat (or comma-separate) for up to 5 fields; one breakdown is returned per field, in the order given.

Items1 <= items <= 5
from?string

Inclusive start, YYYY-MM-DD (UTC midnight) or RFC 3339

to?string

Exclusive end as RFC 3339, or YYYY-MM-DD to include that whole day (UTC)

includeSpam?string

Spam included only when exactly "true"

Value in

  • "true"
  • "false"

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/forms/string/summary?field=string"
{  "total": 0,  "from": "2019-08-24T14:15:22Z",  "to": "2019-08-24T14:15:22Z",  "includeSpam": true,  "breakdowns": [    {      "field": "string",      "groups": [        {          "value": "string",          "count": 0        }      ],      "other": 0    }  ]}