GET
/
competitor-scan
cURL
curl --request GET \
  --url https://api.gmbapi.com/external-api/gmb/competitor-scan \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "payload": {
    "id": "abc123-def4-5678-90ab-cdef12345678",
    "placeId": "ChIJAaBcDdEfGhIJKlMnOpQrStUv",
    "radius": 5000,
    "text": "Coffee Shop",
    "createdAt": 1700000000000,
    "created_by": "user_abc123xyz",
    "type": "general",
    "account_id": "12345678901234567890",
    "origin": "app.example.com",
    "competitors": [
      {
        "rank": "1",
        "name": "Example Coffee House",
        "address": "123 Main Street, City, State 12345, Country",
        "categories": [
          "Coffee shop",
          "Cafe"
        ],
        "reviews": 450,
        "avgRating": 4.8,
        "placeId": "ChIJXyZwAbCdEfGhIjKlMnOpQr",
        "website": "https://example-coffee.com",
        "gac": true,
        "lng": "-122.4194",
        "lat": "37.7749",
        "appearances": 95,
        "top3appearances": 90,
        "top5appearances": 95,
        "top10appearances": 95
      }
    ],
    "center": {
      "lat": 37.7749,
      "lng": -122.4194
    },
    "client": {
      "rank": 8,
      "name": "My Coffee Business",
      "address": "456 Oak Avenue, City, State 12345, Country",
      "categories": [
        "Coffee shop",
        "Bakery"
      ],
      "locationImages": [
        "https://example.com/image1.jpg",
        "https://example.com/image2.jpg"
      ],
      "numberOfImages": 125,
      "reviews": 180,
      "avgRating": 4.5,
      "placeId": "ChIJAaBcDdEfGhIJKlMnOpQrStUv",
      "website": "https://my-coffee-business.com",
      "description": "A cozy neighborhood coffee shop serving artisanal coffee and fresh pastries.",
      "gac": false,
      "lng": "-122.4200",
      "lat": "37.7750",
      "hasQA": true,
      "appearances": 78,
      "top3appearances": 5,
      "top5appearances": 15,
      "top10appearances": 35,
      "hasPosts": true,
      "postDate": "2024-01-15T10:30:00.000Z",
      "profileUrl": "https://example.com/profile.jpg",
      "dots": {
        "dot1": 12,
        "dot2": 8,
        "dot3": 10,
        "dot4": 15,
        "dot5": 7
      }
    },
    "strategy": {
      "reviews_to_top1": 270,
      "reviews_to_top3": 150,
      "reviews_to_top5": 80,
      "images_to_top1": 325,
      "images_to_top3": 200,
      "images_to_top5": 100,
      "reviews_strategy": null
    },
    "dots": [
      {
        "rank": "8",
        "lat": 37.775,
        "lng": -122.42,
        "ring": 1,
        "dotId": "dot1"
      },
      {
        "rank": "12",
        "lat": 37.776,
        "lng": -122.421,
        "ring": 2,
        "dotId": "dot2"
      }
    ],
    "number_of_competitors": 42,
    "finishedAt": {
      "_seconds": 1700000100,
      "_nanoseconds": 500000000
    },
    "status": "completed"
  }
}

Authorizations

Authorization
string
header
required

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

Query Parameters

scanId
string

Unique identifier for the scan

account_id
string
required

Account ID associated with the scan (required)

location_id
string

Location ID associated with the scan

placeId
string

Google Place ID for the location

Response

Scan data response - Returns the latest scan for account location or scan based on scan ID

success
boolean

Indicates if the request was successful

payload
object

Comprehensive scan data including competitors, rankings, and analysis