RankPilot API

GET/reports/global

Totals across every property this credential can read

GET/properties/{id}/reports/dashboard

Dashboard

Clicks, impressions, CTR and position for a property over a range, with the previous period.

GET/properties/{id}/reports/queries

Queries

Search queries with clicks, impressions, CTR and position, and the change against the previous period.

GET/properties/{id}/reports/pages

Pages

Pages with clicks, impressions, CTR and position, and the change against the previous period.

GET/properties/{id}/reports/countries

Countries

Clicks, impressions, CTR and position by country, with the change against the previous period.

GET/properties/{id}/reports/devices

Devices

Clicks, impressions, CTR and position by device, with shares and the change against the previous period.

GET/properties/{id}/reports/appearance

Search Appearance

Clicks, impressions, CTR and position by search appearance type.

GET/properties/{id}/reports/new-lost

New & Lost Rankings

Queries or pages that appeared or disappeared between two periods, with the counts of all four kinds.

GET/properties/{id}/reports/rank-changes

Rank Changes

Keywords whose average position improved or worsened between two periods, with click and impression impact.

GET/properties/{id}/reports/query-detail

Query Detail

Trend, position distribution, ranking pages, seasonality and related queries for one query or a regex group.

GET/properties/{id}/reports/ctr-benchmark

CTR Benchmark

Queries or pages whose click-through rate is below (or above) the property curve at the same position, with the clicks missed.

GET/properties/{id}/reports/ai_visibility

AI Visibility Report

Google generative-AI impressions, assistant referral sessions and AI-prone query share, each on its own, with insights.

GET/properties/{id}/reports/brand-split

Branded vs Non-Branded

Clicks and impressions split into branded, non-branded and unattributed queries, with the previous period.

GET/properties/{id}/reports/change-events

Change events

Deploys, crawl changes, deployed tasks, data gaps and incidents recorded for a property in a date range (read only).

GET/properties/{id}/reports/competitor-comparison

Competitor Comparison

Compares your crawled pages with one competitor sample: click depth, internal links, structured data and title terms. Figures describe the pages crawled, never the whole site, and carry no rankings, traffic, backlinks or keyword volumes.

GET/properties/{id}/reports/ctr-curve

Global CTR Curve

The click-through rate of all your properties by Google position 1 to 20 (ratio of sums over analysed queries), with the gap to each verified benchmark. Unverified placeholder benchmarks are never returned.

GET/properties/{id}/reports/global-report

Global Reports

Clicks, impressions, CTR and position summed over all your properties for a stored global run, with the per-property breakdown, the top countries and the properties that could not be loaded. Ratios are ratios of sums; twin properties are removed by default.

GET/properties/{id}/reports/migration-compare

Migration Compare

The last result of a saved site migration: clicks per day before and after go-live, recovery, the rule-based risk score with every factor, and the old pages ranked worst first.

GET/properties/{id}/reports/position-buckets

Impressions by Position

Queries and impressions in the position buckets 1-3, 4-10, 11-20 and 21+, with the previous period.

GET/properties/{id}/reports/query-counting

Query Counting

Distinct queries per day, in total and by position bucket.

GET/properties/{id}/reports/sampling-impact

Sampling Impact

For each property, the percentage of clicks hidden by Search Console sampling at query and page level, with levels and summary cards. Query over 50 percent and page over 15 percent are High.

GET/properties/{id}/reports/technical-summary

Technical changes

Confirmed technical changes found by the monitor, counted by severity (read only).

GET/properties/{id}/reports/internal-link-opportunities

Internal link opportunities

Ranked internal link suggestions: source, destination, anchor, evidence strength and the queries behind each (read only).

GET/properties/{id}/reports/schema-validation

Structured data validation

Structured data problems grouped by rule with the Google documentation link and affected page count (read only).

GET/properties/{id}/reports/programmatic-seo-health

Programmatic SEO health

Template clusters with indexed ratio and interval, duplication, thin share, depth, worst finding, change since the last run and tasks created (read only).

GET/properties/{id}/reports/local-matrix

Service by city matrix

Services by cities for a local business: the mapped page, impression-weighted position of its tagged queries, clicks, leads, lead rate and the NAP and business-markup status of each cell, plus gap cells with no page. No search volume is estimated (read only).

GET/properties/{id}/reports/sitemap-performance

Sitemap performance

Clicks, impressions and pages without traffic for each sitemap of the newest analysis (read only).

GET/properties/{id}/reports/ga-overview

GA4 overview

Sessions, engaged sessions, key events and revenue of the site by day, from Google Analytics 4 (read only).

GET/properties/{id}/reports/ga-channels

GA4 channels

