EaserixDocs
DevelopersAPI referenceFormsSubmissions

Where the form's submissions came from

The form's non-spam submissions counted by source group, computed from the attribution fields a site adds (attr_source, attr_referrer_host, attr_medium) and checked in order: ai, search, social, direct (no source and no referrer), other. Every group is listed, zeros included. heardAbout holds the top 20 answers to the heard_about field. Counts only. Readable: the caller's own form or one a teammate shared with the organization.

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

In: header

Path Parameters

id*string

Query Parameters

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)

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/forms/string/sources"
{  "total": 0,  "from": "2019-08-24T14:15:22Z",  "to": "2019-08-24T14:15:22Z",  "groups": [    {      "group": "ai",      "count": 0    },    {      "group": "ai",      "count": 0    },    {      "group": "ai",      "count": 0    },    {      "group": "ai",      "count": 0    },    {      "group": "ai",      "count": 0    }  ],  "heardAbout": {    "field": "heard_about",    "groups": [      {        "value": "string",        "count": 0      }    ],    "other": 0  }}