KWatch.io

https://docs.kwatch.io/
Admin
KWatch.io is a social media monitoring tool that tracks specific keywords across various platforms,...
Tokens:7,807
Snippets:30
Trust Score:8
Update:1 year ago
Show doc for...
Tokens:
Raw
### Basic CSV Alert Configuration Example

Source: https://docs.kwatch.io/bulk-alerts-creation

This example demonstrates the minimal required columns for creating alerts using a CSV file. It specifies the platform and keywords for each alert.

```csv
platform,keywords
reddit,chatgpt
twitter,ai tools
linkedin,digital marketing

```

--------------------------------

### Advanced CSV Alert Configuration Example

Source: https://docs.kwatch.io/bulk-alerts-creation

This example showcases a more comprehensive CSV configuration, including optional columns such as excluded keywords, included/excluded users, whole words, case sensitivity, and search scope.

```csv
platform,keywords,excluded keywords,included users,excluded users,included subreddits,excluded subreddits,whole words only,case sensitive,search posts,search comments,include nsfw,enabled
reddit,chatgpt,spam,user1,user2,technology,news,true,false,true,true,false,true
twitter,ai tools,promotion,user3,user4,,,,true,true,false,,true
linkedin,digital marketing,advertisement,,,,,,,true,,,true

```

--------------------------------

### List All Keyword Alerts (curl)

Source: https://docs.kwatch.io/api/list-keyword-alerts

This example demonstrates how to list all keyword alerts across all platforms using the KWatch API via a curl command. It requires an authorization token and specifies the 'all' platform to retrieve alerts from every integrated service.

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

--------------------------------

### Reddit Conversation URL Example

Source: https://docs.kwatch.io/tracking-conversations

This snippet shows an example of a correctly formatted URL for tracking a Reddit conversation. Ensure the URL includes the subreddit, post ID, post title, and optionally a comment ID for deeper tracking.

```plaintext
https://www.reddit.com/r/programming/comments/abc123/interesting_discussion_about_ai/def456
```

--------------------------------

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

Source: https://docs.kwatch.io/api/get-keyword-alert

Retrieves a specific keyword alert by its ID and platform. This endpoint allows you to fetch the details of a previously configured keyword alert.

```APIDOC
## GET /api/keyword-alerts/{platform}/{id}

### Description
Retrieves a specific keyword alert by its ID and platform. This endpoint allows you to fetch the details of a previously configured keyword alert.

### Method
GET

### Endpoint
/api/keyword-alerts/{platform}/{id}

### Parameters
#### Path Parameters
- **platform** (string) - Required - The platform of the alert
- **id** (string) - Required - The unique identifier of the alert

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

### Response
#### Success Response (200)
- **id** (integer) - The unique identifier of the alert
- **keywords** (string) - The keywords to track
- **excluded_keywords** (string) - Keywords to exclude from tracking
- **search_posts** (boolean) - Whether to search in posts
- **search_comments** (boolean) - Whether to search in comments
- **included_users** (string) - Specific users to include
- **excluded_users** (string) - Specific users to exclude
- **included_languages** (string) - Languages to include (comma-separated)
- **excluded_languages** (string) - Languages to exclude (comma-separated)
- **api_webhook_url** (string) - URL for API webhooks
- **slack_webhook_url** (string) - URL for Slack webhooks
- **enabled** (boolean) - Whether the alert is enabled
- **monthly_count** (integer) - Monthly alert count

#### Response Example
```json
{
  "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
}
```
```

--------------------------------

### Hacker News Conversation URL Example

Source: https://docs.kwatch.io/tracking-conversations

This snippet provides an example of a URL for tracking a Hacker News conversation. The URL must include the item ID of the discussion thread you wish to monitor.

```plaintext
https://news.ycombinator.com/item?id=12345678
```

--------------------------------

### API Error Response Structure

Source: https://docs.kwatch.io/api

This example shows the typical JSON structure for error responses from the KWatch API. Error responses may contain a message providing more specific details about the failure.

```json
{
  "error": "Error message here"
}
```

--------------------------------

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

Source: https://docs.kwatch.io/api/list-keyword-alerts

Retrieves all keyword alerts for a specific platform or across all platforms. The response is a JSON object containing an array of JSON objects for each platform, with each final object detailing the alert.

