EaserixDocs
DevelopersAPI referenceFormsSummary

Submissions per day, month or year

How many submissions arrived per period, split into accepted and spam, across the forms the caller can read (their own and any a teammate shared with the workspace). Counted in the database, so a form with more than 500 submissions is counted in full. Periods are cut in the viewer's timezone, not UTC, and a period with nothing in it is returned as zero, so the series has no gaps. day lists every day of the anchor's month; month the 12 months ending with the anchor's month; year every year from the first to the last that has a submission (the anchor is ignored), or the anchor's year alone when there are none.

View as Markdown
GET
/v1/analytics
AuthorizationBearer <token>

In: header

Query Parameters

view*string

Value in

  • "day"
  • "month"
  • "year"
tz*string

IANA timezone name of the viewer, such as Asia/Kolkata

anchor?string

A date, YYYY-MM-DD, in the viewer's timezone, between the years 2000 and 2100. Defaults to today.

Formatdate
formId?string

Count one form only. 404 unless the caller can read it.

projectId?string

Count the forms of one project only. 404 unless the caller can read it. Combined with formId, both apply.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/analytics?view=day&tz=Asia%2FKolkata"
{  "view": "day",  "tz": "string",  "buckets": [    {      "date": "2019-08-24",      "submissions": 0,      "spam": 0    }  ]}