Run a map-pack grid scan

Embed

<a href="https://seolyticize.com/docs/ref-run-local-grid-scan"><img src="https://seolyticize.com/docs/_api/public/orgs/71cb2b7a-a719-4003-b3ea-6321dc1db8ab/spaces/3bf2dbf7-3faa-473c-ba3b-30588f5f8de4/pages/79d52c70-eb61-4767-9036-979a48064695/social-card.svg?v=3e7ae33eec8b" alt="Run a map-pack grid scan" width="600" height="315"></a>

POSThttps://seolyticize.com/api/v1/tools/run_local_grid_scan

Searches the term at every point of a size × size grid around the location (1.5 km apart) and records where the business appears in the map pack. Every point is a paid lookup, so a 7 × 7 grid is 49 lookups: quote it with estimate_cost and get the user's go-ahead first. Runs in the background; read the result with get_local_visibility a few minutes later. With maxCostMicros, the scan is refused before it starts when its estimate is over the limit. Answers 'scan our map-pack visibility now'.

Request body application/json

clientIdstringrequired

locationIdstringrequired

termstringrequired

sizenumber

Grid width in points: 3, 5 or 7.

= 5

maxCostMicrosinteger

Optional spending limit for this call, in micro-USD (1,000,000 = $1). A purchase that would take the call past it is refused before anything is bought. Pass the estimate from estimate_cost, or what the user agreed to spend.

{
  "clientId": "string",
  "locationId": "string",
  "term": "string",
  "size": 5,
  "maxCostMicros": 0
}

Code samples

cURL

curl -X POST "https://seolyticize.com/api/v1/tools/run_local_grid_scan" \
  -H "Content-Type: application/json" \
  -d '{"clientId":"string","locationId":"string","term":"string","size":5,"maxCostMicros":0}'

TypeScript

const res = await fetch('https://seolyticize.com/api/v1/tools/run_local_grid_scan', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({"clientId":"string","locationId":"string","term":"string","size":5,"maxCostMicros":0}),
});
const data = await res.json();

Python

import requests

res = requests.request(
    "POST",
    "https://seolyticize.com/api/v1/tools/run_local_grid_scan",
    headers={
    "Content-Type": "application/json",
    },
    json={"clientId": "string", "locationId": "string", "term": "string", "size": 5, "maxCostMicros": 0},
)
data = res.json()

package main

import (
	"fmt"
	"io"
	"net/http"
	"strings"
)

func main() {
	req, _ := http.NewRequest("POST", "https://seolyticize.com/api/v1/tools/run_local_grid_scan", strings.NewReader(`{"clientId":"string","locationId":"string","term":"string","size":5,"maxCostMicros":0}`))
	req.Header.Set("Content-Type", "application/json")
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}

PHP

<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://seolyticize.com/api/v1/tools/run_local_grid_scan');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{"clientId":"string","locationId":"string","term":"string","size":5,"maxCostMicros":0}');
$response = curl_exec($ch);
curl_close($ch);
echo $response;

Ruby

require 'net/http'
require 'uri'

uri = URI('https://seolyticize.com/api/v1/tools/run_local_grid_scan')
req = Net::HTTP::Post.new(uri)
req['Content-Type'] = 'application/json'
req.body = '{"clientId":"string","locationId":"string","term":"string","size":5,"maxCostMicros":0}'
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body

Java

import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://seolyticize.com/api/v1/tools/run_local_grid_scan"))
    .header("Content-Type", "application/json")
    .method("POST", BodyPublishers.ofString("{\"clientId\":\"string\",\"locationId\":\"string\",\"term\":\"string\",\"size\":5,\"maxCostMicros\":0}"))
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

Responses

200 The tool's result, under data.

Example

{
  "data": {}
}

Schema

datarequired

400 The body was not JSON or did not match the tool's input schema.

Example

{
  "error": "string"
}

Schema

errorstringrequired