Skip to main content

Get Keyword Alert

Retrieves a specific keyword alert by its ID.

Endpoint

GET /api/keyword-alerts/{platform}/{id}

Path Parameters

ParameterTypeDescription
platformstringThe platform of the alert
idstringThe unique identifier of the alert

Response

Returns a JSON object containing the alert details.

Example Request

curl -X GET "https://api.kwatch.io/api/keyword-alerts/twitter/123" \
-H "Authorization: Bearer your-api-key-here"

Example Response

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