---
title: "Fetch Rank Grid Report By ID"
method: GET
path: "/grid-report/{reportId}"
tags: ["Grid Rank"]
---

# Fetch Rank Grid Report By ID

`GET /grid-report/{reportId}`

## Request

- Base URL: `https://api.synup.com/api/v4`
- URL: `https://api.synup.com/api/v4/grid-report/{reportId}`
- Auth: none required
- TypeScript: <https://skmtc.dev/synup/apis/synup-api/docs/grid-report/:reportId/get.ts> (a function with typed inputs; its response is checked against the schema)

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.

## Path parameters

- `reportId` string, uuid, required

## Headers

- `Authorization` string, required

## Response `200`

Grid rank report retrieved successfully

- GridReportResponse
  - `data` object
    - `gridrankReportById` GridReportV2
      - `id` string, uuid: Report ID
      - `locationId` string: Location ID
      - `accountId` string: Account ID
      - `keyword` string: Keyword used for rank analysis
      - `businessName` string: Exact name of the business in Google Maps
      - `businessStreet` string: Street address of the business
      - `businessCity` string: City of the business
      - `businessState` string: State of the business
      - `businessCountry` string: Country of the business
      - `gridSize` 3 | 5 | 7: Size of the grid used for analysis
      - `gridDistance` number: Grid distance value
      - `gridDistanceUnit` 'mi' | 'km': Unit of grid distance measurement
      - `gridDistanceInKm` number, float: Grid distance converted to kilometers
      - `ranks` RankPointV2[]: Array of ranking results for each coordinate
        - `rank` number: Rank at this coordinate (-1 if not ranked)
        - `latitude` number, float: Latitude of the grid point
        - `longitude` number, float: Longitude of the grid point
      - `averageRank` number, float: Average rank across all grid points
      - `topOneShare` number, float: Percentage of coordinates with rank <= 3
      - `topTwoShare` number, float: Percentage of coordinates with rank <= 10
      - `status` 'PROCESSING' | 'COMPLETED': Current status of the report
      - `latitude` number, float: Business latitude coordinate
      - `longitude` number, float: Business longitude coordinate
      - `placeId` string, nullable: Google Place ID of the business
      - `createdAt` string: Epoch timestamp in milliseconds

## Other responses

- `400`: Bad Request - Invalid report ID format
- `401`: Unauthorized - Valid API key required
- `403`: Forbidden - Insufficient permissions
- `404`: Report not found

---

[API](https://skmtc.dev/synup/apis/synup-api.md) - [All operations](https://skmtc.dev/synup/apis/synup-api/llms.txt) - [OpenAPI document](https://skmtc.dev/synup/apis/synup-api/revisions/67de2d51c22e?raw)