Skip to main content
GET
/
api
/
v2
/
keywords
/
suggestions
List keyword suggestions
curl --request GET \
  --url https://app.octolens.com/api/v2/keywords/suggestions \
  --header 'Authorization: Bearer <token>'
{
  "keyword": {
    "excludeWords": "<string>",
    "excludeAuthors": "<string>",
    "additionalTerms": "<string>",
    "additionalTermsAndOr": true,
    "platforms": "<string>",
    "symbolSensitive": true
  },
  "suggestions": [
    {
      "id": 0,
      "keywordId": 0,
      "organizationId": "<string>",
      "type": "add_exclude_words",
      "value": "<string>",
      "reason": "<string>",
      "impact": "<string>",
      "status": "pending",
      "createdAt": "2023-11-07T05:31:56Z",
      "respondedAt": "2023-11-07T05:31:56Z"
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://octolens.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Clerk API key. Create one in Settings → API Keys. Pass as Authorization: Bearer <key>.

Query Parameters

​
keywordId
integer

Narrow to one keyword. Omit to list org-wide.

Required range: -9007199254740991 <= x <= 9007199254740991
​
withVolume
boolean

When true, return the SuggestionsWithVolume shape with per-keyword volumes. Otherwise returns KeywordSuggestionList (requires keywordId).

Response

200 response

Shape depends on the query: per-keyword list, count summary, or full enriched list with volume.

​
keyword
object
required

Snapshot of the current keyword config so the UI can show a diff preview.

​
suggestions
object[]
required

All non-expired suggestions for the requested keyword.