Get a feed

GET /api/v2/feeds/{id}

Get a feed

cURL

curl --request GET \
  --url https://app.octolens.com/api/v2/feeds/{id} \
  --header 'Authorization: Bearer <token>'

200

{
  "id": 0,
  "name": "Competitor mentions",
  "icon": "BellIcon",
  "simpleFilters": {
    "conditions": [
      {
        "field": "Keywords",
        "values": "42,43"
      }
    ]
  },
  "advancedFilters": {
    "groups": [
      {
        "conditions": [
          {
            "field": "<string>",
            "values": "42,43"
          }
        ],
        "isSingleCondition": true
      }
    ]
  },
  "isDefault": true,
  "destinations": [
    {
      "time": "09:00",
      "timezone": "UTC",
      "dayOfWeek": 3,
      "emailDestination": {
        "emails": "[e-mail], [e-mail]"
      },
      "slackDestination": {
        "channels": "<string>",
        "channelNamesMap": "<string>"
      },
      "webhookDestination": {
        "url": "https://example.com/webhook"
      }
    }
  ],
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization · string · header · required

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

Path Parameters

id · integer · required

Required range: -9007199254740991 <= x <= 9007199254740991

Response

200

application/json

200 response

A saved filter with optional notification destinations.

id · integer · required

Feed ID.

Required range: -9007199254740991 <= x <= 9007199254740991

name · string · required

Display name shown in the app and included in notifications.

Example:

"Competitor mentions"

icon · enum<string> · required

Icon identifier for UI display (Heroicons outline set).

Available options: InboxStackIcon, HeartIcon, AtSymbolIcon, ExclamationTriangleIcon, MegaphoneIcon, ArrowTrendingUpIcon, BuildingOffice2Icon, ArrowTrendingDownIcon, BellIcon, BuildingLibraryIcon, ChartBarIcon, ChatBubbleLeftIcon, ChatBubbleLeftRightIcon, CheckCircleIcon, CloudIcon, CodeBracketIcon, ComputerDesktopIcon, CursorArrowRaysIcon, DevicePhoneMobileIcon, DocumentIcon, DocumentTextIcon, EnvelopeIcon, EyeIcon, FaceSmileIcon, FaceFrownIcon, FireIcon, FlagIcon, FolderIcon, GlobeAltIcon, GlobeAmericasIcon, HandThumbUpIcon, HashtagIcon, InboxArrowDownIcon, LightBulbIcon, PaperClipIcon, RocketLaunchIcon, RssIcon, SignalIcon, SparklesIcon, StarIcon, TrophyIcon, UserGroupIcon, WalletIcon

Example:

"BellIcon"

simpleFilters · object · required

Simple AND-combined filter list.

Show child attributes

advancedFilters · object · required

Nested filter expression — groups of conditions combined with AND/OR.

Show child attributes

isDefault · boolean · required

If true, this feed is pinned as the org's default view.

destinations · object[] · required

Notification destinations. Empty array = filter-only feed with no notifications.

Show child attributes

createdAt · string<date-time> · required

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$

updatedAt · string<date-time> · required

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$