Engagement News

Get all engagement news articles

Get the engagement news articles of a project, newest first. Supports filtering by any field via query parameters, plus skip, limit and sort (e.g. sort=-createdAt). limit defaults to 1000 when omitted; when supplied, values above 100 are clamped to 100. Filtering by project or organisation is rejected. Pass withoutChangelogs=true (exact lowercase string) to exclude changelog entries (news items with subType CHANGELOG); any other value is ignored.

get/engagement/news

Request

  • Base URL
    https://api.gleap.io/v3
  • URL
    https://api.gleap.io/v3/engagement/news
  • Auth
    HTTP bearer

Query parameters

withoutChangelogsstring

Headers

projectstring required

Response

Ok

commentEmailOptOutsunknown
trackingunknown
surveyunknown
aiSummaryAttemptedAtstring date-time
aiSummaryDataunknown
triggerunknown
pageFilterDelaynumber double
pageFilterstring
eventTriggerDelaynumber double
eventTriggerstring
actionTypestring
sentAtstring date-time
statsunknown
coverImageUrlstring
slugstring
subTypestring
emailCategorystring
preheaderunknown
subjectunknown
emailStylestring
kaiunknown
searchContentstring
dataunknown
conditionsunknown
configunknown
messageunknown
aiSummaryOutdatedboolean
aiSummarystring
startSendingAfterstring date-time required
dropIfConditionsFailboolean required
stopSendingAfterstring date-time required
pageFilterType'is' | 'contains' | 'isnot' | 'notcontains' | 'startswith' | 'endswith' | 'empty' | 'notempty' required
frequencyDaysnumber double required
frequencystring required
frequencyTypestring required
sentboolean required
soundboolean required
newTriggerboolean required
formatstring required
hiddenboolean required
statusstring required
targetAudiencestring required
updatedAtstring date-time required
createdAtstring date-time required
tagsstring[] required
namestring required
typestring required

Changes

No recorded changes to this operation across all 56 revisions of this API.