```APIDOC
## GET /api/keyword-alerts/{platform}

### Description
Retrieves all keyword alerts for a specific platform or across all platforms. The response is a JSON object containing an array of JSON objects for each platform, with each final object detailing the alert.

### Method
GET

### Endpoint
/api/keyword-alerts/{platform}

### Parameters
#### Path Parameters
- **platform** (string) - Required - The platform to list alerts for. Use `all` to list alerts across all platforms.

### Request Example
```bash
curl -X GET "https://api.kwatch.io/api/keyword-alerts/all" \
     -H "Authorization: Bearer your-api-key-here"
```

### Response
#### Success Response (200)
- **twitter** (array) - Array of keyword alert objects for Twitter.
- **linkedin** (array) - Array of keyword alert objects for LinkedIn.
- **quora** (null) - Null if no alerts for Quora.
- **facebook** (null) - Null if no alerts for Facebook.
- **reddit** (null) - Null if no alerts for Reddit.
- **hn** (null) - Null if no alerts for Hacker News.
- **youtube** (null) - Null if no alerts for YouTube.

Each keyword alert object contains the following fields:
- **id** (integer) - The unique identifier for the alert.
- **keywords** (string) - The keywords to search for.
- **excluded_keywords** (string) - Keywords to exclude from the search.
- **search_posts** (boolean) - Whether to search within posts.
- **search_comments** (boolean) - Whether to search within comments.
- **included_users** (string) - Comma-separated list of users to include.
- **excluded_users** (string) - Comma-separated list of users to exclude.
- **included_languages** (string) - Comma-separated list of language codes to include.
- **excluded_languages** (string) - Comma-separated list of language codes to exclude.
- **api_webhook_url** (string) - URL for the API webhook.
- **slack_webhook_url** (string) - URL for the Slack webhook.
- **enabled** (boolean) - Whether the alert is enabled.
- **monthly_count** (integer) - The number of alerts found this month.

#### Response Example
```json
{
  "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
}
```
```

--------------------------------

### Keyword Alerts Response Structure (JSON)

Source: https://docs.kwatch.io/api/list-keyword-alerts

This JSON object illustrates the structure of the response when retrieving keyword alerts from the KWatch API. It shows example data for 'twitter' and 'linkedin' platforms, including alert configurations and metadata. Platforms with no alerts are represented as null.

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

--------------------------------

### Get Keyword Alert by ID using cURL

Source: https://docs.kwatch.io/api/get-keyword-alert

This snippet shows how to retrieve a specific keyword alert using the cURL command-line tool. It requires the platform and alert ID as path parameters and an authorization token in the header.

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

--------------------------------

### Get Alert

Source: https://docs.kwatch.io/api

Retrieves the details of a specific keyword monitoring alert by its unique ID.

```APIDOC
## GET /alerts/{alert_id}

### Description
Get a specific alert by its ID.

### Method
GET

### Endpoint
`/alerts/{alert_id}`

### Path Parameters
- **alert_id** (string) - Required - The unique identifier of the alert to retrieve.
```

--------------------------------

### Update Keyword Alert API Response (JSON)

Source: https://docs.kwatch.io/api/update-keyword-alert

This is an example JSON response from the Kwatch.io API after successfully updating a keyword alert. It includes the updated alert details and the monthly count of matched items.

```json
{
  "id": 123,
  "keywords": "updated 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
}
```

--------------------------------

### API Webhook Example Payload in JSON

Source: https://docs.kwatch.io/notification-channels

This JSON object represents the data structure sent to an API webhook when a keyword is detected. It includes details about the platform, the triggering query, timestamp, link to the content, author information, the content itself, and sentiment analysis. This format allows for seamless integration with external systems.

```json
{
    "platform": "reddit",
    "query": "Keywords: vllm",
    "datetime": "19 Jan 24 05:52 UTC",
    "link": "https://www.reddit.com/r/LocalLLaMA/comments/19934kd/sglang_new/kijvtk5/",
    "author": "lmzoo",
    "content": "sglang runtime has a different architecture on the higher-level part with vllm.",
    "sentiment": "neutral"
}
```

--------------------------------

### POST /api/keyword-alerts/{platform}

Source: https://docs.kwatch.io/api/create-keyword-alert

Creates a new keyword alert for a specific platform. This endpoint allows for detailed configuration of monitoring parameters to capture relevant content.