GA4 sessions, engagement, key events and revenue by default channel group (read only).

GET/properties/{id}/reports/ga-sources

GA4 sources

GA4 sessions by source and medium (read only).

GET/properties/{id}/reports/ga-pages

GA4 pages

GA4 page views per page with the Search Console clicks of the same page (read only).

GET/properties/{id}/reports/ga-landing-pages

GA4 landing pages

GA4 landing sessions, engagement, organic sessions, key events and revenue per landing page (read only).

GET/properties/{id}/reports/ga-countries

GA4 countries

GA4 sessions by country, with full country names (read only).

GET/properties/{id}/reports/ga-key-events

GA4 key events

The events marked as key events in GA4: how often they fired and what they were worth (read only).

GET/properties/{id}/reports/ga-error-pages

GA4 error pages

Pages whose title or path looks like a 404, with views, previous period and Search Console clicks (read only). Detected from titles and paths: GA4 records no HTTP status.

GET/properties/{id}/reports/ga-ecommerce

GA4 e-commerce

GA4 item views, add to cart, purchases and revenue per item (read only).

GET/properties/{id}/reports/ga-custom-dimensions

GA4 custom dimensions

Event counts per value of one synced GA4 custom dimension (read only); pass dim as customEvent:name or customUser:name.

GET/properties/{id}/reports/ga-blended

Blended Search Console and GA4

Search Console clicks and GA4 sessions of the same pages joined on the normalised URL, with match state both, gsc_only or ga4_only (read only). ga4filters is the JSON of the screen.

GET/properties/{id}/reports/merchant-listings

Merchant listings

Clicks, impressions, CTR, impression-weighted position and share of site impressions for the Merchant listings and Product snippets search appearances, with the change against the previous period.

GET/properties/{id}/reports/organic-shopping

Organic Shopping

Free listing clicks, impressions and CTR per product from Google Merchant Center (paid ads excluded), with the change against the previous period. At most 100 rows; there is no position in this data.

GET/properties/{id}/reports/feed-audit

Feed Audit

The 21 Merchant feed checks with the number of errors, warnings and suggestions found by the latest finished audit (read only).

GET/properties/{id}/reports/title-hygiene

Title Hygiene

How many synced Merchant products break each title rule: short, long, capitals, promotion, symbols, missing brand, odd spaces, repeated word, duplicate title, no colour or size (read only).

GET/properties/{id}/reports/tracked-rankings

Tracked rankings

Tracked keywords with the latest SERP vendor sample: rank at one location and device on one date from a named provider (a third-party estimate, empty when the property was not in the top 20), the previous sample and change, the ranking URL, and the GSC average position in a separate column. Never merged with Search Console position (read only).

GET/properties/{id}/reports/affiliate-links

Affiliate links

Affiliate links detected on the property pages: network, rel attributes (sponsored or nofollow only), whether a disclosure phrase was found in the page text RankPilot stored (a text heuristic, not legal advice), and destination health (a blocked or rate-limited destination is unknown, never dead). Page revenue appears only where a page-level source reports it, labelled with that source; otherwise clicks to affiliate links or nothing (read only).

GET/properties/{id}/reports/trust-checklist

Trust checklist

Trust checklist from stored page snapshots: for each site policy page and each page element (byline, author link, reviewer credit for YMYL pages, visible and machine-readable dates, sources, disclosure, first-hand cue) the status present, missing, unknown or not applicable, with the matched or looked-for evidence. Observable on-page facts, not a score, and not a claim about rankings (read only).

GET/properties/{id}/reports/backlinks

Backlinks

Referring domains per backlink source (Bing Webmaster Tools, a Search Console Links import, each vendor you connected): newest snapshot against the one before, as new, lost and changed domains. Every row names its source and whether it is first-party data or a third-party estimate; sources are never summed or merged, and a capped snapshot makes "lost" unreliable (read only).

GET/properties/{id}/reports/adsense-readiness

AdSense readiness

The AdSense readiness checklist of the newest run: blocking and advisory checks with their status (ok, fail or unknown with the missing input), pages affected, and whether each check comes from a program policy, Google guidance or a RankPilot heuristic. A list of observable facts to fix before applying; it never predicts approval, which Google decides (read only).

GET/properties/{id}/reports/crawl-logs

Crawl logs

Crawler hits read from the property's server logs: per day, crawler family (Googlebot, Bingbot, GPTBot, ClaudeBot and the other registry families) and trust level, with status classes. Verified means the request came from an address the vendor publishes; claimed means only the user agent says so. Families are never summed. Fewer than 14 days of logs (see Days of logs) means crawl conclusions are likely, not measured (read only).

GET/properties/{id}/reports/{reportId}

Run any report by id