SEsequenzy
In-app

Record an in-app event

Changed on

Records that the app displayed, clicked, dismissed or read an item. The first report of each type sets its timestamp; repeats change nothing except clickCount, and recorded is false. Clicks, dismissals and reads also mark the item displayed. Messages leave the open feed once displayed, clicked or dismissed; cards once dismissed. Requires the subscribers:write scope.

post/in-app/messages/{messageId}/events

Request

  • Base URL
    https://api.sequenzy.com/api/v1
  • URL
    https://api.sequenzy.com/api/v1/in-app/messages/{messageId}/events
  • Auth
    HTTP bearer

Path parameters

messageIdstring required

Request body

type'displayed' | 'clicked' | 'dismissed' | 'read' required

Response

Event recorded (or already recorded)

successboolean
recordedboolean

True when this report set the timestamp; false for a repeat.

Example response

{
  "success": true
}

Changes

  • 54f67ac2d016Revision changes
    • warning

      added the new center enum value to the / response property for the response status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

  • db3873ca3d4dRevision changes
    • info

      endpoint added