```APIDOC
## POST /api/keyword-alerts/{platform}

### Description
Creates a new keyword alert for a specific platform.

### Method
POST

### Endpoint
`/api/keyword-alerts/{platform}`

### Parameters
#### Path Parameters
- **platform** (string) - Required - The platform to create the alert for

#### Request Body
- **keywords** (string) - Required - The keywords you want to monitor. Each keyword can be made of one or several words. You can specify up to 3 independent keywords that should ALL appear in the result. Separate multiple keywords with commas. Example: `chatgpt, blog article, seo`
- **excluded_keywords** (string) - Optional - Keywords that should not appear in the results. You can specify up to 10 excluded keywords (5 for LinkedIn). Separate multiple keywords with commas. Example: `spam, promotion, advertisement`
- **included_users** (string) - Optional - (Reddit, Hacker News, X (Twitter), and Youtube only) Only monitor content from these specific users. Up to 3 users maximum. Not case sensitive. Example: `maxai834, thebloke, badenergy12x`
- **excluded_users** (string) - Optional - (Reddit, Hacker News, X (Twitter), and Youtube only) Do not monitor content from these users. Up to 3 users maximum. Not case sensitive. Example: `maxai834, thebloke, badenergy12x`
- **included_subreddits** (string) - Optional - (Reddit only) Only monitor these specific subreddits. Up to 10 subreddits maximum. Not case sensitive, no 'r/' prefix. Example: `marketing, saas, startups`
- **excluded_subreddits** (string) - Optional - (Reddit only) Do not monitor these subreddits. Up to 10 subreddits maximum. Not case sensitive, no 'r/' prefix. Example: `marketing, saas, startups`
- **public_facebook_group_url** (string) - Optional - (Facebook only) The URL of the public Facebook group to monitor. Example: `https://www.facebook.com/groups/1234567890/`
- **included_languages** (string) - Optional - Only monitor content in these languages. Use ISO language codes. Up to 3 languages maximum. Example: `en, fr, es`
- **excluded_languages** (string) - Optional - Do not monitor content in these languages. Use ISO language codes. Up to 3 languages maximum. Example: `en, fr, es`
- **whole_words_only** (boolean) - Optional - (Reddit, Hacker News, and X (Twitter) only) Only match complete words. For example, if you monitor "kwatch", it won't match "kwatch.io". Use "true" or "false".
- **case_sensitive** (boolean) - Optional - (Reddit and Hacker News only) Match exact case. For example, if you monitor "kwatch", it won't match "KWatch". Use "true" or "false".
- **search_posts** (boolean) - Optional - (Reddit, Hacker News, and X (Twitter) only) Monitor keywords in posts. Use "true" or "false".
- **search_comments** (boolean) - Optional - (Reddit, Hacker News, and X (Twitter) only) Monitor keywords in comments. Use "true" or "false".
- **include_nsfw** (boolean) - Optional - (Reddit only) Include NSFW content. Use "true" or "false".
- **api_webhook_url** (string) - Optional - URL to send webhook notifications to.
- **slack_webhook_url** (string) - Optional - Slack webhook URL for notifications.
- **enabled** (boolean) - Optional - Whether the alert should be active. Use "true" or "false".

### Request Example
```json
{
  "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
}
```

### Response
#### Success Response (200)
- **id** (integer) - The unique identifier for the created alert.
- **keywords** (string) - The keywords that were monitored.
- **excluded_keywords** (string) - The keywords that were excluded from monitoring.
- **search_posts** (boolean) - Indicates if posts were monitored.
- **search_comments** (boolean) - Indicates if comments were monitored.
- **included_users** (string) - The users that were included in the monitoring.
- **excluded_users** (string) - The users that were excluded from monitoring.
- **included_languages** (string) - The languages that were included in the monitoring.
- **excluded_languages** (string) - The languages that were excluded from monitoring.
- **api_webhook_url** (string) - The URL for API webhook notifications.
- **slack_webhook_url** (string) - The Slack webhook URL for notifications.
- **enabled** (boolean) - Indicates if the alert is currently active.
- **monthly_count** (integer) - The number of monthly occurrences for this alert.

#### Response Example
```json
{
  "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
}
```
```

--------------------------------

### Create Alert

Source: https://docs.kwatch.io/api

Creates a new keyword monitoring alert for a specified platform.

```APIDOC
## POST /alerts

### Description
Create a new keyword monitoring alert.

### Method
POST

### Endpoint
`/alerts`

