Gainsight Engagement View Event API

openapi: 3.2.0
info:
  description: Gainsight PX API provides a programmatic (server-based) method to access the users, accounts, and events that have been captured by the Gainsight PX subscription.
  version: 0.1.6
  title: Gainsight PX REST Engagement View Event API
  contact:
    name: Gainsight PX
    url: https://www.gainsight.com/product-experience/
    email: pxsupport@gainsight.com
  license:
    name: internal
servers:
- url: https://api.aptrinsic.com/
tags:
- name: EngagementViewEvent
  description: Engagement View Event Operations
paths:
  /v1/events/engagementView:
    get:
      tags:
      - EngagementViewEvent
      summary: Get Engagement View events
      description: 'Retrieves Engagement View events. 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 |

        | contentType |

        | carouselState |

        | guideState |

        | surveyState |


        #### Operators

        | Operator | Meaning |

        | ----- | -------- |

        | == | Exact match |

        | != | Not equal |

        | | Greater than |

        | >= | Greater than or equal |

        | ~ | Matches string, supports wildcard characters * and ? |

        | !~ | Not like, supports wildcard characters * and ? |


        Examples:


        | URI | Results |

        | ----- | -------- |

        | GET /v1/events/engagementView?filter=identifyId==ABC123 | Engagement View event matches 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/events/engagementView?sort=-date | Matches sorted by date descending. |'
      operationId: getEngagementViewEventsUsingGET_1
      parameters:
      - name: filter
        in: query
        description: Filters
        required: false
        allowEmptyValue: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: pageSize
        in: query
        description: Number of events per page
        required: false
        allowEmptyValue: false
        schema:
          type: integer
          format: int32
          default: 25
          maximum: 1000
          minimum: 1
      - name: scrollId
        in: query
        description: Used for fetching subsequent pages after the first one.  Returned in response.scrollId
        required: false
        allowEmptyValue: false
        schema:
          type: string
      - name: sort
        in: query
        description: Sort fields
        required: false
        allowEmptyValue: false
        x-example: sort=-date
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/EngagementAllTypesViewEventsPage'
        '400':
          description: Bad request
        '401':
          description: Unauthorized or bad API Key
        '429':
          description: Rate limit exceeded
      deprecated: false
components:
  schemas:
    EngagementAllTypesViewEventsPage:
      type: object
      properties:
        results:
          type: array
          description: Array of result records
          readOnly: true
          items:
            $ref: '#/components/schemas/EngagementAllTypesViewEvent'
        totalHits:
          type: integer
          format: int64
          description: Total number of records matching filters
          readOnly: true
        scrollId:
          type: string
          description: If passed on subsequent requests as the scrollId parameter, will fetch the next page
          readOnly: true
      title: EngagementAllTypesViewEventsPage
    EngagementAllTypesViewEvent:
      type: object
      required:
      - identifyId
      - propertyKey
      - userType
      properties:
        eventId:
          type: string
        identifyId:
          type: string
        propertyKey:
          type: string
        date:
          type: integer
          format: int64
        eventType:
          type: string
        sessionId:
          type: string
        userType:
          type: string
          enum:
          - LEAD
          - USER
          - VISITOR
          - EMPTY_USER_TYPE
        accountId:
          type: string
        globalContext:
          type: object
        engagementId:
          type: string
        engagementTrackType:
          type: string
          enum:
          - ENGAGEMENT_VIEW
          - ENGAGEMENT_CLICK
        contentId:
          type: string
        contentType:
          type: string
          enum:
          - IN_APP_DIALOG
          - IN_APP_GUIDE
          - IN_APP_CAROUSEL
          - IN_APP_SURVEY_NPS
          - IN_APP_SURVEY_CES
          - IN_APP_SURVEY_BOOLEAN
          - IN_APP_SURVEY_RATING
        executionDate:
          type: integer
          format: int64
          description: Will be the same on all events related to a single engagement view, e.g. separate answers for multi-question surveys
        executionId:
          type: string
          description: Will be the same on all events related to a single engagement view, e.g. separate answers for multi-question surveys
        viewEventId:
          type: string
        carouselState:
          type: string
          enum:
          - VIEWED
          - COMPLETED
        slideId:
          type: string
        sequenceNumber:
          type: integer
          format: int64
        linkUrl:
          type: string
        guideState:
          type: string
          enum:
          - VIEWED
          - COMPLETED
        stepId:
          type: string
        surveyState:
          type: string
          enum:
          - VIEWED
          - COMPLETED
        contactMeAllowed:
          type: boolean
        score:
          type: integer
          format: int32
        comment:
          type: string
        questionType:
          type: string
        selectionIds:
          type: array
          items:
            type: string
        path:
          type: string
      title: EngagementAllTypesViewEvent
      description: Engagement View Event object
  securitySchemes:
    X-APTRINSIC-API-KEY:
      type: apiKey
      name: Aptrinsic API Key
      in: header