POSTapi.synup.com/api/v4/create-grid-report

Create Rank Grid Report

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.

Requires an API key. Send it as Authorization: API <your-key> — see Getting started.

Parameters

Body

Name	Type	Required	Description
`locationId`	string	required	Base64 encoded location ID
`keywords`	array of 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	required	Latitude coordinate of the business
`longitude`	number	required	Longitude coordinate of the business
`distance`	number	required	Grid Distance
`distanceUnit`	string	required	Distance unit (mi for Miles, km for Kilometers) `mikm`
`gridSize`	integer	required	Size of the grid for analysis `357`

Request

curl -X POST 'https://api.synup.com/api/v4/create-grid-report' \
  -H 'Authorization: API YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "locationId": "TG9jYXRpb246OTI2MDMw",
  "keywords": [
    "grill"
  ],
  "gridSize": 3,
  "distanceUnit": "mi",
  "latitude": "33.8937913",
  "longitude": "35.5017767",
  "distance": 2.5,
  "businessName": "The Grill",
  "businessStreet": "1418 Professor Wafic Sinno Avenue, Beirut, LB",
  "businessCity": "Beirut",
  "businessState": "",
  "businessCountry": "Lebanon"
}'

const res = await fetch('https://api.synup.com/api/v4/create-grid-report', {
  method: 'POST',
  headers: {
    Authorization: 'API YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "locationId": "TG9jYXRpb246OTI2MDMw",
    "keywords": [
      "grill"
    ],
    "gridSize": 3,
    "distanceUnit": "mi",
    "latitude": "33.8937913",
    "longitude": "35.5017767",
    "distance": 2.5,
    "businessName": "The Grill",
    "businessStreet": "1418 Professor Wafic Sinno Avenue, Beirut, LB",
    "businessCity": "Beirut",
    "businessState": "",
    "businessCountry": "Lebanon"
  }),
});
const data = await res.json();

import requests
res = requests.post(
    "https://api.synup.com/api/v4/create-grid-report",
    headers={
        "Authorization": "API YOUR_API_KEY",
        "Content-Type": "application/json",
    },
    json={
      "locationId": "TG9jYXRpb246OTI2MDMw",
      "keywords": [
        "grill"
      ],
      "gridSize": 3,
      "distanceUnit": "mi",
      "latitude": "33.8937913",
      "longitude": "35.5017767",
      "distance": 2.5,
      "businessName": "The Grill",
      "businessStreet": "1418 Professor Wafic Sinno Avenue, Beirut, LB",
      "businessCity": "Beirut",
      "businessState": "",
      "businessCountry": "Lebanon"
    },
)
data = res.json()

req, _ := http.NewRequest("POST", "https://api.synup.com/api/v4/create-grid-report", bytes.NewBufferString(payload))
req.Header.Set("Authorization", "API YOUR_API_KEY")
req.Header.Set("Content-Type", "application/json")

res, err := http.DefaultClient.Do(req)

Responses

Status	Description
`200`	Grid rank report created successfully
`400`	Bad Request - Invalid input parameters
`401`	Unauthorized - Valid API key required
`403`	Forbidden - Insufficient permissions

Example response

{
  "data": {
    "createGridrankReport": {
      "data": {
        "reportIds": [
          "79a2773e-17ab-4209-b8d2-8261478f655f"
        ]
      },
      "errors": null
    }
  }
}

Response body

Name	Type	Required	Description
`data`	object	optional
`data.createGridrankReport`	object	optional
`data.createGridrankReport.data`	object	optional
`data.createGridrankReport.data.reportIds`	array of string	optional	Array of created report IDs
`data.createGridrankReport.errors`	string	optional	Error message if request failed