v1

latestOpenAPI 3.0.0raw.githubusercontent.com2018-12-181310.4 KB

GET form_responses

Returns responses from CloseAlert that are received.

get/{project_key}/form_responses

Query parameters

form_idinteger

To filter on a specific form

sincestring date-time

Responses received since a specific date-time (ISO8601)

untilstring date-time

Responses received until a specific date-time (ISO8601)

per_pageinteger

Maximum results per page

pageinteger

The page number

mailing_idinteger

The id of the mailing to filter on

group_idinteger

The id of the group to filter on

Response

successful operation

Example response

{
  "form_responses": [
    {
      "id": 1,
      "created_at": "2014-03-17T17:22:10.055-07:00",
      "email": "peter@closealert.com",
      "mail_url": "http://www.closealert.com",
      "user_agent": "Mozilla/5.0 (Intel Mac OS X 10.9",
      "followed_up": true,
      "merge_tags": [
        {
          "age": 10,
          "gender": "male"
        }
      ],
      "form": {
        "id": 34,
        "form_type": "email-satisfaction,",
        "name": "Email satisfaction form"
      },
      "mailing": {
        "id": 42,
        "name": "Email satisfaction mailing"
      },
      "group": {
        "id": 44,
        "name": "Email satisfaction group"
      },
      "answers": [
        {
          "question": "What do you think of this email?",
          "question_type": "sentiment",
          "question_index": 1,
          "response_value": 1,
          "scale": 2
        },
        {
          "question": "Why are you positive?",
          "question_type": "comment",
          "question_index": 1.1,
          "response_value": "I love the articles in this email"
        }
      ]
    }
  ],
  "meta": {
    "page": 0,
    "page_number": 1,
    "total_pages": 1
  }
}
All 1 operations