Alertly API
Astro Logo

Feature

Alertly API

Pull your social alerts into your own tools — dashboards, CRMs, reporting, and internal workflows — with one simple endpoint.

Create API key
Two steps: generate a key → make a request.

One endpoint

Fetch alerts with filters like timeframe, platform, and unread-only.

Flexible filtering

Search content, paginate, and narrow down by sentiment and keywords.

Quick start

Generate a key, then fetch alerts.

Step 1 — Generate an API key

Create an API key with the scope alert.read.

Step 2 — Make your request

Call GET /alert and filter results with query params.

Step 1 — Generate an API key

Create a key in the app, then copy it.

Go to Account → API Keys in the app, click New, and make sure the key includes the scope alert.read.

Keys are shown masked by default — use Reveal to copy the full value.

Create API key
Tip: Treat API keys like passwords. Store them in a secret manager and rotate/revoke them if they’re ever exposed.

Step 2 — Make your request

Send your API key in the header, then filter results with query params.

Authentication header
Authorization: Basic key-xxxxxxxxxxxxxxxx
Request
GET https://api.usealertly.com/alert
Query parameters
Param Type Notes
platform string Comma-separated platforms (e.g. reddit,x,linkedin).
keyword string Comma-separated keyword IDs to filter by.
offset number Pagination offset (e.g. 0, 50).
limit number Page size (e.g. 25, 100).
search string Searches title and content (SQL LIKE).
include_filtered boolean Set true to include filtered alerts. Default: excludes filtered.
unread_only boolean Set true to only return unread alerts.
timeframe string today, yesterday, this_week, this_month, or last_<N>_days (e.g. last_7_days). Use all to disable.
sentiment string Filter by positive, neutral, or negative. Use all to disable.
Example (curl)
curl -G "https://api.usealertly.com/alert" \
  -H "Authorization: Basic key-xxxxxxxxxxxxxxxx" \
  --data-urlencode "unread_only=true" \
  --data-urlencode "timeframe=last_7_days" \
  --data-urlencode "limit=25"
Example (JavaScript)
const API_KEY = "key-xxxxxxxxxxxxxxxx";

const params = new URLSearchParams({
  platform: "reddit,x",
  unread_only: "true",
  timeframe: "last_30_days",
  limit: "50",
});

const res = await fetch("https://api.usealertly.com/alert?" + params.toString(), {
  headers: { Authorization: "Basic " + API_KEY },
});

if (!res.ok) throw new Error(await res.text());

const { data } = await res.json();
console.log(data.total, data.results?.[0]);
Response shape
{
  "data": {
    "results": [
      {
        "id": "…",
        "title": "…",
        "content": "…",
        "url": "…",
        "platform": "reddit",
        "keyword": "Alertly",
        "status": "unread",
        "filtered": false,
        "sentiment": "neutral",
        "score": 7,
        "time_ago": "3 hours ago"
      }
    ],
    "total": 123
  }
}

Build workflows on top of your social alerts

Start Free Today