GET
/
engagement
/
news
Get all engagement news articles
curl --request GET \
  --url https://api.gleap.io/v3/engagement/news \
  --header 'Authorization: Bearer <token>' \
  --header 'project: <project>'
[
  {
    "emailTemplate": {
      "isValid": {},
      "createFromHexString": {},
      "createFromTime": {},
      "generate": {},
      "cacheHexString": "<any>",
      "prototype": "<string>"
    },
    "sourceOutbound": {
      "isValid": {},
      "createFromHexString": {},
      "createFromTime": {},
      "generate": {},
      "cacheHexString": "<any>",
      "prototype": "<string>"
    },
    "trigger": "<any>",
    "pageFilterDelay": 123,
    "pageFilter": "<string>",
    "eventTriggerDelay": 123,
    "eventTrigger": "<string>",
    "actionType": "<string>",
    "sentAt": "2023-11-07T05:31:56Z",
    "stats": "<any>",
    "subject": "<any>",
    "coverImageUrl": "<string>",
    "sender": {
      "isValid": {},
      "createFromHexString": {},
      "createFromTime": {},
      "generate": {},
      "cacheHexString": "<any>",
      "prototype": "<string>"
    },
    "project": {
      "isValid": {},
      "createFromHexString": {},
      "createFromTime": {},
      "generate": {},
      "cacheHexString": "<any>",
      "prototype": "<string>"
    },
    "data": "<any>",
    "conditions": "<any>",
    "config": "<any>",
    "message": "<any>",
    "aiSummaryOutdated": true,
    "aiSummary": "<string>",
    "organisation": {
      "isValid": {},
      "createFromHexString": {},
      "createFromTime": {},
      "generate": {},
      "cacheHexString": "<any>",
      "prototype": "<string>"
    },
    "createdBy": {
      "isValid": {},
      "createFromHexString": {},
      "createFromTime": {},
      "generate": {},
      "cacheHexString": "<any>",
      "prototype": "<string>"
    },
    "startSendingAfter": "2023-11-07T05:31:56Z",
    "stopSendingAfter": "2023-11-07T05:31:56Z",
    "pageFilterType": "is",
    "frequencyDays": 123,
    "frequency": "<string>",
    "frequencyType": "<string>",
    "format": "<string>",
    "sent": true,
    "sound": true,
    "newTrigger": true,
    "hidden": true,
    "status": "<string>",
    "updatedAt": "2023-11-07T05:31:56Z",
    "targetAudience": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "name": "<string>",
    "type": "<string>"
  }
]

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

project
string
required

Response

200 - application/json

Ok

startSendingAfter
string<date-time>
required
stopSendingAfter
string<date-time>
required
pageFilterType
enum<string>
required
Available options:
is,
contains,
isnot,
notcontains,
startswith,
endswith,
empty,
notempty
frequencyDays
number
required
frequency
string
required
frequencyType
string
required
format
string
required
sent
boolean
required
sound
boolean
required
newTrigger
boolean
required
hidden
boolean
required
status
string
required
updatedAt
string<date-time>
required
targetAudience
string
required
createdAt
string<date-time>
required
name
string
required
type
string
required
emailTemplate
object
sourceOutbound
object
trigger
any
pageFilterDelay
number
pageFilter
string
eventTriggerDelay
number
eventTrigger
string
actionType
string
sentAt
string<date-time>
stats
any
subject
any
coverImageUrl
string
sender
object
project
object
data
any
conditions
any
config
any
message
any
aiSummaryOutdated
boolean
aiSummary
string
organisation
object
createdBy
object