Results list

List all results for a survey specified by survey_id.

To obtain survey_id please refer to the survey list endpoint

Alternatively, to obtain survey_id , you may find it in a survey builder URL path.

after_time cursor pagination

When the after_time parameter is applied, pagination behavior changes from page-based to time-based. We use after_time as a pagination cursor to select the next 25 elements after the specified cursor time. You can navigate through the paginated chunks of data using the links.next and links.prev metadata parameters.

Let's use an example to make this clearer. Assume we have a survey with 70 results, and we want to fetch all results submitted after 2023-07-04T18:04:00. We add a query parameter to the route like this: /?after_time=2023-07-04T18:04:00. By default, this will limit the response to 25 elements. After sending the first request, we receive results with metadata like this:

{
    "data": [...],
    "links": {
        "first": null,
        "last": null,
        "prev": null,
        "next": "https://app.voiceform.com/api/v1/surveys/{surveyId}/results?after_time=2023-07-04T18%3A04%3A00&cursor=eyJjcmVhdGVkX2F0IjoiMjAyMy0wNy0xNyAxOTozNzo1NyIsIl9wb2ludHNUb05leHRJdGVtcyI6dHJ1ZX0"
    }
}

{
    "data": [...],
    "links": {
        "first": null,
        "last": null,
        "prev": "https://app.voiceform.com/api/v1/surveys/{surveyId}/results?after_time=2023-07-04T18%3A04%3A00&cursor=eyJjcmVhdGVkX2F0IjoiMjAyMy0wNy0xNyAxOToxNTo1MSIsIl9wb2ludHNUb05leHRJdGVtcyI6ZmFsc2V9",
        "next": null
    }
}

You can use the links.next link to fetch the next chunk of data and continue this process until links.next becomes null.

For convenience, you may also use the sort parameter or limit for quicker navigation through the data. The sort parameter can be set to asc or desc, with the default being asc. The limit parameter has a maximum value of 30.