Skip to main content
Keyword logo
  • Category: marketing
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 20
  • Triggers: 0
  • Slug: KEYWORD
  • Version: 20261101_00

Tools

Slug: KEYWORD_ADD_KEYWORDSAdds keywords to a Keyword.com project or group for search ranking tracking across supported Google regions and devices. Adding an already tracked keyword updates the settings supplied for it.

Input Parameters

array
required
List of keyword objects to add. Each object contains keyword details like the phrase, URL, region, language, device type, and tags. You can add multiple keywords in a single request.
string
required
The name or identifier of the project/group to add keywords to. Must match an existing project in your Keyword.com account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KEYWORD_ARCHIVE_PROJECTArchive a Keyword.com project without deleting it. The project remains archived until it is restored or deleted; the account’s only active top-level project cannot be archived.

Input Parameters

string
required
The name of the project to archive. This is the project identifier used in the API path.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KEYWORD_CREATE_PROJECTTool to create a new project or group in Keyword.com account. Use when you need to create a new project for organizing keywords or create a group within an existing project. For groups, the category must follow the naming convention with [sub] delimiter (e.g., ProjectName[sub]GroupName).

Input Parameters

string
required
Project name or group name. For creating a project, use the project name (e.g., ‘MyProject’). For creating a group within a project, use the format ‘ProjectName[sub]GroupName’ (e.g., ‘MyProject[sub]MyGroup’). The [sub] delimiter is required for group creation.
string
Optional 3-letter currency code for reporting (e.g., ‘USD’, ‘GBP’, ‘EUR’). If not provided, the account’s default currency will be used.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KEYWORD_DELETE_KEYWORDTool to delete a single keyword from a project or group. Use when you need to permanently remove a keyword. Warning: This action cannot be undone and all historic ranking data will be lost.

Input Parameters