### Request Body
- **platform** (string) - Required - The platform for which to create the alert (e.g., `twitter`, `linkedin`).
- **keywords** (array of strings) - Required - A list of keywords to monitor.
- **name** (string) - Optional - A descriptive name for the alert.
```

--------------------------------

### Create Keyword Alert Request (cURL)

Source: https://docs.kwatch.io/api/create-keyword-alert

This snippet demonstrates how to create a keyword alert using a cURL command. It specifies the platform, authentication, content type, and a JSON payload with various parameters for filtering keywords, users, languages, and notification settings.

```shell
curl -X POST "https://api.kwatch.io/api/keyword-alerts/twitter" \
     -H "Authorization: Bearer your-api-key-here" \
     -H "Content-Type: application/json" \
     -d '{  
       "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  
     }'
```

--------------------------------

### List Alerts

Source: https://docs.kwatch.io/api

Retrieves a list of all keyword monitoring alerts for a specific platform or across all platforms.

```APIDOC
## GET /alerts

### Description
Get all alerts for a platform or for all platforms.

### Method
GET

### Endpoint
`/alerts`

### Query Parameters
- **platform** (string) - Optional - Filter alerts by a specific platform (e.g., `twitter`, `linkedin`).
```

--------------------------------

### Base URL

Source: https://docs.kwatch.io/api

All API endpoints are relative to the base URL: `https://api.kwatch.io`.

```APIDOC
## Base URL

All API endpoints are relative to the base URL:

```
https://api.kwatch.io
```
```

--------------------------------

### API Webhooks

Source: https://docs.kwatch.io/notification-channels

Set up API webhooks to integrate KWatch.io alerts with your own systems. This allows for automated responses, custom dashboards, and more.

```APIDOC
## API Webhooks

### Description
Configure API webhooks to integrate KWatch.io notifications with your own systems. You can store mentions, trigger automated responses, create custom dashboards, and interface with other services. You can set a global webhook or configure per-alert webhooks, with per-alert settings taking precedence.

### Parameters
#### Request Body (Global)
- **api_webhook_url** (string) - Optional - The global API webhook URL for your account.
- **enable_api_webhook** (boolean) - Optional - Whether to enable the global API webhook.

### API Webhook Payload Format
KWatch.io sends a POST HTTP request to your webhook URL with a JSON payload when a keyword is detected.

### API Webhook Payload Fields
- **platform** (string) - The social media platform where the keyword was detected. Possible values: "reddit", "hacker_news", "twitter", "linkedin", "quora", "youtube", "facebook"
- **query** (string) - The keywords that triggered the alert
- **datetime** (string) - The date and time when the content was posted
- **link** (string) - The URL to the post or comment containing your keyword
- **author** (string) - The author of the content. For Twitter, includes username, full name, and follower count
- **content** (string) - The full text content. For YouTube, includes video length at the beginning
- **sentiment** (string) - AI-powered sentiment analysis of the content. Possible values: "positive", "negative", "neutral"

### API Webhook Example Payload
```json
{
    "platform": "reddit",
    "query": "Keywords: vllm",
    "datetime": "19 Jan 24 05:52 UTC",
    "link": "https://www.reddit.com/r/LocalLLaMA/comments/19934kd/sglang_new/kijvtk5/",
    "author": "lmzoo",
    "content": "sglang runtime has a different architecture on the higher-level part with vllm.",
    "sentiment": "neutral"
}
```
```

--------------------------------

### Authentication

Source: https://docs.kwatch.io/api

All API requests must be authenticated using an API key. Include your API key in the `Authorization` header as a bearer token.

```APIDOC
## Authentication

All API requests must be authenticated using an API key. You can generate API keys from your dashboard under the API section.

To authenticate your requests, include your API key in the `Authorization` header as a bearer token:

```
Authorization: Bearer your-api-key-here
```
```

--------------------------------

### API Authentication Header

Source: https://docs.kwatch.io/api

This snippet demonstrates how to authenticate API requests using an API key. Include this header in all requests to authorize your actions. The API key can be generated from the user dashboard.

```http
Authorization: Bearer your-api-key-here
```

--------------------------------

### Response Codes

Source: https://docs.kwatch.io/api

The API uses standard HTTP response codes to indicate the success or failure of requests, including codes for OK, Created, No Content, and various error scenarios.

