List Keyword Alerts
Retrieves all keyword alerts for a specific platform or across all platforms.
Endpoint
GET /api/keyword-alerts/{platform}
Path Parameters
Parameter | Type | Description |
---|---|---|
platform | string | The platform to list alerts for. Use all to list alerts across all platforms. |
Response
Returns a JSON object that contains an array of JSON objects for each platform. Each final object contains the alert details.
Example Request
curl -X GET "https://api.kwatch.io/api/keyword-alerts/all" \
-H "Authorization: Bearer your-api-key-here"
Example Response
{
"twitter": [
{
"id": 123,
"keywords": "example keyword",
"excluded_keywords": "exclude this",
"search_posts": true,
"search_comments": false,
"included_users": "user1,user2",
"excluded_users": "user3",
"included_languages": "en,fr",
"excluded_languages": "es",
"api_webhook_url": "https://example.com/webhook",
"slack_webhook_url": "https://hooks.slack.com/...",
"enabled": true,
"monthly_count": 42
}
],
"linkedin": [
{
"id": 456,
"keywords": "example keyword",
"excluded_keywords": "exclude this",
"search_posts": true,
"search_comments": false,
"included_languages": "en,fr",
"excluded_languages": "es",
"api_webhook_url": "https://example.com/webhook",
"slack_webhook_url": "https://hooks.slack.com/...",
"enabled": true,
"monthly_count": 24
}
],
"quora": null,
"facebook": null,
"reddit": null,
"hn": null,
"youtube": null
}