---
title: "Create Rank Grid Report"
method: POST
path: "/create-grid-report"
tags: ["Grid Rank"]
---

# Create Rank Grid Report

`POST /create-grid-report`

## Request

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

This API generates a new rank grid report to analyze business rankings across specified keywords.

**Behavior:**
- Evaluates business rankings in a defined geographic grid.
- Supports multiple keywords for ranking analysis.
- The response includes report IDs, which can be used to fetch report details.

## Headers

- `Authorization` string, required

## Request body

- CreateGridReportInput
  - `locationId` string, required: Base64 encoded location ID
  - `keywords` string[], required: Keywords for analysis of rank for the business (maximum 25)
  - `businessName` string, required: Exact name of the business in Google Maps
  - `businessStreet` string, required: Street address of the business
  - `businessCity` string, required: City of the business
  - `businessState` string, required: State of the business
  - `businessCountry` string, required: Country of the business
  - `latitude` number, float, required: Latitude coordinate of the business
  - `longitude` number, float, required: Longitude coordinate of the business
  - `distance` number, required: Grid Distance
  - `distanceUnit` 'mi' | 'km', required: Distance unit (mi for Miles, km for Kilometers)
  - `gridSize` 3 | 5 | 7, required: Size of the grid for analysis

## Response `200`

Grid rank report created successfully

- CreateGridReportResponse
  - `data` object
    - `createGridrankReport` object
      - `data` object
        - `reportIds` string[]: Array of created report IDs
      - `errors` string, nullable: Error message if request failed

## Other responses

- `400`: Bad Request - Invalid input parameters
- `401`: Unauthorized - Valid API key required
- `403`: Forbidden - Insufficient permissions

---

[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)