```APIDOC
## Response Codes

The API uses standard HTTP response codes to indicate the success or failure of requests:
  * `200 OK`: The request was successful
  * `201 Created`: The resource was successfully created
  * `204 No Content`: The request was successful and there is no content to return (used for DELETE operations)
  * `400 Bad Request`: The request was invalid (e.g., invalid alert ID format, invalid keywords format)
  * `401 Unauthorized`: Invalid or missing API key
  * `403 Forbidden`: 
    * API access not available on your current plan
    * Subscription limit reached for the platform
    * Your role does not allow you to perform this action
  * `404 Not Found`: The requested resource doesn't exist
  * `429 Too Many Requests`: You've exceeded the rate limit
  * `500 Internal Server Error`: Something went wrong on our end

Error responses sometimes include a JSON object with an error message with more details:

```
{
  "error": "Error message here"
}
```
```

--------------------------------

### Slack Notifications

Source: https://docs.kwatch.io/notification-channels

Integrate KWatch.io with Slack to receive real-time notifications in your workspace. You can set a global webhook or configure per-alert webhooks.

```APIDOC
## Slack Notifications

### Description
Configure Slack notifications to receive real-time updates directly in your Slack workspace. You can set a global webhook for your account or specify a webhook URL for individual alerts. Per-alert webhooks take precedence over global settings.

### Parameters
#### Request Body (Global)
- **slack_webhook_url** (string) - Optional - The global Slack webhook URL for your account.
- **enable_slack_notifications** (boolean) - Optional - Whether to enable the global Slack webhook.
```

--------------------------------

### Update Keyword Alert API Request (cURL)

Source: https://docs.kwatch.io/api/update-keyword-alert

This cURL command demonstrates how to update an existing keyword alert using the Kwatch.io API. It includes the endpoint, authentication, content type, and a sample JSON request body with various parameters.

```curl
curl -X PUT "https://api.kwatch.io/api/keyword-alerts/twitter/123" \
     -H "Authorization: Bearer your-api-key-here" \
     -H "Content-Type: application/json" \
     -d '{  
       "keywords": "updated 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  
     }'
```

--------------------------------

### Update Alert

Source: https://docs.kwatch.io/api

Updates an existing keyword monitoring alert identified by its ID.

```APIDOC
## PUT /alerts/{alert_id}

### Description
Update an existing alert by ID.

### Method
PUT

### Endpoint
`/alerts/{alert_id}`

### Path Parameters
- **alert_id** (string) - Required - The unique identifier of the alert to update.

### Request Body
- **keywords** (array of strings) - Optional - A new list of keywords to monitor.
- **name** (string) - Optional - A new descriptive name for the alert.
```

--------------------------------

### Delete Keyword Alert using cURL

Source: https://docs.kwatch.io/api/delete-keyword-alert

This snippet demonstrates how to delete a specific keyword alert using a cURL command. It requires the platform and alert ID as path parameters and an authorization token in the header.

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

--------------------------------

### PUT /api/keyword-alerts/{platform}/{id}

Source: https://docs.kwatch.io/api/update-keyword-alert

Updates an existing keyword alert with new parameters. You can modify keywords, exclusions, user/subreddit targeting, language filters, and notification settings.

