Customer REST

List safe engagement summaries for one lead.

Changed on
get/customer/leads/{leadId}/engagements

Request

Path parameters

leadIdstring uuid required

Query parameters

limitinteger

Number of items to return. The default is 50 and the maximum is 100.

cursorstring

Opaque cursor returned in page.nextCursor. Pass it unchanged with the same filters and sort. Incompatible cursors return validation_failed.

engagementType'LIKE' | 'COMMENT' | 'REPOST' | 'POST_AUTHOR'
monitoredProfileIdstring uuid
postIdstring uuid
dateFromstring date-time

Inclusive start of the date range.

dateTostring date-time

Inclusive end of the date range.

Response

Engagement page.

dataobject[] required

Changes

    • info

      added the new enum value POST_AUTHOR to the query request parameter engagementType

    • breaking

      for the query request parameter limit, default value was changed from 25 to 50

    • warning

      for the query request parameter cursor, the maxLength was set to 256

    • info

      added the new optional query request parameter dateFrom

    • info

      added the new optional query request parameter dateTo

    • info

      added the new optional query request parameter monitoredProfileId

    • info

      added the new optional query request parameter postId