Create Rank Grid Report

POST

https://api.synup.com/api/v4/create-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.

Request

Header Params

Body Params application/json

Example

{
    "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"
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.synup.com/api/v4/create-grid-report' \
--header 'Authorization: API T9V35W3xxxxxxxxxxx' \
--header 'Content-Type: application/json' \
--data-raw '{
    "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"
}'

Responses

🟢200OK

application/json

Grid rank report created successfully

Body

Example

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

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

Modified at 2025-05-15 13:49:59

Local Rank Grid

Fetch All Grid Reports for Location