```APIDOC
## PUT /api/keyword-alerts/{platform}/{id}

### Description
Updates an existing keyword alert with new parameters. You can modify keywords, exclusions, user/subreddit targeting, language filters, and notification settings.

### Method
PUT

### Endpoint
`/api/keyword-alerts/{platform}/{id}`

### Parameters
#### Path Parameters
- **platform** (string) - Required - The platform of the alert
- **id** (string) - Required - The unique identifier of the alert

#### Request Body
- **keywords** (string) - Required - The keywords you want to monitor. Separate multiple keywords with commas.
- **excluded_keywords** (string) - Optional - Keywords that should not appear in the results. Separate multiple keywords with commas.
- **included_users** (string) - Optional - (Reddit, Hacker News, X (Twitter), and Youtube only) Only monitor content from these specific users. Up to 3 users maximum. Separate multiple users with commas.
- **excluded_users** (string) - Optional - (Reddit, Hacker News, X (Twitter), and Youtube only) Do not monitor content from these users. Up to 3 users maximum. Separate multiple users with commas.
- **included_subreddits** (string) - Optional - (Reddit only) Only monitor these specific subreddits. Up to 10 subreddits maximum. Separate multiple subreddits with commas.
- **excluded_subreddits** (string) - Optional - (Reddit only) Do not monitor these subreddits. Up to 10 subreddits maximum. Separate multiple subreddits with commas.
- **public_facebook_group_url** (string) - Optional - (Facebook only) The URL of the public Facebook group to monitor.
- **included_languages** (string) - Optional - Only monitor content in these languages. Use ISO language codes. Up to 3 languages maximum. Separate multiple languages with commas.
- **excluded_languages** (string) - Optional - Do not monitor content in these languages. Use ISO language codes. Up to 3 languages maximum. Separate multiple languages with commas.
- **whole_words_only** (boolean) - Optional - (Reddit, Hacker News, and X (Twitter) only) Only match complete words. Use `true` or `false`.
- **case_sensitive** (boolean) - Optional - (Reddit and Hacker News only) Match exact case. Use `true` or `false`.
- **search_posts** (boolean) - Optional - (Reddit, Hacker News, and X (Twitter) only) Monitor keywords in posts. Use `true` or `false`.
- **search_comments** (boolean) - Optional - (Reddit, Hacker News, and X (Twitter) only) Monitor keywords in comments. Use `true` or `false`.
- **include_nsfw** (boolean) - Optional - (Reddit only) Include NSFW content. Use `true` or `false`.
- **api_webhook_url** (string) - Optional - URL to send webhook notifications to.
- **slack_webhook_url** (string) - Optional - Slack webhook URL for notifications.
- **enabled** (boolean) - Optional - Whether the alert should be active. Use `true` or `false`.

### Request Example
```json
{
  "keywords": "updated 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
}
```

### Response
#### Success Response (200)
- **id** (integer) - The unique identifier of the alert.
- **keywords** (string) - The keywords being monitored.
- **excluded_keywords** (string) - Keywords that are excluded from monitoring.
- **search_posts** (boolean) - Indicates if posts are being searched.
- **search_comments** (boolean) - Indicates if comments are being searched.
- **included_users** (string) - Users whose content is being monitored.
- **excluded_users** (string) - Users whose content is excluded from monitoring.
- **included_languages** (string) - Languages included in the monitoring.
- **excluded_languages** (string) - Languages excluded from the monitoring.
- **api_webhook_url** (string) - The URL for API webhook notifications.
- **slack_webhook_url** (string) - The Slack webhook URL for notifications.
- **enabled** (boolean) - Indicates if the alert is active.
- **monthly_count** (integer) - The number of monthly alerts.

#### Response Example
```json
{
  "id": 123,
  "keywords": "updated 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
}
```
```

--------------------------------

### Email Notifications

Source: https://docs.kwatch.io/notification-channels

Configure email notifications to receive alerts for detected keywords directly in your inbox. You can specify a preferred email address and enable/disable notifications.

```APIDOC
## Email Notifications

### Description
Set up email notifications to receive alerts when your keywords are detected. You can specify a preferred email address and enable or disable notifications.

### Parameters
#### Request Body
- **notification_email** (string) - Optional - The email address to send notifications to. Defaults to the account's sign-up email.
- **enable_email_notifications** (boolean) - Optional - Whether to enable or disable email notifications.
```

--------------------------------

### DELETE /api/keyword-alerts/{platform}/{id}

Source: https://docs.kwatch.io/api/delete-keyword-alert

Deletes a specific keyword alert identified by its platform and unique ID.

```APIDOC
## DELETE /api/keyword-alerts/{platform}/{id}

### Description
Deletes a specific keyword alert identified by its platform and unique ID.

### Method
DELETE

### Endpoint
/api/keyword-alerts/{platform}/{id}

### Parameters
#### Path Parameters
- **platform** (string) - Required - The platform of the alert
- **id** (string) - Required - The unique identifier of the alert

### Request Example
```curl
curl -X DELETE "https://api.kwatch.io/api/keyword-alerts/twitter/123" \
     -H "Authorization: Bearer your-api-key-here"
```

### Response
#### Success Response (200)
Returns a JSON object containing a confirmation message.

#### Response Example
```json
{
  "message": "Alert deleted successfully"
}
```
```

--------------------------------

### Delete Alert

Source: https://docs.kwatch.io/api

Deletes a specific keyword monitoring alert by its ID.

```APIDOC
## DELETE /alerts/{alert_id}

### Description
Delete an alert by its ID.

### Method
DELETE

### Endpoint
`/alerts/{alert_id}`

### Path Parameters
- **alert_id** (string) - Required - The unique identifier of the alert to delete.
```
Tokens:
Raw