gainsight-px-rest-api
GET /v1/survey/responses

Retrieves Survey responses. Supports filtering, sorting and paging.

Filtering

The filter parameter accepts a list of semicolon-separated filters in the form: {fieldName}{operator}{fieldValue} Filter terms within a single filter parameter are joined by a logical AND. Separate filter parameters are joined by a logical OR.

Supported filter fields
Field
identifyId
accountId
date (as epoch milliseconds value)
contentType (IN_APP_SURVEY_NPS,IN_APP_SURVEY_CES,IN_APP_SURVEY_BOOLEAN,IN_APP_SURVEY_RATING, IN_APP_MULTIPLE_QUESTION_SURVEY)
Operators
Operator Meaning
== Exact match
!= Not equal
< Less than
<= Less than or equal
> Greater than
>= Greater than or equal
~ Matches string, supports wildcard characters * and ?
!~ Not like, supports wildcard characters * and ?

Examples:

URI Results
GET /v1/survey/responses?filter=identifyId==ABC123 Survey responses for user with identifyId of 'ABC123'.

Sorting

The sort parameter accepts a list of semi-colon separated fields names, each with an optional dash to imply descending sort order.

Supported sort fields
Field
accountId
date

Examples:

URI Results
GET /v1/survey/responses?sort=-date Matches sorted by date descending.

Query parameters

  • filter array[string]

    Filters

  • pageSize integer(int32)

    Number of responses per page

    Minimum value is 1, maximum value is 1000. Default value is 25.

  • scrollId string

    Used for fetching subsequent pages after the first one. Returned in response.scrollId

  • sort string

    Sort fields

Responses

  • 200 */*

    Success

    Hide response attributes Show response attributes object
    • results array[object]

      Array of result records

      Hide results attributes Show results attributes object

      Engagement View Event object

      • eventId string
      • identifyId string Required
      • propertyKey string Required
      • date integer(int64)
      • eventType string
      • sessionId string
      • userType string Required

        Values are LEAD, USER, VISITOR, or EMPTY_USER_TYPE.

      • accountId string
      • globalContext object
      • engagementId string
      • engagementTrackType string

        Values are ENGAGEMENT_VIEW or ENGAGEMENT_CLICK.

      • contentId string
      • contentType string

        Values are IN_APP_DIALOG, IN_APP_GUIDE, IN_APP_CAROUSEL, IN_APP_SURVEY_NPS, IN_APP_SURVEY_CES, IN_APP_SURVEY_BOOLEAN, or IN_APP_SURVEY_RATING.

      • executionDate integer(int64)

        Will be the same on all events related to a single engagement view, e.g. separate answers for multi-question surveys

      • executionId string

        Will be the same on all events related to a single engagement view, e.g. separate answers for multi-question surveys

      • viewEventId string
      • carouselState string

        Values are VIEWED or COMPLETED.

      • slideId string
      • sequenceNumber integer(int64)
      • linkUrl string
      • guideState string

        Values are VIEWED or COMPLETED.

      • stepId string
      • surveyState string

        Values are VIEWED or COMPLETED.

      • contactMeAllowed boolean
      • score integer(int32)
      • comment string
      • questionType string
      • selectionIds array[string]
      • path string
    • totalHits integer(int64)

      Total number of records matching filters

    • scrollId string

      If passed on subsequent requests as the scrollId parameter, will fetch the next page
  • 400

    Bad request

  • 401

    Unauthorized or bad API Key

  • 429

    Rate limit exceeded

GET /v1/survey/responses 
curl \
 --request GET 'https://api.aptrinsic.com/v1/survey/responses'
Response examples (200) 
{
  "results": [
    {
      "eventId": "string",
      "identifyId": "string",
      "propertyKey": "string",
      "date": 42,
      "eventType": "string",
      "sessionId": "string",
      "userType": "LEAD",
      "accountId": "string",
      "globalContext": {},
      "engagementId": "string",
      "engagementTrackType": "ENGAGEMENT_VIEW",
      "contentId": "string",
      "contentType": "IN_APP_DIALOG",
      "executionDate": 42,
      "executionId": "string",
      "viewEventId": "string",
      "carouselState": "VIEWED",
      "slideId": "string",
      "sequenceNumber": 42,
      "linkUrl": "string",
      "guideState": "VIEWED",
      "stepId": "string",
      "surveyState": "VIEWED",
      "contactMeAllowed": true,
      "score": 42,
      "comment": "string",
      "questionType": "string",
      "selectionIds": [
        "string"
      ],
      "path": "string"
    }
  ],
  "totalHits": 42,
  "scrollId": "string"
}