Keyword
keywordKeyword.com is a digital marketing platform that provides search engine ranking tracking and SEO analytics
Acciones disponibles (20)
Cada acción es una operación que el agente puede ejecutar contra este conector. Haz clic en una acción para ver sus parámetros.
Add KeywordsKEYWORD_ADD_KEYWORDSAcciónTool to add keywords to a Keyword.com project for search ranking tracking. Use when you need to monitor how specific URLs rank for target keywords across different Google regions and devices.
KEYWORD_ADD_KEYWORDSAcciónTool to add keywords to a Keyword.com project for search ranking tracking. Use when you need to monitor how specific URLs rank for target keywords across different Google regions and devices.
Parámetros de entrada
dataobject[]ObligatorioList 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_namestringObligatorioThe name or identifier of the project/group to add keywords to. Must match an existing project in your Keyword.com account.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Archive ProjectKEYWORD_ARCHIVE_PROJECTAcciónTool to archive a project in Keyword.com. Sets the project status to Archived. Use when you need to archive a project without permanently deleting it. The project will remain archived until restored or permanently deleted.
KEYWORD_ARCHIVE_PROJECTAcciónTool to archive a project in Keyword.com. Sets the project status to Archived. Use when you need to archive a project without permanently deleting it. The project will remain archived until restored or permanently deleted.
Parámetros de entrada
project_namestringObligatorioThe name of the project to archive. This is the project identifier used in the API path.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create Project or GroupKEYWORD_CREATE_PROJECTAcciónTool 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).
KEYWORD_CREATE_PROJECTAcciónTool 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).
Parámetros de entrada
categorystringObligatorioProject 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_codestringOptional 3-letter currency code for reporting (e.g., 'USD', 'GBP', 'EUR'). If not provided, the account's default currency will be used.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete KeywordKEYWORD_DELETE_KEYWORDAcciónTool 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.
KEYWORD_DELETE_KEYWORDAcciónTool 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.
Parámetros de entrada
keyword_idstringObligatorioThe unique identifier of the keyword to delete. Warning: This action cannot be undone and all historic ranking data will be lost.
project_namestringObligatorioThe name of the project or group containing the keyword (e.g., 'composio.dev')
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Bulk delete keywordsKEYWORD_DELETE_KEYWORDS_BULKAcciónTool to bulk delete multiple keywords from a single project by providing keyword IDs. Use when you need to remove multiple keywords at once from a project.
KEYWORD_DELETE_KEYWORDS_BULKAcciónTool to bulk delete multiple keywords from a single project by providing keyword IDs. Use when you need to remove multiple keywords at once from a project.
Parámetros de entrada
project_idstringObligatorioThe unique identifier of the project from which keywords will be deleted.
keyword_idsstring[]ObligatorioArray of keyword IDs to delete from the project. Each ID must belong to the specified project.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete ProjectKEYWORD_DELETE_PROJECTAcciónTool to delete a single project or group from Keyword.com. Use when you need to permanently remove a project. This action cannot be undone.
KEYWORD_DELETE_PROJECTAcciónTool to delete a single project or group from Keyword.com. Use when you need to permanently remove a project. This action cannot be undone.
Parámetros de entrada
project_namestringObligatorioThe name of the project or group to delete. This action cannot be undone and will permanently remove the project.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Current UserKEYWORD_GET_CURRENT_USERAcciónTool to retrieve the current authenticated user's account information. Returns user profile details including ID, name, email, onboarding status, and optionally subscription information.
KEYWORD_GET_CURRENT_USERAcciónTool to retrieve the current authenticated user's account information. Returns user profile details including ID, name, email, onboarding status, and optionally subscription information.
Parámetros de entrada
include_subscriptionsbooleanInclude subscription details in response
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get KeywordKEYWORD_GET_KEYWORDAcciónTool to retrieve all keyword settings and ranking metrics for a single keyword. Use when you need to get detailed information about a keyword's performance and configuration. Can optionally retrieve data for a specific date.
KEYWORD_GET_KEYWORDAcciónTool to retrieve all keyword settings and ranking metrics for a single keyword. Use when you need to get detailed information about a keyword's performance and configuration. Can optionally retrieve data for a specific date.
Parámetros de entrada
datestringOptional date to retrieve keyword data for a specific date. Format: YYYY-MM-DD.
keyword_idstringObligatorioThe unique identifier of the keyword to retrieve.
project_namestringObligatorioThe project name (domain) that the keyword belongs to.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Project DetailsKEYWORD_GET_PROJECTAcciónTool to retrieve a single project's summary from Keyword.com. Returns groups, tags, keyword counts, and the PROJECT AUTH KEY required for detailed data collection. Use when you need project details or the auth key for further API operations.
KEYWORD_GET_PROJECTAcciónTool to retrieve a single project's summary from Keyword.com. Returns groups, tags, keyword counts, and the PROJECT AUTH KEY required for detailed data collection. Use when you need project details or the auth key for further API operations.
Parámetros de entrada
project_namestringObligatorioThe project name or domain to retrieve (e.g., 'composio.dev')
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Project MetricsKEYWORD_GET_PROJECT_METRICSAcciónRetrieve keyword movement metrics for a project, group, or tag. Returns ranking changes (daily, weekly, or monthly) including number of keywords that improved, declined, or remained unchanged, along with detailed movement data for individual keywords.
KEYWORD_GET_PROJECT_METRICSAcciónRetrieve keyword movement metrics for a project, group, or tag. Returns ranking changes (daily, weekly, or monthly) including number of keywords that improved, declined, or remained unchanged, along with detailed movement data for individual keywords.
Parámetros de entrada
timeframestringObligatorioenumTimeframe for metrics calculation. Determines the period for ranking changes.
dailyweeklymonthlyproject_namestringObligatorioThe name of the project, group, or tag to retrieve metrics for (e.g., 'composio.dev')
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Keyword Ranking HistoryKEYWORD_GET_RANKING_HISTORYAcciónTool to retrieve Google ranking history for specified keywords for up to 180 days. Use when you need to analyze historical ranking trends or track keyword performance over time. Returns daily ranking positions grouped by keyword ID and domain.
KEYWORD_GET_RANKING_HISTORYAcciónTool to retrieve Google ranking history for specified keywords for up to 180 days. Use when you need to analyze historical ranking trends or track keyword performance over time. Returns daily ranking positions grouped by keyword ID and domain.
Parámetros de entrada
kwidinteger[]ObligatorioArray of keyword IDs to retrieve ranking history for. Each ID should be a valid keyword ID from your Keyword.com account.
limitintegerNumber of days of ranking history to retrieve. Maximum value is 180 days. If not specified, returns the default number of days.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Share of Voice HistoryKEYWORD_GET_SOV_HISTORYAcciónRetrieve Share of Voice data over time for a specific project. Use when you need historical SOV metrics. Supports ranges of 7, 30, 90, 180, and 365 days with varying data point intervals.
KEYWORD_GET_SOV_HISTORYAcciónRetrieve Share of Voice data over time for a specific project. Use when you need historical SOV metrics. Supports ranges of 7, 30, 90, 180, and 365 days with varying data point intervals.
Parámetros de entrada
project_idstringObligatorioThe unique identifier of the project for which to retrieve Share of Voice data
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Top PagesKEYWORD_GET_TOP_PAGESAcciónTool 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.
KEYWORD_GET_TOP_PAGESAcciónTool 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.
Parámetros de entrada
project_namestringObligatorioThe name or identifier of the project/group to retrieve top pages for. This is typically the domain name (e.g., 'composio.dev').
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List Active ProjectsKEYWORD_LIST_ACTIVE_PROJECTSAcciónTool to retrieve all active projects with their groups, tags, and keyword counts. Returns PROJECT AUTH KEY for each project which is required to collect detailed project and keyword data.
KEYWORD_LIST_ACTIVE_PROJECTSAcciónTool to retrieve all active projects with their groups, tags, and keyword counts. Returns PROJECT AUTH KEY for each project which is required to collect detailed project and keyword data.
Parámetros de entrada
Sin parámetros.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List AlertsKEYWORD_LIST_ALERTSAcciónTool to retrieve all alerts for the Keyword.com account with pagination and sorting options. Use when you need to fetch alerts, check alert status, or monitor notifications. Supports filtering by view type and retrieving only recent alerts.
KEYWORD_LIST_ALERTSAcciónTool to retrieve all alerts for the Keyword.com account with pagination and sorting options. Use when you need to fetch alerts, check alert status, or monitor notifications. Supports filtering by view type and retrieving only recent alerts.
Parámetros de entrada
lastbooleanWhen true, retrieves only the most recent alerts. Useful for getting latest notifications without pagination.
pageintegerPage number for pagination (starts at 1). Use with per_page to navigate through alerts.
per_pageintegerNumber of results per page (e.g., 100). Controls how many alerts are returned in a single request.
view_typestringFilter alerts by view type (e.g., 'All alerts'). Narrows results to specific alert categories or statuses.
sort_fieldstringField to sort results by (e.g., 'created_at', 'updated_at'). Determines the ordering of alerts in the response.
sort_directionstringenumSort direction for results. Use 'asc' for ascending order (oldest first) or 'desc' for descending order (newest first).
ascdesc
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List KeywordsKEYWORD_LIST_KEYWORDSAcciónTool to retrieve all keywords and their ranking data in a project or group. Use when you need to get keyword rankings, search volumes, and position changes. Supports pagination with per_page (max 250) and page parameters, and can filter by specific date.
KEYWORD_LIST_KEYWORDSAcciónTool to retrieve all keywords and their ranking data in a project or group. Use when you need to get keyword rankings, search volumes, and position changes. Supports pagination with per_page (max 250) and page parameters, and can filter by specific date.
Parámetros de entrada
datestringOptional date to retrieve keyword data for a specific date. Format: YYYY-MM-DD.
pageintegerPage number for pagination. Starts at 1.
per_pageintegerNumber of keywords to return per page. Maximum 250.
project_namestringObligatorioThe project name (domain) to retrieve keywords from.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List Project RegionsKEYWORD_LIST_PROJECT_REGIONSAcciónTool to list all Google regions being tracked in a Keyword.com project. Returns each region with the count of keywords being monitored in that region. Use when you need to see which geographic regions are configured for keyword tracking in a specific project.
KEYWORD_LIST_PROJECT_REGIONSAcciónTool to list all Google regions being tracked in a Keyword.com project. Returns each region with the count of keywords being monitored in that region. Use when you need to see which geographic regions are configured for keyword tracking in a specific project.
Parámetros de entrada
project_namestringObligatorioThe name or identifier of the project (group) to retrieve regions for.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Refresh KeywordsKEYWORD_REFRESH_KEYWORDSAcciónTool to trigger an on-demand update for all keywords in one or more projects or groups. Use when you need to refresh keyword rankings data immediately instead of waiting for the scheduled update. Returns the number of refreshes remaining for the day.
KEYWORD_REFRESH_KEYWORDSAcciónTool to trigger an on-demand update for all keywords in one or more projects or groups. Use when you need to refresh keyword rankings data immediately instead of waiting for the scheduled update. Returns the number of refreshes remaining for the day.
Parámetros de entrada
project_idsinteger[]ObligatorioList of project IDs that need to be refreshed. You must provide at least one project ID.
include_sub_groupsbooleanSet to true to refresh all keywords in the project and its sub-groups. If false, only refreshes keywords in the specified projects.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Restore Archived ProjectKEYWORD_RESTORE_PROJECTAcciónTool to restore an archived project or group. Use when you need to unarchive a project and resume keyword tracking. Once restored, keywords will automatically update during the next scheduled cycle.
KEYWORD_RESTORE_PROJECTAcciónTool to restore an archived project or group. Use when you need to unarchive a project and resume keyword tracking. Once restored, keywords will automatically update during the next scheduled cycle.
Parámetros de entrada
project_namestringObligatorioThe name of the project or group to restore from archive. Once restored, keywords will automatically update during the next scheduled cycle.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update KeywordsKEYWORD_UPDATE_KEYWORDSAcciónTool to update keyword settings in a project. Updates tracking parameters such as device type, tracked URL, Google region, language, and URL tracking method for multiple keywords at once. Use when you need to modify keyword tracking configuration.
KEYWORD_UPDATE_KEYWORDSAcciónTool to update keyword settings in a project. Updates tracking parameters such as device type, tracked URL, Google region, language, and URL tracking method for multiple keywords at once. Use when you need to modify keyword tracking configuration.
Parámetros de entrada
dataobjectObligatorioJSON:API formatted data containing keyword update information.
project_idstringObligatorioThe unique identifier of the project containing the keywords to update.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not