Get all engagement news articles

curl --request GET \
  --url https://api.gleap.io/v3/engagement/news \
  --header 'Authorization: Bearer <token>' \
  --header 'project: <project>'

import requests

url = "https://api.gleap.io/v3/engagement/news"

headers = {
    "project": "<project>",
    "Authorization": "Bearer <token>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {project: '<project>', Authorization: 'Bearer <token>'}
};

fetch('https://api.gleap.io/v3/engagement/news', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.gleap.io/v3/engagement/news",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "project: <project>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.gleap.io/v3/engagement/news"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("project", "<project>")
	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.gleap.io/v3/engagement/news")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["project"] = '<project>'
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

[
  {
    "startSendingAfter": "2023-11-07T05:31:56Z",
    "stopSendingAfter": "2023-11-07T05:31:56Z",
    "pageRules": [
      {
        "pageFilter": "<string>"
      }
    ],
    "frequencyDays": 123,
    "frequency": "<string>",
    "frequencyType": "<string>",
    "sent": true,
    "sound": true,
    "newTrigger": true,
    "format": "<string>",
    "updatedAt": "2023-11-07T05:31:56Z",
    "status": "<string>",
    "targetAudience": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "hidden": true,
    "tags": [
      "<string>"
    ],
    "name": "<string>",
    "type": "<string>",
    "emailTemplate": {
      "isValid": {},
      "createFromHexString": {},
      "createFromTime": {},
      "generate": {},
      "cacheHexString": "<unknown>"
    },
    "sourceOutbound": {
      "isValid": {},
      "createFromHexString": {},
      "createFromTime": {},
      "generate": {},
      "cacheHexString": "<unknown>"
    },
    "trigger": "<unknown>",
    "pageFilterDelay": 123,
    "pageFilter": "<string>",
    "eventTriggerDelay": 123,
    "eventTrigger": "<string>",
    "actionType": "<string>",
    "sentAt": "2023-11-07T05:31:56Z",
    "stats": "<unknown>",
    "subject": "<unknown>",
    "coverImageUrl": "<string>",
    "slug": "<string>",
    "subType": "<string>",
    "sender": {
      "isValid": {},
      "createFromHexString": {},
      "createFromTime": {},
      "generate": {},
      "cacheHexString": "<unknown>"
    },
    "searchContent": "<string>",
    "project": {
      "isValid": {},
      "createFromHexString": {},
      "createFromTime": {},
      "generate": {},
      "cacheHexString": "<unknown>"
    },
    "data": "<unknown>",
    "conditions": "<unknown>",
    "config": "<unknown>",
    "message": "<unknown>",
    "aiSummaryOutdated": true,
    "aiSummary": "<string>",
    "organisation": {
      "isValid": {},
      "createFromHexString": {},
      "createFromTime": {},
      "generate": {},
      "cacheHexString": "<unknown>"
    },
    "createdBy": {
      "isValid": {},
      "createFromHexString": {},
      "createFromTime": {},
      "generate": {},
      "cacheHexString": "<unknown>"
    }
  }
]

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>'

import requests

url = "https://api.gleap.io/v3/engagement/news"

headers = {
    "project": "<project>",
    "Authorization": "Bearer <token>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {project: '<project>', Authorization: 'Bearer <token>'}
};

fetch('https://api.gleap.io/v3/engagement/news', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.gleap.io/v3/engagement/news",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "project: <project>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.gleap.io/v3/engagement/news"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("project", "<project>")
	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.gleap.io/v3/engagement/news")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["project"] = '<project>'
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

[
  {
    "startSendingAfter": "2023-11-07T05:31:56Z",
    "stopSendingAfter": "2023-11-07T05:31:56Z",
    "pageRules": [
      {
        "pageFilter": "<string>"
      }
    ],
    "frequencyDays": 123,
    "frequency": "<string>",
    "frequencyType": "<string>",
    "sent": true,
    "sound": true,
    "newTrigger": true,
    "format": "<string>",
    "updatedAt": "2023-11-07T05:31:56Z",
    "status": "<string>",
    "targetAudience": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "hidden": true,
    "tags": [
      "<string>"
    ],
    "name": "<string>",
    "type": "<string>",
    "emailTemplate": {
      "isValid": {},
      "createFromHexString": {},
      "createFromTime": {},
      "generate": {},
      "cacheHexString": "<unknown>"
    },
    "sourceOutbound": {
      "isValid": {},
      "createFromHexString": {},
      "createFromTime": {},
      "generate": {},
      "cacheHexString": "<unknown>"
    },
    "trigger": "<unknown>",
    "pageFilterDelay": 123,
    "pageFilter": "<string>",
    "eventTriggerDelay": 123,
    "eventTrigger": "<string>",
    "actionType": "<string>",
    "sentAt": "2023-11-07T05:31:56Z",
    "stats": "<unknown>",
    "subject": "<unknown>",
    "coverImageUrl": "<string>",
    "slug": "<string>",
    "subType": "<string>",
    "sender": {
      "isValid": {},
      "createFromHexString": {},
      "createFromTime": {},
      "generate": {},
      "cacheHexString": "<unknown>"
    },
    "searchContent": "<string>",
    "project": {
      "isValid": {},
      "createFromHexString": {},
      "createFromTime": {},
      "generate": {},
      "cacheHexString": "<unknown>"
    },
    "data": "<unknown>",
    "conditions": "<unknown>",
    "config": "<unknown>",
    "message": "<unknown>",
    "aiSummaryOutdated": true,
    "aiSummary": "<string>",
    "organisation": {
      "isValid": {},
      "createFromHexString": {},
      "createFromTime": {},
      "generate": {},
      "cacheHexString": "<unknown>"
    },
    "createdBy": {
      "isValid": {},
      "createFromHexString": {},
      "createFromTime": {},
      "generate": {},
      "cacheHexString": "<unknown>"
    }
  }
]

Authorizations

Authorization

string

header

required

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

Headers

project

string

required

Query Parameters

withoutChangelogs

string

Response

200 - application/json

startSendingAfter

string<date-time>

required

stopSendingAfter

string<date-time>

required

pageRules

object[]

required

Show child attributes

pageFilterType

enum<string>

required

Available options:

is,

contains,

isnot,

notcontains,

startswith,

endswith,

empty,

notempty

frequencyDays

number<double>

required

frequency

string

required

frequencyType

string

required

sent

boolean

required

sound

boolean

required

newTrigger

boolean

required

format

string

required

updatedAt

string<date-time>

required

status

string

required

targetAudience

string

required

createdAt

string<date-time>

required

hidden

boolean

required

Getting Started

Endpoints

Get all engagement news articles

Authorizations

Headers

Query Parameters

Response