Skip to content
SynupAPI
Get an API key
GETapi.synup.com/api/v4/grid-report/{reportId}

Fetch Rank Grid Report By ID

This API retrieves all grid rank reports associated with a specific location.

Behaviour:

  • Business details – It returns a list of reports generated for the given location.
  • Grid configuration – Grid size, geographic coordinates, and search parameters.
  • Ranking results – Performance across specified keywords within the grid.
Requires an API key. Send it as Authorization: API <your-key> — see Getting started.

Parameters

Path

NameTypeRequiredDescription
reportIdstringrequiredUUID of the report to fetch

Request

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

Responses

StatusDescription
200Grid rank report retrieved successfully
400Bad Request - Invalid report ID format
401Unauthorized - Valid API key required
403Forbidden - Insufficient permissions
404Report not found
Example response
{
  "data": {
    "gridrankReportById": {
      "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.gridrankReportByIdobjectoptional
data.gridrankReportById.idstringoptionalReport ID
data.gridrankReportById.locationIdstringoptionalLocation ID
data.gridrankReportById.accountIdstringoptionalAccount ID
data.gridrankReportById.keywordstringoptionalKeyword used for rank analysis
data.gridrankReportById.businessNamestringoptionalExact name of the business in Google Maps
data.gridrankReportById.businessStreetstringoptionalStreet address of the business
data.gridrankReportById.businessCitystringoptionalCity of the business
data.gridrankReportById.businessStatestringoptionalState of the business
data.gridrankReportById.businessCountrystringoptionalCountry of the business
data.gridrankReportById.gridSizeintegeroptionalSize of the grid used for analysis
357
data.gridrankReportById.gridDistancenumberoptionalGrid distance value
data.gridrankReportById.gridDistanceUnitstringoptionalUnit of grid distance measurement
mikm
data.gridrankReportById.gridDistanceInKmnumberoptionalGrid distance converted to kilometers
data.gridrankReportById.ranksarray of objectoptionalArray of ranking results for each coordinate
data.gridrankReportById.ranks[].ranknumberoptionalRank at this coordinate (-1 if not ranked)
data.gridrankReportById.ranks[].latitudenumberoptionalLatitude of the grid point
data.gridrankReportById.ranks[].longitudenumberoptionalLongitude of the grid point
data.gridrankReportById.averageRanknumberoptionalAverage rank across all grid points
data.gridrankReportById.topOneSharenumberoptionalPercentage of coordinates with rank <= 3
data.gridrankReportById.topTwoSharenumberoptionalPercentage of coordinates with rank <= 10
data.gridrankReportById.statusstringoptionalCurrent status of the report
PROCESSINGCOMPLETED
data.gridrankReportById.latitudenumberoptionalBusiness latitude coordinate
data.gridrankReportById.longitudenumberoptionalBusiness longitude coordinate
data.gridrankReportById.placeIdstringoptionalGoogle Place ID of the business
data.gridrankReportById.createdAtstringoptionalEpoch timestamp in milliseconds