Keyword integration: operations for AI agents
Keyword connects to Type.com as an integration. This page lists the 31 operations documented for Claude and Codex in Type.com: 21 read, 6 write, 4 destructive.
About Keyword
Keyword.com is a digital marketing platform that provides search engine ranking tracking and SEO analytics
Categories: Marketing & Social
How to connect Keyword to Type.com
- Access
- Organization connection: one shared account for the workspace.
To add the connection, follow the steps in Space connections.
Documented operations
31 operations. Your connection's permissions determine which operations are available. API references describe the vendor surface; they do not expand your connection's credentials or access.
31 operations listed.
Projects
- Read
List projects
This call will get you a summary of all your projects with their respective groups, tags and number of keywords. It will also provide you with the PROJECT AUTH KEY which is required to collect detailed project and keyword data. Important Notes: 1. The group name must follow the required naming convention and include \[sub\] when submitting the request. 2. Ensure the parent project is created before adding groups to it.
GET /api/v2/groups/active - Read
Get project
This call is used to retrieve a single project’s summary of groups, tags and number of keywords. It will also provide you with the PROJECT AUTH KEY which is required to collect detailed project and keyword data. Important Notes: 1. The group name must follow the required naming convention and include \[sub\] when submitting the request. 2. Ensure the parent project is created before adding groups to it.
GET /api/v2/groups/{project_name} - Read
Restore project
This endpoint allows users to restore archived projects or groups. Once restored, the associated keywords will automatically update during the next scheduled automatic cycle. If an immediate update is needed, users can trigger an on-demand request for the restored project. Important Notes: The group name must follow the required naming convention and include [sub] when submitting the request. Ensure the parent project is created before adding groups to it.
GET /api/v2/groups/{project_name}/undo/archive - Write
Create project
Use this endpoint to create a single project in your Keyword.com account
POST /api/v2/groups - Destructive
Archive project
Sets the project status to “Archived.” The project will remain in the “Archived” state until it is either restored or permanently deleted. Important Notes: 1. The group name must follow the required naming convention and include \[sub\] when submitting the request. 2. Ensure the parent project is created before adding groups to it.
PUT /api/v2/groups/{project_name} - Destructive
Delete project
This call will delete a single project or group. Important Notes: 1. The group name must follow the required naming convention and include \[sub\] when submitting the request. 2. Ensure the parent project is created before adding groups to it.
DELETE /api/v2/groups/{project_name}
Keywords
- Read
List keywords
Use this endpoint to fetch all keyword settings and ranking metrics for a specific group or project. This includes each keyword’s configuration, rank history, and associated metrics. By default, the API returns 20 results per page. However, for best performance—especially when dealing with large datasets—we recommend setting the perpage parameter to 250 and paginating through results using the page parameter. Example for a group or project with 500 keywords: - Request 1: https://app.keyword.com/api/v2/groups/[projectname]/keywords/?perpage=250&page=1 - Request 2: https://app.keyword.com/api/v2/groups/[projectname]/keywords/?perpage=250&page=2 This method ensures faster responses and minimizes server load while retrieving bulk keyword data. ⚠️ Note: If perpage is not specified, the default is 20 results per page. You can obtain each keywordid after you’ve added a keyword to a group or project. This ID is used for other actions like updating or refreshing a specific keyword. You can also collect the data for a single date by using the 'date' parameter.
GET /api/v2/groups/{project_name}/keywords - Read
Get keyword
Use this call to retrieve all the keyword settings and ranking metrics for a single keyword. The keywordid is the unique identifier of the keyword, which is obtained after you add the keyword. You can add the 'date' parameter to retrieve the ranking data for a specific date.
GET /api/v2/groups/{project_name}/keywords/{keyword_id} - Write
Add keywords
Add keywords to project or group. The response will include details of the keywords, but will not include tracking data and keyword metrics. Those are being updated in the background. Important Notes: 1. A new keyword, or one restored from a deleted or archived state, gets a ranking update right away. 2. A keyword the project already tracks is updated with the settings you send and returned in the response, but gets no extra ranking update. Its rankings refresh on the next scheduled update. Use POST /api/v2/keywords/refresh for an on-demand update.
POST /api/v2/groups/{project_name}/keywords - Write
Update keyword
Use this call to change the settings of a single keyword. Only the attributes you send are changed. Important Notes: 1. tags replaces the keyword's whole tag set. Send tag names; a name the project does not have yet is created. Send an empty array to remove every tag. 2. category moves the keyword into another project or group of the same account. That project or group must already exist.
PATCH /api/v2/groups/{project_name}/keywords/{keyword_id} - Write
Update keywords
PATCH /api/v2/projects/{project_id}/keywords
PATCH /api/v2/projects/{project_id}/keywords - Write
Refresh keywords
Use this call to run an on demand update for specific keywords, or for all the keywords in a project or group. Every keyword refreshed consumes one on-demand refresh from the plan's daily quota; a request that would exceed the remaining quota is rejected whole with a 403 and error code 10003. Important Notes: 1. The group name must follow the required naming convention and include \[sub\] when submitting the request. 2. Ensure the parent project is created before adding groups to it. 3. Send keywordids to refresh only those keywords. If you also send projectids, only the listed keywords in those projects are refreshed. 4. A keyword ID that is not an active keyword on your account is skipped without an error. 5. excludedkeywordids is ignored when keywordids is not empty. 6. An empty array is the same as an omitted field. If projectids and keywordids are both omitted or empty, every active keyword on your account is refreshed, except the IDs in excludedkeywordids.
POST /api/v2/keywords/refresh - Destructive
Delete keyword
- Use this call to delete keywords from a project or group. Note that this cannot be undone and when deleted you lose all historic ranking data.
DELETE /api/v2/groups/{project_name}/keywords/{keyword_id} - Destructive
Bulk delete keywords
DELETE /api/v2/projects/{project_id}/keywords
DELETE /api/v2/projects/{project_id}/keywords
Ranking Data
- Read
Get keyword metrics
GET /api/v2/groups/Disney/metrics This endpoint retrieves metrics for a specific group within a project. Request - Path Parameters - projectname (string, required): The name of the project. - Query Parameters - tagId (string, required): The ID of the tag. - timeframe (string, required): The time frame for the metrics. Response The response for this request follows the JSON schema below: json { "data": { "type": "", "id": "", "attributes": { "ranges": [ { "daily": { "count": 0, "change": 0, "status": "" }, "weekly": { "count": 0, "change": 0, "status": "" }, "monthly": { "count": 0, "change": 0, "status": "" }, "semester": { "count": 0, "change": 0, "status": "" }, "yearly": { "count": 0, "change": 0, "status": "" }, "life": { "count": 0, "change": 0, "status": "" }, "count": 0, "title": "" } ], "movements": { "daily": { "up": 0, "down": 0, "tie": 0 }, "weekly": { "up": 0, "down": 0, "tie": 0 }, "monthly": { "up": 0, "down": 0, "tie": 0 }, "semester": { "up": 0, "down": 0, "tie": 0 }, "yearly": { "up": 0, "down": 0, "tie": 0 }, "life": { "up": 0, "down": 0, "tie": 0 } }, "chart": null, "total": 0 } } }
GET /api/v2/groups/{project_name}/metrics - Read
Get rank history
Returns the daily ranking position for each specified keyword for the number of days prior to today. You can specify up to 180 days of history using the limit query parameter. Rankings are grouped by keyword ID and domain and include both a chart-ready series — each point a [day, rank] pair whose day is a YYYY-MM-DD date — and raw rank history with URLs.
POST /api/v2/keywords/chart - Read
Get competitors
GET /api/v2/metrics/{project_name}/competitors/{keyword_id}/history
GET /api/v2/metrics/{project_name}/competitors/{keyword_id}/history - Read
List regions
Use this call to get a list of all the regions your are tracking in this project with the count of number of keywords per region. Important Notes: 1. The group name must follow the required naming convention and include \[sub\] when submitting the request. 2. Ensure the parent project is created before adding groups to it.
GET /api/v2/groups/{project_name}/regions - Read
Get top pages
GET /api/v2/groups/{project_name}/keywords/ranking-urls
GET /api/v2/groups/{project_name}/keywords/ranking-urls
Share of Voice
Alerts
- Read
List alerts
Retrieves all the alerts present for your Keyword.com account
GET /api/v2/alerts
Project Sharing
- Read
Get sharing settings
Returns the project's shared-report configuration. visibility, keywordcolumns, and the chart sections resolve to what the shared report actually renders — a per-project override when one is set, otherwise the account-wide default. Note that visibility.hidetoppages reads as true whenever visibility.hideoverview is true, because hiding the Overview tab hides Top Pages with it.
GET /api/v2/projects/{project_id}/sharing-settings - Write
Update sharing settings
Partially updates the project's shared-report configuration and returns the full resolved settings. Top-level sections are optional: a present section is applied, an omitted one stays unchanged. Merge behavior differs per section — visibility and keywordcolumns.columns merge member by member, while keywordcharts and overviewcharts replace their whole section (see the request schema). password is three-state: omit the key to leave it unchanged, null or an empty string removes protection, a non-empty string sets it — setting a password on an unprotected project additionally requires the account's white-label plan entitlement. Everything except isactive requires the caller to hold the white-label management permission; without it the request returns 403.
PATCH /api/v2/projects/{project_id}/sharing-settings
Account
- Read
Get current user
GET /api/v2/users/self
GET /api/v2/users/self
Domains
- Read
Fetch all domains
Retrieves all AI Visibility domains for your account
GET /api/v2/ai-visibility/domains - Read
Fetch a single domain
Retrieves a single AI Visibility domain for your account
GET /api/v2/ai-visibility/domains/{domain_id} - Read
Fetch all search terms
GET /api/v2/ai-visibility/domains/{domain_id}/search-terms
GET /api/v2/ai-visibility/domains/{domain_id}/search-terms
Reporting API
- Read
Fetch dashboard metrics
Dashboard Metrics Endpoint Get dashboard-ready metrics for a domain's AI visibility tracking. This endpoint returns comprehensive analytics data to power your dashboard visualizations. Overview This endpoint fetches detailed metrics about how a domain appears in AI-generated search responses across various AI engines. It provides insights into visibility, sentiment, mentions, citations, and competitive positioning over time. Query Parameters topics[] (array) Filter metrics by specific topics you want to track. - Example: Ai Search visibility - Type: Array of strings - Description: Allows you to narrow down metrics to specific topic areas searchterms[] (array) Specific search terms or queries to analyze for AI visibility. - Example: How often does Keyword.com show up in AI-generated search responses? - Type: Array of strings - Description: The actual search queries you want to track across AI engines engine[] (array) Specify which AI engine(s) to analyze. - Example: chatgptgui - Type: Array of strings - Description: Target specific AI platforms for your analysis timeframe (string) The time period for which to retrieve metrics. - Example: 30d (30 days) - Type: String - Description: Defines the duration of the analysis period. Can be specified in days (e.g., "30d" or "30") periodoffset (string) Offset for the time period to analyze historical data. - Example: 0 (current period) - Type: String - Description: Use "0" for the current period, or specify an offset to analyze previous periods aggregation (string) How to aggregate the time series data. - Example: monthly - Type: String - Description: Determines the granularity of time-based metrics (e.g., daily, weekly, monthly) Response Data The endpoint returns a comprehensive dataset including: - Visibility Scores: Quantitative metrics showing how prominently the domain appears in AI responses - Sentiment Analysis: Tone and sentiment of mentions across AI-generated content - Mentions: Frequency and context of domain references - Citations: How often the domain is cited as a source - Competitor Analysis: Comparative metrics against competing domains - Time Series Data: Historical trends based on the specified aggregation period
GET /api/v2/ai-visibility/domains/{domain_id}/metrics - Read
Fetch Sentiment analytics
Fetch Sentiment Analytics Get comprehensive sentiment analysis data for a specific domain. This endpoint returns brand and company sentiment aggregates, keyword clouds, and sentiment breakdowns by AI engine. Endpoint Overview This endpoint analyzes how your domain is perceived across AI-generated search responses, providing insights into brand sentiment, company reputation, and keyword associations. Path Variables - domainid (required): The unique identifier for the domain you want to fetch sentiment data for. Use the {{domainid}} variable to reference your target domain. Query Parameters topics[] - Type: Array of strings - Required: No - Description: Filter sentiment data by specific topics or categories. This allows you to narrow down the sentiment analysis to particular areas of interest. - Example: topics[]=Ai Search visibility - Usage: Can be passed multiple times to filter by multiple topics searchterms[] - Type: Array of strings - Required: No - Description: Analyze sentiment for specific search terms or queries. This helps you understand how sentiment varies across different search contexts. - Example: searchterms[]=How often does Keyword.com show up in AI-generated search responses? - Usage: Can be passed multiple times to analyze sentiment across multiple search terms Response Data The response includes the following sentiment analysis components: - Brand Sentiment Aggregates: Overall sentiment metrics for your brand across AI responses - Company Sentiment Aggregates: Aggregated sentiment data specific to your company mentions - Keyword Clouds: Visual representation of frequently associated keywords and their sentiment weights - Sentiment Breakdowns by Engine: Detailed sentiment analysis segmented by different AI search engines (e.g., ChatGPT, Perplexity, etc.) Authentication This endpoint requires authentication via the apitoken variable.
GET /api/v2/ai-visibility/domains/{domain_id}/metrics/sentiment - Read
Fetch Citation analytics
Fetch Citation Analytics Get comprehensive citation analytics for a domain, including detailed breakdowns of how the domain appears in AI-generated search responses. Overview This endpoint retrieves citation data for a specified domain, providing insights into: - Domain aggregations: Overall citation metrics at the domain level - URL aggregations: Citation metrics broken down by individual URLs - Citation breakdowns by AI engine: How different AI search engines cite your domain - Citation breakdowns by query: Which search queries trigger citations of your domain - Brand analysis: Citation performance for your brand - Competitor analysis: Comparative citation data against competitors Path Variables - {{domainid}} (required): The unique identifier for the domain you want to fetch citation analytics for Query Parameters All query parameters are optional and can be used to filter and refine the citation data: - topics[]: Filter citation data by specific topics - Type: Array of strings - Example: topics[]=Ai Search visibility - Use this to focus on citations related to particular subject areas or themes - searchterms[]: Analyze citations for specific search terms or queries - Type: Array of strings - Example: searchterms[]=How often does Keyword.com show up in AI-generated search responses? - Use this to understand how your domain is cited when users search for particular terms Response The response includes comprehensive citation analytics with domain and URL level aggregations, breakdowns by AI engine, query-specific citation data, brand performance metrics, and competitor comparison data.
GET /api/v2/ai-visibility/domains/{domain_id}/metrics/citations
No operations match.
See How connections work for access and permissions, or browse all integrations.
Reference date: October 28, 2026. Keyword API docs.