Create Grid Report
POST/api/v4/create-grid-reportThis endpoint generates a grid report based on the provided location and business details.
Request
Header Params
Authorization
string
required
Example:
API nC3IaYImyrUzMv_NH6MrzDfp-CA
Content-Type
string
required
Example:
application/json
Body Params application/json
locationId
string
optional
Example:
TG9jYXRpb246MTA0MzgzNw==q32
keywords
array[string]
optional
Example:
["Debt collection"]
businessName
string
optional
Example:
Debt rec
businessStreet
string
optional
Example:
Aspin Commercial Tower Sheikh Zayed Road, , AE
businessCity
string
optional
Example:
businessState
string
optional
Example:
businessCountry
string
optional
Example:
AE
latitude
number <double>
optional
Example:
25.2089625
longitude
number <double>
optional
Example:
55.2724984
distance
number <double>
optional
Example:
2.5
distanceUnit
string
optional
Example:
km
gridSize
integer
optional
Example:
3
Example
{
"locationId": "TG9jYXRpb246MTA0MzgzNw==q32",
"keywords": [
"Debt collection"
],
"businessName": "Debt rec",
"businessStreet": "Aspin Commercial Tower Sheikh Zayed Road, , AE",
"businessCity": "",
"businessState": "",
"businessCountry": "AE",
"latitude": 25.2089625,
"longitude": 55.2724984,
"distance": 2.5,
"distanceUnit": "km",
"gridSize": 3
}Request samples
Responses
OK(200)
Bad Request(400)
Unauthorized(401)
Record Not Found(404)
HTTP Code: 200
Content Type : JSONapplication/json
Successfully created grid report
Data Schema
reportId
string
optional
ID of the created report
Example:
report_12345
Example
{
"reportId": "report_12345"
}Last modified: 5 days ago