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))
}HttpResponse<String> response = Unirest.get("https://api.gleap.io/v3/engagement/news")
.header("project", "<project>")
.header("Authorization", "Bearer <token>")
.asString();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": [
{
"pageFilterType": "is",
"pageFilter": "<string>"
}
],
"pageFilterType": "is",
"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>"
},
"aiSummaryAttemptedAt": "2023-11-07T05:31:56Z",
"aiSummaryData": "<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>"
}
}
]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
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))
}HttpResponse<String> response = Unirest.get("https://api.gleap.io/v3/engagement/news")
.header("project", "<project>")
.header("Authorization", "Bearer <token>")
.asString();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": [
{
"pageFilterType": "is",
"pageFilter": "<string>"
}
],
"pageFilterType": "is",
"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>"
},
"aiSummaryAttemptedAt": "2023-11-07T05:31:56Z",
"aiSummaryData": "<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
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
Query Parameters
Response
200 - application/json
Ok
Show child attributes
Show child attributes
Available options:
is, contains, isnot, notcontains, startswith, endswith, empty, notempty Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes