Mentions

Export mentions to a download link

Exports the mentions matching the filter set (keyword ids, sources, sentiment, relevance, an inclusive YYYY-MM-DD window, a text query; up to 5,000 rows) as a CSV file uploaded to an unguessable public URL, and answers that URL. Subject to the export limits: 5 exports per hour and 2 concurrent exports per workspace (429 RATE_LIMITED). 503 EXPORT_LINK_UNAVAILABLE when the deployment has no file store — use POST /api/v2/mentions/export then.

POST

api

mentions

export

link

Export mentions to a download link

curl --request POST \
  --url https://app.octolens.com/api/v2/mentions/export/link \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "keywordIds": 4503599627370495,
  "sources": [
    "reddit"
  ],
  "startDate": "<string>",
  "endDate": "<string>",
  "query": "<string>",
  "limit": 1000
}
'

import requests

url = "https://app.octolens.com/api/v2/mentions/export/link"

payload = {
    "keywordIds": 4503599627370495,
    "sources": ["reddit"],
    "startDate": "<string>",
    "endDate": "<string>",
    "query": "<string>",
    "limit": 1000
}
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({
    keywordIds: 4503599627370495,
    sources: ['reddit'],
    startDate: '<string>',
    endDate: '<string>',
    query: '<string>',
    limit: 1000
  })
};

fetch('https://app.octolens.com/api/v2/mentions/export/link', 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/export/link",
  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([
    'keywordIds' => 4503599627370495,
    'sources' => [
        'reddit'
    ],
    'startDate' => '<string>',
    'endDate' => '<string>',
    'query' => '<string>',
    'limit' => 1000
  ]),
  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/export/link"

	payload := strings.NewReader("{\n  \"keywordIds\": 4503599627370495,\n  \"sources\": [\n    \"reddit\"\n  ],\n  \"startDate\": \"<string>\",\n  \"endDate\": \"<string>\",\n  \"query\": \"<string>\",\n  \"limit\": 1000\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/export/link")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"keywordIds\": 4503599627370495,\n  \"sources\": [\n    \"reddit\"\n  ],\n  \"startDate\": \"<string>\",\n  \"endDate\": \"<string>\",\n  \"query\": \"<string>\",\n  \"limit\": 1000\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.octolens.com/api/v2/mentions/export/link")

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  \"keywordIds\": 4503599627370495,\n  \"sources\": [\n    \"reddit\"\n  ],\n  \"startDate\": \"<string>\",\n  \"endDate\": \"<string>\",\n  \"query\": \"<string>\",\n  \"limit\": 1000\n}"

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

{
  "url": "<string>",
  "filename": "<string>",
  "format": "csv",
  "rows": 0,
  "truncated": true
}

{
  "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

Authorization

string

header

required

Clerk API key. Create one in Settings → API Keys. Pass as Authorization: Bearer <key>. Keys carry a scope — read, write (implies read) or admin (implies write) — chosen when the key is minted. Each operation's security requirement (and its x-required-scope extension) names the minimum scope it needs; request the least-privileged key that covers the operations you call.

Body

application/json

The filter set to export as CSV. Same window semantics as the analytics tools.

keywordIds

Numeric ids of the monitored keywords to scope to (from list_keywords). Omit for every keyword. A mention that matched several keywords counts once per keyword in per-keyword breakdowns and once in totals.

Required range: 0 < x <= 9007199254740991

sources

enum<string>[]

Platforms to include.

Minimum array length: 1

Platform a mention can originate from / a keyword can be monitored on.

Available options:

dev,

github,

hackernews,

linkedin,

producthunt,

reddit,

stackoverflow,

twitter,

youtube,

tiktok,

medium,

reddit_comment,

bluesky,

newsletter,

podcasts,

news,

firehose,

trustpilot_reviews,

google_reviews,

app_store_reviews,

google_play_reviews,

instagram

sentiment

enum<string>

Only this sentiment.

Available options:

positive,

neutral,

negative

relevance

enum<string>

high, relevant (default) or all.

Available options:

high,

relevant,

all

startDate

string

YYYY-MM-DD; default last 30 days.

Pattern: ^\d{4}-\d{2}-\d{2}$

endDate

string

YYYY-MM-DD; default today.

Pattern: ^\d{4}-\d{2}-\d{2}$

query

string

Free-text filter.

Maximum string length: 200

limit

integer

default:1000

Row cap, 1–5000.

Required range: 1 <= x <= 5000

Response

200 response

url

string

required

Public, unguessable download URL of the CSV.

filename

string

required

format

string

required

Allowed value: "csv"

rows

integer

required

Rows in the file.

Required range: -9007199254740991 <= x <= 9007199254740991

truncated

boolean

required

true when the row cap cut the result.

Export mentions to a download link

curl --request POST \
  --url https://app.octolens.com/api/v2/mentions/export/link \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "keywordIds": 4503599627370495,
  "sources": [
    "reddit"
  ],
  "startDate": "<string>",
  "endDate": "<string>",
  "query": "<string>",
  "limit": 1000
}
'

import requests

url = "https://app.octolens.com/api/v2/mentions/export/link"

payload = {
    "keywordIds": 4503599627370495,
    "sources": ["reddit"],
    "startDate": "<string>",
    "endDate": "<string>",
    "query": "<string>",
    "limit": 1000
}
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({
    keywordIds: 4503599627370495,
    sources: ['reddit'],
    startDate: '<string>',
    endDate: '<string>',
    query: '<string>',
    limit: 1000
  })
};

fetch('https://app.octolens.com/api/v2/mentions/export/link', 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/export/link",
  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([
    'keywordIds' => 4503599627370495,
    'sources' => [
        'reddit'
    ],
    'startDate' => '<string>',
    'endDate' => '<string>',
    'query' => '<string>',
    'limit' => 1000
  ]),
  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/export/link"

	payload := strings.NewReader("{\n  \"keywordIds\": 4503599627370495,\n  \"sources\": [\n    \"reddit\"\n  ],\n  \"startDate\": \"<string>\",\n  \"endDate\": \"<string>\",\n  \"query\": \"<string>\",\n  \"limit\": 1000\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/export/link")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"keywordIds\": 4503599627370495,\n  \"sources\": [\n    \"reddit\"\n  ],\n  \"startDate\": \"<string>\",\n  \"endDate\": \"<string>\",\n  \"query\": \"<string>\",\n  \"limit\": 1000\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.octolens.com/api/v2/mentions/export/link")

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  \"keywordIds\": 4503599627370495,\n  \"sources\": [\n    \"reddit\"\n  ],\n  \"startDate\": \"<string>\",\n  \"endDate\": \"<string>\",\n  \"query\": \"<string>\",\n  \"limit\": 1000\n}"

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

{
  "url": "<string>",
  "filename": "<string>",
  "format": "csv",
  "rows": 0,
  "truncated": true
}

{
  "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"
  }
}