Create Keyword

POST/v2/organizations/{organizationId}/keywords

Creates a new keyword (monitoring query) within the specified organization.

2 req/10s

Parameters

Path Parameters

organizationIdintegerrequiredpath

The unique identifier of the organization (int64).

Body Parameters

groupIdintegerrequiredbody

The ID of the group to add the keyword to (int64).

namestringrequiredbody

Display name for the keyword.

keywordjsonrequiredbody

Keyword definition object containing the search query and filters. See keyword object fields below.

Keyword Object Fields

Field	Type	Description
naturalQuery	string	The search query in natural language. Supports boolean operators like OR, AND, and quoted phrases.
mayLangs	array of string	Language codes to include (e.g. ["en", "de"]). Use the Languages endpoint to get valid codes.
mayLocations	array of string	Location codes to include (e.g. ["US", "GB"]). Use the Locations endpoint to get valid codes.
maySourceTypes	array of string	Source types to monitor. Allowed values: WEB, FACEBOOK, TWITTER, FORUM, COMMENT, YOUTUBE, INSTAGRAM, REDDIT, TIKTOK, PRINT, RADIO, TV, BLUESKY

Additional filter fields

The keyword object supports many additional filter fields beyond those listed above. The fields documented here cover the most common use cases. Contact support for information about advanced filtering options.

Request Body Example

{
  "groupId": 456,
  "name": "Tesla Mentions",
  "keyword": {
    "naturalQuery": "Tesla OR \"Elon Musk\"",
    "mayLangs": ["en", "de"],
    "maySourceTypes": ["WEB", "TWITTER", "FACEBOOK"]
  }
}

Try it

Parameters

organizationId *integer

Organization ID

Keyword

Group ID *integer

The group to add the keyword to

Keyword Name *string

Display name for the keyword

Keyword Definition

Search Query *string

Natural language search query

Languages select multiple

Include mentions in these languages

Locations select multiple

Include mentions from these locations

Source Types select multiple

Include mentions from these sources

Response

{
  "id": 789,
  "name": "Tesla Mentions",
  "color": "#4A90D9",
  "naturalQuery": "Tesla OR \"Elon Musk\"",
  "active": true,
  "createdAt": "2024-01-15T10:30:00Z",
  "editedAt": "2024-01-15T10:30:00Z"
}

Response Fields

Field	Type	Description
id	integer (int64)	Unique identifier for the created keyword
name	string	Display name of the keyword
color	string	Hex color code assigned to the keyword
naturalQuery	string	The search query as provided in the request
active	boolean	Whether the keyword is actively monitoring
createdAt	string (ISO 8601)	Timestamp of when the keyword was created
editedAt	string (ISO 8601)	Timestamp of the last edit to the keyword