> ## Documentation Index
> Fetch the complete documentation index at: https://composio-preview.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Keyword

> Keyword.com is a digital marketing platform that provides search engine ranking tracking and SEO analytics

![Keyword logo](https://mintcdn.com/composio-preview/tIuAovF9-7pXq2wA/images/toolkits/keyword.svg?fit=max\&auto=format\&n=tIuAovF9-7pXq2wA\&q=85\&s=7b1006efe44be1dbb2aedacf6926ff45)

* **Category:** marketing
* **Auth:** API\_KEY
* **Composio-managed OAuth available?** N/A
* **Tools:** 20
* **Triggers:** 0
* **Slug:** `KEYWORD`
* **Version:** 20261101\_00

## Tools

> [accordion] Add Keywords
>
> **Slug:** `KEYWORD_ADD_KEYWORDS`
>
> Adds 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
>
> **data** `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.
>
> **project\_name** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Archive Project
>
> **Slug:** `KEYWORD_ARCHIVE_PROJECT`
>
> Archive 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
>
> **project\_name** `string` *required*
>
> The name of the project to archive. This is the project identifier used in the API path.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Project or Group
>
> **Slug:** `KEYWORD_CREATE_PROJECT`
>
> Tool 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
>
> **category** `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.
>
> **currency\_code** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Keyword
>
> **Slug:** `KEYWORD_DELETE_KEYWORD`
>
> Tool 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
>
> **keyword\_id** `string` *required*
>
> The unique identifier of the keyword to delete. Warning: This action cannot be undone and all historic ranking data will be lost.
>
> **project\_name** `string` *required*
>
> The name of the project or group containing the keyword (e.g., 'composio.dev')
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Bulk delete keywords
>
> **Slug:** `KEYWORD_DELETE_KEYWORDS_BULK`
>
> Bulk 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
>
> **project\_id** `string` *required*
>
> The unique identifier of the project from which keywords will be deleted.
>
> **keyword\_ids** `array` *required*
>
> Array of keyword IDs to delete from the project. Each ID must belong to the specified project.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Project
>
> **Slug:** `KEYWORD_DELETE_PROJECT`
>
> Delete 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
>
> **project\_name** `string` *required*
>
> The name of the project or group to delete. This action cannot be undone and will permanently remove the project.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Current User
>
> **Slug:** `KEYWORD_GET_CURRENT_USER`
>
> Retrieve 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
>
> **include\_subscriptions** `boolean`
>
> Include subscription details in response
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Keyword
>
> **Slug:** `KEYWORD_GET_KEYWORD`
>
> Retrieve 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
>
> **date** `string`
>
> Optional date to retrieve keyword data for a specific date. Format: YYYY-MM-DD.
>
> **keyword\_id** `string` *required*
>
> The unique identifier of the keyword to retrieve.
>
> **project\_name** `string` *required*
>
> The project name (domain) that the keyword belongs to.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Project Details
>
> **Slug:** `KEYWORD_GET_PROJECT`
>
> Retrieve 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
>
> **project\_name** `string` *required*
>
> The project name or domain to retrieve (e.g., 'composio.dev')
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Project Metrics
>
> **Slug:** `KEYWORD_GET_PROJECT_METRICS`
>
> Retrieve 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
>
> **timeframe** `string ("daily" | "weekly" | "monthly")` *required*
>
> Timeframe for metrics calculation. Determines the period for ranking changes.
>
> **project\_name** `string` *required*
>
> The name of the project, group, or tag to retrieve metrics for (e.g., 'composio.dev')
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Keyword Ranking History
>
> **Slug:** `KEYWORD_GET_RANKING_HISTORY`
>
> Retrieve 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
>
> **kwid** `array` *required*
>
> Array of keyword IDs to retrieve ranking history for. Each ID should be a valid keyword ID from your Keyword.com account.
>
> **limit** `integer`
>
> Number of days of ranking history to retrieve. Maximum value is 180 days. If not specified, returns the default number of days.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Share of Voice History
>
> **Slug:** `KEYWORD_GET_SOV_HISTORY`
>
> Retrieve 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
>
> **project\_id** `string` *required*
>
> The unique identifier of the project for which to retrieve Share of Voice data
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Top Pages
>
> **Slug:** `KEYWORD_GET_TOP_PAGES`
>
> Tool 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
>
> **page** `integer`
>
> Page number for pagination. Starts at 1.
>
> **per\_page** `integer`
>
> Number of results to return per page. Maximum 250.
>
> **project\_name** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Active Projects
>
> **Slug:** `KEYWORD_LIST_ACTIVE_PROJECTS`
>
> List 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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Alerts
>
> **Slug:** `KEYWORD_LIST_ALERTS`
>
> Requests 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
>
> **last** `boolean`
>
> When true, retrieves only the most recent alerts. Useful for getting latest notifications without pagination.
>
> **page** `integer`
>
> Page number for pagination (starts at 1). Use with per\_page to navigate through alerts.
>
> **per\_page** `integer`
>
> Number of results per page (e.g., 100). Controls how many alerts are returned in a single request.
>
> **view\_type** `string`
>
> Filter alerts by view type (e.g., 'All alerts'). Narrows results to specific alert categories or statuses.
>
> **sort\_field** `string`
>
> Field to sort results by (e.g., 'created\_at', 'updated\_at'). Determines the ordering of alerts in the response.
>
> **sort\_direction** `string ("asc" | "desc")`
>
> Sort direction for results. Use 'asc' for ascending order (oldest first) or 'desc' for descending order (newest first).
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Keywords
>
> **Slug:** `KEYWORD_LIST_KEYWORDS`
>
> List 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
>
> **date** `string`
>
> Optional date to retrieve keyword data for a specific date. Format: YYYY-MM-DD.
>
> **page** `integer`
>
> Page number for pagination. Starts at 1.
>
> **per\_page** `integer`
>
> Number of keywords to return per page. Maximum 250.
>
> **project\_name** `string` *required*
>
> The project name (domain) to retrieve keywords from.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Project Regions
>
> **Slug:** `KEYWORD_LIST_PROJECT_REGIONS`
>
> List 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
>
> **project\_name** `string` *required*
>
> The name or identifier of the project (group) to retrieve regions for.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Refresh Keywords
>
> **Slug:** `KEYWORD_REFRESH_KEYWORDS`
>
> Request 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
>
> **project\_ids** `array` *required*
>
> List of project IDs that need to be refreshed. You must provide at least one project ID.
>
> **include\_sub\_groups** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Restore Archived Project
>
> **Slug:** `KEYWORD_RESTORE_PROJECT`
>
> Restore an archived Keyword.com project or group to resume keyword tracking. Once restored, its keywords update during the next scheduled automatic cycle.
>
> #### Input Parameters
>
> **project\_name** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Keywords
>
> **Slug:** `KEYWORD_UPDATE_KEYWORDS`
>
> Request 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
>
> **data** `object` *required*
>
> JSON:API formatted data containing keyword update information.
>
> **project\_id** `string` *required*
>
> The unique identifier of the project containing the keywords to update.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not
