New to Corsair? See API access, authentication, and error handling.
Searchanalytics
query
searchanalytics.query
Query search traffic: clicks, impressions, CTR and position, grouped by date, query, page, country, device or another dimension
Risk: read
Page with
startRow; there is no page token. Results are sorted by clicks, descending. The HOUR dimension needs dataState HOURLY_ALL and covers only 10 days.
dimensionFilterGroups full type
dimensionFilterGroups full type
rows full type
rows full type
metadata full type
metadata full type
Sitemaps
delete
sitemaps.delete
Remove a sitemap from the property’s Sitemaps report. Google may still crawl the sitemap and the URLs it already found
Risk: destructive
Output:
void
get
sitemaps.get
Read one submitted sitemap
Risk: read
Output
contents full type
contents full type
list
sitemaps.list
List the sitemaps submitted for a property, with their errors and warnings
Risk: read
Output
sitemap full type
sitemap full type
submit
sitemaps.submit
Submit a sitemap URL, which asks Google to fetch it. Sending one already listed refreshes its status
Risk: write
feedpath is the sitemap URL; Google fetches it. A PUT with no body.
Output: void
Sites
add
sites.add
Add a property the account already controls to the API’s property list. It does not verify ownership
Risk: write
Adds a property the account already controls. It does not verify ownership.
Output:
void
delete
sites.delete
Remove a property from this account’s Search Console property list. Other owners keep it, and it can usually be re-added without verifying again
Risk: destructive
Output:
void
get
sites.get
Read one property and the permission level on it
Risk: read
Output
list
sites.list
List the properties the credentials can reach, with the permission level on each
Risk: read
siteEntry full type
siteEntry full type
Url Inspection
inspect
urlInspection.inspect
Inspect one URL: whether Google indexed it, the canonical it chose, and any mobile-usability, rich-result or AMP issues
Risk: read
Its own quota: 2,000 per day and 600 per minute per site.
Output
inspectionResult full type
inspectionResult full type