Account
get
account.get
The token’s own user, optionally with the subscription block
Risk: read
data full type
data full type
Keywords
add
keywords.add
Add keywords to a project, each with its domain, region and language. Adding a keyword already tracked returns the existing one
Risk: write
keywords full type
keywords full type
data full type
data full type
bulkDelete
keywords.bulkDelete
Delete many keywords from one project in a single call; their history is lost
Risk: destructive · Irreversible
projectId, where the single-keyword routes take the project name.
Output
meta full type
meta full type
bulkUpdate
keywords.bulkUpdate
Apply the same domain, region, tags or status to many keywords in one project
Risk: write
changes full type
changes full type
meta full type
meta full type
delete
keywords.delete
Delete one keyword and its ranking history; it cannot be restored
Risk: destructive · Irreversible
meta full type
meta full type
get
keywords.get
One keyword with its rank, metrics and rank history
Risk: read
data full type
data full type
list
keywords.list
Every keyword in a project or group with its rank, best rank, search volume and trend, read as of a given day
Risk: read
data full type
data full type
refresh
keywords.refresh
Queue keywords for an on-demand rank check; spends the plan’s daily refresh quota. The whole request is refused if the quota would be exceeded
Risk: destructive
update
keywords.update
Change a keyword’s domain, region, tags, status, baseline or favourite flag
Risk: write
data full type
data full type
Metrics
competitors
metrics.competitors
The top competing URLs for one keyword in a date window, with each result’s type and position
Risk: read
data full type
data full type
get
metrics.get
Keyword movement for a project, group or tag: how many sit in each top-N bucket and how that changed day over day
Risk: read
data full type
data full type
Mindshare
history
mindshare.history
Share of Voice over a date window, read from Keyword’s cache
Risk: read
projectId, and read from Keyword’s cache.
Output
Projects
archive
projects.archive
Archive a project or subproject: it stops updating until projects.restore brings it back. Keyword refuses to archive the account’s only active top-level project
Risk: write
meta full type
meta full type
create
projects.create
Create a project, or a subproject from a Parent[sub]Child name; the parent must exist first
Risk: write
data full type
data full type
delete
projects.delete
Delete a project with every keyword and its ranking history; it cannot be restored
Risk: destructive · Irreversible
meta full type
meta full type
get
projects.get
One project or subproject with its tags and counts
Risk: read
data full type
data full type
list
projects.list
Every project and subproject with its tags and keyword counts; a subproject is named Parent[sub]Child
Risk: read
Parent[sub]Child in its id.
Output
data full type
data full type
restore
projects.restore
Undo an archive, bringing the project and its keywords back
Risk: write
meta full type
meta full type
Rank Chart
get
rankChart.get
Daily rank history for a set of keywords over a number of days; Keyword refuses a call covering more than 400,000 keyword-days
Risk: read
limit or send fewer keywords.
Output
data full type
data full type
Ranking Urls
list
rankingUrls.list
The pages that rank best for a project, with their average position and total search volume, 10 to a page
Risk: read
data full type
data full type
Regions
list
regions.list
The Google regions a project tracks, with each one’s language and keyword count
Risk: read
data full type
data full type
Sharing
get
sharing.get
A project’s shared-report settings: whether the share link is on, its hash, whether it needs a password, and what the report shows
Risk: read
visibility full type
visibility full type
keyword_columns full type
keyword_columns full type
keyword_charts full type
keyword_charts full type
overview_charts full type
overview_charts full type
branding full type
branding full type
update
sharing.update
Turn a project’s share link on or off, set or clear its password, or toggle what the shared report shows. Everything except the on/off switch needs Keyword’s white-label permission
Risk: write
visibility full type
visibility full type
visibility full type
visibility full type
keyword_columns full type
keyword_columns full type
keyword_charts full type
keyword_charts full type
overview_charts full type
overview_charts full type
branding full type
branding full type