1. Grid Rank
  • Getting Started
  • Locations
    • Location Attributes
      MARKDOWN
    • Photo specifications for your business location
      MARKDOWN
    • Star and Unstar Photos
      MARKDOWN
    • Create a new business location
      POST
    • Update business location
      POST
    • List all locations
      GET
    • List particular locations
      GET
    • Search locations
      GET
    • Get locations by store codes
      GET
    • Upload Photos to a Location
      POST
    • Check Bulk Photo Upload Status
      GET
    • Star/Unstar Location Photos
      POST
    • Delete Location Photos
      POST
    • Archive multiple locations
      POST
    • Cancel scheduled location archival
      POST
    • Activate archived locations
      POST
    • List Active Subscriptions
      GET
    • Get a list of supported countries and their states
      GET
    • Get SubCategories and AdditionalCategories
      GET
    • Get Site Details for Your Plan
      GET
  • Organizing locations
    • Organizing locations
      MARKDOWN
    • Create a new folder
      POST
    • List all folders
      GET
    • List all folders under an account in hierarchical structure
      GET
    • Get details of a folder
      GET
    • Rename a folder
      POST
    • Add locations to a folder
      POST
    • Remove locations from a folder
      POST
    • Delete a folder
      POST
    • List locations under a folder
      GET
    • List all tags
      GET
    • List locations by tags
      GET
    • Add location to a tag
      POST
    • Remove location from a tag
      POST
  • User Management
    • User Attributes
    • Create User with Role
    • List Users
    • List Users by ID
    • Add Locations to User
    • Add User and folder
    • List User Roles
    • Add folders to user
    • List User Resources
    • Update a User
    • Remove Folders for User
    • Remove Locations for User
  • Grid Rank
    • Local Rank Grid
      MARKDOWN
    • Create Rank Grid Report
      POST
    • Fetch All Grid Reports for Location
      GET
    • Fetch Rank Grid Report By ID
      GET
  • Review Campaigns
    • Review Campaign Info Attributes
    • Create a review campaign
    • Add customers to a review campaign
    • List review campaigns
    • List review campaign customers
  • Listings
    • Listings
    • Listing Status Webhooks
    • Get premium listings
    • Get voice listings for a location
    • Get duplicate listings for a location
    • Get all duplicate listings for an account
    • Mark listings as duplicates
    • Mark listings as not duplicates
    • Get AI listings
  • Connected Accounts
    • Connected Accounts
    • Connect Google Profile to Account
    • Connect Facebook Page to Account
    • List all connected accounts
    • List folders under a Google account
    • Create GMB Listing
    • Disconnect GMB Profile
    • Disconnect Facebook Account
    • Fetch Connected Account Details
    • Trigger New Matches
    • List Connection Suggestions
    • Fetch Connected Account Listings
    • Confirm Connected Account Matches
    • Connect a location with a listing of a connected account
    • Disconnect Location from Listing
  • Rankings
    • Rankings Analytics Attributes
    • Add keywords
    • List Keywords
    • Get keywords performance
    • Archive a keyword
    • Get Rollup Keyword Performance
    • Get Rankings Distribution By Time
  • Profile Analytics
    • Profile Analytics
    • Get Bing Analytics
    • Get Facebook Page Analytics
    • Get Google My Business Analytics
  • Reviews
    • Reviews
    • Review Sources
      • Get a list of interaction sources for location
      • Get a list of interaction sources for account
      • Add / Edit interaction source
    • Fetch all interactions
    • List Interactions by IDs
    • Respond to an Interaction
    • Edit Response for Interaction
    • Archive Response for Interaction
    • Get Interaction Analytics
    • Add Review Widget
    • Edit Review Widget
  • Automations
    • Temporary Close Location with a reopening date
  • Error Codes
    • ERROR CODES
  1. Grid Rank

Fetch Rank Grid Report By ID

GET
https://api.synup.com/api/v4/grid-report/{reportId}
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.

Request

Path Params

Header Params

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api.synup.com/api/v4/grid-report/' \
--header 'Authorization: API T9V35W3xxxxxxxxxxx'

Responses

🟢200OK
application/json
Grid rank report retrieved successfully
Body

Example
{
    "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"
        }
    }
}
🟠400Bad Request
🟠401Unauthorized
🟠403Forbidden
🟠404Record Not Found
Modified at 2025-05-15 13:50:26
Previous
Fetch All Grid Reports for Location
Next
Review Campaign Info Attributes
Built with