Download OpenAPI specification:
Local Dominator
grid_size is the number of pins across the diameter (circle) or side (square), while distance is the distance in meters between each pin.
For example, grid_size: 10 and distance: 100 gives a ~900m diameter.
| text |
string
Filter scans by text(name, keywords, labels) |
| per_page |
integer
Default:
10
Example:
per_page=10
|
| page |
integer
Default:
0
Example:
page=0
|
| start_date |
string
<date>
Example:
start_date=2024-01-01
Retrieve scans that occurred on or after the specified start date (in YYYY-MM-DD format). |
| end_date |
string
<date>
Example:
end_date=2024-08-31
Retrieve scans that occurred on or before the specified end date (in YYYY-MM-DD format). |
| labels |
Array of strings
An array of labels associated with the scan |
{
-
"totalcount":
10,
-
"scans":
[
-
{
-
"keyword":
"Something
near
me",
-
"name":
"Something
INC.",
-
"vicinity":
"Something
street
69
Somethingland",
-
"place_id":
"ChIJszZ0aEdOqTcR-wk88Z99zx8",
-
"data_id":
"0x872b09a937691f09:0x430887a672cf2151",
-
"grid_size":
6,
-
"locations_distance":
1609.344,
-
"shape":
"circle",
-
"creation_timestamp":
"2024-07-12
14:08:50.736785+00",
-
"center_lat":
10.69696,
-
"center_lng":
10.42,
-
"average_rank":
5.5,
-
-
"share_links":
{
-
-
},
-
"content":
[
-
[
-
5,
-
5,
-
5,
-
4,
-
4,
-
8,
-
5
],
-
[
-
5,
-
5,
-
5,
-
3,
-
1,
-
3,
-
2
],
-
[
-
5,
-
5,
-
2,
-
2,
-
2,
-
2,
-
2
],
-
[
-
4,
-
3,
-
2,
-
1,
-
1,
-
2,
-
4
],
-
[
-
3,
-
3,
-
2,
-
2,
-
2,
-
3,
-
2
],
-
[
-
null,
-
3,
-
3,
-
2,
-
2,
-
6,
-
5
],
-
[
-
null,
-
null,
-
null,
-
null,
-
2,
-
2,
-
2
]
],
-
"pins_status":
[
-
[
-
1,
-
1,
-
1,
-
1,
-
1,
-
1,
-
1
],
-
[
-
1,
-
1,
-
1,
-
1,
-
1,
-
1,
-
1
],
-
[
-
1,
-
1,
-
1,
-
1,
-
1,
-
1,
-
1
],
-
[
-
1,
-
1,
-
1,
-
1,
-
1,
-
1,
-
1
],
-
[
-
1,
-
1,
-
1,
-
1,
-
1,
-
1,
-
1
],
-
[
-
0,
-
1,
-
1,
-
1,
-
1,
-
1,
-
1
],
-
[
-
0,
-
0,
-
0,
-
0,
-
1,
-
1,
-
1
]
],
-
"labels":
[
-
"string"
]
}
]
}
Initiates a scan based on the specified parameters.
|
latitude
required
|
number
<float>
Latitude of the center point from where the scan will be performed. |
|
longitude
required
|
number
<float>
Longitude of the center point from where the scan will be performed. |
|
shape
required
|
string
Enum:
"circle"
"square"
Shape of the scan area, either circle or square. |
|
distance
required
|
integer
<int32>
Distance in meters between adjacent pins in the scan grid. This does not define the total diameter directly. |
|
google_place_id
required
|
string
The PlaceID in
Google. For
example,
|
|
grid_size
required
|
integer
<int32>
<= 21
Defines the number of points on each square side or diameter to perform the search from. Maximum value is 21. |
|
search_terms
required
|
Array of strings
Array of strings representing the search terms to use during the scan. |
| webhook_url |
string
A url where we will POST the results back once the scan is completed. |
| preschedule_analysis |
boolean
Default:
false
When set to true, automatically schedules analysis when the scan is completed. |
{
-
"latitude":
40.712776,
-
"longitude":
-74.005974,
-
"shape":
"circle",
-
"distance":
1000,
-
"google_place_id":
"ChIJgUbEo8cfqokR5lP9_Wh_DaM",
-
"grid_size":
13,
-
"search_terms":
[
-
"coffee
shop",
-
"restaurant"
],
-
-
"preschedule_analysis":
true
}
{
-
"message":
"Scan
creation
started.",
-
"scan_uuid":
"xPH5x_SZcmcf8E7FROCNQ"
}
Returns the details of the scan
specified by scan_id.
|
scan_id
required
|
string
The ID of the scan |
[
-
{
-
"keyword":
"Something
near
me",
-
"name":
"Something
INC.",
-
"vicinity":
"Something
street
69
Somethingland",
-
"place_id":
"ChIJszZ0aEdOqTcR-wk88Z99zx8",
-
"data_id":
"0x872b09a937691f09:0x430887a672cf2151",
-
"grid_size":
6,
-
"locations_distance":
1609.344,
-
"shape":
"circle",
-
"creation_timestamp":
"2024-07-12
14:08:50.736785+00",
-
"center_lat":
10.69696,
-
"center_lng":
10.42,
-
"average_rank":
5.5,
-
-
"share_links":
{
-
-
},
-
"content":
[
-
[
-
5,
-
5,
-
5,
-
4,
-
4,
-
8,
-
5
],
-
[
-
5,
-
5,
-
5,
-
3,
-
1,
-
3,
-
2
],
-
[
-
5,
-
5,
-
2,
-
2,
-
2,
-
2,
-
2
],
-
[
-
4,
-
3,
-
2,
-
1,
-
1,
-
2,
-
4
],
-
[
-
3,
-
3,
-
2,
-
2,
-
2,
-
3,
-
2
],
-
[
-
null,
-
3,
-
3,
-
2,
-
2,
-
6,
-
5
],
-
[
-
null,
-
null,
-
null,
-
null,
-
2,
-
2,
-
2
]
],
-
"pins_status":
[
-
[
-
1,
-
1,
-
1,
-
1,
-
1,
-
1,
-
1
],
-
[
-
1,
-
1,
-
1,
-
1,
-
1,
-
1,
-
1
],
-
[
-
1,
-
1,
-
1,
-
1,
-
1,
-
1,
-
1
],
-
[
-
1,
-
1,
-
1,
-
1,
-
1,
-
1,
-
1
],
-
[
-
1,
-
1,
-
1,
-
1,
-
1,
-
1,
-
1
],
-
[
-
0,
-
1,
-
1,
-
1,
-
1,
-
1,
-
1
],
-
[
-
0,
-
0,
-
0,
-
0,
-
1,
-
1,
-
1
]
],
-
"labels":
[
-
"string"
]
}
]
The details of each business in every point in the scan.
|
scan_id
required
|
string
The ID of the scan |
[
-
{
-
"scan_id":
1,
-
"compressed_grid":
[
-
[
-
0
]
],
-
"details_array":
[
-
{
-
"place_id":
"ChIJCR9pl6kJK4cRUCHPcqaHCPr",
-
"data_id":
"0x872b09a997691f09:0xa30887a672cf2150",
-
"name":
"Something
INC.",
-
"vicinity":
"Something
street
4",
-
"location":
{
-
"latitude":
1.222,
-
"longitude":
100.222
},
-
"rating":
2.5,
-
"rating_count":
620,
-
"primary_category":
"Somethining",
-
"secondary_categories":
[
-
"string"
],
-
-
}
]
}
]
Initiates or retrieves the AI analysis for a scan. The analysis examines the scan data and provides insights on business rankings and optimization opportunities.
|
scan_id
required
|
string
The ID of the scan to analyze |
{
-
"scanId":
"xPH5x_SZcmcf8E7FROCNQ",
-
"message":
"Group
was
successfully
analyzed",
-
"analysis":
{
-
"property1":
{
-
"analysis_content":
{
-
"summary":
{
-
"overall_status":
"string",
-
"top_competitors":
[
-
{
-
"name":
"string",
-
"average_rank":
0,
-
"reviews_count":
0,
-
"average_rating":
0,
-
"total_appearances":
0,
-
"performance_summary":
"string",
-
"appearances_position_1":
0,
-
"appearances_position_2":
0,
-
"appearances_position_3":
0
}
],
-
"competitor_analysis":
"string",
-
"competition_overview":
"string",
-
"top_competitor_action_items":
[
-
"string"
]
},
-
"basic_info":
{
-
"grid_size":
0,
-
"scan_date":
"string",
-
"grid_shape":
"string",
-
"business_name":
"string",
-
"primary_keyword":
"string",
-
"locations_amount":
0,
-
"average_position_rank":
0
},
-
"action_plan":
[
-
{
-
"actions":
[
-
"string"
],
-
"category":
"string"
}
],
-
"seo_insights":
{
-
"keyword_uniformity":
"string",
-
"geographic_patterns":
{
-
"weak_zones":
[
-
{
-
"details":
"string",
-
"direction":
"string"
}
],
-
"strong_zones":
[
-
{
-
"details":
"string",
-
"direction":
"string"
}
]
},
-
"directional_patterns":
[
-
{
-
"direction":
"string",
-
"performance":
"string"
}
],
-
"geographic_performance_summary":
"string"
},
-
"opportunity_statement":
"string"
},
-
},
-
"property2":
{
-
"analysis_content":
{
-
"summary":
{
-
"overall_status":
"string",
-
"top_competitors":
[
-
{
-
"name":
"string",
-
"average_rank":
0,
-
"reviews_count":
0,
-
"average_rating":
0,
-
"total_appearances":
0,
-
"performance_summary":
"string",
-
"appearances_position_1":
0,
-
"appearances_position_2":
0,
-
"appearances_position_3":
0
}
],
-
"competitor_analysis":
"string",
-
"competition_overview":
"string",
-
"top_competitor_action_items":
[
-
"string"
]
},
-
"basic_info":
{
-
"grid_size":
0,
-
"scan_date":
"string",
-
"grid_shape":
"string",
-
"business_name":
"string",
-
"primary_keyword":
"string",
-
"locations_amount":
0,
-
"average_position_rank":
0
},
-
"action_plan":
[
-
{
-
"actions":
[
-
"string"
],
-
"category":
"string"
}
],
-
"seo_insights":
{
-
"keyword_uniformity":
"string",
-
"geographic_patterns":
{
-
"weak_zones":
[
-
{
-
"details":
"string",
-
"direction":
"string"
}
],
-
"strong_zones":
[
-
{
-
"details":
"string",
-
"direction":
"string"
}
]
},
-
"directional_patterns":
[
-
{
-
"direction":
"string",
-
"performance":
"string"
}
],
-
"geographic_performance_summary":
"string"
},
-
"opportunity_statement":
"string"
},
-
}
}
}