Skip to content
SynupAPI
Get an API key
GETapi.synup.com/api/v4/locations/{locationId}/grid-reports

Fetch All Grid Reports for Location

This API generates a new rank grid report to analyze business rankings for specified keywords across a grid specified by the user using grid distance and the number of grid coordinates to be analyzed. Behavior:

  • Returns a list of reports generated for the given location.
  • Includes report IDs, keywords analyzed, and timestamps.
  • Can be used to track ranking trends over time.
Requires an API key. Send it as Authorization: API <your-key> — see Getting started.

Parameters

Path

NameTypeRequiredDescription
locationIdstringrequiredLocation ID should be provided in Base64 encoded format. Must be in the format Location:<Location ID>

Request

Request
curl -X GET 'https://api.synup.com/api/v4/locations/:locationId/grid-reports' \
  -H 'Authorization: API YOUR_API_KEY' \
  -H 'Content-Type: application/json'

Responses

StatusDescription
200Grid rank reports retrieved successfully
400Bad Request - Invalid location ID format
401Unauthorized - Valid API key required
403Forbidden - Insufficient permissions
404Location not found
Example response
{
  "data": {
    "gridrankReportsByLocationId": [
      {
        "id": "df996f3d-1c0e-48da-be74-8cfec452984b",
        "locationId": "84703",
        "accountId": "15004",
        "keyword": "italian restaurant",
        "businessName": "Chianti, Koramangala",
        "businessStreet": "No 12, 5th Block, Koramangala",
        "businessCity": "Bengaluru",
        "businessState": "Karnataka",
        "businessCountry": "India",
        "gridSize": 3,
        "gridDistance": 20,
        "gridDistanceUnit": "km",
        "gridDistanceInKm": 20,
        "ranks": [
          {
            "rank": 6,
            "latitude": 12.80803271879746,
            "longitude": 77.4894662571528
          }
        ],
        "averageRank": 8.25,
        "topOneShare": 0,
        "topTwoShare": 0,
        "status": "COMPLETED",
        "latitude": 12.935216,
        "longitude": 77.619961,
        "placeId": null,
        "createdAt": "1719372126514"
      }
    ]
  }
}

Response body

NameTypeRequiredDescription
dataobjectoptional
data.gridrankReportsByLocationIdarray of objectoptional
data.gridrankReportsByLocationId[].idstringoptionalReport ID
data.gridrankReportsByLocationId[].locationIdstringoptionalLocation ID
data.gridrankReportsByLocationId[].accountIdstringoptionalAccount ID
data.gridrankReportsByLocationId[].keywordstringoptionalKeyword used for rank analysis
data.gridrankReportsByLocationId[].businessNamestringoptionalExact name of the business in Google Maps
data.gridrankReportsByLocationId[].businessStreetstringoptionalStreet address of the business
data.gridrankReportsByLocationId[].businessCitystringoptionalCity of the business
data.gridrankReportsByLocationId[].businessStatestringoptionalState of the business
data.gridrankReportsByLocationId[].businessCountrystringoptionalCountry of the business
data.gridrankReportsByLocationId[].gridSizeintegeroptionalSize of the grid used for analysis
357
data.gridrankReportsByLocationId[].gridDistancenumberoptionalGrid distance value
data.gridrankReportsByLocationId[].gridDistanceUnitstringoptionalUnit of grid distance measurement
mikm
data.gridrankReportsByLocationId[].gridDistanceInKmnumberoptionalGrid distance converted to kilometers
data.gridrankReportsByLocationId[].ranksarray of objectoptionalArray of ranking results for each coordinate
data.gridrankReportsByLocationId[].ranks[].ranknumberoptionalRank at this coordinate (-1 if not ranked)
data.gridrankReportsByLocationId[].ranks[].latitudenumberoptionalLatitude of the grid point
data.gridrankReportsByLocationId[].ranks[].longitudenumberoptionalLongitude of the grid point
data.gridrankReportsByLocationId[].averageRanknumberoptionalAverage rank across all grid points
data.gridrankReportsByLocationId[].topOneSharenumberoptionalPercentage of coordinates with rank <= 3
data.gridrankReportsByLocationId[].topTwoSharenumberoptionalPercentage of coordinates with rank <= 10
data.gridrankReportsByLocationId[].statusstringoptionalCurrent status of the report
PROCESSINGCOMPLETED
data.gridrankReportsByLocationId[].latitudenumberoptionalBusiness latitude coordinate
data.gridrankReportsByLocationId[].longitudenumberoptionalBusiness longitude coordinate
data.gridrankReportsByLocationId[].placeIdstringoptionalGoogle Place ID of the business
data.gridrankReportsByLocationId[].createdAtstringoptionalEpoch timestamp in milliseconds