Mentions
List mentions
Returns mentions scoped to the authenticated organization. Filter by keyword, source, sentiment, date range, or custom filter groups.
Body shape matches POST /api/v1/mentions exactly — simple or advanced filters object, view to reuse a feed’s filters, includeAll to toggle low-relevance, cursor pagination via limit + cursor.
Tip: call POST /api/v2/ai/filter-wizard with a natural-language prompt to get a ready-to-paste filters object.
POST
/
api
/
v2
/
mentions
List mentions
curl --request POST \
--url https://app.octolens.com/api/v2/mentions \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"view": 123,
"filters": {
"source": [
"reddit"
],
"sentiment": [],
"keyword": [
0
],
"language": [],
"tag": [
"<string>"
],
"relevance": [
"<string>"
],
"!source": [
"reddit"
],
"!sentiment": [],
"!keyword": [
0
],
"!language": [],
"!tag": [
"<string>"
],
"!relevance": [
"<string>"
],
"minXFollowers": 4503599627370495,
"maxXFollowers": 4503599627370495,
"startDate": "<string>",
"endDate": "<string>"
},
"includeAll": false,
"includeRelevantOnly": true,
"limit": 20,
"cursor": "<string>",
"search": "<string>"
}
'import requests
url = "https://app.octolens.com/api/v2/mentions"
payload = {
"view": 123,
"filters": {
"source": ["reddit"],
"sentiment": [],
"keyword": [0],
"language": [],
"tag": ["<string>"],
"relevance": ["<string>"],
"!source": ["reddit"],
"!sentiment": [],
"!keyword": [0],
"!language": [],
"!tag": ["<string>"],
"!relevance": ["<string>"],
"minXFollowers": 4503599627370495,
"maxXFollowers": 4503599627370495,
"startDate": "<string>",
"endDate": "<string>"
},
"includeAll": False,
"includeRelevantOnly": True,
"limit": 20,
"cursor": "<string>",
"search": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
view: 123,
filters: {
source: ['reddit'],
sentiment: [],
keyword: [0],
language: [],
tag: ['<string>'],
relevance: ['<string>'],
'!source': ['reddit'],
'!sentiment': [],
'!keyword': [0],
'!language': [],
'!tag': ['<string>'],
'!relevance': ['<string>'],
minXFollowers: 4503599627370495,
maxXFollowers: 4503599627370495,
startDate: '<string>',
endDate: '<string>'
},
includeAll: false,
includeRelevantOnly: true,
limit: 20,
cursor: '<string>',
search: '<string>'
})
};
fetch('https://app.octolens.com/api/v2/mentions', 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://app.octolens.com/api/v2/mentions",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'view' => 123,
'filters' => [
'source' => [
'reddit'
],
'sentiment' => [
],
'keyword' => [
0
],
'language' => [
],
'tag' => [
'<string>'
],
'relevance' => [
'<string>'
],
'!source' => [
'reddit'
],
'!sentiment' => [
],
'!keyword' => [
0
],
'!language' => [
],
'!tag' => [
'<string>'
],
'!relevance' => [
'<string>'
],
'minXFollowers' => 4503599627370495,
'maxXFollowers' => 4503599627370495,
'startDate' => '<string>',
'endDate' => '<string>'
],
'includeAll' => false,
'includeRelevantOnly' => true,
'limit' => 20,
'cursor' => '<string>',
'search' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://app.octolens.com/api/v2/mentions"
payload := strings.NewReader("{\n \"view\": 123,\n \"filters\": {\n \"source\": [\n \"reddit\"\n ],\n \"sentiment\": [],\n \"keyword\": [\n 0\n ],\n \"language\": [],\n \"tag\": [\n \"<string>\"\n ],\n \"relevance\": [\n \"<string>\"\n ],\n \"!source\": [\n \"reddit\"\n ],\n \"!sentiment\": [],\n \"!keyword\": [\n 0\n ],\n \"!language\": [],\n \"!tag\": [\n \"<string>\"\n ],\n \"!relevance\": [\n \"<string>\"\n ],\n \"minXFollowers\": 4503599627370495,\n \"maxXFollowers\": 4503599627370495,\n \"startDate\": \"<string>\",\n \"endDate\": \"<string>\"\n },\n \"includeAll\": false,\n \"includeRelevantOnly\": true,\n \"limit\": 20,\n \"cursor\": \"<string>\",\n \"search\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://app.octolens.com/api/v2/mentions")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"view\": 123,\n \"filters\": {\n \"source\": [\n \"reddit\"\n ],\n \"sentiment\": [],\n \"keyword\": [\n 0\n ],\n \"language\": [],\n \"tag\": [\n \"<string>\"\n ],\n \"relevance\": [\n \"<string>\"\n ],\n \"!source\": [\n \"reddit\"\n ],\n \"!sentiment\": [],\n \"!keyword\": [\n 0\n ],\n \"!language\": [],\n \"!tag\": [\n \"<string>\"\n ],\n \"!relevance\": [\n \"<string>\"\n ],\n \"minXFollowers\": 4503599627370495,\n \"maxXFollowers\": 4503599627370495,\n \"startDate\": \"<string>\",\n \"endDate\": \"<string>\"\n },\n \"includeAll\": false,\n \"includeRelevantOnly\": true,\n \"limit\": 20,\n \"cursor\": \"<string>\",\n \"search\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.octolens.com/api/v2/mentions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"view\": 123,\n \"filters\": {\n \"source\": [\n \"reddit\"\n ],\n \"sentiment\": [],\n \"keyword\": [\n 0\n ],\n \"language\": [],\n \"tag\": [\n \"<string>\"\n ],\n \"relevance\": [\n \"<string>\"\n ],\n \"!source\": [\n \"reddit\"\n ],\n \"!sentiment\": [],\n \"!keyword\": [\n 0\n ],\n \"!language\": [],\n \"!tag\": [\n \"<string>\"\n ],\n \"!relevance\": [\n \"<string>\"\n ],\n \"minXFollowers\": 4503599627370495,\n \"maxXFollowers\": 4503599627370495,\n \"startDate\": \"<string>\",\n \"endDate\": \"<string>\"\n },\n \"includeAll\": false,\n \"includeRelevantOnly\": true,\n \"limit\": 20,\n \"cursor\": \"<string>\",\n \"search\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": [
{
"id": 0,
"sourceId": "reddit_t3_1abc234",
"url": "https://reddit.com/r/example/comments/abc123/...",
"title": "<string>",
"body": "<string>",
"source": "reddit",
"timestamp": "2026-05-06 13:35:37.000",
"author": "jane.doe",
"authorName": "<string>",
"authorAvatar": "<string>",
"authorUrl": "<string>",
"authorFollowers": 0,
"relevance": "relevant",
"relevanceComment": "<string>",
"sentiment": "Neutral",
"language": "english",
"tags": [
"competitor_mention",
"pricing"
],
"keywords": [
{
"id": 42,
"keyword": "social listening"
}
],
"engaged": true,
"relevanceScore": 123,
"feedbackRelevant": 123,
"imageUrl": "<string>",
"keywordId": 123
}
],
"pagination": {
"nextCursor": "<string>"
}
}{
"error": {
"code": "NOT_FOUND",
"message": "Resource not found",
"status": 404,
"details": [
"<unknown>"
],
"upgradeUrl": "https://app.octolens.com/me/upgrade?src=agents",
"upgradeCommand": "octolens upgrade"
}
}{
"error": {
"code": "NOT_FOUND",
"message": "Resource not found",
"status": 404,
"details": [
"<unknown>"
],
"upgradeUrl": "https://app.octolens.com/me/upgrade?src=agents",
"upgradeCommand": "octolens upgrade"
}
}{
"error": {
"code": "NOT_FOUND",
"message": "Resource not found",
"status": 404,
"details": [
"<unknown>"
],
"upgradeUrl": "https://app.octolens.com/me/upgrade?src=agents",
"upgradeCommand": "octolens upgrade"
}
}{
"error": {
"code": "NOT_FOUND",
"message": "Resource not found",
"status": 404,
"details": [
"<unknown>"
],
"upgradeUrl": "https://app.octolens.com/me/upgrade?src=agents",
"upgradeCommand": "octolens upgrade"
}
}{
"error": {
"code": "NOT_FOUND",
"message": "Resource not found",
"status": 404,
"details": [
"<unknown>"
],
"upgradeUrl": "https://app.octolens.com/me/upgrade?src=agents",
"upgradeCommand": "octolens upgrade"
}
}Authorizations
Clerk API key. Create one in Settings → API Keys. Pass as Authorization: Bearer <key>.
Body
application/json
Filter and paginate mentions. Either provide view to reuse an existing feed's filters, or supply filters directly (or both - they merge). Body shape matches v1 /api/v1/mentions so v1 clients can reuse the same request bodies. Date ranges live inside filters.startDate / filters.endDate (ISO 8601).
Feed/view ID to reuse as a base filter. If filters is also provided, the two are merged (view's saved filters + inline filters both apply).
Required range:
x <= 9007199254740991Filter object. Accepts the simple flat form ({ source: ["twitter"], sentiment: ["positive"] }) or the advanced group form with AND/OR operators. Use POST /api/v2/ai/filter-wizard to generate one from natural language.
- Option 1
- Option 2
Show child attributes
Show child attributes
When true, includes low-relevance mentions (internal relevanceScore = 2). Default false returns only high and medium relevance (scores 0 and 1).
When true, forces relevant-only results (scores 0 and 1) even if includeAll is true. Convenience parity with the in-app feed toggle; omit to defer to includeAll.
Page size, 1-100.
Required range:
1 <= x <= 100Opaque cursor from a previous response's pagination.nextCursor.
Free-text search. Case-insensitive substring match across the mention's title, body, author handle, and author display name. Composes with view/filters (AND semantics). Empty or whitespace-only values are ignored.
Maximum string length:
200Was this page helpful?
⌘I
List mentions
curl --request POST \
--url https://app.octolens.com/api/v2/mentions \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"view": 123,
"filters": {
"source": [
"reddit"
],
"sentiment": [],
"keyword": [
0
],
"language": [],
"tag": [
"<string>"
],
"relevance": [
"<string>"
],
"!source": [
"reddit"
],
"!sentiment": [],
"!keyword": [
0
],
"!language": [],
"!tag": [
"<string>"
],
"!relevance": [
"<string>"
],
"minXFollowers": 4503599627370495,
"maxXFollowers": 4503599627370495,
"startDate": "<string>",
"endDate": "<string>"
},
"includeAll": false,
"includeRelevantOnly": true,
"limit": 20,
"cursor": "<string>",
"search": "<string>"
}
'import requests
url = "https://app.octolens.com/api/v2/mentions"
payload = {
"view": 123,
"filters": {
"source": ["reddit"],
"sentiment": [],
"keyword": [0],
"language": [],
"tag": ["<string>"],
"relevance": ["<string>"],
"!source": ["reddit"],
"!sentiment": [],
"!keyword": [0],
"!language": [],
"!tag": ["<string>"],
"!relevance": ["<string>"],
"minXFollowers": 4503599627370495,
"maxXFollowers": 4503599627370495,
"startDate": "<string>",
"endDate": "<string>"
},
"includeAll": False,
"includeRelevantOnly": True,
"limit": 20,
"cursor": "<string>",
"search": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
view: 123,
filters: {
source: ['reddit'],
sentiment: [],
keyword: [0],
language: [],
tag: ['<string>'],
relevance: ['<string>'],
'!source': ['reddit'],
'!sentiment': [],
'!keyword': [0],
'!language': [],
'!tag': ['<string>'],
'!relevance': ['<string>'],
minXFollowers: 4503599627370495,
maxXFollowers: 4503599627370495,
startDate: '<string>',
endDate: '<string>'
},
includeAll: false,
includeRelevantOnly: true,
limit: 20,
cursor: '<string>',
search: '<string>'
})
};
fetch('https://app.octolens.com/api/v2/mentions', 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://app.octolens.com/api/v2/mentions",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'view' => 123,
'filters' => [
'source' => [
'reddit'
],
'sentiment' => [
],
'keyword' => [
0
],
'language' => [
],
'tag' => [
'<string>'
],
'relevance' => [
'<string>'
],
'!source' => [
'reddit'
],
'!sentiment' => [
],
'!keyword' => [
0
],
'!language' => [
],
'!tag' => [
'<string>'
],
'!relevance' => [
'<string>'
],
'minXFollowers' => 4503599627370495,
'maxXFollowers' => 4503599627370495,
'startDate' => '<string>',
'endDate' => '<string>'
],
'includeAll' => false,
'includeRelevantOnly' => true,
'limit' => 20,
'cursor' => '<string>',
'search' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://app.octolens.com/api/v2/mentions"
payload := strings.NewReader("{\n \"view\": 123,\n \"filters\": {\n \"source\": [\n \"reddit\"\n ],\n \"sentiment\": [],\n \"keyword\": [\n 0\n ],\n \"language\": [],\n \"tag\": [\n \"<string>\"\n ],\n \"relevance\": [\n \"<string>\"\n ],\n \"!source\": [\n \"reddit\"\n ],\n \"!sentiment\": [],\n \"!keyword\": [\n 0\n ],\n \"!language\": [],\n \"!tag\": [\n \"<string>\"\n ],\n \"!relevance\": [\n \"<string>\"\n ],\n \"minXFollowers\": 4503599627370495,\n \"maxXFollowers\": 4503599627370495,\n \"startDate\": \"<string>\",\n \"endDate\": \"<string>\"\n },\n \"includeAll\": false,\n \"includeRelevantOnly\": true,\n \"limit\": 20,\n \"cursor\": \"<string>\",\n \"search\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://app.octolens.com/api/v2/mentions")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"view\": 123,\n \"filters\": {\n \"source\": [\n \"reddit\"\n ],\n \"sentiment\": [],\n \"keyword\": [\n 0\n ],\n \"language\": [],\n \"tag\": [\n \"<string>\"\n ],\n \"relevance\": [\n \"<string>\"\n ],\n \"!source\": [\n \"reddit\"\n ],\n \"!sentiment\": [],\n \"!keyword\": [\n 0\n ],\n \"!language\": [],\n \"!tag\": [\n \"<string>\"\n ],\n \"!relevance\": [\n \"<string>\"\n ],\n \"minXFollowers\": 4503599627370495,\n \"maxXFollowers\": 4503599627370495,\n \"startDate\": \"<string>\",\n \"endDate\": \"<string>\"\n },\n \"includeAll\": false,\n \"includeRelevantOnly\": true,\n \"limit\": 20,\n \"cursor\": \"<string>\",\n \"search\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.octolens.com/api/v2/mentions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"view\": 123,\n \"filters\": {\n \"source\": [\n \"reddit\"\n ],\n \"sentiment\": [],\n \"keyword\": [\n 0\n ],\n \"language\": [],\n \"tag\": [\n \"<string>\"\n ],\n \"relevance\": [\n \"<string>\"\n ],\n \"!source\": [\n \"reddit\"\n ],\n \"!sentiment\": [],\n \"!keyword\": [\n 0\n ],\n \"!language\": [],\n \"!tag\": [\n \"<string>\"\n ],\n \"!relevance\": [\n \"<string>\"\n ],\n \"minXFollowers\": 4503599627370495,\n \"maxXFollowers\": 4503599627370495,\n \"startDate\": \"<string>\",\n \"endDate\": \"<string>\"\n },\n \"includeAll\": false,\n \"includeRelevantOnly\": true,\n \"limit\": 20,\n \"cursor\": \"<string>\",\n \"search\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": [
{
"id": 0,
"sourceId": "reddit_t3_1abc234",
"url": "https://reddit.com/r/example/comments/abc123/...",
"title": "<string>",
"body": "<string>",
"source": "reddit",
"timestamp": "2026-05-06 13:35:37.000",
"author": "jane.doe",
"authorName": "<string>",
"authorAvatar": "<string>",
"authorUrl": "<string>",
"authorFollowers": 0,
"relevance": "relevant",
"relevanceComment": "<string>",
"sentiment": "Neutral",
"language": "english",
"tags": [
"competitor_mention",
"pricing"
],
"keywords": [
{
"id": 42,
"keyword": "social listening"
}
],
"engaged": true,
"relevanceScore": 123,
"feedbackRelevant": 123,
"imageUrl": "<string>",
"keywordId": 123
}
],
"pagination": {
"nextCursor": "<string>"
}
}{
"error": {
"code": "NOT_FOUND",
"message": "Resource not found",
"status": 404,
"details": [
"<unknown>"
],
"upgradeUrl": "https://app.octolens.com/me/upgrade?src=agents",
"upgradeCommand": "octolens upgrade"
}
}{
"error": {
"code": "NOT_FOUND",
"message": "Resource not found",
"status": 404,
"details": [
"<unknown>"
],
"upgradeUrl": "https://app.octolens.com/me/upgrade?src=agents",
"upgradeCommand": "octolens upgrade"
}
}{
"error": {
"code": "NOT_FOUND",
"message": "Resource not found",
"status": 404,
"details": [
"<unknown>"
],
"upgradeUrl": "https://app.octolens.com/me/upgrade?src=agents",
"upgradeCommand": "octolens upgrade"
}
}{
"error": {
"code": "NOT_FOUND",
"message": "Resource not found",
"status": 404,
"details": [
"<unknown>"
],
"upgradeUrl": "https://app.octolens.com/me/upgrade?src=agents",
"upgradeCommand": "octolens upgrade"
}
}{
"error": {
"code": "NOT_FOUND",
"message": "Resource not found",
"status": 404,
"details": [
"<unknown>"
],
"upgradeUrl": "https://app.octolens.com/me/upgrade?src=agents",
"upgradeCommand": "octolens upgrade"
}
}