GET
/
competitor-scan
/
keyword-scans
cURL
curl --request GET \
  --url https://api.gmbapi.com/external-api/gmb/competitor-scan/keyword-scans \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "payload": [
    {
      "keyword": "<string>",
      "rank": 123,
      "appearance": 123,
      "radius": 123,
      "placeId": "<string>",
      "created_date": 123,
      "location_id": "<string>",
      "scan_id": "<string>"
    }
  ]
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

account_id
string
required

Account ID (required)

location_id
string

Location ID associated with the keywords

placeId
string

Google Place ID for the location

status
enum<string>

Filter scans by status

Available options:
completed,
failed,
in_progress

Response

Keyword scans response

success
boolean

Indicates if the request was successful

payload
object[]

Array of keyword scan data