RankSharkDocs
Scans

List a campaign's scans

RankShark TrackScopetrack:read

GET
/v1/track/campaigns/{id}/scans

Newest first, summaries only (no points).

Scope: track:read.

Authorization

headerAuthorizationBearer <rstk_… API key or OAuth access token>

A Track API key (rstk_…, Settings → API & MCP) or an OAuth access token issued for this API

Path Parameters

id*string

Campaign id (gt_…). A malformed id is 404 not_found.

Match^gt_[A-Za-z0-9]{10,40}$

Query Parameters

keyword?string

One keyword (prompt)

Lengthlength <= 300
engine?string

One engine: a campaign engine (maps, local_pack, search, bing_maps, bing_local_pack, bing_search) or an AI engine (ai_mode, ai_overview, gemini, chatgpt, perplexity)

Lengthlength <= 40
limit?integer

1-200, default 50

Range1 <= value <= 200

Response Body

OK

application/json
  1. response
[index: integer]?
Example Request
curl -X GET 'https://panel.rankshark.io/v1/track/campaigns/gt_8fK2mQ9xLp3s/scans'
Example Response
[  {    "id": "gs_4Pz8Qw2Er6TyUi",    "keyword": "emergency dentist",    "engine": "maps",    "mode": "grid",    "status": "running",    "trigger": "manual",    "createdAt": "2026-11-05T10:12:40.000Z",    "startedAt": "2026-11-05T10:13:02.000Z",    "finishedAt": null,    "progress": {      "done": 18,      "failed": 0,      "total": 49    },    "metrics": null,    "organicMetrics": null,    "error": null,    "note": null,    "grid": {      "size": 7,      "radiusM": 4828,      "shape": "square",      "unit": "mi"    },    "suspect": false,    "wait": {      "ahead": 0,      "startsInMin": 0,      "minutesLeft": 4    }  },  {    "id": "gs_3Hq7Vt2NwR8cYp",    "keyword": "dentist near me",    "engine": "maps",    "mode": "grid",    "status": "done",    "trigger": "schedule",    "createdAt": "2026-11-02T15:00:04.000Z",    "startedAt": "2026-11-02T15:00:31.000Z",    "finishedAt": "2026-11-02T15:06:12.000Z",    "progress": {      "done": 49,      "failed": 0,      "total": 49    },    "metrics": {      "points": 49,      "total": 49,      "found": 44,      "foundPct": 89.8,      "top3": 27,      "top10": 39,      "arp": 4.18,      "atrp": 5.9,      "solv": 55.1    },    "organicMetrics": null,    "error": null,    "note": null,    "grid": {      "size": 7,      "radiusM": 4828,      "shape": "square",      "unit": "mi"    },    "suspect": false  }]

Get a scan GET

Every grid point (rank, organic rank, the listings seen in order), the listings, the metrics, the competitors and, for AI scans, aiMetrics and brands. Live while the scan runs. Scope: `track:read`.

The competitors of a scan GET

The businesses seen across the grid, best (lowest ATRP) first; the tracked business is marked isTarget. AI scans also list the brands the answers named. Scope: `track:read`.