string
required
The unique identifier of the keyword to delete. Warning: This action cannot be undone and all historic ranking data will be lost.
string
required
The name of the project or group containing the keyword (e.g., ‘composio.dev’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KEYWORD_DELETE_KEYWORDS_BULKBulk delete keywords from a single Keyword.com project by providing the project ID and keyword IDs. Use this operation to remove multiple tracked keywords in one request.

Input Parameters

string
required
The unique identifier of the project from which keywords will be deleted.
array
required
Array of keyword IDs to delete from the project. Each ID must belong to the specified project.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KEYWORD_DELETE_PROJECTDelete a single Keyword.com project or group, including its keywords and historical data. For a group, use its full name with the [sub] convention. The account’s only active top-level project cannot be deleted.

Input Parameters

string
required
The name of the project or group to delete. This action cannot be undone and will permanently remove the project.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KEYWORD_GET_CURRENT_USERRetrieve the authenticated Keyword.com user’s account profile, including identifying and onboarding information and available account or plan details. Use it to inspect the current user’s account information.

Input Parameters

boolean
Include subscription details in response

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KEYWORD_GET_KEYWORDRetrieve settings and ranking metrics for a single keyword in a Keyword.com project, identified by keyword ID. Optionally request ranking data for a specific date to examine the keyword’s performance and configuration.

Input Parameters

string
Optional date to retrieve keyword data for a specific date. Format: YYYY-MM-DD.
string
required
The unique identifier of the keyword to retrieve.
string
required
The project name (domain) that the keyword belongs to.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KEYWORD_GET_PROJECTRetrieve a summary of a Keyword.com project or group, including tags, keyword counts and the project auth key. Use the full [sub] name for a group; the summary can support further project and keyword data collection.

Input Parameters

string
required
The project name or domain to retrieve (e.g., ‘composio.dev’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KEYWORD_GET_PROJECT_METRICSRetrieve keyword ranking movement metrics for a Keyword.com project or group for a daily, weekly, or monthly timeframe. The results summarize ranking ranges and counts of keywords that improved, declined, or stayed unchanged.

Input Parameters

string ("daily" | "weekly" | "monthly")
required
Timeframe for metrics calculation. Determines the period for ranking changes.
string
required
The name of the project, group, or tag to retrieve metrics for (e.g., ‘composio.dev’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KEYWORD_GET_RANKING_HISTORYRetrieve Google ranking history for specified keywords for up to 180 days. The results provide daily ranking positions grouped by keyword ID and domain, useful for analyzing ranking trends over time.

Input Parameters

array
required
Array of keyword IDs to retrieve ranking history for. Each ID should be a valid keyword ID from your Keyword.com account.
integer
Number of days of ranking history to retrieve. Maximum value is 180 days. If not specified, returns the default number of days.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KEYWORD_GET_SOV_HISTORYRetrieve cached Share of Voice history for a specific project, showing how domains compare over time. The request uses the provider’s default date range, from 30 days ago to today.

Input Parameters

string
required
The unique identifier of the project for which to retrieve Share of Voice data

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KEYWORD_GET_TOP_PAGESTool to retrieve Top Pages data for a project showing ranking URLs with keyword counts, average rank, search volume, and cost per click metrics. Use when you need to analyze which pages are ranking for the most keywords in a project.

Input Parameters

integer
Page number for pagination. Starts at 1.
integer
Number of results to return per page. Maximum 250.
string
required
The name or identifier of the project/group to retrieve top pages for. This is typically the domain name (e.g., ‘composio.dev’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KEYWORD_LIST_ACTIVE_PROJECTSList active Keyword.com projects and groups, including their tags and keyword counts. The results include project authorization keys used to access detailed project and keyword data.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KEYWORD_LIST_ALERTSRequests Keyword.com account alerts with pagination, sorting, view-type filtering, and an option for the most recent alert per keyword. Alert details and pagination metadata may be missing from the returned result.

Input Parameters

boolean
When true, retrieves only the most recent alerts. Useful for getting latest notifications without pagination.
integer
Page number for pagination (starts at 1). Use with per_page to navigate through alerts.
integer
Number of results per page (e.g., 100). Controls how many alerts are returned in a single request.
string
Filter alerts by view type (e.g., ‘All alerts’). Narrows results to specific alert categories or statuses.
string
Field to sort results by (e.g., ‘created_at’, ‘updated_at’). Determines the ordering of alerts in the response.
string ("asc" | "desc")
Sort direction for results. Use ‘asc’ for ascending order (oldest first) or ‘desc’ for descending order (newest first).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KEYWORD_LIST_KEYWORDSList keywords and their ranking data for a Keyword.com project, including rankings, search volumes and position changes. Request a specific date and paginate using page and per_page, with up to 250 results per page.

Input Parameters

string
Optional date to retrieve keyword data for a specific date. Format: YYYY-MM-DD.
integer
Page number for pagination. Starts at 1.
integer
Number of keywords to return per page. Maximum 250.
string
required
The project name (domain) to retrieve keywords from.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KEYWORD_LIST_PROJECT_REGIONSList the Google regions tracked in a Keyword.com project or group, including the number of keywords tracked in each region. Use the full [sub] name to identify a group.

Input Parameters

string
required
The name or identifier of the project (group) to retrieve regions for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KEYWORD_REFRESH_KEYWORDSRequest an on-demand keyword ranking refresh for one or more projects or groups, optionally including subgroups. Refreshes consume the plan’s daily on-demand quota; requests exceeding the remaining quota are rejected without queuing keywords.

Input Parameters

array
required
List of project IDs that need to be refreshed. You must provide at least one project ID.
boolean
Set to true to refresh all keywords in the project and its sub-groups. If false, only refreshes keywords in the specified projects.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KEYWORD_RESTORE_PROJECTRestore an archived Keyword.com project or group to resume keyword tracking. Once restored, its keywords update during the next scheduled automatic cycle.

Input Parameters

string
required
The name of the project or group to restore from archive. Once restored, keywords will automatically update during the next scheduled cycle.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KEYWORD_UPDATE_KEYWORDSRequest a bulk update of tracking settings for selected keywords in a project. The available options include device, Google region, language, and URL tracking method.

Input Parameters

object
required
JSON:API formatted data containing keyword update information.
string
required
The unique identifier of the project containing the keywords to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not