New to Corsair? See API access, authentication, and error handling.
Analysis
get
analysis.get
Poll one analysis: the status alone while it runs, then the target word count, terms, questions and SERP competitors
Risk: read
Answers only a status until it is ready; the metrics, terms, ideas and competitors appear only then.
Output
metrics full type
metrics full type
terms full type
terms full type
terms_txt full type
terms_txt full type
ideas full type
ideas full type
competitors full type
competitors full type
start
analysis.start
Queue a content analysis for a keyword, spending one Content Writer analysis from the monthly limit; poll analysis.get for the recommendations
Risk: destructive · Irreversible
Spends one Content Writer analysis from the monthly limit, and answers before the recommendations exist.
Output
Content
evaluate
content.evaluate
Score content against its analysis without saving a revision, so a draft can be checked before it is written back
Risk: read
Scores the content without saving a revision, so it costs no revision history.
Output
get
content.get
Read a query’s last saved content revision, or the latest autosave as well
Risk: read
Output
import
content.import
Replace the editor content from HTML or a fetched URL, saving it as a new revision
Risk: write
Saves a new revision. Takes html or url, never both.
Output
Projects
list
projects.list
List the account’s projects with the id, language and search engine each one uses
Risk: read
projects full type
projects full type
Queries
list
queries.list
List the queries in a project, filterable by status, source, keyword, language, engine, dates and tags
Risk: read
Output
queries full type
queries full type