Keyword plugin

• Most routes are scoped by project name, a few by project ID. keywords.list, metrics.get and the rest take the project name exactly as projects.list returns it, which may be a subproject written Parent[sub]Child. The bulk routes and mindshare.history take the numeric project_id instead.
• A group is a project. Keyword calls them groups in its API and projects in its app, and projects.list returns both projects and subprojects, told apart by the [sub] marker in the id.
• The project’s own auth key is never returned. Keyword includes a per-project auth key in every project and keyword resource. The plugin removes it before a result reaches a caller, so it never lands in a log or a response body.
• Adding a keyword that already exists returns the existing one rather than an error, so a bulk add is safe to repeat.
• A refresh spends the plan’s daily quota. keywords.refresh queues keywords for an on-demand check. The whole request is refused when the quota would be exceeded, and the answer names how many refreshes remain.
• A full plan is a 402, not a rate limit. Keyword enforces the plan’s keyword allowance, and that failure is permanent, so it is not retried. A 429 is a throughput limit and is retried twice.
• Rank history is bounded. rankChart.get refuses a call covering more than 400,000 keyword-days, so a large group needs a shorter limit or fewer keywords.
• Paging. keywords.list takes page and per_page and returns a meta block; Keyword does not publish a total-count cursor, so read meta for what it does send.
• Webhooks. The plugin does not receive Keyword webhooks; none are configured here.

• 23 typed API operations

Setup

npm install corsair @corsair-dev/keyword better-sqlite3
npm install --save-dev @types/better-sqlite3

yarn add corsair @corsair-dev/keyword better-sqlite3
yarn add --dev @types/better-sqlite3

pnpm install corsair @corsair-dev/keyword better-sqlite3
pnpm install --save-dev @types/better-sqlite3

bun add corsair @corsair-dev/keyword better-sqlite3
bun add --dev @types/better-sqlite3

import Database from 'better-sqlite3';
import { createCorsair } from 'corsair';
import { keyword } from '@corsair-dev/keyword';

export const corsair = createCorsair({
	plugins: [
		keyword(),
	],
	database: new Database('corsair.db'),
	kek: process.env.CORSAIR_KEK!,
	multiTenancy: true,
	hub: {
		projectApiKey: process.env.CORSAIR_API_KEY!,
		signingSecret: process.env.CORSAIR_SIGNING_SECRET!,
	},
});

keyword()

const { connectUrl } = await corsair.manage.connect.createLink({
	plugin: 'keyword',
	tenantId: 'acme',
});
// redirect the user's browser to connectUrl

Example API calls

const tenant = corsair.withTenant('acme');
await tenant.keyword.api.keywords.list({ projectName: 'Disney', per_page: 50 });

const tenant = corsair.withTenant('acme');
await tenant.keyword.api.keywords.add({
	projectName: 'Disney',
	keywords: [{
		kw: 'jungle book',
		url: 'disney.com',
		region: 'google.com',
		language: 'en',
	}],
});

What’s next